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

Class SerializationGroupImpl<K extends Serializable,V extends Cacheable<K>>

java.lang.Object

org.jboss.as.ejb3.cache.spi.impl.AbstractBackingCacheEntry<UUID,Cacheable<UUID>>

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

All Implemented Interfaces:

Serializable, Comparable<BackingCacheEntry<UUID,Cacheable<UUID>>>, Cacheable<UUID>, Identifiable<UUID>, BackingCacheEntry<UUID,Cacheable<UUID>>, SerializationGroup<K,V,UUID>

public class SerializationGroupImpl<K extends Serializable,V extends Cacheable<K>>
extends AbstractBackingCacheEntry<UUID,Cacheable<UUID>>
implements SerializationGroup<K,V,UUID>

Defines a group of serializable objects which must be serialized in one unit of work.

Author:

Carlo de Wolf, Brian Stansberry, Paul Ferraro

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerializationGroupImpl(UUID id)

Method Summary

Methods

Modifier and Type	Method and Description
void	addActive(SerializationGroupMember<K,V,UUID> member) Records that the given member is "active"; i.e.
void	addInUse(K key) Notification that the given member is "in use", and therefore the group should not be serialized.
void	addMember(SerializationGroupMember<K,V,UUID> member) Initially associates a new member with the group.
PassivatingBackingCache<UUID,Cacheable<UUID>,SerializationGroup<K,V,UUID>>	getGroupCache() Gets the cache used to manage the group.
UUID	getId() The object identifier.
int	getInUseCount() Gets the number of members currently in use.
V	getMemberObject(K key) Returns the member object associated with the member whose id matches key.
Cacheable<UUID>	getUnderlyingItem() FIXME -- returns null; what should it do?
boolean	isClustered() Gets whether this groups supports (and requires) clustering functionality from its members.
boolean	isGroupModified() Returns whether the group has been modified.
boolean	isModified() Gets whether this object's internal state has been modified since the last request to this method.
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() Prepare members for passivation.
void	preReplicate() Prepare members for replication.
void	removeActive(K key) Records that the given member is no longer "active"; i.e.
void	removeInUse(K key) Notification that the given member is no longer "in use", and therefore should not prevent the group being serialized.
void	removeMember(K key) Remove the specified member from the group.
void	setClustered(boolean clustered) Sets whether this groups supports (and requires) clustering functionality from its members.
void	setGroupCache(PassivatingBackingCache<UUID,Cacheable<UUID>,SerializationGroup<K,V,UUID>> groupCache) Handback provided by the cache managing the group.
void	setGroupModified(boolean modified) Sets the modified state.
int	size() Gets the number of group members.
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, setInUse, 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, setInUse, setPrePassivated

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

SerializationGroupImpl

public SerializationGroupImpl(UUID id)

Method Detail

getId

public UUID getId()

Description copied from interface: Identifiable

The object identifier.

Specified by:

getId in interface Identifiable<UUID>

Returns:

the object identifier

isClustered

public boolean isClustered()

Gets whether this groups supports (and requires) clustering functionality from its members.

Returns:

true if clustering is supported, false otherwise

setClustered

public void setClustered(boolean clustered)

Sets whether this groups supports (and requires) clustering functionality from its members.

addMember

public void addMember(SerializationGroupMember<K,V,UUID> member)

Initially associates a new member with the group. Also marks the member as active.

Specified by:

addMember in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

member -

Throws:

IllegalStateException - if member was previously added to the group

removeMember

public void removeMember(K key)

Remove the specified member from the group.

Specified by:

removeMember in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

key - the id of the member

size

public int size()

Gets the number of group members.

Specified by:

size in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

getMemberObject

public V getMemberObject(K key)

Returns the member object associated with the member whose id matches key.

Specified by:

getMemberObject in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

key - the id of the member

Returns:

the object associated with the member, or null if key does not identify a member.

prePassivate

public void prePassivate()

Prepare members for passivation.

Specified by:

prePassivate in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

postActivate

public void postActivate()

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

Specified by:

postActivate in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

preReplicate

public void preReplicate()

Prepare members for replication.

Specified by:

preReplicate in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

postReplicate

public void postReplicate()

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

Specified by:

postReplicate in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

addActive

public void addActive(SerializationGroupMember<K,V,UUID> member)

Records that the given member is "active"; i.e. needs to have

Specified by:

addActive in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

member - the member

Throws:

IllegalStateException - if member wasn't previously added to the group via addMember(SerializationGroupMember)

removeActive

public void removeActive(K key)

Records that the given member is no longer "active"; i.e. does not need to have @PrePassivate callbacks invoked before serialization.

Specified by:

removeActive in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

key - the id of the member

Throws:

IllegalStateException - if member wasn't previously added to the group via addMember(SerializationGroupMember)

addInUse

public void addInUse(K key)

Notification that the given member is "in use", and therefore the group should not be serialized.

Specified by:

addInUse in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

key - the id of the member

Throws:

IllegalStateException - if member wasn't previously added to the group via addMember(SerializationGroupMember)

removeInUse

public void removeInUse(K key)

Notification that the given member is no longer "in use", and therefore should not prevent the group being serialized.

Specified by:

removeInUse in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

key - the id of the member

Throws:

IllegalStateException - if member wasn't previously added to the group via addMember(SerializationGroupMember)

getInUseCount

public int getInUseCount()

Gets the number of members currently in use.

Specified by:

getInUseCount in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

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

Returns:

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

isGroupModified

public boolean isGroupModified()

Description copied from interface: SerializationGroup

Returns whether the group has been modified. Differs from Cacheable.isModified() in that invoking this method does not clear the modified state.

Specified by:

isGroupModified in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

setGroupModified

public void setGroupModified(boolean modified)

Description copied from interface: SerializationGroup

Sets the modified state.

Specified by:

setGroupModified in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

modified - true if the group should be considered to have been modified, false if not

getUnderlyingItem

public Cacheable<UUID> getUnderlyingItem()

FIXME -- returns null; what should it do?

Specified by:

getUnderlyingItem in interface BackingCacheEntry<UUID,Cacheable<UUID>>

Returns:

getGroupCache

public PassivatingBackingCache<UUID,Cacheable<UUID>,SerializationGroup<K,V,UUID>> getGroupCache()

Description copied from interface: SerializationGroup

Gets the cache used to manage the group.

Specified by:

getGroupCache in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Returns:

the cache. May return null if the group has been serialized and not yet activated.

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<UUID,Cacheable<UUID>>

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<UUID,Cacheable<UUID>>

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<UUID,Cacheable<UUID>>

toString

public String toString()

Overrides:

toString in class Object

setGroupCache

public void setGroupCache(PassivatingBackingCache<UUID,Cacheable<UUID>,SerializationGroup<K,V,UUID>> groupCache)

Description copied from interface: SerializationGroup

Handback provided by the cache managing the group.

Specified by:

setGroupCache in interface SerializationGroup<K extends Serializable,V extends Cacheable<K>,UUID>

Parameters:

groupCache - the cache. Cannot be null.