SerializationGroupMemberContainer (JBoss Application Server: Parent Aggregator 7.1.1.Final API)

java.lang.Object
- org.jboss.as.ejb3.cache.impl.backing.SerializationGroupMemberContainer<K,V,G>

All Implemented Interfaces:

AffinitySupport<K>, PassivationManager<K,SerializationGroupMember<K,V,G>>, BackingCacheEntryFactory<K,V,SerializationGroupMember<K,V,G>>, BackingCacheEntryStore<K,V,SerializationGroupMember<K,V,G>>, GroupCompatibilityChecker, ReplicationPassivationManager<K,SerializationGroupMember<K,V,G>>
```
public class SerializationGroupMemberContainer<K extends Serializable,V extends Cacheable<K>,G extends Serializable>
extends Object
implements BackingCacheEntryFactory<K,V,SerializationGroupMember<K,V,G>>, ReplicationPassivationManager<K,SerializationGroupMember<K,V,G>>, BackingCacheEntryStore<K,V,SerializationGroupMember<K,V,G>>
```
Functions as both a StatefulObjectFactory and PassivationManager for SerializationGroupMembers.

Author:

Brian Stansberry, Paul Ferraro

Constructor Summary

Constructors
Constructor and Description
`SerializationGroupMemberContainer(PassivationManager<K,V> passivationManager, PassivatingBackingCache<G,Cacheable<G>,SerializationGroup<K,V,G>> groupCache, BackingCacheEntryStoreConfig config)`

Method Summary

Methods
Modifier and Type	Method and Description
`SerializationGroupMember<K,V,G>`	`createEntry(V item)`
`void`	`destroyEntry(SerializationGroupMember<K,V,G> entry)`
`SerializationGroupMember<K,V,G>`	`get(K key, boolean lock)` Gets the entry with the given id from the store.
`BackingCacheEntryStoreConfig`	`getConfig()`
`org.jboss.marshalling.MarshallingConfiguration`	`getMarshallingConfiguration()`
`org.jboss.ejb.client.Affinity`	`getStrictAffinity()` Returns the strict affinity associated with the entries of this cache
`StatefulTimeoutInfo`	`getTimeout()`
`org.jboss.ejb.client.Affinity`	`getWeakAffinity(K key)` Returns the weak affinity associated with the specified entry of this cache
`boolean`	`hasAffinity(K key)` Indicates whether the cache has an affinity for the specified key.
`Set<K>`	`insert(SerializationGroupMember<K,V,G> entry)` Put a new entry into the store.
`boolean`	`isClustered()` Gets whether this store supports clustering functionality.
`boolean`	`isCompatibleWith(GroupCompatibilityChecker other)` Gets whether this object can work compatibly with another in the management of `SerializationGroup`s.
`boolean`	`isCompatibleWith(SerializationGroup<K,V,G> group)`
`void`	`passivate(SerializationGroupMember<K,V,G> entry)` Remove the entry with the given key from any in-memory store while retaining it in the persistent store.
`void`	`postActivate(SerializationGroupMember<K,V,G> entry)` This method is called after an object has been retrieved deserialized after passivation.
`void`	`postReplicate(SerializationGroupMember<K,V,G> entry)` This method is called after a previously replicated object has been retrieved from a clustered cache.
`void`	`prePassivate(SerializationGroupMember<K,V,G> entry)` This method is called before an object is serialized for passivation.
`void`	`preReplicate(SerializationGroupMember<K,V,G> entry)` This method is called before an object is replicated by a clustered cache.
`SerializationGroupMember<K,V,G>`	`remove(K key)` Remove the object with the given key from the store.
`void`	`setBackingCache(GroupAwareBackingCache<K,V,G,SerializationGroupMember<K,V,G>> delegate)`
`void`	`setBackingCacheEntryStore(BackingCacheEntryStore<K,V,SerializationGroupMember<K,V,G>> store)`
`void`	`start()` Perform any initialization work.
`void`	`stop()` Perform any shutdown work.
`void`	`update(SerializationGroupMember<K,V,G> entry, boolean modified)` Update an already cached item.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SerializationGroupMemberContainer
```
public SerializationGroupMemberContainer(PassivationManager<K,V> passivationManager,
                                 PassivatingBackingCache<G,Cacheable<G>,SerializationGroup<K,V,G>> groupCache,
                                 BackingCacheEntryStoreConfig config)
```
- Method Detail
  - setBackingCache
```
public void setBackingCache(GroupAwareBackingCache<K,V,G,SerializationGroupMember<K,V,G>> delegate)
```
  - setBackingCacheEntryStore
```
public void setBackingCacheEntryStore(BackingCacheEntryStore<K,V,SerializationGroupMember<K,V,G>> store)
```
  - getStrictAffinity
```
public org.jboss.ejb.client.Affinity getStrictAffinity()
```
    Description copied from interface: AffinitySupport
    
    Returns the strict affinity associated with the entries of this cache
    
    Specified by:
    
    getStrictAffinity in interface AffinitySupport<K extends Serializable>
  - getWeakAffinity
```
public org.jboss.ejb.client.Affinity getWeakAffinity(K key)
```
    Description copied from interface: AffinitySupport
    
    Returns the weak affinity associated with the specified entry of this cache
    
    Specified by:
    
    getWeakAffinity in interface AffinitySupport<K extends Serializable>
  - hasAffinity
```
public boolean hasAffinity(K key)
```
    Description copied from interface: AffinitySupport
    
    Indicates whether the cache has an affinity for the specified key.
    
    Specified by:
    
    hasAffinity in interface AffinitySupport<K extends Serializable>
    
    Parameters:
    key - a candidate key
    
    Returns:
    true if this cache likes this key, false otherwise
  - getMarshallingConfiguration
