org.alfresco.jlan.server.locking

Class LocalOpLockDetails

java.lang.Object

org.alfresco.jlan.server.locking.OpLockDetailsAdapter

org.alfresco.jlan.server.locking.LocalOpLockDetails

All Implemented Interfaces:

OpLockDetails

public class LocalOpLockDetails
extends OpLockDetailsAdapter

Local OpLock Details Class

Contains the details of an oplock that is owned by a session on the local node.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MaxDeferredRequests

Constructor Summary

Constructors

Constructor and Description
LocalOpLockDetails(int lockTyp, java.lang.String path, SMBSrvSession sess, int pid, int treeId, boolean folder) Class constructor
LocalOpLockDetails(int lockTyp, java.lang.String path, SMBSrvSession sess, int pid, int uid, int treeId, int fileId, boolean folder) Class constructor
LocalOpLockDetails(int lockTyp, java.lang.String path, SMBSrvSession sess, SMBSrvPacket pkt, boolean folder) 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
void	finalize() Finalize, check if there are any deferred requests in the list
int	getLockType() Return the oplock type
long	getOplockBreakTime() Return the time that the oplock break was sent to the client
int	getOwnerFileId() Return the owner file id (FID)
int	getOwnerPID() Return the owner process id
SMBSrvSession	getOwnerSession() Return the lock owner session
int	getOwnerTreeId() Return the owner tree id
int	getOwnerUID() Return the owner virtual circuit id/UID
java.lang.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
java.lang.String	toString() Return the oplock details 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 java.lang.Object

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

Field Detail

MaxDeferredRequests

public static final int MaxDeferredRequests

See Also:

Constant Field Values

Constructor Detail

LocalOpLockDetails

public LocalOpLockDetails(int lockTyp,
                  java.lang.String path,
                  SMBSrvSession sess,
                  int pid,
                  int uid,
                  int treeId,
                  int fileId,
                  boolean folder)

Class constructor

Parameters:

lockTyp - int

path - String

sess - SMBSrvSession

pid - int

uid - int

treeId - int

fileId - int

folder - boolean

LocalOpLockDetails

public LocalOpLockDetails(int lockTyp,
                  java.lang.String path,
                  SMBSrvSession sess,
                  SMBSrvPacket pkt,
                  boolean folder)

Class constructor

Parameters:

lockTyp - int

path - String

sess - SMBSrvSession

pkt - SMBSrvPacket

folder - boolean

LocalOpLockDetails

public LocalOpLockDetails(int lockTyp,
                  java.lang.String path,
                  SMBSrvSession sess,
                  int pid,
                  int treeId,
                  boolean folder)

Class constructor

Parameters:

lockTyp - int

path - String

sess - SMBSrvSession

pid - int

treeId - int

folder - boolean

Method Detail

getLockType

public int getLockType()

Return the oplock type

Specified by:

getLockType in interface OpLockDetails

Overrides:

getLockType in class OpLockDetailsAdapter

Returns:

int

getOwnerSession

public SMBSrvSession getOwnerSession()

Return the lock owner session

Returns:

SMBSrvSession

getOwnerPID

public final int getOwnerPID()

Return the owner process id

Returns:

int

getOwnerUID

public final int getOwnerUID()

Return the owner virtual circuit id/UID

Returns:

int

getOwnerTreeId

public final int getOwnerTreeId()

Return the owner tree id

Returns:

int

getOwnerFileId

public final int getOwnerFileId()

Return the owner file id (FID)

Returns:

int

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

isFolder

public boolean isFolder()

Check if the oplock is on a file or folder

Specified by:

isFolder in interface OpLockDetails

Overrides:

isFolder in class OpLockDetailsAdapter

Returns:

boolean

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

isRemoteLock

public boolean isRemoteLock()

Check if this is a remote oplock

Specified by:

isRemoteLock in interface OpLockDetails

Overrides:

isRemoteLock in class OpLockDetailsAdapter

Returns:

boolean

setOwnerFileId

public final void setOwnerFileId(int fileId)

Set the owner file id

Specified by:

setOwnerFileId in interface OpLockDetails

Overrides:

setOwnerFileId in class OpLockDetailsAdapter

Parameters:

fileId - int

setOplockBreakFailed

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

setLockType

public void setLockType(int lockTyp)

Set the lock type

Specified by:

setLockType in interface OpLockDetails

Overrides:

setLockType in class OpLockDetailsAdapter

Parameters:

lockTyp - int

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

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

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

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

hasBreakInProgress

public boolean hasBreakInProgress()

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

Specified by:

hasBreakInProgress in interface OpLockDetails

Overrides:

hasBreakInProgress in class OpLockDetailsAdapter

Returns:

boolean

finalize

public void finalize()

Finalize, check if there are any deferred requests in the list

Overrides:

finalize in class java.lang.Object

toString

public java.lang.String toString()

Return the oplock details as a string

Overrides:

toString in class java.lang.Object

Returns:

String