Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.ejb.plugins.cmp.jdbc2
Class JDBCStoreManager2

java.lang.Object
  extended byorg.jboss.ejb.plugins.cmp.jdbc2.JDBCStoreManager2
All Implemented Interfaces:
AllowedOperationsFlags (src) , ContainerPlugin (src) , EntityPersistenceStore (src) , JDBCEntityPersistenceStore (src) , Service (src)
public class JDBCStoreManager2
extends java.lang.Object
implements JDBCEntityPersistenceStore (src)

Field Summary
 
Fields inherited from interface org.jboss.ejb.AllowedOperationsFlags (src)
IN_AFTER_BEGIN, IN_AFTER_COMPLETION, IN_BEFORE_COMPLETION, IN_BUSINESS_METHOD, IN_EJB_ACTIVATE, IN_EJB_CREATE, IN_EJB_FIND, IN_EJB_HOME, IN_EJB_LOAD, IN_EJB_PASSIVATE, IN_EJB_POST_CREATE, IN_EJB_REMOVE, IN_EJB_STORE, IN_EJB_TIMEOUT, IN_INTERCEPTOR_METHOD, IN_SERVICE_ENDPOINT_METHOD, IN_SET_ENTITY_CONTEXT, IN_SET_MESSAGE_DRIVEN_CONTEXT, IN_SET_SESSION_CONTEXT, IN_UNSET_ENTITY_CONTEXT, NOT_ALLOWED
 
Constructor Summary
JDBCStoreManager2()
           
 
Method Summary
 void activateEntity(EntityEnterpriseContext (src)  ctx)
          This method is called when an entity shall be activated.
 void create()
          create the service, do expensive operations etc
 java.lang.Object createBeanClassInstance()
          Returns a new instance of the bean class or a subclass of the bean class.
 java.lang.Object createEntity(java.lang.reflect.Method m, java.lang.Object[] args, EntityEnterpriseContext (src)  ctx)
          This method is called whenever an entity is to be created.
 void destroy()
          destroy the service, tear down
 java.util.Collection findEntities(java.lang.reflect.Method finderMethod, java.lang.Object[] args, EntityEnterpriseContext (src)  instance, GenericEntityObjectFactory (src)  factory)
          This method is called when collections of entities are to be found.
 java.lang.Object findEntity(java.lang.reflect.Method finderMethod, java.lang.Object[] args, EntityEnterpriseContext (src)  instance, GenericEntityObjectFactory (src)  factory)
          This method is called when single entities are to be found.
 java.lang.Object getApplicationData(java.lang.Object key)
           
 Catalog (src) getCatalog()
           
 EntityContainer (src) getContainer()
           
 JDBCAbstractEntityBridge (src) getEntityBridge()
           
 JDBCTypeFactory (src) getJDBCTypeFactory()
           
 JDBCEntityMetaData (src) getMetaData()
           
 QueryFactory (src) getQueryFactory()
           
 Schema (src) getSchema()
           
 void initEntity(EntityEnterpriseContext (src)  ctx)
          Initializes the instance context.
protected  void initStoreManager()
           
 boolean isCascadeDeleted(java.lang.Object key)
           
 boolean isModified(EntityEnterpriseContext (src)  instance)
          This method is used to determined whether the instance was modified.
 boolean isStoreRequired(EntityEnterpriseContext (src)  instance)
          This method is used to determine if an entity should be stored.
 void loadEntity(EntityEnterpriseContext (src)  ctx)
          This method is called whenever an entity shall be load from the underlying storage.
 void passivateEntity(EntityEnterpriseContext (src)  ctx)
          This method is called when an entity shall be passivate.
 java.lang.Object postCreateEntity(java.lang.reflect.Method m, java.lang.Object[] args, EntityEnterpriseContext (src)  ctx)
          This method is called after the createEntity.
 void putApplicationData(java.lang.Object key, java.lang.Object value)
           
 boolean registerCascadeDelete(java.lang.Object key, java.lang.Object value)
           
 void removeEntity(EntityEnterpriseContext (src)  ctx)
          This method is called when an entity shall be removed from the underlying storage.
 void setContainer(Container (src)  con)
          This callback is set by the container so that the plugin may access it
 void start()
          start the service, create is already called
protected  void startStoreManager()
           
 void stop()
          stop the service
 void storeEntity(EntityEnterpriseContext (src)  instance)
          This method is called whenever an entity shall be stored to the underlying storage.
 void unregisterCascadeDelete(java.lang.Object key)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JDBCStoreManager2

public JDBCStoreManager2()
Method Detail

getSchema

public Schema (src)  getSchema()

getCatalog

public Catalog (src)  getCatalog()
Specified by:
getCatalog in interface JDBCEntityPersistenceStore (src)

getQueryFactory

public QueryFactory (src)  getQueryFactory()

registerCascadeDelete

public boolean registerCascadeDelete(java.lang.Object key,
                                     java.lang.Object value)

isCascadeDeleted

public boolean isCascadeDeleted(java.lang.Object key)

unregisterCascadeDelete

