org.jboss.ejb.plugins
Class CMPClusteredInMemoryPersistenceManager

java.lang.Object
  org.jboss.ejb.plugins.CMPClusteredInMemoryPersistenceManager

All Implemented Interfaces:

AllowedOperationsFlags (src) , ContainerPlugin (src) , EntityPersistenceStore (src) , Service (src)

public class CMPClusteredInMemoryPersistenceManager

extends java.lang.Object

implements EntityPersistenceStore (src)

EntityPersistenceStore implementation storing values in-memory and shared accross the cluster through the DistributedState service from the clustering framework. It always uses the DefaultPartition.

See Also:

EntityPersistenceStore (src) , CMPInMemoryPersistenceManager (src) , DistributedState (src)

con

protected EntityContainer (src)  con

idField

protected java.lang.reflect.Field idField

ds

protected DistributedState (src)  ds

DS_CATEGORY

protected java.lang.String DS_CATEGORY

isModified

protected java.lang.reflect.Method isModified

Optional isModified method used by storeEntity

CMPClusteredInMemoryPersistenceManager

public CMPClusteredInMemoryPersistenceManager()

setContainer

public void setContainer(Container (src)  con)

This callback is set by the container so that the plugin may access it

Specified by:

setContainer in interface ContainerPlugin (src)

Parameters:

con - The container using this plugin.

create

public void create()
            throws java.lang.Exception

create the service, do expensive operations etc

Specified by:

create in interface Service (src)

Throws:

java.lang.Exception

start

public void start()
           throws java.lang.Exception

start the service, create is already called

Specified by:

start in interface Service (src)

Throws:

java.lang.Exception

stop

public void stop()

stop the service

Specified by:

stop in interface Service (src)

destroy

public void destroy()

destroy the service, tear down

Specified by:

destroy in interface Service (src)

createBeanClassInstance

public java.lang.Object createBeanClassInstance()
                                         throws java.lang.Exception

Returns a new instance of the bean class or a subclass of the bean class.

Specified by:

createBeanClassInstance in interface EntityPersistenceStore (src)

Returns:

the new instance

Throws:

java.lang.Exception

initEntity

public void initEntity(EntityEnterpriseContext (src)  ctx)

Initializes the instance context.

This method is called before createEntity, and should reset the value of all cmpFields to 0 or null.

Specified by:

initEntity in interface EntityPersistenceStore (src)

Parameters:

ctx -

createEntity

public java.lang.Object createEntity(java.lang.reflect.Method m,
                                     java.lang.Object[] args,
                                     EntityEnterpriseContext (src)  ctx)
                              throws java.lang.Exception

This method is called whenever an entity is to be created. The persistence manager is responsible for handling the results properly wrt the persistent store.

Specified by:

createEntity in interface EntityPersistenceStore (src)

Parameters:

m - the create method in the home interface that was called

args - any create parameters

ctx - the instance ctx being used for this create call

Returns:

The primary key computed by CMP PM or null for BMP

Throws:

java.lang.Exception

postCreateEntity

public java.lang.Object postCreateEntity(java.lang.reflect.Method m,
                                         java.lang.Object[] args,
                                         EntityEnterpriseContext (src)  ctx)
                                  throws java.lang.Exception

This method is called after the ejbCreate. The persistence manager is responsible for handling the results properly wrt the persistent store.

Specified by:

postCreateEntity in interface EntityPersistenceStore (src)

Parameters:

m - the ejbPostCreate method in the bean class that was called

args - any create parameters

ctx - the instance being used for this create call

Returns:

The primary key computed by CMP PM or null for BMP

Throws:

java.lang.Exception

findEntity

public java.lang.Object findEntity(java.lang.reflect.Method finderMethod,
                                   java.lang.Object[] args,
                                   EntityEnterpriseContext (src)  instance,
                                   GenericEntityObjectFactory (src)  factory)
                            throws java.lang.Exception

This method is called when single entities are to be found. The persistence manager must find out whether the wanted instance is available in the persistence store, if so it returns the primary key of the object.

Specified by:

findEntity in interface EntityPersistenceStore (src)

Parameters:

finderMethod - the find method in the home interface that was called

