org.alfresco.jlan.server.filesys.cache.hazelcast

Class RemoteOpLockDetails

java.lang.Object

org.alfresco.jlan.server.locking.OpLockDetailsAdapter

org.alfresco.jlan.server.filesys.cache.hazelcast.RemoteOpLockDetails

All Implemented Interfaces:

java.io.Serializable, OpLockDetails

public class RemoteOpLockDetails
extends OpLockDetailsAdapter
implements java.io.Serializable

Remote OpLock Details Class

Contains the oplock details that need to be stored in the cluster cache, the actual oplock details will be stored locally on the node that owns the oplock.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	RemoteOpLockDetails() Default constructor
protected	RemoteOpLockDetails(ClusterNode clNode, int lockTyp, java.lang.String path, ClusterFileStateCache stateCache) Class constructor
protected	RemoteOpLockDetails(ClusterNode clNode, OpLockDetails localOpLock, ClusterFileStateCache stateCache) Class constructor
protected	RemoteOpLockDetails(java.lang.String ownerName, int lockTyp, java.lang.String path, ClusterFileStateCache stateCache) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeferredSession(SMBSrvSession deferredSess, SMBSrvPacket deferredPkt) Add a deferred session/packet, whilst an oplock break is in progress
int	failDeferredRequests() Fail any deferred requests that are attached to this oplock, and clear the deferred list
int	getLockType() Return the oplock type
long	getOplockBreakTime() Return the time that the oplock break was sent to the client
java.lang.String	getOwnerName() Return the owner name
java.lang.String	getPath() Return the share relative path of the locked file
ClusterFileStateCache	getStateCache() Get the state cache that this state belongs to
boolean	hasDeferredSessions() Check if there is a deferred session attached to the oplock, this indicates an oplock break is in progress for this oplock.
boolean	hasOplockBreakFailed() Check if this oplock is still valid, or an oplock break has failed
boolean	isRemoteLock() Check if this is a remote oplock
int	numberOfDeferredSessions() Return the count of deferred requests
void	requestOpLockBreak() Request an oplock break
int	requeueDeferredRequests() Requeue deferred requests to the thread pool for processing, oplock has been released
void	setLockType(int lockTyp) Set the lock type
void	setOplockBreakFailed() Set the failed oplock break flag, to indicate the client did not respond to the oplock break request within a reasonable time.
void	setStateCache(ClusterFileStateCache stateCache) Set the state cache that this state belongs to
java.lang.String	toString() Return the remote oplock as a string
void	updateDeferredPacketLease() Update the deferred packet lease time(s) as we wait for an oplock break or timeout

Methods inherited from class org.alfresco.jlan.server.locking.OpLockDetailsAdapter

hasBreakInProgress, isFolder, setOwnerFileId

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteOpLockDetails

public RemoteOpLockDetails()

Default constructor

RemoteOpLockDetails

protected RemoteOpLockDetails(ClusterNode clNode,
                   int lockTyp,
                   java.lang.String path,
                   ClusterFileStateCache stateCache)

Class constructor

Parameters:

clNode - ClusterNode

lockTyp - int

path - String

stateCache - ClusterFileStateCache

RemoteOpLockDetails

protected RemoteOpLockDetails(ClusterNode clNode,
                   OpLockDetails localOpLock,
                   ClusterFileStateCache stateCache)

Class constructor

Parameters:

clNode - ClusterNode

localOplock - OpLockDetails

stateCache - ClusterFileStateCache

RemoteOpLockDetails

protected RemoteOpLockDetails(java.lang.String ownerName,
                   int lockTyp,
                   java.lang.String path,
                   ClusterFileStateCache stateCache)

Class constructor

Parameters:

ownerName - String

lockTyp - int

path - String

stateCache - ClusterFileStateCache

Method Detail

getLockType

public int getLockType()

Return the oplock type

Specified by:

getLockType in interface OpLockDetails

Overrides:

getLockType in class OpLockDetailsAdapter

Returns:

int

getOwnerName

public final java.lang.String getOwnerName()

Return the owner name

Returns:

String

getPath

public java.lang.String getPath()

Return the share relative path of the locked file

Specified by:

