|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The Lease interface defines a type of object that is returned to the lease holder and issued by the lease grantor. Particular instances of the Lease type will be created by the grantors of a lease, and returned to the holder of the lease as part of the return value from a call that allocates a leased resource. The call that requests a leased resource will typically include a requested duration for the lease. If the request is for a particular duration, the lease grantor is required to grant a lease of no more than the requested period of time. A lease may be granted for a period of time shorter than that requested.
Field Summary | |
static int |
ABSOLUTE
The serialized form of the lease will contain the time of expiration stored as an absolute time, represented in terms of milliseconds since the beginning of the epoch. |
static long |
ANY
Used by the requestor to indicate that there is no particular lease time desired, and that the grantor of the lease should supply a time that is most convenient for the grantor. |
static int |
DURATION
The serialized form of the lease will convert the time of lease expiration into a duration (in milliseconds) from the time of serialization. |
static long |
FOREVER
Used to request a lease that never expires. |
Method Summary | |
boolean |
canBatch(Lease lease)
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. |
void |
cancel()
Used by the lease holder to indicate that it is no longer interested in the resource or information held by the lease. |
LeaseMap |
createLeaseMap(long duration)
Creates a Map object that can contain leases whose renewal or cancellation can be batched, and adds the current lease to that map. |
long |
getExpiration()
Returns the absolute time that the lease will expire, represented as milliseconds from the beginning of the epoch, relative to the local clock. |
int |
getSerialFormat()
Returns the format that will be used to serialize the lease. |
void |
renew(long duration)
Used to renew a lease for an additional period of time, specified in milliseconds. |
void |
setSerialFormat(int format)
Sets the format to use when serializing the lease. |
Field Detail |
public static final long FOREVER
public static final long ANY
public static final int DURATION
public static final int ABSOLUTE
Method Detail |
public long getExpiration()
public void cancel() throws UnknownLeaseException, java.rmi.RemoteException
public void renew(long duration) throws LeaseDeniedException, UnknownLeaseException, java.rmi.RemoteException
duration
- the requested duration in millisecondspublic void setSerialFormat(int format)
format
- DURATION or ABSOLUTEpublic int getSerialFormat()
public LeaseMap createLeaseMap(long duration)
duration
- the duration to put into a Long and use as the
value for the current lease in the created LeaseMappublic boolean canBatch(Lease lease)
lease
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |