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

Class HazelCastClusterFileState

java.lang.Object

org.alfresco.jlan.server.filesys.cache.FileState

org.alfresco.jlan.server.filesys.cache.cluster.ClusterFileState

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

All Implemented Interfaces:

java.io.Serializable

public class HazelCastClusterFileState
extends ClusterFileState

HazelCast Cluster File State Class

See Also:

Serialized Form

Field Summary

Fields inherited from class org.alfresco.jlan.server.filesys.cache.cluster.ClusterFileState

UpdateAllocSize, UpdateByteLock, UpdateChangeDate, UpdateFileSize, UpdateFileStatus, UpdateMaskCount, UpdateModifyDate, UpdateOpenCount, UpdateOplock, UpdateRetentionExpire, UpdateSharingMode

Fields inherited from class org.alfresco.jlan.server.filesys.cache.FileState

DefTimeout, DeleteTimeout, FILE_AVAILABLE, FILE_DELETED, FILE_DELETEONCLOSE, FILE_LOADING, FILE_LOADWAIT, FILE_RENAMED, FILE_SAVED, FILE_SAVEWAIT, FILE_SAVING, FILE_UPDATED, FileInformation, NoTimeout, ReasonFileCreated, ReasonFileDeleted, ReasonFolderCreated, ReasonFolderDeleted, ReasonNone, RenameTimeout, StreamsList, UnknownFileId

Constructor Summary

Constructors

Constructor and Description
HazelCastClusterFileState() Default constructor
HazelCastClusterFileState(java.lang.String fname, boolean caseSensitive) Class constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyNearCacheDetails(HazelCastClusterFileState hcState) Copy near-cache details to a new copy of the file state
long	getNearCacheHitCount() Return the near-cache hit counter
long	getNearCacheLastAccessTime() Return the time the near-cache entry was last accessed
long	getNearCacheTime() Return the time the state was added to the near-cache
long	getNearRemoteUpdateTime() Return the time the state was last updated remotely
long	incrementNearCacheHitCount() Increment the near-cache hit counter
boolean	isCopyState() Check if this is a copy file state, or the master file state object
boolean	isStateValid() Check if the near-cache entry is valid
protected void	queueLowPriorityUpdate(int updateMask) Queue a low priority update for this file state
protected void	runHighPriorityUpdate(int updateMask) Run a high priority update for this file state
void	setAllocationSize(long allocSize) Set the allocation size
void	setFileSize(long fileSize) Set the file size
void	setFileStatus(int status, int reason) Set the file status (not exist, file exists, folder exists)
void	setNearCacheTime() Set the time the state was added to the near-cache
void	setNearRemoteUpdateTime() Set the remote update time for a near-cached state
void	setNearRemoteUpdateTime(long updateTime) Set the remote update time for a near-cached state
void	setOpLock(OpLockDetails oplock) Set the oplock for this file
void	setRetentionExpiryDateTime(long expires) Set the retention period expiry date/time
void	setStateCache(ClusterFileStateCache stateCache) Set the state cache that this state belongs to
void	setStateValid(boolean nearValid) Set the near-cache entry valid flag
java.lang.String	toString() Return the file state as a string
void	updateChangeDateTime(long changeTime) Update the change date/time
void	updateModifyDateTime(long modTime) Update the modify date/time
protected void	updateState(StateUpdateMessage updateMsg) Update the file state from values in the update message

Methods inherited from class org.alfresco.jlan.server.filesys.cache.cluster.ClusterFileState

canReadFile, canWriteFile, clearLocalOpLock, clearPendingUpdates, getAttributeMap, getDataStatus, getDataUpdateNode, getFileId, getFilesystemObject, getLocalOpLock, getOpLock, getPendingUpdates, getPrimaryOwner, getPseudoFileList, getStateCache, getStatusChangeReason, getUpdateMaskAsString, hasDataUpdateInProgress, hasLocalOpLock, hasPrimaryOwner, setDataStatus, setDataUpdateNode, setFileId, setFileStatusInternal, setFilesystemObject, setLocalOpLock, setNormalizedPath, setPrimaryOwner, setStatusChangeReason, setUpdateMask

Methods inherited from class org.alfresco.jlan.server.filesys.cache.FileState

