com.sun.jini.reggie

Class ConstrainableEventLease

java.lang.Object

com.sun.jini.lease.AbstractLease

com.sun.jini.reggie.EventLease

com.sun.jini.reggie.ConstrainableEventLease

All Implemented Interfaces:

Serializable, RemoteMethodControl, Lease, ReferentUuid

public final class ConstrainableEventLease
extends EventLease
implements RemoteMethodControl

EventLease subclass that supports constraints.

Author:

Sun Microsystems, Inc.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sun.jini.lease.AbstractLease

expiration, serialFormat

Fields inherited from interface net.jini.core.lease.Lease

ABSOLUTE, ANY, DURATION, FOREVER

Method Summary

Modifier and Type	Method and Description
boolean	canBatch(Lease lease) Two leases can be batched if they are both RegistrarLeases, share the same server, and have compatible constraints.
LeaseMap	createLeaseMap(long duration) Creates a constraint-aware lease map.
boolean	equals(Object obj) Returns true if lease Uuids match, false otherwise.
MethodConstraints	getConstraints() Returns the client constraints placed on this proxy.
Uuid	getReferentUuid() Returns the lease Uuid.
int	hashCode() Returns the lease Uuid's hash code.
RemoteMethodControl	setConstraints(MethodConstraints constraints) Returns a new copy of this proxy with the client constraints set to the specified constraints.
String	toString() Returns a string created from the proxy class name, the registrar's service ID, the id of the lessee or event (depending on the subclass), and the result of the underlying server proxy's toString method.

Methods inherited from class com.sun.jini.reggie.EventLease

cancel, doRenew

Methods inherited from class com.sun.jini.lease.AbstractLease

getExpiration, getSerialFormat, renew, setSerialFormat

Methods inherited from class java.lang.Object

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

Method Detail

createLeaseMap

public LeaseMap createLeaseMap(long duration)

Creates a constraint-aware lease map.

Specified by:

createLeaseMap in interface Lease

Parameters:

duration - the duration to put into a Long and use as the value for the current lease in the created LeaseMap

Returns:

the created LeaseMap object

canBatch

public boolean canBatch(Lease lease)

Two leases can be batched if they are both RegistrarLeases, share the same server, and have compatible constraints.

Specified by:

canBatch in interface Lease

Parameters:

lease - the Lease to be evaluated

Returns:

a boolean indicating whether or not the lease given as a parameter can be batched (placed in the same LeaseMap) with the current lease

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)

getReferentUuid

public Uuid getReferentUuid()

Returns the lease Uuid.

Specified by:

getReferentUuid in interface ReferentUuid

Returns:

the Uuid associated with the resource this proxy represents. Will not return null.

hashCode

public int hashCode()

Returns the lease Uuid's hash code.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Returns true if lease Uuids match, false otherwise.

Overrides:

equals in class Object

toString

public String toString()

Returns a string created from the proxy class name, the registrar's service ID, the id of the lessee or event (depending on the subclass), and the result of the underlying server proxy's toString method.

Overrides:

toString in class Object

Returns:

String