```
public org.jboss.marshalling.MarshallingConfiguration getMarshallingConfiguration()
```
    Specified by:
    
    getMarshallingConfiguration in interface PassivationManager<K extends Serializable,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - createEntry
```
public SerializationGroupMember<K,V,G> createEntry(V item)
```
    Specified by:
    
    createEntry in interface BackingCacheEntryFactory<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - destroyEntry
```
public void destroyEntry(SerializationGroupMember<K,V,G> entry)
```
    Specified by:
    
    destroyEntry in interface BackingCacheEntryFactory<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - postActivate
```
public void postActivate(SerializationGroupMember<K,V,G> entry)
```
    Description copied from interface: PassivationManager
    
    This method is called after an object has been retrieved deserialized after passivation.
    
    Specified by:
    
    postActivate in interface PassivationManager<K extends Serializable,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the object
  - prePassivate
```
public void prePassivate(SerializationGroupMember<K,V,G> entry)
```
    Description copied from interface: PassivationManager
    
    This method is called before an object is serialized for passivation.
    
    Specified by:
    
    prePassivate in interface PassivationManager<K extends Serializable,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the object
  - preReplicate
```
public void preReplicate(SerializationGroupMember<K,V,G> entry)
```
    Description copied from interface: ReplicationPassivationManager
    
    This method is called before an object is replicated by a clustered cache.
    
    Specified by:
    
    preReplicate in interface ReplicationPassivationManager<K extends Serializable,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the object
  - postReplicate
```
public void postReplicate(SerializationGroupMember<K,V,G> entry)
```
    Description copied from interface: ReplicationPassivationManager
    
    This method is called after a previously replicated object has been retrieved from a clustered cache.
    
    Specified by:
    
    postReplicate in interface ReplicationPassivationManager<K extends Serializable,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the object.
  - update
```
public void update(SerializationGroupMember<K,V,G> entry,
          boolean modified)
```
    Description copied from interface: BackingCacheEntryStore
    
    Update an already cached item.
    
    Specified by:
    
    update in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the entry to update
    modified - was the entry modified since BackingCacheEntryStore.get(java.io.Serializable, boolean) was called?
  - isClustered
```
public boolean isClustered()
```
    Description copied from interface: BackingCacheEntryStore
    
    Gets whether this store supports clustering functionality.
    
    Specified by:
    
    isClustered in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Returns:
    true if clustering is supported, false otherwise
  - get
```
public SerializationGroupMember<K,V,G> get(K key,
                                  boolean lock)
```
    Description copied from interface: BackingCacheEntryStore
    
    Gets the entry with the given id from the store.
    
    Specified by:
    
    get in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    key - id of the entry. Cannot be null.
    
    Returns:
    the object store under id. May return null.
  - passivate
```
public void passivate(SerializationGroupMember<K,V,G> entry)
```
    Description copied from interface: BackingCacheEntryStore
    
    Remove the entry with the given key from any in-memory store while retaining it in the persistent store.
    
    Specified by:
    
    passivate in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the entry to passivate
  - insert
```
public Set<K> insert(SerializationGroupMember<K,V,G> entry)
```
    Description copied from interface: BackingCacheEntryStore
    
    Put a new entry into the store. This operation should only be performed once per entry.
    
    Specified by:
    
    insert in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    entry - the object to store. Cannot be null.
    
    Returns:
    A set of keys that need to be passivated, to keep the store below the max size
  - remove
```
public SerializationGroupMember<K,V,G> remove(K key)
```
    Description copied from interface: BackingCacheEntryStore
    
    Remove the object with the given key from the store.
    
    Specified by:
    
    remove in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
    
    Parameters:
    key - id of the entry. Cannot be null.
    
    Returns:
    the object that was cached under key
  - start
```
public void start()
```
    Description copied from interface: BackingCacheEntryStore
    
    Perform any initialization work.
    
    Specified by:
    
    start in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - stop
```
public void stop()
```
    Description copied from interface: BackingCacheEntryStore
    
    Perform any shutdown work.
    
    Specified by:
    
    stop in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - getConfig
```
public BackingCacheEntryStoreConfig getConfig()
```
    Specified by:
    
    getConfig in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - getTimeout
```
public StatefulTimeoutInfo getTimeout()
```
    Specified by:
    
    getTimeout in interface BackingCacheEntryStore<K extends Serializable,V extends Cacheable<K>,SerializationGroupMember<K extends Serializable,V extends Cacheable<K>,G extends Serializable>>
  - isCompatibleWith
```
public boolean isCompatibleWith(SerializationGroup<K,V,G> group)
```
  - isCompatibleWith
```
public boolean isCompatibleWith(GroupCompatibilityChecker other)
```
    Description copied from interface: GroupCompatibilityChecker
    
    Gets whether this object can work compatibly with another in the management of SerializationGroups.
    
    Specified by:
    
    isCompatibleWith in interface GroupCompatibilityChecker
    
    Parameters:
    other - the other checker. May be null.
    
    Returns:
    true if this object is compatible with other, false otherwise

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SerializationGroupMemberContainer

Method Detail

setBackingCache

setBackingCacheEntryStore

getStrictAffinity

getWeakAffinity

hasAffinity

getMarshallingConfiguration

createEntry

destroyEntry

postActivate

prePassivate

preReplicate

postReplicate

update

isClustered

get

passivate

insert

remove

start

stop

getConfig

getTimeout

isCompatibleWith

isCompatibleWith