org.alfresco.jlan.server.locking

Interface OpLockDetails

All Known Implementing Classes:

LocalOpLockDetails, OpLockDetailsAdapter, RemoteOpLockDetails

public interface OpLockDetails

OpLock Details Interface

Contains the main oplock details and type, and is also used to store a deferred file open request from another session during an oplock break.

Author:

gkspencer

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
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

Method Detail

getLockType

int getLockType()

Return the oplock type

Returns:

int

getPath

String getPath()

Return the share relative path of the locked file

Returns:

String

isFolder

boolean isFolder()

Check if the oplock is on a file or folder

Returns:

boolean

hasDeferredSessions

boolean hasDeferredSessions()

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

Returns:

boolean

numberOfDeferredSessions

int numberOfDeferredSessions()

Return the count of deferred requests

Returns:

int

requeueDeferredRequests

int requeueDeferredRequests()

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

Returns:

int Number of deferred requests requeued

failDeferredRequests

int failDeferredRequests()

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

Returns:

int Number of deferred requests that were failed

getOplockBreakTime

long getOplockBreakTime()

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

Returns:

long

hasOplockBreakFailed

boolean hasOplockBreakFailed()

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

Returns:

boolean

isRemoteLock

boolean isRemoteLock()

Check if this is a remote oplock

Returns:

boolean

addDeferredSession

void addDeferredSession(SMBSrvSession deferredSess,
                      SMBSrvPacket deferredPkt)
                        throws DeferFailedException

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

Parameters:

deferredSess - SMBSrvSession

deferredPkt - SMBSrvPacket

Throws:

DeferFailedException - If the session/packet cannot be deferred

updateDeferredPacketLease

void updateDeferredPacketLease()

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

setOplockBreakFailed

void setOplockBreakFailed()

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

setOwnerFileId

void setOwnerFileId(int fileId)

Set the owner file id

Parameters:

fileId - int

requestOpLockBreak

void requestOpLockBreak()
                        throws IOException

Request an oplock break

Throws:

IOException

setLockType

void setLockType(int lockTyp)

Set the lock type

Parameters:

lockTyp - int

hasBreakInProgress

boolean hasBreakInProgress()

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

Returns:

boolean