Package org.apache.river.landlord

This is a utility for services implementing leases.

See: Description

Interface Summary

Interface	Description
Landlord	Interface that granters of leases must implement in order to work with the LandlordLease implementation of the Lease interface.
LeasedResource	Server side representation of a lease
LeasePeriodPolicy	Interface for objects that define what policy to use when calculating lease grants and renewals.
LocalLandlord	Interface that defines the basic landlord primitives (renew and cancel) as local methods.

Class Summary

Class	Description
AbstractLeasedResource	This is a convenience abstract LeasedResource that creates a new LeasedResource instead of modifying the original.
ConstrainableLandlordLease	Constrainable sub-class of LandlordLease.
ConstrainableLandlordLeaseMap	Constrainable sub-class of LandlordLeaseMap.
FixedLeasePeriodPolicy	Simple implementation of LeasePeriodPolicy that grants lease times based on a fixed default and maximum lease.
Landlord.RenewResults	Simple class that holds return values of the Landlord.renewAll method.
LandlordLease	Basic implementation of net.jini.core.lease.Lease that works with the the Landlord protocol.
LandlordLeaseMap	Implementation of LeaseMap for LandlordLease.
LandlordProxyVerifier	This class defines a trust verifier for the proxies defined in the landlord package.
LandlordUtil	Static methods useful for implementing landlords.
LeaseFactory	Factory for LandlordLease instances.
LeasePeriodPolicy.Result	Simple class that holds a pair of times, the new expiration and duration for a lease.

Package org.apache.river.landlord Description

This is a utility for services implementing leases. The Landlord is the basic interface that defines the utility. A service that exports leases implements the Landlord interface, which is used for callbacks by the utility classes when a lease's status changes. Each leased resource is identified by a landlord-generated Uuid called a cookie. The Lease object handed to the client contains the cookie, and that cookie is used when communicating with the landlord about the lease.

The utility classes define a lease object type LandlordLease. The Lease objects handed to clients will be of this type. LandlordLease objects talk to the Landlord about the lease. A factory class, LeaseFactory, can be used to generate new leases. The package also contains a constrainable implementation of Lease, ConstrainableLandlordLease, that implements RemoteMethodControl and supports proxy trust verification (when used with LandlordProxyVerifier) and suitable implementations of LeaseMap. It also contains utilities and interfaces to assist you in implementing the Landlord interfaces: LandlordUtil, LeasePeriodPolicy, and FixedLeasePeriodPolicy.

Using the classes in this package, you can write services that export leases and handle primarily those factors that are unique to your service, letting the utility classes do generic lease-related work.