org.alfresco.jlan.server.locking

Class OpLockDetailsAdapter

java.lang.Object

org.alfresco.jlan.server.locking.OpLockDetailsAdapter

All Implemented Interfaces:

OpLockDetails

Direct Known Subclasses:

LocalOpLockDetails, RemoteOpLockDetails

public class OpLockDetailsAdapter
extends Object
implements OpLockDetails

OpLock Details Adapter Class

Author:

gkspencer

Constructor Summary

Constructors

Constructor and Description
OpLockDetailsAdapter() Default constructor

Method Summary

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
String	getPath() Return the share relative path of the locked file
boolean	hasBreakInProgress() Check if there is an oplock break in progress for this oplock
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	isFolder() Check if the oplock is on a file or folder
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	setOwnerFileId(int fileId) Set the owner file id
void	updateDeferredPacketLease() Update the deferred packet lease time(s) as we wait for an oplock break or timeout

Methods inherited from class java.lang.Object

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

Constructor Detail

OpLockDetailsAdapter

public OpLockDetailsAdapter()

Default constructor

Method Detail

getLockType

public int getLockType()

Return the oplock type

Specified by:

getLockType in interface OpLockDetails

Returns:

int

getPath

public String getPath()

Return the share relative path of the locked file

Specified by:

getPath in interface OpLockDetails

Returns:

String

isFolder

public boolean isFolder()

Check if the oplock is on a file or folder

Specified by:

isFolder in interface OpLockDetails

Returns:

boolean

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

Returns:

boolean

numberOfDeferredSessions

public int numberOfDeferredSessions()

Return the count of deferred requests

Specified by:

numberOfDeferredSessions in interface OpLockDetails

Returns:

int

requeueDeferredRequests

public int requeueDeferredRequests()

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

Specified by:

requeueDeferredRequests in interface OpLockDetails

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

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

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

Returns:

boolean

isRemoteLock

public boolean isRemoteLock()

Check if this is a remote oplock

Specified by:

isRemoteLock in interface OpLockDetails

Returns:

boolean

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

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

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

setOwnerFileId

public void setOwnerFileId(int fileId)

Set the owner file id

Specified by:

setOwnerFileId in interface OpLockDetails

Parameters:

fileId - int

requestOpLockBreak

public void requestOpLockBreak()
                        throws IOException

Request an oplock break

Specified by:

requestOpLockBreak in interface OpLockDetails

Throws:

IOException

setLockType

public void setLockType(int lockTyp)

Set the lock type

Specified by:

setLockType in interface OpLockDetails

Parameters:

lockTyp - int

hasBreakInProgress

public boolean hasBreakInProgress()

Check if there is an oplock break in progress for this oplock

Specified by:

hasBreakInProgress in interface OpLockDetails

Returns:

boolean