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>

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.
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

Method Detail

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 - if one or more lease cancellations fail.

RemoteException - if a connection problem occurs.

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 - if one or more lease renewals fail.

RemoteException - if a connection problem occurs.