com.gigaspaces.internal.events.durable

Class DurableNotificationLease

java.lang.Object

com.gigaspaces.internal.events.durable.DurableNotificationLease

All Implemented Interfaces:

Lease

public class DurableNotificationLease
extends Object
implements Lease

Since:

9.0

Author:

Dan Kilman

Field Summary

Fields inherited from interface net.jini.core.lease.Lease

ABSOLUTE, ANY, DURATION, FOREVER

Constructor Summary

Constructors

Constructor and Description
DurableNotificationLease(ReplicationNotificationClientEndpoint replicationNotificationClientEndpoint, long lease, EventSessionConfig sessionConfig, IAsyncHandlerProvider asyncProvider)

Method Summary

Modifier and Type	Method and Description
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 a long that indicates the time that the lease will expire.
Logger	getLogger()
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.
void	startLeaseReaperIfNecessary()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DurableNotificationLease

public DurableNotificationLease(ReplicationNotificationClientEndpoint replicationNotificationClientEndpoint,
                                long lease,
                                EventSessionConfig sessionConfig,
                                IAsyncHandlerProvider asyncProvider)

Method Detail

getLogger

public Logger getLogger()

startLeaseReaperIfNecessary

public void startLeaseReaperIfNecessary()

getExpiration

public long getExpiration()

Description copied from interface: Lease

Returns a long that indicates the time that the lease will expire. This time is represented as milliseconds from the beginning of the epoch, relative to the local clock.

Specified by:

getExpiration in interface Lease

Returns:

a long that indicates the time that the lease will expire

cancel

public void cancel()

Description copied from interface: Lease

Used by the lease holder to indicate that it is no longer interested in the resource or information held by the lease. If the leased information or resource could cause a callback to the lease holder (or some other object on behalf of the lease holder), the lease grantor should not issue such a callback after the lease has been cancelled. The overall effect of a cancel call is the same as lease expiration, but instead of happening at the end of a pre-agreed duration it happens immediately.

Specified by:

cancel in interface Lease

renew

public void renew(long duration)
           throws LeaseDeniedException,
                  UnknownLeaseException,
                  RemoteException

Description copied from interface: Lease

Used to renew a lease for an additional period of time, specified in milliseconds. This duration is not added to the original lease, but is used to determine a new expiration time for the existing lease. If the renewal is granted this is reflected in value returned by getExpiration. If the renewal fails, the lease is left intact for the same duration that was in force prior to the call to renew.

Specified by:

renew in interface Lease

Parameters:

duration - the requested duration in milliseconds

Throws:

LeaseDeniedException - the lease grantor is unable or unwilling to renew the lease

UnknownLeaseException - the lease being renewed is unknown to the lease grantor

RemoteException

setSerialFormat

public void setSerialFormat(int format)

Description copied from interface: Lease

Sets the format to use when serializing the lease.

Specified by:

setSerialFormat in interface Lease

Parameters:

format - DURATION or ABSOLUTE

See Also:

Lease.getSerialFormat()

getSerialFormat

public int getSerialFormat()

Description copied from interface: Lease

Returns the format that will be used to serialize the lease.

Specified by:

getSerialFormat in interface Lease

Returns:

an int representing the serial format value

See Also:

Lease.setSerialFormat(int)

createLeaseMap

public LeaseMap createLeaseMap(long duration)

Description copied from interface: Lease

Creates a Map object that can contain leases whose renewal or cancellation can be batched, and adds the current lease to that map. The current lease is put in the map with the duration value given by the parameter.

Specified by:

createLeaseMap in interface Lease

Parameters:

duration - the duration to put into a Long and use as the value for the current lease in the created LeaseMap

Returns:

the created LeaseMap object

canBatch

public boolean canBatch(Lease lease)

Description copied from interface: 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. Whether or not two Lease objects can be batched is an implementation detail determined by the objects.

Specified by:

canBatch in interface Lease

Parameters:

lease - the Lease to be evaluated

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