addAttribute, addLock, addPseudoFile, allowsOpen, clearOpLock, decrementOpenCount, DumpAttributes, exists, fileExists, findAttribute, getAccessDateTime, getAllocationSize, getChangeDateTime, getChangeReasonString, getFileSize, getFileStatus, getLockList, getModifyDateTime, getOpenCount, getPath, getProcessId, getPseudoFileList, getRetentionExpiryDateTime, getSecondsToExpire, getSharedAccess, getStatusAsString, hasAccessDateTime, hasActiveLocks, hasActiveRetentionPeriod, hasAllocationSize, hasChangeDateTime, hasExpired, hasFileSize, hasFilesystemObject, hasModifyDateTime, hasOpLock, hasPseudoFiles, incrementOpenCount, isDirectory, isPermanentState, normalizePath, normalizePath, numberOfAttributes, numberOfLocks, removeAllAttributes, removeAttribute, removeLock, setExpiryTime, setFileStatus, setOpenCount, setPath, setPathInternal, setProcessId, setSharedAccess, updateAccessDateTime, updateChangeDateTime, updateModifyDateTime, upperCaseAToZ

Methods inherited from class java.lang.Object

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

Constructor Detail

HazelCastClusterFileState

public HazelCastClusterFileState()

Default constructor

HazelCastClusterFileState

public HazelCastClusterFileState(java.lang.String fname,
                         boolean caseSensitive)

Class constructor

Parameters:

fname - String

caseSensitive - boolean

Method Detail

isCopyState

public boolean isCopyState()

Check if this is a copy file state, or the master file state object

Specified by:

isCopyState in class FileState

Returns:

boolean

getNearCacheTime

public final long getNearCacheTime()

Return the time the state was added to the near-cache

Returns:

long

getNearCacheHitCount

public final long getNearCacheHitCount()

Return the near-cache hit counter

Returns:

long

getNearCacheLastAccessTime

public final long getNearCacheLastAccessTime()

Return the time the near-cache entry was last accessed

Returns:

long

getNearRemoteUpdateTime

public final long getNearRemoteUpdateTime()

Return the time the state was last updated remotely

Returns:

long

isStateValid

public final boolean isStateValid()

Check if the near-cache entry is valid

Returns:

boolean

setStateCache

public void setStateCache(ClusterFileStateCache stateCache)

Set the state cache that this state belongs to

Overrides:

setStateCache in class ClusterFileState

Parameters:

stateCache - ClusterFileStateCache

setOpLock

public void setOpLock(OpLockDetails oplock)
               throws ExistingOpLockException

Set the oplock for this file

Overrides:

setOpLock in class FileState

Parameters:

oplock - OpLockDetails

Throws:

ExistingOpLockException - If there is an active oplock on this file

setFileStatus

public void setFileStatus(int status,
                 int reason)

Set the file status (not exist, file exists, folder exists)

Overrides:

setFileStatus in class FileState

Parameters:

status - int

reason - int

setFileSize

public void setFileSize(long fileSize)

Set the file size

Overrides:

setFileSize in class FileState

Parameters:

fileSize - long

setAllocationSize

public void setAllocationSize(long allocSize)

Set the allocation size

Overrides:

setAllocationSize in class FileState

Parameters:

allocSize - long

updateModifyDateTime

public void updateModifyDateTime(long modTime)

Update the modify date/time

Overrides:

updateModifyDateTime in class FileState

Parameters:

modTime - long

updateChangeDateTime

public void updateChangeDateTime(long changeTime)

Update the change date/time

Overrides:

updateChangeDateTime in class FileState

Parameters:

changeTime - long

setRetentionExpiryDateTime

public void setRetentionExpiryDateTime(long expires)

Set the retention period expiry date/time

Overrides:

setRetentionExpiryDateTime in class FileState

Parameters:

expires - long

setNearCacheTime

public final void setNearCacheTime()

Set the time the state was added to the near-cache

setNearRemoteUpdateTime

public final void setNearRemoteUpdateTime()

Set the remote update time for a near-cached state

setNearRemoteUpdateTime

public final void setNearRemoteUpdateTime(long updateTime)

Set the remote update time for a near-cached state

Parameters:

updateTime - long

incrementNearCacheHitCount

public final long incrementNearCacheHitCount()

Increment the near-cache hit counter

Returns:

long

setStateValid

public final void setStateValid(boolean nearValid)

Set the near-cache entry valid flag

Parameters:

nearValid - boolean

copyNearCacheDetails

protected final void copyNearCacheDetails(HazelCastClusterFileState hcState)

Copy near-cache details to a new copy of the file state

Parameters:

hcState - HazelCastClusterFileState

queueLowPriorityUpdate

protected void queueLowPriorityUpdate(int updateMask)

Queue a low priority update for this file state

Parameters:

updateMask - int

runHighPriorityUpdate

protected void runHighPriorityUpdate(int updateMask)

Run a high priority update for this file state

Parameters:

updateMask - int

updateState

protected final void updateState(StateUpdateMessage updateMsg)

Update the file state from values in the update message

Parameters:

updateMsg - StateUpdateMessage

toString

public java.lang.String toString()

Return the file state as a string

Overrides:

toString in class ClusterFileState

Returns:

String