args - any finder parameters

instance - the instance to use for the finder call

Returns:

a primary key representing the found entity

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

FinderException (src) - thrown if some heuristic problem occurs

java.lang.Exception - thrown if some heuristic problem occurs

findEntities

public java.util.Collection findEntities(java.lang.reflect.Method finderMethod,
                                         java.lang.Object[] args,
                                         EntityEnterpriseContext (src)  instance,
                                         GenericEntityObjectFactory (src)  factory)
                                  throws java.lang.Exception

This method is called when collections of entities are to be found. The persistence manager must find out whether the wanted instances are available in the persistence store, and if so it must return a collection of primaryKeys.

Specified by:

findEntities in interface EntityPersistenceStore (src)

Parameters:

finderMethod - the find method in the home interface that was called

args - any finder parameters

instance - the instance to use for the finder call

Returns:

an primary key collection representing the found entities

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

FinderException (src) - thrown if some heuristic problem occurs

java.lang.Exception - thrown if some heuristic problem occurs

activateEntity

public void activateEntity(EntityEnterpriseContext (src)  instance)

This method is called when an entity shall be activated.

With the PersistenceManager factorization most EJB calls should not exists However this calls permits us to introduce optimizations in the persistence store. Particularly the context has a "PersistenceContext" that a PersistenceStore can use (JAWS does for smart updates) and this is as good a callback as any other to set it up.

Specified by:

activateEntity in interface EntityPersistenceStore (src)

Parameters:

instance - the instance to use for the activation

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

loadEntity

public void loadEntity(EntityEnterpriseContext (src)  ctx)

This method is called whenever an entity shall be load from the underlying storage. The persistence manager must load the state from the underlying storage and then call ejbLoad on the supplied instance.

Specified by:

loadEntity in interface EntityPersistenceStore (src)

Parameters:

ctx - the instance to synchronize

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

isStoreRequired

public boolean isStoreRequired(EntityEnterpriseContext (src)  ctx)
                        throws java.lang.Exception

This method is used to determine if an entity should be stored.

Specified by:

isStoreRequired in interface EntityPersistenceStore (src)

Parameters:

ctx - the instance to check

Returns:

true, if the entity has been modified

Throws:

java.lang.Exception - thrown if some system exception occurs

isModified

public boolean isModified(EntityEnterpriseContext (src)  ctx)
                   throws java.lang.Exception

Description copied from interface: EntityPersistenceStore (src)

This method is used to determined whether the instance was modified. NOTE, even if the method returns true the isStoreRequired for this same instance might return false, e.g. a CMR field that doesn't have a foreign key was modified.

Specified by:

isModified in interface EntityPersistenceStore (src)

Parameters:

ctx -

Returns:

Throws:

java.lang.Exception

storeEntity

public void storeEntity(EntityEnterpriseContext (src)  ctx)
                 throws java.rmi.RemoteException

This method is called whenever an entity shall be stored to the underlying storage. The persistence manager must call ejbStore on the supplied instance and then store the state to the underlying storage. B

Specified by:

storeEntity in interface EntityPersistenceStore (src)

Parameters:

ctx - the instance to synchronize

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

passivateEntity

public void passivateEntity(EntityEnterpriseContext (src)  instance)

This method is called when an entity shall be passivate. The persistence manager must call the ejbPassivate method on the instance.

See the activate discussion for the reason for exposing EJB callback calls to the store.

Specified by:

passivateEntity in interface EntityPersistenceStore (src)

Parameters:

instance - the instance to passivate

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

removeEntity

public void removeEntity(EntityEnterpriseContext (src)  ctx)
                  throws RemoveException (src) 

This method is called when an entity shall be removed from the underlying storage. The persistence manager must call ejbRemove on the instance and then remove its state from the underlying storage.

Specified by:

removeEntity in interface EntityPersistenceStore (src)

Parameters:

ctx - the instance to remove

Throws:

java.rmi.RemoteException - thrown if some system exception occurs

RemoveException (src) - thrown if the instance could not be removed

storeEntity

protected void storeEntity(java.lang.Object id,
                           java.lang.Object obj)
                    throws java.lang.Exception

Throws:

java.lang.Exception