org.exolab.jms.lease
Interface LeaseIfc

All Known Implementing Classes:

BaseLease

public interface LeaseIfc

A lease is used to track message exipration. It contains the object to be leased, the duration and the object to callback if or when the lease expirex

Version:

$Revision: 1.2 $ $Date: 2005/03/18 03:47:30 $

Author:

Jim Alateras

Method Summary

long	getDuration() Returns the duration of the lease.
long	getExpiryTime() Return the absolute expiry time of this lease.
java.lang.Object	getLeasedObject() Returns the leased object.
long	getRemainingTime() Returns the time remaining on the lease.

Method Detail

getExpiryTime

public long getExpiryTime()

Return the absolute expiry time of this lease.

Returns:

the expiry time of the lease, in milliseconds

getDuration

public long getDuration()

Returns the duration of the lease.

Returns:

the duration of the lease, in milliseconds

getRemainingTime

public long getRemainingTime()

Returns the time remaining on the lease.

Returns:

the time remaining, in milliseconds

getLeasedObject

public java.lang.Object getLeasedObject()

Returns the leased object.

Returns:

the leased object