org.jboss.as.ejb3.cache.distributable

Class DistributableCache<K,V extends Identifiable<K>>

java.lang.Object

org.jboss.as.ejb3.cache.distributable.DistributableCache<K,V>

Type Parameters:

K - the cache key type

V - the cache value type

All Implemented Interfaces:

Cache<K,V>, AffinitySupport<K>, IdentifierFactory<K>

public class DistributableCache<K,V extends Identifiable<K>>
extends Object
implements Cache<K,V>

Distributable Cache implementation. This object is responsible for:

• Group association based on creation context
• Batching of bean manager operations

Author:

Paul Ferraro

Field Summary

Fields inherited from interface org.jboss.as.ejb3.cache.Cache

CURRENT_GROUP

Constructor Summary

Constructors

Constructor and Description
DistributableCache(BeanManager<UUID,K,V> manager, StatefulObjectFactory<V> factory, ServerEnvironment environment)

Method Summary

Modifier and Type	Method and Description
boolean	contains(K id) Indicates whether or not the specified key is contained within this cache.
V	create() Creates and caches a new instance of T.
K	createIdentifier()
void	discard(K id) Discard the specified object from cache.
V	get(K id) Get the specified object from cache.
int	getCacheSize()
int	getPassivatedCount()
org.jboss.ejb.client.Affinity	getStrictAffinity()
int	getTotalSize()
org.jboss.ejb.client.Affinity	getWeakAffinity(K id)
void	release(V value) Decreases the objects usage count.
void	remove(K id) Remove and destroy the specified object from cache.
void	start() Start the cache.
void	stop() Stop the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributableCache

public DistributableCache(BeanManager<UUID,K,V> manager,
                          StatefulObjectFactory<V> factory,
                          ServerEnvironment environment)

Method Detail

getStrictAffinity

public org.jboss.ejb.client.Affinity getStrictAffinity()

Specified by:

getStrictAffinity in interface AffinitySupport<K>

getWeakAffinity

public org.jboss.ejb.client.Affinity getWeakAffinity(K id)

Specified by:

getWeakAffinity in interface AffinitySupport<K>

createIdentifier

public K createIdentifier()

Specified by:

createIdentifier in interface IdentifierFactory<K>

create

public V create()

Description copied from interface: Cache

Creates and caches a new instance of T.

Specified by:

create in interface Cache<K,V extends Identifiable<K>>

Returns:

a new T

get

public V get(K id)

Description copied from interface: Cache

Get the specified object from cache. This will mark the object as being in use, and increase its usage count.

Specified by:

get in interface Cache<K,V extends Identifiable<K>>

Parameters:

id - the identifier of the object

Returns:

the object, or null if it does not exist

release

public void release(V value)

Description copied from interface: Cache

Decreases the objects usage count. If the usage count hits 0 then the object will be released.

Specified by:

release in interface Cache<K,V extends Identifiable<K>>

Parameters:

value - the object

remove

public void remove(K id)

Description copied from interface: Cache

Remove and destroy the specified object from cache.

Specified by:

remove in interface Cache<K,V extends Identifiable<K>>

Parameters:

id - the identifier of the object

discard

public void discard(K id)

Description copied from interface: Cache

Discard the specified object from cache.

Specified by:

discard in interface Cache<K,V extends Identifiable<K>>

Parameters:

id - the identifier of the object

contains

public boolean contains(K id)

Description copied from interface: Cache

Indicates whether or not the specified key is contained within this cache.

Specified by:

contains in interface Cache<K,V extends Identifiable<K>>

Parameters:

id - the cache key

Returns:

true if the key is present in the cache, false otherwise.

start

public void start()

Description copied from interface: Cache

Start the cache.

Specified by:

start in interface Cache<K,V extends Identifiable<K>>

stop

public void stop()

Description copied from interface: Cache

Stop the cache.

Specified by:

stop in interface Cache<K,V extends Identifiable<K>>

getCacheSize

public int getCacheSize()

Specified by:

getCacheSize in interface Cache<K,V extends Identifiable<K>>

getPassivatedCount

public int getPassivatedCount()

Specified by:

getPassivatedCount in interface Cache<K,V extends Identifiable<K>>

getTotalSize

public int getTotalSize()

Specified by:

getTotalSize in interface Cache<K,V extends Identifiable<K>>