getPath in interface OpLockDetails

Overrides:

getPath in class OpLockDetailsAdapter

Returns:

String

isRemoteLock

public boolean isRemoteLock()

Check if this is a remote oplock

Specified by:

isRemoteLock in interface OpLockDetails

Overrides:

isRemoteLock in class OpLockDetailsAdapter

Returns:

boolean

requestOpLockBreak

public void requestOpLockBreak()
                        throws java.io.IOException

Request an oplock break

Specified by:

requestOpLockBreak in interface OpLockDetails

Overrides:

requestOpLockBreak in class OpLockDetailsAdapter

Throws:

java.io.IOException

hasDeferredSessions

public boolean hasDeferredSessions()

Check if there is a deferred session attached to the oplock, this indicates an oplock break is in progress for this oplock.

Specified by:

hasDeferredSessions in interface OpLockDetails

Overrides:

hasDeferredSessions in class OpLockDetailsAdapter

Returns:

boolean

numberOfDeferredSessions

public int numberOfDeferredSessions()

Return the count of deferred requests

Specified by:

numberOfDeferredSessions in interface OpLockDetails

Overrides:

numberOfDeferredSessions in class OpLockDetailsAdapter

Returns:

int

addDeferredSession

public void addDeferredSession(SMBSrvSession deferredSess,
                      SMBSrvPacket deferredPkt)
                        throws DeferFailedException

Add a deferred session/packet, whilst an oplock break is in progress

Specified by:

addDeferredSession in interface OpLockDetails

Overrides:

addDeferredSession in class OpLockDetailsAdapter

Parameters:

deferredSess - SMBSrvSession

deferredPkt - SMBSrvPacket

Throws:

DeferFailedException - If the session/packet cannot be deferred

updateDeferredPacketLease

public void updateDeferredPacketLease()

Update the deferred packet lease time(s) as we wait for an oplock break or timeout

Specified by:

updateDeferredPacketLease in interface OpLockDetails

Overrides:

updateDeferredPacketLease in class OpLockDetailsAdapter

requeueDeferredRequests

public int requeueDeferredRequests()

Requeue deferred requests to the thread pool for processing, oplock has been released

Specified by:

requeueDeferredRequests in interface OpLockDetails

Overrides:

requeueDeferredRequests in class OpLockDetailsAdapter

Returns:

int Number of deferred requests requeued

failDeferredRequests

public int failDeferredRequests()

Fail any deferred requests that are attached to this oplock, and clear the deferred list

Specified by:

failDeferredRequests in interface OpLockDetails

Overrides:

failDeferredRequests in class OpLockDetailsAdapter

Returns:

int Number of deferred requests that were failed

getOplockBreakTime

public long getOplockBreakTime()

Return the time that the oplock break was sent to the client

Specified by:

getOplockBreakTime in interface OpLockDetails

Overrides:

getOplockBreakTime in class OpLockDetailsAdapter

Returns:

long

hasOplockBreakFailed

public boolean hasOplockBreakFailed()

Check if this oplock is still valid, or an oplock break has failed

Specified by:

hasOplockBreakFailed in interface OpLockDetails

Overrides:

hasOplockBreakFailed in class OpLockDetailsAdapter

Returns:

boolean

setOplockBreakFailed

public void setOplockBreakFailed()

Set the failed oplock break flag, to indicate the client did not respond to the oplock break request within a reasonable time.

Specified by:

setOplockBreakFailed in interface OpLockDetails

Overrides:

setOplockBreakFailed in class OpLockDetailsAdapter

getStateCache

public final ClusterFileStateCache getStateCache()

Get the state cache that this state belongs to

Returns:

ClusterFileStateCache

setStateCache

public final void setStateCache(ClusterFileStateCache stateCache)

Set the state cache that this state belongs to

Parameters:

stateCache - ClusterFileStateCache

setLockType

public void setLockType(int lockTyp)

Set the lock type

Specified by:

setLockType in interface OpLockDetails

Overrides:

setLockType in class OpLockDetailsAdapter

Parameters:

lockTyp - int

toString

public java.lang.String toString()

Return the remote oplock as a string

Overrides:

toString in class java.lang.Object

Returns:

String