org.jboss.as.cmp.jdbc2

Class JDBCStoreManager2

java.lang.Object

org.jboss.as.cmp.jdbc2.JDBCStoreManager2

All Implemented Interfaces:

JDBCEntityPersistenceStore

public class JDBCStoreManager2
extends Object
implements JDBCEntityPersistenceStore

Version:

$Revision: 94413 $

Author:

Alexey Loubyansky

Field Summary

Fields

Modifier and Type	Field and Description
static AttachmentKey<Schema>	SCHEMA

Constructor Summary

Constructors

Constructor and Description
JDBCStoreManager2(DeploymentUnit deploymentUnit, JDBCEntityMetaData metaData, CmpConfig cmpConfig, Catalog catalog)

Method Summary

Methods

Modifier and Type	Method and Description
void	activateEntity(CmpEntityBeanContext ctx) This method is called when an entity shall be activated.
void	addCreateTable(String entityName)
void	addExistingTable(String entityName)
Object	createBeanClassInstance() Returns a new instance of the bean class or a subclass of the bean class.
Object	createEntity(Method m, Object[] args, CmpEntityBeanContext ctx) This method is called whenever an entity is to be created.
Collection	findEntities(Method finderMethod, Object[] args, CmpEntityBeanContext instance, JDBCQueryCommand.EntityProxyFactory factory) This method is called when collections of entities are to be found.
Object	findEntity(Method finderMethod, Object[] args, CmpEntityBeanContext instance, JDBCQueryCommand.EntityProxyFactory factory) This method is called when single entities are to be found.
Catalog	getCatalog()
CmpConfig	getCmpConfig()
CmpEntityBeanComponent	getComponent()
DataSource	getDataSource(String name)
JDBCAbstractEntityBridge	getEntityBridge()
EntityBridgeInvocationHandler	getInvocationHandler()
JDBCTypeFactory	getJDBCTypeFactory()
KeyGeneratorFactory	getKeyGeneratorFactory(String name)
org.jboss.msc.inject.Injector<KeyGeneratorFactoryRegistry>	getKeyGeneratorFactoryInjector()
JDBCEntityMetaData	getMetaData()
QueryFactory	getQueryFactory()
Schema	getSchema()
boolean	hasCreateTable(String entityName)
void	init(CmpEntityBeanComponent component)
void	initEntity(CmpEntityBeanContext ctx) Initializes the instance context.
protected void	initStoreManager()
boolean	isCascadeDeleted(Object key)
boolean	isModified(CmpEntityBeanContext instance) This method is used to determined whether the instance was modified.
boolean	isStoreRequired(CmpEntityBeanContext instance) This method is used to determine if an entity should be stored.
void	loadEntity(CmpEntityBeanContext ctx) This method is called whenever an entity shall be load from the underlying storage.
void	passivateEntity(CmpEntityBeanContext ctx) This method is called when an entity shall be passivate.
Object	postCreateEntity(Method m, Object[] args, CmpEntityBeanContext ctx) This method is called after the createEntity.
boolean	registerCascadeDelete(Object key, Object value)
void	removeEntity(CmpEntityBeanContext ctx) This method is called when an entity shall be removed from the underlying storage.
protected void	startStoreManager()
void	stop()
void	storeEntity(CmpEntityBeanContext instance) This method is called whenever an entity shall be stored to the underlying storage.
void	unregisterCascadeDelete(Object key)

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA

public static final AttachmentKey<Schema> SCHEMA

Constructor Detail

JDBCStoreManager2

public JDBCStoreManager2(DeploymentUnit deploymentUnit,
                 JDBCEntityMetaData metaData,
                 CmpConfig cmpConfig,
                 Catalog catalog)

Method Detail

getSchema

public Schema getSchema()

getCatalog

public Catalog getCatalog()

Specified by:

getCatalog in interface JDBCEntityPersistenceStore

getQueryFactory

public QueryFactory getQueryFactory()

registerCascadeDelete

public boolean registerCascadeDelete(Object key,
                            Object value)

isCascadeDeleted

public boolean isCascadeDeleted(Object key)

unregisterCascadeDelete

public void unregisterCascadeDelete(Object key)

init

public void init(CmpEntityBeanComponent component)

stop

public void stop()

getEntityBridge

public JDBCAbstractEntityBridge getEntityBridge()

Specified by:

getEntityBridge in interface JDBCEntityPersistenceStore

getMetaData

public JDBCEntityMetaData getMetaData()

Specified by:

getMetaData in interface JDBCEntityPersistenceStore

getJDBCTypeFactory

public JDBCTypeFactory getJDBCTypeFactory()

