com.gigaspaces.internal.server.storage

Class EntryHolder

java.lang.Object

com.gigaspaces.internal.server.storage.AbstractSpaceItem

com.gigaspaces.internal.server.storage.EntryHolder

All Implemented Interfaces:

IEntryHolder, ISpaceItem, Textualizable, ILockedSubject, ILockObject, ISelfLockingSubject

Direct Known Subclasses:

OffHeapEntryHolder, ReplicationEntryHolder, ShadowEntryHolder

public class EntryHolder
extends AbstractSpaceItem
implements IEntryHolder

This class represents an Entry in a GigaSpace. Each instance of this class contains a reference to the Entry value plus any other necessary info about the entry; including its class name, field types, and field values (could be in a MarshalledObject form).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntryHolder(IEntryHolder other)
	EntryHolder(IServerTypeDesc typeDesc, String uid, long scn, boolean isTransient, ITransactionalEntryData entryData)

Method Summary

Modifier and Type	Method and Description
void	addReadLockOwner(XtnEntry xtn)
void	addTemplateWaitingForEntry(ITemplateHolder template)
boolean	anyReadLockXtn()
void	clearReadLockOwners()
IEntryHolder	createCopy()
IEntryHolder	createDummy()
void	dump(Logger logger, String msg)
Collection<ITemplateHolder>	getCopyOfTemplatesWaitingForEntry()
IEntryData	getEntryData()
ILockObject	getExternalLockObject() in case the locking object can be derived from the subject WHEN its not the subject itself
IEntryHolder	getMaster()
IEntryHolder	getOriginalEntryHolder()
protected IEntryHolder	getOtherUpdateUnderXtnEntry()
List<XtnEntry>	getReadLockOwners()
ShadowEntryHolder	getShadow()
Collection<ITemplateHolder>	getTemplatesWaitingForEntry()
ITransactionalEntryData	getTxnEntryData()
String	getUidToOperateBy()
int	getWriteLockOperation()
XtnEntry	getWriteLockOwner()
ServerTransaction	getWriteLockTransaction()
XtnEntry	getXidOriginated()
ServerTransaction	getXidOriginatedTransaction()
boolean	hasShadow(boolean safeEntry)
boolean	isEntryUnderWriteLockXtn()
boolean	isExpired()
boolean	isExpired(long limit)
boolean	isHasWaitingFor()
boolean	isOffHeapEntry()
boolean	isSameEntryInstance(IEntryHolder other)
boolean	isUnderPendingUpdate()
boolean	isUnstable()
void	removeReadLockOwner(XtnEntry xtn)
void	removeTemplateWaitingForEntry(ITemplateHolder template)
void	resetEntryXtnInfo()
void	resetWriteLockOwner()
void	resetXidOriginated()
void	restoreUpdateXtnRollback(IEntryData entryData)
void	setExpirationTime(long expirationTime)
void	setHasWaitingFor(boolean value)
void	setOtherUpdateUnderXtnEntry(IEntryHolder eh)
void	setunStable(boolean value)
void	setWriteLockOperation(int writeLockOperation, boolean createSnapshot)
void	setWriteLockOwnerAndOperation(XtnEntry writeLockOwner, int writeLockOperation)
void	setWriteLockOwnerAndOperation(XtnEntry writeLockOwner, int writeLockOperation, boolean createSnapshot)
void	setWriteLockOwnerOperationAndShadow(XtnEntry writeLockOwner, int writeLockOperation, IEntryHolder otherEh)
void	updateEntryData(IEntryData newEntryData, long expirationTime)
void	updateVersionAndExpiration(int versionID, long expiration)

Methods inherited from class com.gigaspaces.internal.server.storage.AbstractSpaceItem

getClassName, getEntryId, getEvictableLockObject, getExpirationTime, getHandback, getNotifyType, getOrder, getRoutingValue, getSCN, getServerTypeDesc, getUID, getVersionID, hasShadow, isDeleted, isLockSubject, isMaybeUnderXtn, isShadow, isTransient, setDeleted, setMaybeUnderXtn, setOrder, setSCN, setUID, toString, toText

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gigaspaces.internal.server.storage.IEntryHolder

