org.jboss.as.ejb3.component.entity.entitycache

Class ReferenceCountingEntityCache

java.lang.Object

org.jboss.as.ejb3.component.entity.entitycache.ReferenceCountingEntityCache

All Implemented Interfaces:

ReadyEntityCache

public class ReferenceCountingEntityCache
extends Object
implements ReadyEntityCache

Author:

John Bailey, Wolf-Dieter Fink

Constructor Summary

Constructors

Constructor and Description
ReferenceCountingEntityCache(EntityBeanComponent component)

Method Summary

Modifier and Type	Method and Description
boolean	contains(Object key) Checks whether an entity bean instance for the given primary key is cached.
boolean	containsNotRemoved(Object key) Checks whether an entity bean instance for the given primary key is cached and the entity is not marked as removed.
void	create(EntityBeanComponentInstance instance) Called after an entity bean has been created and associated with a new identity.
void	discard(EntityBeanComponentInstance instance) Discard the object, called when an exception occurs
EntityBeanComponentInstance	get(Object key) Gets an entity bean instance for the given primary key.
void	release(EntityBeanComponentInstance instance, boolean success) Release the object from use.
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

ReferenceCountingEntityCache

public ReferenceCountingEntityCache(EntityBeanComponent component)

Method Detail

create

public void create(EntityBeanComponentInstance instance)

Description copied from interface: ReadyEntityCache

Called after an entity bean has been created and associated with a new identity. This corresponds to an ejbCreate call on the entity bean. The newly created object will be marked as in use, and must be released in the normal manner

Specified by:

create in interface ReadyEntityCache

Parameters:

instance - The new instance

contains

public boolean contains(Object key)

Description copied from interface: ReadyEntityCache

Checks whether an entity bean instance for the given primary key is cached. The reference counter will not be increased.

Specified by:

contains in interface ReadyEntityCache

Parameters:

key - the identifier of the object

Returns:

true if the object is cached.

containsNotRemoved

public boolean containsNotRemoved(Object key)

Description copied from interface: ReadyEntityCache

Checks whether an entity bean instance for the given primary key is cached and the entity is not marked as removed. The reference counter will not be increased.

Specified by:

containsNotRemoved in interface ReadyEntityCache

Parameters:

key - the identifier of the object

Returns:

true if the object is cached and not marked as removed.

get

public EntityBeanComponentInstance get(Object key)
                                throws javax.ejb.NoSuchEntityException

Description copied from interface: ReadyEntityCache

Gets an entity bean instance for the given primary key. This may return a cached instance, or may associate the given ket with a pooled entity. The returned entity will be referenced, and will have its reference count increased by one. It must be de-referenced via ReadyEntityCache.release(org.jboss.as.ejb3.component.entity.EntityBeanComponentInstance, boolean) Implementors of this method must ensure that repeated calls to get within the same transaction return the same instance for a given primary key. This must also take into account entity beans created in the same transaction using the ReadyEntityCache.create(org.jboss.as.ejb3.component.entity.EntityBeanComponentInstance) method. Implementations are free to use a 1 to 1 instance -> pk mapping, or create multiple instances per primary key.

Specified by:

get in interface ReadyEntityCache

Parameters:

key - the identifier of the object

Returns:

the object

Throws:

javax.ejb.NoSuchEntityException - if the object identity association failed

release

public void release(EntityBeanComponentInstance instance,
                    boolean success)

Description copied from interface: ReadyEntityCache

Release the object from use. This will be called at transaction commit time. If the entity bean has been removed it should be released back into the pool. This method is called before the lock on the instance has been released.

Specified by:

release in interface ReadyEntityCache

Parameters:

instance - The entity

success - True if the transaction succeeded

discard

public void discard(EntityBeanComponentInstance instance)

Description copied from interface: ReadyEntityCache

Discard the object, called when an exception occurs

Specified by:

discard in interface ReadyEntityCache

Parameters:

instance - The instance to discard

start

public void start()

Description copied from interface: ReadyEntityCache

Start the cache.

Specified by:

start in interface ReadyEntityCache

stop

public void stop()

Description copied from interface: ReadyEntityCache

Stop the cache.

Specified by:

stop in interface ReadyEntityCache