org.jboss.as.cmp.jdbc

Class JDBCStoreManager

java.lang.Object

org.jboss.as.cmp.jdbc.JDBCStoreManager

All Implemented Interfaces:

JDBCEntityPersistenceStore

public final class JDBCStoreManager
extends Object
implements JDBCEntityPersistenceStore

JDBCStoreManager manages storage of persistence data into a table. Other then loading the initial jbosscmp-jdbc.xml file this class does very little. The interesting tasks are performed by the command classes.

Life-cycle: Tied to the life-cycle of the entity container.

Multiplicity: One per cmp entity bean. This could be less if another implementation of EntityPersistenceStore is created and those beans use the implementation

Version:

$Revision: 81030 $

Author:

Dain Sundstrom, Alex Loubyansky

Field Summary

Fields

Modifier and Type	Field and Description
static AttachmentKey<AttachmentList<String>>	CREATE_TABLES
static AttachmentKey<AttachmentList<String>>	EXISTING_TABLES
static AttachmentKey<Object>	TX_DATA_MAP

Constructor Summary

Constructors

Constructor and Description
JDBCStoreManager(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 a class which implements the bean class.
Object	createEntity(Method createMethod, Object[] args, CmpEntityBeanContext ctx) This method is called whenever an entity is to be created.
Collection	findEntities(Method finderMethod, Object[] args, CmpEntityBeanContext ctx, JDBCQueryCommand.EntityProxyFactory factory) This method is called when collections of entities are to be found.
Object	findEntity(Method finderMethod, Object[] args, CmpEntityBeanContext ctx, JDBCQueryCommand.EntityProxyFactory factory) This method is called when single entities are to be found.
Object	getApplicationTxData(Object key)
Catalog	getCatalog()
CmpConfig	getCmpConfig()
JDBCCommandFactory	getCommandFactory()
CmpEntityBeanComponent	getComponent()
org.jboss.msc.inject.Injector<CmpEntityBeanComponent>	getComponentInjector()
DataSource	getDataSource(String name)
org.jboss.msc.inject.Injector<DataSource>	getDataSourceInjector(String name)
JDBCAbstractEntityBridge	getEntityBridge()
Object	getEntityTxData(Object key)
EntityBridgeInvocationHandler	getInvocationHandler()
JDBCTypeFactory	getJDBCTypeFactory()
KeyGeneratorFactory	getKeyGeneratorFactory(String name)
org.jboss.msc.inject.Injector<KeyGeneratorFactoryRegistry>	getKeyGeneratorFactoryInjector()
JDBCEntityMetaData	getMetaData()
JDBCQueryManager	getQueryManager()
ReadAheadCache	getReadAheadCache()
boolean	hasCreateTable(String entityName)
void	initEntity(CmpEntityBeanContext ctx) Initializes the instance context.
boolean	isModified(CmpEntityBeanContext ctx) This method is used to determined whether the instance was modified.
boolean	isStoreRequired(CmpEntityBeanContext ctx) This method is used to determine if an entity should be stored.
void	loadEntity(CmpEntityBeanContext ctx) Loads entity.
boolean	loadEntity(CmpEntityBeanContext ctx, boolean failIfNotFound)
void	loadField(JDBCCMPFieldBridge field, CmpEntityBeanContext ctx)
Collection	loadRelation(JDBCCMRFieldBridge cmrField, Object pk)
void	passivateEntity(CmpEntityBeanContext ctx) This method is called when an entity shall be passivate.
Object	postCreateEntity(Method createMethod, Object[] args, CmpEntityBeanContext ctx) This method is called after the createEntity.
void	putApplicationTxData(Object key, Object value)
void	putEntityTxData(Object key, Object value)
void	removeEntity(CmpEntityBeanContext ctx) This method is called when an entity shall be removed from the underlying storage.
void	removeEntityTxData(Object key)
void	scheduleCascadeDelete(List pks) Schedules instances for cascade-delete
void	storeEntity(CmpEntityBeanContext ctx) This method is called whenever an entity shall be stored to the underlying storage.
boolean	unscheduledCascadeDelete(Object pk) Unschedules instance cascade delete.

Methods inherited from class java.lang.Object

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

Field Detail

TX_DATA_MAP

public static final AttachmentKey<Object> TX_DATA_MAP

CREATE_TABLES

public static final AttachmentKey<AttachmentList<String>> CREATE_TABLES

EXISTING_TABLES

public static final AttachmentKey<AttachmentList<String>> EXISTING_TABLES

Constructor Detail

JDBCStoreManager

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

Method Detail

getEntityBridge

public JDBCAbstractEntityBridge getEntityBridge()

Specified by:

getEntityBridge in interface JDBCEntityPersistenceStore

getJDBCTypeFactory

public JDBCTypeFactory getJDBCTypeFactory()

Specified by:

getJDBCTypeFactory in interface JDBCEntityPersistenceStore

getMetaData

public JDBCEntityMetaData getMetaData()

Specified by:

getMetaData in interface JDBCEntityPersistenceStore

getQueryManager

public JDBCQueryManager getQueryManager()

getCommandFactory

public JDBCCommandFactory getCommandFactory()

getReadAheadCache

public ReadAheadCache getReadAheadCache()

scheduleCascadeDelete

public void scheduleCascadeDelete(List pks)

Schedules instances for cascade-delete

unscheduledCascadeDelete

public boolean unscheduledCascadeDelete(Object pk)

Unschedules instance cascade delete.

Parameters:

pk - instance primary key.

Returns:

true if the instance was scheduled for cascade deleted.

getApplicationTxData

public Object getApplicationTxData(Object key)

putApplicationTxData

public void putApplicationTxData(Object key,
                        Object value)

getEntityTxData

public Object getEntityTxData(Object key)

putEntityTxData

public void putEntityTxData(Object key,
                   Object value)

removeEntityTxData

public void removeEntityTxData(Object key)

getComponent

public CmpEntityBeanComponent getComponent()

Specified by:

getComponent in interface JDBCEntityPersistenceStore

getComponentInjector

public org.jboss.msc.inject.Injector<CmpEntityBeanComponent> getComponentInjector()

createBeanClassInstance

public Object createBeanClassInstance()
                               throws Exception

Returns a new instance of a class which implements 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 createMethod,
                  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:

createMethod - 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 createMethod,
                      Object[] args,
                      CmpEntityBeanContext ctx)

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:

createMethod - 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

findEntity

public Object findEntity(Method finderMethod,
                Object[] args,
                CmpEntityBeanContext ctx,
                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

ctx - 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 ctx,
                      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

ctx - 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)

Loads entity. If entity not found NoSuchEntityException is thrown.

Specified by:

loadEntity in interface JDBCEntityPersistenceStore

Parameters:

ctx - - entity context.

loadEntity

public boolean loadEntity(CmpEntityBeanContext ctx,
                 boolean failIfNotFound)

loadField

public void loadField(JDBCCMPFieldBridge field,
             CmpEntityBeanContext ctx)

isStoreRequired

public boolean isStoreRequired(CmpEntityBeanContext ctx)

Description copied from interface: JDBCEntityPersistenceStore

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

Specified by:

isStoreRequired in interface JDBCEntityPersistenceStore

Parameters:

ctx - the instance to check

Returns:

true, if the entity has been modified

isModified

public boolean isModified(CmpEntityBeanContext ctx)

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:

storeEntity

public void storeEntity(CmpEntityBeanContext ctx)

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:

ctx - 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,
                         RemoteException

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

RemoteException - thrown if some system exception occurs

loadRelation

public Collection loadRelation(JDBCCMRFieldBridge cmrField,
                      Object pk)

getDataSource

public DataSource getDataSource(String name)

Specified by:

getDataSource in interface JDBCEntityPersistenceStore

getCmpConfig

public CmpConfig getCmpConfig()

Specified by:

getCmpConfig in interface JDBCEntityPersistenceStore

getCatalog

public Catalog getCatalog()

Specified by:

getCatalog 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

getDataSourceInjector

public org.jboss.msc.inject.Injector<DataSource> getDataSourceInjector(String name)

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()