getEntryId, getHandback, getNotifyType, getOrder, getRoutingValue, hasShadow, isShadow, setOrder, setSCN, setUID

Methods inherited from interface com.gigaspaces.internal.server.storage.ISpaceItem

getClassName, getSCN, getServerTypeDesc, isDeleted, isMaybeUnderXtn, isTransient, setDeleted, setMaybeUnderXtn

Methods inherited from interface com.j_spaces.kernel.locks.ILockObject

isLockSubject

Methods inherited from interface com.j_spaces.kernel.locks.ILockedSubject

getUID

Constructor Detail

EntryHolder

public EntryHolder(IServerTypeDesc typeDesc,
                   String uid,
                   long scn,
                   boolean isTransient,
                   ITransactionalEntryData entryData)

EntryHolder

protected EntryHolder(IEntryHolder other)

Method Detail

createCopy

public IEntryHolder createCopy()

Specified by:

createCopy in interface IEntryHolder

createDummy

public IEntryHolder createDummy()

Specified by:

createDummy in interface IEntryHolder

isHasWaitingFor

public boolean isHasWaitingFor()

Specified by:

isHasWaitingFor in interface ISpaceItem

setHasWaitingFor

public void setHasWaitingFor(boolean value)

Specified by:

setHasWaitingFor in interface ISpaceItem

isUnstable

public boolean isUnstable()

Specified by:

isUnstable in interface IEntryHolder

setunStable

public void setunStable(boolean value)

Specified by:

setunStable in interface IEntryHolder

getEntryData

public IEntryData getEntryData()

Specified by:

getEntryData in interface ISpaceItem

getTxnEntryData

public ITransactionalEntryData getTxnEntryData()

Specified by:

getTxnEntryData in interface IEntryHolder

updateVersionAndExpiration

public void updateVersionAndExpiration(int versionID,
                                       long expiration)

Specified by:

updateVersionAndExpiration in interface ISpaceItem

updateEntryData

public void updateEntryData(IEntryData newEntryData,
                            long expirationTime)

Specified by:

updateEntryData in interface IEntryHolder

setExpirationTime

public void setExpirationTime(long expirationTime)

Specified by:

setExpirationTime in interface ISpaceItem

Specified by:

setExpirationTime in class AbstractSpaceItem

resetEntryXtnInfo

public void resetEntryXtnInfo()

Specified by:

resetEntryXtnInfo in interface IEntryHolder

resetWriteLockOwner

public void resetWriteLockOwner()

Specified by:

resetWriteLockOwner in interface IEntryHolder

setWriteLockOwnerAndOperation

public void setWriteLockOwnerAndOperation(XtnEntry writeLockOwner,
                                          int writeLockOperation)

Specified by:

setWriteLockOwnerAndOperation in interface IEntryHolder

setWriteLockOwnerAndOperation

public void setWriteLockOwnerAndOperation(XtnEntry writeLockOwner,
                                          int writeLockOperation,
                                          boolean createSnapshot)

Specified by:

setWriteLockOwnerAndOperation in interface IEntryHolder

setWriteLockOwnerOperationAndShadow

public void setWriteLockOwnerOperationAndShadow(XtnEntry writeLockOwner,
                                                int writeLockOperation,
                                                IEntryHolder otherEh)

Specified by:

setWriteLockOwnerOperationAndShadow in interface IEntryHolder

restoreUpdateXtnRollback

public void restoreUpdateXtnRollback(IEntryData entryData)

Specified by:

restoreUpdateXtnRollback in interface IEntryHolder

setWriteLockOperation

public void setWriteLockOperation(int writeLockOperation,
                                  boolean createSnapshot)

Specified by:

setWriteLockOperation in interface IEntryHolder

resetXidOriginated

public void resetXidOriginated()

Specified by:

resetXidOriginated in interface IEntryHolder

getXidOriginated

public XtnEntry getXidOriginated()

Specified by:

getXidOriginated in interface ISpaceItem

getXidOriginatedTransaction

public ServerTransaction getXidOriginatedTransaction()

Specified by:

getXidOriginatedTransaction in interface ISpaceItem

Returns:

the m_XidOriginated transaction

setOtherUpdateUnderXtnEntry

public void setOtherUpdateUnderXtnEntry(IEntryHolder eh)

Specified by:

setOtherUpdateUnderXtnEntry in interface IEntryHolder

isUnderPendingUpdate

public boolean isUnderPendingUpdate()

getUidToOperateBy

public String getUidToOperateBy()

Specified by:

getUidToOperateBy in interface ISpaceItem

dump

public void dump(Logger logger,
                 String msg)

Overrides:

dump in class AbstractSpaceItem

anyReadLockXtn

public boolean anyReadLockXtn()

Specified by:

anyReadLockXtn in interface IEntryHolder

getReadLockOwners

public List<XtnEntry> getReadLockOwners()

Specified by:

getReadLockOwners in interface IEntryHolder

Returns:

Returns ReadWriteLock Transaction's Owner Lists.

addReadLockOwner

public void addReadLockOwner(XtnEntry xtn)

Specified by:

addReadLockOwner in interface IEntryHolder

removeReadLockOwner

public void removeReadLockOwner(XtnEntry xtn)

Specified by:

removeReadLockOwner in interface IEntryHolder

clearReadLockOwners

public void clearReadLockOwners()

Specified by:

clearReadLockOwners in interface IEntryHolder

getWriteLockOwner

public XtnEntry getWriteLockOwner()

Specified by:

getWriteLockOwner in interface IEntryHolder

isEntryUnderWriteLockXtn

public boolean isEntryUnderWriteLockXtn()

Specified by:

isEntryUnderWriteLockXtn in interface IEntryHolder

getWriteLockOperation

public int getWriteLockOperation()

Specified by:

getWriteLockOperation in interface IEntryHolder

getWriteLockTransaction

public ServerTransaction getWriteLockTransaction()

Specified by:

getWriteLockTransaction in interface IEntryHolder

getTemplatesWaitingForEntry

public Collection<ITemplateHolder> getTemplatesWaitingForEntry()

Specified by:

getTemplatesWaitingForEntry in interface IEntryHolder

Returns:

Returns the m_WaitingFor. holds all entries waited by templates ReadIfExists/TaleIfExists

getCopyOfTemplatesWaitingForEntry

public Collection<ITemplateHolder> getCopyOfTemplatesWaitingForEntry()

Specified by:

getCopyOfTemplatesWaitingForEntry in interface IEntryHolder

addTemplateWaitingForEntry

public void addTemplateWaitingForEntry(ITemplateHolder template)

Specified by:

addTemplateWaitingForEntry in interface IEntryHolder

removeTemplateWaitingForEntry

public void removeTemplateWaitingForEntry(ITemplateHolder template)

Specified by:

removeTemplateWaitingForEntry in interface IEntryHolder

getOtherUpdateUnderXtnEntry

protected IEntryHolder getOtherUpdateUnderXtnEntry()

hasShadow

public boolean hasShadow(boolean safeEntry)

Specified by:

hasShadow in interface IEntryHolder

Specified by:

hasShadow in class AbstractSpaceItem

getShadow

public ShadowEntryHolder getShadow()

Specified by:

getShadow in interface IEntryHolder

getMaster

public IEntryHolder getMaster()

Specified by:

getMaster in interface IEntryHolder

isExpired

public boolean isExpired(long limit)

Specified by:

isExpired in interface IEntryHolder

isExpired

public boolean isExpired()

Specified by:

isExpired in interface IEntryHolder

isSameEntryInstance

public boolean isSameEntryInstance(IEntryHolder other)

Specified by:

isSameEntryInstance in interface IEntryHolder

isOffHeapEntry

public boolean isOffHeapEntry()

Specified by:

isOffHeapEntry in interface IEntryHolder

getOriginalEntryHolder

public IEntryHolder getOriginalEntryHolder()

Specified by:

getOriginalEntryHolder in interface IEntryHolder

getExternalLockObject

public ILockObject getExternalLockObject()

Description copied from interface: ILockedSubject

in case the locking object can be derived from the subject WHEN its not the subject itself

Specified by:

getExternalLockObject in interface ILockedSubject

Returns:

the lock object