Specified by:

getJDBCTypeFactory in interface JDBCEntityPersistenceStore

getComponent

public CmpEntityBeanComponent getComponent()

Specified by:

getComponent in interface JDBCEntityPersistenceStore

createBeanClassInstance

public Object createBeanClassInstance()
                               throws Exception

Description copied from interface: JDBCEntityPersistenceStore

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

Specified by:

createBeanClassInstance in interface JDBCEntityPersistenceStore

Returns:

the new instance

Throws:

Exception

initEntity

public void initEntity(CmpEntityBeanContext ctx)

Description copied from interface: JDBCEntityPersistenceStore

Initializes the instance context.

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

Specified by:

initEntity in interface JDBCEntityPersistenceStore

createEntity

public Object createEntity(Method m,
                  Object[] args,
                  CmpEntityBeanContext ctx)
                    throws javax.ejb.CreateException

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

Parameters:

m - the create method in the home interface 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:

javax.ejb.CreateException

postCreateEntity

public Object postCreateEntity(Method m,
                      Object[] args,
                      CmpEntityBeanContext ctx)
                        throws javax.ejb.CreateException

Description copied from interface: JDBCEntityPersistenceStore

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

Specified by:

postCreateEntity in interface JDBCEntityPersistenceStore

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:

null

Throws:

javax.ejb.CreateException

findEntity

public Object findEntity(Method finderMethod,
                Object[] args,
                CmpEntityBeanContext instance,
                JDBCQueryCommand.EntityProxyFactory factory)
                  throws javax.ejb.FinderException

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

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:

javax.ejb.FinderException

findEntities

public Collection findEntities(Method finderMethod,
                      Object[] args,
                      CmpEntityBeanContext instance,
                      JDBCQueryCommand.EntityProxyFactory factory)
                        throws javax.ejb.FinderException

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

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:

javax.ejb.FinderException

activateEntity

public void activateEntity(CmpEntityBeanContext ctx)

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

Parameters:

ctx - the instance to use for the activation

loadEntity

public void loadEntity(CmpEntityBeanContext ctx)

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

Parameters:

ctx - the instance to synchronize

isStoreRequired

public boolean isStoreRequired(CmpEntityBeanContext instance)

Description copied from interface: JDBCEntityPersistenceStore

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

Specified by:

isStoreRequired in interface JDBCEntityPersistenceStore

Parameters:

instance - the instance to check

Returns:

true, if the entity has been modified

isModified

public boolean isModified(CmpEntityBeanContext instance)
                   throws Exception

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

Returns:

Throws:

Exception

storeEntity

public void storeEntity(CmpEntityBeanContext instance)

Description copied from interface: JDBCEntityPersistenceStore

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.

Specified by:

storeEntity in interface JDBCEntityPersistenceStore

Parameters:

instance - the instance to synchronize

passivateEntity

public void passivateEntity(CmpEntityBeanContext ctx)

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

Parameters:

ctx - the instance to passivate

removeEntity

public void removeEntity(CmpEntityBeanContext ctx)
                  throws javax.ejb.RemoveException

Description copied from interface: JDBCEntityPersistenceStore

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 JDBCEntityPersistenceStore

Parameters:

ctx - the instance to remove

Throws:

javax.ejb.RemoveException - thrown if the instance could not be removed

initStoreManager

protected void initStoreManager()

startStoreManager

protected void startStoreManager()
                          throws Exception

Throws:

Exception

getCmpConfig

public CmpConfig getCmpConfig()

Specified by:

getCmpConfig in interface JDBCEntityPersistenceStore

getDataSource

public DataSource getDataSource(String name)

Specified by:

getDataSource in interface JDBCEntityPersistenceStore

hasCreateTable

public boolean hasCreateTable(String entityName)

Specified by:

hasCreateTable in interface JDBCEntityPersistenceStore

addCreateTable

public void addCreateTable(String entityName)

Specified by:

addCreateTable in interface JDBCEntityPersistenceStore

addExistingTable

public void addExistingTable(String entityName)

Specified by:

addExistingTable in interface JDBCEntityPersistenceStore

getInvocationHandler

public EntityBridgeInvocationHandler getInvocationHandler()

Specified by:

getInvocationHandler in interface JDBCEntityPersistenceStore

getKeyGeneratorFactory

public KeyGeneratorFactory getKeyGeneratorFactory(String name)

Specified by:

getKeyGeneratorFactory in interface JDBCEntityPersistenceStore

getKeyGeneratorFactoryInjector

public org.jboss.msc.inject.Injector<KeyGeneratorFactoryRegistry> getKeyGeneratorFactoryInjector()