com.hazelcast.client.proxy

Class ClientLockProxy

java.lang.Object

com.hazelcast.client.spi.ClientProxy

com.hazelcast.client.proxy.ClientLockProxy

All Implemented Interfaces:

DistributedObject, ILock, Lock

public class ClientLockProxy
extends ClientProxy
implements ILock

Proxy implementation of ILock.

Field Summary

Fields inherited from class com.hazelcast.client.spi.ClientProxy

name

Constructor Summary

Constructors

Constructor and Description
ClientLockProxy(String serviceName, String objectId, ClientContext context)

Method Summary

Modifier and Type	Method and Description
void	forceUnlock() Releases the lock regardless of the lock owner.
Object	getKey() Deprecated.
int	getLockCount() Returns re-entrant lock hold count, regardless of lock ownership.
long	getRemainingLeaseTime() Returns remaining lease time in milliseconds.
protected ClientMessage	invokeOnPartition(ClientMessage req)
protected <T> ClientDelegatingFuture<T>	invokeOnPartitionAsync(ClientMessage clientMessage, ClientMessageDecoder clientMessageDecoder)
protected <T> T	invokeOnPartitionInterruptibly(ClientMessage clientMessage)
boolean	isLocked() Returns whether this lock is locked or not.
boolean	isLockedByCurrentThread() Returns whether this lock is locked by current thread or not.
void	lock()
void	lock(long leaseTime, TimeUnit timeUnit) Acquires the lock for the specified lease time.
void	lockInterruptibly()
Condition	newCondition() This method is not implemented! Use ILock.newCondition(String) instead.
ICondition	newCondition(String name) Returns a new ICondition instance that is bound to this ILock instance with given name.
protected void	onInitialize() Called when proxy is created.
String	toString()
boolean	tryLock()
boolean	tryLock(long timeout, TimeUnit unit)
boolean	tryLock(long timeout, TimeUnit unit, long leaseTime, TimeUnit leaseUnit) Tries to acquire the lock for the specified lease time.
void	unlock() Releases the lock.

Methods inherited from class com.hazelcast.client.spi.ClientProxy

deregisterListener, destroy, destroyLocally, destroyRemotely, equals, getClient, getConnectedServerVersion, getContext, getDistributedObjectName, getId, getName, getPartitionKey, getSerializationService, getServiceName, hashCode, invoke, invoke, invokeOnAddress, invokeOnPartition, invokeOnPartitionInterruptibly, onDestroy, onShutdown, postDestroy, preDestroy, registerListener, setContext, toData, toObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hazelcast.core.DistributedObject

destroy, getName, getPartitionKey, getServiceName

Constructor Detail

ClientLockProxy

public ClientLockProxy(String serviceName,
                       String objectId,
                       ClientContext context)

Method Detail

getKey

@Deprecated
public Object getKey()

Deprecated.

Description copied from interface: ILock

Returns the lock object, the key for this lock instance.

Specified by:

getKey in interface ILock

Returns:

lock object.

isLocked

public boolean isLocked()

Description copied from interface: ILock

Returns whether this lock is locked or not.

Specified by:

isLocked in interface ILock

Returns:

true if this lock is locked, false otherwise.

isLockedByCurrentThread

public boolean isLockedByCurrentThread()

Description copied from interface: ILock

Returns whether this lock is locked by current thread or not.

Specified by:

isLockedByCurrentThread in interface ILock

Returns:

true if this lock is locked by current thread, false otherwise.

getLockCount

public int getLockCount()

Description copied from interface: ILock

Returns re-entrant lock hold count, regardless of lock ownership.

Specified by:

getLockCount in interface ILock

Returns:

the lock hold count.

getRemainingLeaseTime

public long getRemainingLeaseTime()

Description copied from interface: ILock

Returns remaining lease time in milliseconds. If the lock is not locked then -1 will be returned.

Specified by:

getRemainingLeaseTime in interface ILock

Returns:

remaining lease time in milliseconds.

lock

public void lock(long leaseTime,
                 TimeUnit timeUnit)

Description copied from interface: ILock

Acquires the lock for the specified lease time.

After lease time, lock will be released..

If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock has been acquired.

Specified by:

lock in interface ILock

Parameters:

leaseTime - time to wait before releasing the lock.

timeUnit - unit of time for the lease time.

forceUnlock

public void forceUnlock()

Description copied from interface: ILock

Releases the lock regardless of the lock owner. It always successfully unlocks, never blocks, and returns immediately.

Specified by:

forceUnlock in interface ILock

newCondition

public ICondition newCondition(String name)

Description copied from interface: ILock

Returns a new ICondition instance that is bound to this ILock instance with given name.

Before waiting on the condition the lock must be held by the current thread. A call to Condition.await() will atomically release the lock before waiting and re-acquire the lock before the wait returns.

Specified by:

newCondition in interface ILock

Parameters:

name - identifier of the new condition instance

Returns:

A new ICondition instance for this ILock instance

lock

public void lock()

Description copied from interface: ILock

Specified by:

lock in interface ILock

Specified by:

lock in interface Lock

lockInterruptibly

public void lockInterruptibly()
                       throws InterruptedException

Specified by:

lockInterruptibly in interface Lock

Throws:

InterruptedException

tryLock

public boolean tryLock()

Description copied from interface: ILock

Specified by:

tryLock in interface ILock

Specified by:

tryLock in interface Lock

tryLock

public boolean tryLock(long timeout,
                       TimeUnit unit)
                throws InterruptedException

Description copied from interface: ILock

Specified by:

tryLock in interface ILock

Specified by:

tryLock in interface Lock

Throws:

InterruptedException

tryLock

public boolean tryLock(long timeout,
                       TimeUnit unit,
                       long leaseTime,
                       TimeUnit leaseUnit)
                throws InterruptedException

Description copied from interface: ILock

Tries to acquire the lock for the specified lease time.

After lease time, the lock will be released.

If the lock is not available, then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:

• the lock is acquired by the current thread, or
• the specified waiting time elapses.

Specified by:

tryLock in interface ILock

Parameters:

timeout - maximum time to wait for the lock.

unit - time unit of the time argument.

leaseTime - time to wait before releasing the lock.

leaseUnit - unit of time to specify lease time.

Returns:

true if the lock was acquired and false if the waiting time elapsed before the lock was acquired.

Throws:

InterruptedException

unlock

public void unlock()

Description copied from interface: ILock

Releases the lock.

Specified by:

unlock in interface ILock

Specified by:

unlock in interface Lock

newCondition

public Condition newCondition()

Description copied from interface: ILock

This method is not implemented! Use ILock.newCondition(String) instead.

Specified by:

newCondition in interface ILock

Specified by:

newCondition in interface Lock

toString

public String toString()

Overrides:

toString in class Object

onInitialize

protected void onInitialize()

Description copied from class: ClientProxy

Called when proxy is created. Overriding implementations can add initialization specific logic into this method like registering a listener, creating a cleanup task etc.

invokeOnPartition

protected ClientMessage invokeOnPartition(ClientMessage req)

invokeOnPartitionInterruptibly

protected <T> T invokeOnPartitionInterruptibly(ClientMessage clientMessage)
                                        throws InterruptedException

Throws:

InterruptedException

invokeOnPartitionAsync

protected <T> ClientDelegatingFuture<T> invokeOnPartitionAsync(ClientMessage clientMessage,
                                                               ClientMessageDecoder clientMessageDecoder)