org.jboss.as.ejb3.cache.impl.backing

Class SerializationGroupMemberImpl<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

java.lang.Object

org.jboss.as.ejb3.cache.spi.impl.AbstractBackingCacheEntry<K,V>

org.jboss.as.ejb3.cache.impl.backing.SerializationGroupMemberImpl<K,V,G>

All Implemented Interfaces:

Serializable, Comparable<BackingCacheEntry<K,V>>, Cacheable<K>, Identifiable<K>, BackingCacheEntry<K,V>, SerializationGroupMember<K,V,G>

public class SerializationGroupMemberImpl<K extends Serializable,V extends Cacheable<K>,G extends Serializable>
extends AbstractBackingCacheEntry<K,V>
implements SerializationGroupMember<K,V,G>

A member of a SerializationGroupImpl.

Author:

Brian Stansberry, Paul Ferraro

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializationGroupMemberImpl(V obj, GroupAwareBackingCache<K,V,G,SerializationGroupMember<K,V,G>> cache)

Method Summary

Methods

Modifier and Type	Method and Description
SerializationGroup<K,V,G>	getGroup() Gets the SerializationGroupImpl of which this object is a member.
G	getGroupId() Gets the id for the group
K	getId() The object identifier.
V	getUnderlyingItem() Gets the underlying CacheItem.
boolean	isClustered() Gets whether this member supports clustering functionality.
boolean	isModified() Gets whether this object's internal state has been modified since the last request to this method.
boolean	isPreReplicated() Gets whether pre-replication callbacks have been invoked on the underlying item.
void	lock() Lock this item, blocking until the lock is acquired.
void	postActivate() Notification that the group has been activated from a passivated state.
void	postReplicate() Notification that the previously replicated group has been retrieved from a clustered cache.
void	prePassivate() Instructs this group member to ensure any prePassivate callbacks are invoked on the underlying item and any internal references to its group and underlying item are released.
void	preReplicate() Instructs this group member to ensure any preReplicate callbacks are invoked on the underlying item and any internal references to its group and underlying item are released.
void	setGroup(SerializationGroup<K,V,G> group) Sets the SerializationGroupImpl of which this object is a member.
void	setInUse(boolean inUse) Sets whether this entry is in use by a caller.
void	setPassivatingCache(GroupAwareBackingCache<K,V,G,SerializationGroupMember<K,V,G>> delegate) Allows our controlling PassivatingBackingCache to provide us a reference after deserialization.
void	setPreReplicated(boolean preReplicated) Sets whether pre-replication callbacks have been invoked on the underlying item.
void	setUnderlyingItem(V obj) Sets the underlying Cacheable associated with this group member.
String	toString()
boolean	tryLock() Attempt to lock this item, failing promptly if the lock is already held by another thread.
void	unlock() Unlock this item.

Methods inherited from class org.jboss.as.ejb3.cache.spi.impl.AbstractBackingCacheEntry

compareTo, equals, getLastUsed, hashCode, invalidate, isInUse, isPrePassivated, isValid, setLastUsed, setPrePassivated

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.as.ejb3.cache.spi.BackingCacheEntry

getLastUsed, invalidate, isInUse, isPrePassivated, isValid, setPrePassivated

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

SerializationGroupMemberImpl

public SerializationGroupMemberImpl(V obj,
                            GroupAwareBackingCache<K,V,G,SerializationGroupMember<K,V,G>> cache)

Method Detail

getId

public K getId()

Description copied from interface: Identifiable

The object identifier.

Specified by:

getId in interface Identifiable<K extends Serializable>

Returns:

the object identifier

isModified

public boolean isModified()

Description copied from interface: Cacheable

Gets whether this object's internal state has been modified since the last request to this method.

Implementations must be aggressive about returning true if they are uncertain about whether they have been modified; false should only be returned if the implementing object is certain its internal state has not been modified.

Specified by:

isModified in interface Cacheable<K extends Serializable>

Returns:

true if the state has been modified or the implementing object does not know; false otherwise.

isClustered

public boolean isClustered()

Gets whether this member supports clustering functionality.

Returns:

true if clustering is supported, false otherwise

getUnderlyingItem

public V getUnderlyingItem()

Description copied from interface: BackingCacheEntry

Gets the underlying CacheItem.

Specified by:

getUnderlyingItem in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

Returns:

setUnderlyingItem

public void setUnderlyingItem(V obj)

Sets the underlying Cacheable associated with this group member.

Specified by:

setUnderlyingItem in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

Parameters:

obj - the cache item

getGroup

public SerializationGroup<K,V,G> getGroup()

Gets the SerializationGroupImpl of which this object is a member.

Specified by:

getGroup in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

Returns:

the group. May return null

setGroup

public void setGroup(SerializationGroup<K,V,G> group)

Sets the SerializationGroupImpl of which this object is a member.

Specified by:

setGroup in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

Parameters:

group - May be null

getGroupId

public G getGroupId()

Gets the id for the group

Specified by:

getGroupId in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

Returns:

prePassivate

public void prePassivate()

Description copied from interface: SerializationGroupMember

Instructs this group member to ensure any prePassivate callbacks are invoked on the underlying item and any internal references to its group and underlying item are released. Called in preparation for serialization of the group. Clearing references is necessary in order to ensure no stale references to group content are retained outside of the SerializationGroup itself.

Specified by:

prePassivate in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

preReplicate

public void preReplicate()

Description copied from interface: SerializationGroupMember

Instructs this group member to ensure any preReplicate callbacks are invoked on the underlying item and any internal references to its group and underlying item are released. Called in preparation for serialization of the group. Clearing references is necessary in order to ensure no stale references to group content are retained outside of the SerializationGroup itself.

Specified by:

preReplicate in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

postActivate

public void postActivate()

Notification that the group has been activated from a passivated state.

isPreReplicated

public boolean isPreReplicated()

Description copied from interface: SerializationGroupMember

Gets whether pre-replication callbacks have been invoked on the underlying item.

Specified by:

isPreReplicated in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

setPreReplicated

public void setPreReplicated(boolean preReplicated)

Description copied from interface: SerializationGroupMember

Sets whether pre-replication callbacks have been invoked on the underlying item.

Specified by:

setPreReplicated in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

postReplicate

public void postReplicate()

Notification that the previously replicated group has been retrieved from a clustered cache.

setInUse

public void setInUse(boolean inUse)

Description copied from interface: BackingCacheEntry

Sets whether this entry is in use by a caller.

Specified by:

setInUse in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

Overrides:

setInUse in class AbstractBackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

setPassivatingCache

public void setPassivatingCache(GroupAwareBackingCache<K,V,G,SerializationGroupMember<K,V,G>> delegate)

Allows our controlling PassivatingBackingCache to provide us a reference after deserialization.

Specified by:

setPassivatingCache in interface SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>

Parameters:

delegate -

lock

public void lock()

Description copied from interface: BackingCacheEntry

Lock this item, blocking until the lock is acquired. Has the same semantics as , except that a RuntimeException will be thrown if the thread is interrupted instead of InterruptedException.

Specified by:

lock in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

tryLock

public boolean tryLock()

Description copied from interface: BackingCacheEntry

Attempt to lock this item, failing promptly if the lock is already held by another thread. Has the same semantics as .

Specified by:

tryLock in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

Returns:

true if the lock was acquired, false otherwise

unlock

public void unlock()

Description copied from interface: BackingCacheEntry

Unlock this item. Has the same semantics as .

Specified by:

unlock in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

toString

public String toString()

Overrides:

toString in class Object