org.apache.river.outrigger

Class ConstrainableSpaceProxy2

java.lang.Object

org.apache.river.outrigger.SpaceProxy2

org.apache.river.outrigger.ConstrainableSpaceProxy2

All Implemented Interfaces:

Serializable, Administrable, RemoteMethodControl, ReferentUuid, JavaSpace, JavaSpace05

final class ConstrainableSpaceProxy2
extends SpaceProxy2
implements RemoteMethodControl

Constrainable subclass of SpaceProxy2

Field Summary

Fields

Modifier and Type	Field and Description
private MethodConstraints	methodConstraints Client constraints placed on this proxy (may be null
private static Method[]	methodMapArray Array containing element pairs in which each pair of elements represents a mapping between two methods having the following characteristics: the first element in the pair is one of the public, remote method(s) that may be invoked by the client through SpaceProxy2.
(package private) static long	serialVersionUID

Fields inherited from class org.apache.river.outrigger.SpaceProxy2

serverMaxServerQueryTimeout, space, spaceUuid

Fields inherited from interface net.jini.space.JavaSpace

NO_WAIT

Constructor Summary

Constructors

Constructor and Description
ConstrainableSpaceProxy2(OutriggerServer space, Uuid spaceUuid, long serverMaxServerQueryTimeout, MethodConstraints methodConstraints) Create a new ConstrainableSpaceProxy2.

Method Summary

Modifier and Type	Method and Description
private static OutriggerServer	constrainServer(OutriggerServer server, MethodConstraints constraints) Returns a copy of the given OutriggerServer proxy having the client method constraints that result after mapping defined by methodMapArray is applied.
protected Lease	constructLease(Uuid uuid, long expiration) Create a new lease with the specified id and initial expiration
MethodConstraints	getConstraints() Returns the client constraints placed on this proxy.
private ProxyTrustIterator	getProxyTrustIterator() Returns a proxy trust iterator that is used in ProxyTrustVerifier to retrieve this object's trust verifier.
private void	readObject(ObjectInputStream s)
RemoteMethodControl	setConstraints(MethodConstraints constraints) Returns a new copy of this proxy with the client constraints set to the specified constraints.

Methods inherited from class org.apache.river.outrigger.SpaceProxy2

contents, entryFrom, equals, getAdmin, getReferentUuid, hashCode, newLease, notify, read, readIfExists, registerForAvailabilityEvent, repFor, repFor, snapshot, take, take, takeIfExists, toString, write, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

methodMapArray

private static final Method[] methodMapArray

Array containing element pairs in which each pair of elements represents a mapping between two methods having the following characteristics:

• the first element in the pair is one of the public, remote method(s) that may be invoked by the client through SpaceProxy2.
• the second element in the pair is the method, implemented in the backend server class, that is ultimately executed in the server's backend when the client invokes the corresponding method in this proxy.

methodConstraints

private final MethodConstraints methodConstraints

Client constraints placed on this proxy (may be null

Constructor Detail

ConstrainableSpaceProxy2

ConstrainableSpaceProxy2(OutriggerServer space,
                         Uuid spaceUuid,
                         long serverMaxServerQueryTimeout,
                         MethodConstraints methodConstraints)

Create a new ConstrainableSpaceProxy2.

Parameters:

space - The OutriggerServer for the space.

spaceUuid - The universally unique ID for the space

serverMaxServerQueryTimeout - The value this proxy should use for the maxServerQueryTimeout if no local value is provided.

methodConstraints - the client method constraints to place on this proxy (may be null).

Throws:

NullPointerException - if space or spaceUuid is null.

IllegalArgumentException - if serverMaxServerQueryTimeout is not larger than zero.

ClassCastException - if server does not implement RemoteMethodControl.

Method Detail

constrainServer

private static OutriggerServer constrainServer(OutriggerServer server,
                                               MethodConstraints constraints)

Returns a copy of the given OutriggerServer proxy having the client method constraints that result after mapping defined by methodMapArray is applied.

Parameters:

server - The proxy to attach constrains too.

constraints - The source method constraints.

Throws:

NullPointerException - if server is null.

ClassCastException - if server does not implement RemoteMethodControl.

setConstraints

public RemoteMethodControl setConstraints(MethodConstraints constraints)

Description copied from interface: RemoteMethodControl

Returns a new copy of this proxy with the client constraints set to the specified constraints. These constraints completely replace (in the copy) any client constraints previously placed on this proxy; calling the getConstraints method of the copy returns the identical constraints instance. The original proxy is not modified. A null value is interpreted as mapping all methods to empty constraints (one that has no requirements and no preferences). For any given remote call, the specific client requirements and preferences to be satisfied are given by the return value of invoking the getConstraints method of the specified MethodConstraints instance with a Method object representing the remote method.

Client constraints placed on a proxy are included in the serialized state of the proxy. This allows third-party services to be transparent to the client's needs. For example, if remote object s1 obtains a proxy for remote object s2, and passes that proxy to remote object s3, expecting s3 to invoke a remote method on s2, then s1 can control that call by placing its constraints directly on the proxy before passing it to s3. If s3 does not wish to be transparent in this way, then it should explicitly replace the client constraints on received proxies with whatever constraints are appropriate to implement its own policy.

Specified by:

setConstraints in interface RemoteMethodControl

Parameters:

constraints - client constraints, or null

Returns:

a new copy of this proxy with the client constraints set to the specified constraints

See Also:

RemoteMethodControl.getConstraints()

getConstraints

public MethodConstraints getConstraints()

Description copied from interface: RemoteMethodControl

Returns the client constraints placed on this proxy. The return value can be null, which is interpreted as mapping all methods to empty constraints (one that has no requirements and no preferences).

Specified by:

getConstraints in interface RemoteMethodControl

Returns:

the client constraints, or null

See Also:

RemoteMethodControl.setConstraints(net.jini.core.constraint.MethodConstraints)

getProxyTrustIterator

private ProxyTrustIterator getProxyTrustIterator()

Returns a proxy trust iterator that is used in ProxyTrustVerifier to retrieve this object's trust verifier.

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

constructLease

protected Lease constructLease(Uuid uuid,
                               long expiration)

Description copied from class: SpaceProxy2

Create a new lease with the specified id and initial expiration

Overrides:

constructLease in class SpaceProxy2