public void unregisterCascadeDelete(java.lang.Object key)

setContainer

public void setContainer(Container (src)  con)
Description copied from interface: ContainerPlugin (src)
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. This may be null if the plugin is being disassociated from a container.

create

public void create()
            throws java.lang.Exception
Description copied from interface: Service (src)
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
Description copied from interface: Service (src)
start the service, create is already called

Specified by:
start in interface Service (src)
Throws:
java.lang.Exception

stop

public void stop()
Description copied from interface: Service (src)
stop the service

Specified by:
stop in interface Service (src)

destroy

public void destroy()
Description copied from interface: Service (src)
destroy the service, tear down

Specified by:
destroy in interface Service (src)

getEntityBridge

public JDBCAbstractEntityBridge (src)  getEntityBridge()
Specified by:
getEntityBridge in interface JDBCEntityPersistenceStore (src)

getMetaData

public JDBCEntityMetaData (src)  getMetaData()
Specified by:
getMetaData in interface JDBCEntityPersistenceStore (src)

getJDBCTypeFactory

public JDBCTypeFactory (src)  getJDBCTypeFactory()
Specified by:
getJDBCTypeFactory in interface JDBCEntityPersistenceStore (src)

getContainer

public EntityContainer (src)  getContainer()
Specified by:
getContainer in interface JDBCEntityPersistenceStore (src)

getApplicationData

public java.lang.Object getApplicationData(java.lang.Object key)
Specified by:
getApplicationData in interface JDBCEntityPersistenceStore (src)

putApplicationData

public void putApplicationData(java.lang.Object key,
                               java.lang.Object value)
Specified by:
putApplicationData in interface JDBCEntityPersistenceStore (src)

createBeanClassInstance

public java.lang.Object createBeanClassInstance()
                                         throws java.lang.Exception
Description copied from interface: EntityPersistenceStore (src)
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)
Description copied from interface: EntityPersistenceStore (src)
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 EntityPersistenceStore (src)
Parameters:
ctx -

createEntity

public java.lang.Object createEntity(java.lang.reflect.Method m,
                                     java.lang.Object[] args,
                                     EntityEnterpriseContext (src)  ctx)
                              throws CreateException (src)
Description copied from interface: EntityPersistenceStore (src)
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 being used for this create call
Returns:
The primary key computed by CMP PM or null for BMP
Throws:
CreateException (src)

postCreateEntity

public java.lang.Object postCreateEntity(java.lang.reflect.Method m,
                                         java.lang.Object[] args,
                                         EntityEnterpriseContext (src)  ctx)
                                  throws CreateException (src)
Description copied from interface: EntityPersistenceStore (src)
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 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:
null
Throws:
CreateException (src)

findEntity

public java.lang.Object findEntity(java.lang.reflect.Method finderMethod,
                                   java.lang.Object[] args,
                                   EntityEnterpriseContext (src)  instance,
                                   GenericEntityObjectFactory (src)  factory)
                            throws FinderException (src)
Description copied from interface: EntityPersistenceStore (src)
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:
FinderException (src)

findEntities

public java.util.Collection findEntities(java.lang.reflect.Method finderMethod,
                                         java.lang.Object[] args,
                                         EntityEnterpriseContext (src)  instance,
                                         GenericEntityObjectFactory (src)  factory)
                                  throws FinderException (src)
Description copied from interface: EntityPersistenceStore (src)
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:
FinderException (src)

activateEntity

public void activateEntity(EntityEnterpriseContext (src)  ctx)
Description copied from interface: EntityPersistenceStore (src)
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:
ctx - the instance to use for the activation

loadEntity

public void loadEntity(EntityEnterpriseContext (src)  ctx)
Description copied from interface: EntityPersistenceStore (src)
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

isStoreRequired

public boolean isStoreRequired(EntityEnterpriseContext (src)  instance)
Description copied from interface: EntityPersistenceStore (src)
This method is used to determine if an entity should be stored.

Specified by:
isStoreRequired in interface EntityPersistenceStore (src)
Parameters:
instance - the instance to check
Returns:
true, if the entity has been modified

isModified

public boolean isModified(EntityEnterpriseContext (src)  instance)
                   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:
instance -
Returns:
Throws:
java.lang.Exception

storeEntity

public void storeEntity(EntityEnterpriseContext (src)  instance)
Description copied from interface: EntityPersistenceStore (src)
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 EntityPersistenceStore (src)
Parameters:
instance - the instance to synchronize

passivateEntity

public void passivateEntity(EntityEnterpriseContext (src)  ctx)
Description copied from interface: EntityPersistenceStore (src)
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:
ctx - the instance to passivate

removeEntity

public void removeEntity(EntityEnterpriseContext (src)  ctx)
                  throws RemoveException (src)
Description copied from interface: EntityPersistenceStore (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:
RemoveException (src) - thrown if the instance could not be removed

initStoreManager

protected void initStoreManager()
                         throws java.lang.Exception
Throws:
java.lang.Exception

startStoreManager

protected void startStoreManager()
                          throws java.lang.Exception
Throws:
java.lang.Exception
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD