org.apache.river.landlord

Class LandlordLease

java.lang.Object

org.apache.river.lease.AbstractLease

org.apache.river.landlord.LandlordLease

All Implemented Interfaces:

Serializable, Lease, ProxyAccessor, ReferentUuid, ID<Uuid>

Direct Known Subclasses:

ConstrainableLandlordLease

public class LandlordLease
extends AbstractLease
implements ReferentUuid, ID<Uuid>, ProxyAccessor

Basic implementation of net.jini.core.lease.Lease that works with the the Landlord protocol.

Since:

2.0

Author:

Sun Microsystems, Inc.

See Also:

Landlord, Serialized Form

Field Summary

Fields inherited from class org.apache.river.lease.AbstractLease

expiration, serialFormat

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

ABSOLUTE, ANY, DURATION, FOREVER

Constructor Summary

Constructors

Constructor and Description
LandlordLease(Uuid cookie, Landlord landlord, Uuid landlordUuid, long expiration) Create a new LandlordLease.

Method Summary

Modifier and Type	Method and Description
boolean	canBatch(Lease lease)
void	cancel()
LeaseMap<? extends Lease,Long>	createLeaseMap(long duration)
protected long	doRenew(long renewDuration) Renew the lease for a duration relative to now, and return the duration actually granted.
boolean	equals(Object other)
Object	getProxy()
Uuid	getReferentUuid()
int	hashCode()
Uuid	identity()
String	toString()

Methods inherited from class org.apache.river.lease.AbstractLease

getExpiration, getSerialFormat, renew, setSerialFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

LandlordLease

public LandlordLease(Uuid cookie,
                     Landlord landlord,
                     Uuid landlordUuid,
                     long expiration)

Create a new LandlordLease.

Parameters:

cookie - a Uuid that universally and uniquely identifies the lease this object is to be a proxy for

landlord - Landlord object that will be used to communicate renew and cancel requests to the granter of the lease

landlordUuid - a universally unique id that has been assigned to the server granting of the lease. Ideally the Uuid landlord.getUuid would return if landlord implemented ReferentUuid. Used to determine when two leases can be batched together.

expiration - the initial expiration time of the lease in milliseconds since the beginning of the epoch

Throws:

NullPointerException - if landlord, landlordUuid or cookie is null

Method Detail

cancel

public void cancel()
            throws UnknownLeaseException,
                   RemoteException

Specified by:

cancel in interface Lease

Throws:

UnknownLeaseException

RemoteException

doRenew

protected long doRenew(long renewDuration)
                throws LeaseDeniedException,
                       UnknownLeaseException,
                       RemoteException

Description copied from class: AbstractLease

Renew the lease for a duration relative to now, and return the duration actually granted.

Specified by:

doRenew in class AbstractLease

Throws:

LeaseDeniedException

UnknownLeaseException

RemoteException

getReferentUuid

public Uuid getReferentUuid()

Specified by:

getReferentUuid in interface ReferentUuid

equals

public boolean equals(Object other)

Overrides:

equals in class Object

canBatch

public boolean canBatch(Lease lease)

Specified by:

canBatch in interface Lease

createLeaseMap

public LeaseMap<? extends Lease,Long> createLeaseMap(long duration)

Specified by:

createLeaseMap in interface Lease

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

identity

public Uuid identity()

Specified by:

identity in interface ID<Uuid>

Returns:

object representing identity, usually a Uuid.

getProxy

public Object getProxy()

Specified by:

getProxy in interface ProxyAccessor