org.apache.river.landlord

Class LandlordLeaseMap

java.lang.Object

java.util.AbstractMap<K,Long>

org.apache.river.lease.AbstractIDLeaseMap

org.apache.river.landlord.LandlordLeaseMap

All Implemented Interfaces:

Map, LeaseMap

Direct Known Subclasses:

ConstrainableLandlordLeaseMap

public class LandlordLeaseMap
extends AbstractIDLeaseMap

Implementation of LeaseMap for LandlordLease.

Since:

2.0

Author:

Sun Microsystems, Inc.

See Also:

LandlordLease, LeaseMap

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private Landlord	landlord The landlord which this map will talk to.
private Uuid	landlordUuid The Uuid of the landlord.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LandlordLeaseMap(Landlord landlord, Uuid landlordUuid, Lease lease)
(package private)	LandlordLeaseMap(Landlord landlord, Uuid landlordUuid, Lease lease, long duration) Create a new LandlordLeaseMap.

Method Summary

Modifier and Type	Method and Description
void	cancelAll() Cancels all leases in the LeaseMap.
boolean	canContainKey(Object key) Returns true if the given object is a Lease which can be renewed and cancelled in a batch with other leases in the map.
(package private) static Landlord	checkLandlord(Landlord landlord)
(package private) static Uuid	checkLandlordUuid(Uuid landlordUuid)
(package private) static Lease	checkLease(Lease lease)
(package private) Landlord	landlord() Return the landlord.
void	renewAll() Renews all leases in the LeaseMap, using their current values as the renewal durations.

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

containsKey, containsValue, entrySet, get, put, remove

Methods inherited from class java.util.AbstractMap

clear, clone, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll, size, values

Field Detail

landlord

private final Landlord landlord

The landlord which this map will talk to.

landlordUuid

private final Uuid landlordUuid

The Uuid of the landlord. Used to determine if a lease can be placed in this map.

Constructor Detail

LandlordLeaseMap

LandlordLeaseMap(Landlord landlord,
                 Uuid landlordUuid,
                 Lease lease,
                 long duration)

Create a new LandlordLeaseMap.

Parameters:

landlord - Owner of the resource lease is for.

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.

lease - first lease to be placed in the map. It is assumed that canContainKey(lease) would be true. Must work with the landlord protocol.

duration - the duration the lease should be renewed for if renewAll is called

Throws:

NullPointerException - if landlord or landlordUuid is null.

LandlordLeaseMap

private LandlordLeaseMap(Landlord landlord,
                         Uuid landlordUuid,
                         Lease lease)

Method Detail

checkLease

static Lease checkLease(Lease lease)
                 throws ClassCastException

Throws:

ClassCastException

checkLandlordUuid

static Uuid checkLandlordUuid(Uuid landlordUuid)
                       throws NullPointerException

Throws:

NullPointerException

checkLandlord

static Landlord checkLandlord(Landlord landlord)
                       throws NullPointerException

Throws:

NullPointerException

canContainKey

public boolean canContainKey(Object key)

Description copied from interface: LeaseMap

Returns true if the given object is a Lease which can be renewed and cancelled in a batch with other leases in the map. Whether or not two Lease objects can be batched is an implementation detail determined by the objects.

Parameters:

key - an object that should be a lease

Returns:

true if the lease can be renewed and cancelled in a a batch with other leases

See Also:

Lease.canBatch(net.jini.core.lease.Lease)

cancelAll

public void cancelAll()
               throws LeaseMapException,
                      RemoteException

Description copied from interface: LeaseMap

Cancels all leases in the LeaseMap. If all cancels are successful, returns normally (leaving all leases in the map). Otherwise, removes all leases that failed to cancel from the LeaseMap, and throws LeaseMapException.

Throws:

LeaseMapException

RemoteException

renewAll

public void renewAll()
              throws LeaseMapException,
                     RemoteException

Description copied from interface: LeaseMap

Renews all leases in the LeaseMap, using their current values as the renewal durations. If all renewals are successful, returns normally. Otherwise, removes all leases that failed to renew from the LeaseMap, and throws LeaseMapException.

Throws:

LeaseMapException

RemoteException

landlord

Landlord landlord()

Return the landlord.