001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.ejb;
023:
024: import java.lang.reflect.Method;
025: import java.rmi.RemoteException;
026: import java.util.Collection;
027:
028: import javax.ejb.RemoveException;
029:
030: /**
031: * This interface is implemented by any EntityBean persistence managers plugins.
032: *
033: * <p>Implementations of this interface are called by other plugins in the
034: * container. If the persistence manager wants to, it may attach any
035: * instance specific metadata to the EntityEnterpriseContext that is
036: * passed in method calls.
037: *
038: * @see EntityContainer
039: *
040: * @author <a href="mailto:rickard.oberg@telkel.com">Rickard Öberg</a>
041: * @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>
042: * @version $Revision: 57209 $
043: */
044: public interface EntityPersistenceManager extends ContainerPlugin {
045: /**
046: * Returns a new instance of the bean class or a subclass of the bean class.
047: *
048: * @return the new instance
049: */
050: Object createBeanClassInstance() throws Exception;
051:
052: /**
053: * This method is called whenever an entity is to be created. The
054: * persistence manager is responsible for calling the ejbCreate method
055: * on the instance and to handle the results properly wrt the persistent
056: * store.
057: *
058: * @param m the create method in the home interface that was
059: * called
060: * @param args any create parameters
061: * @param instance the instance being used for this create call
062: */
063: void createEntity(Method m, Object[] args,
064: EntityEnterpriseContext instance) throws Exception;
065:
066: /**
067: * This method is called whenever an entity is to be created. The
068: * persistence manager is responsible for calling the ejbPostCreate method
069: * on the instance and to handle the results properly wrt the persistent
070: * store.
071: *
072: * @param m the create method in the home interface that was
073: * called
074: * @param args any create parameters
075: * @param instance the instance being used for this create call
076: */
077: void postCreateEntity(Method m, Object[] args,
078: EntityEnterpriseContext instance) throws Exception;
079:
080: /**
081: * This method is called when single entities are to be found. The
082: * persistence manager must find out whether the wanted instance is
083: * available in the persistence store, and if so it shall use the
084: * EJBProxyFactory plugin to create an EJBObject to the instance, which
085: * is to be returned as result.
086: *
087: * @param finderMethod the find method in the home interface that was
088: * called
089: * @param args any finder parameters
090: * @param instance the instance to use for the finder call
091: * @return an EJBObject representing the found entity
092: */
093: Object findEntity(Method finderMethod, Object[] args,
094: EntityEnterpriseContext instance,
095: GenericEntityObjectFactory factory) throws Exception;
096:
097: /**
098: * This method is called when collections of entities are to be found. The
099: * persistence manager must find out whether the wanted instances are
100: * available in the persistence store, and if so it shall use the
101: * EJBProxyFactory plugin to create EJBObjects to the instances, which are
102: * to be returned as result.
103: *
104: * @param finderMethod the find method in the home interface that was
105: * called
106: * @param args any finder parameters
107: * @param instance the instance to use for the finder call
108: * @return an EJBObject collection representing the found
109: * entities
110: */
111: Collection findEntities(Method finderMethod, Object[] args,
112: EntityEnterpriseContext instance,
113: GenericEntityObjectFactory factory) throws Exception;
114:
115: /**
116: * This method is called when an entity shall be activated. The persistence
117: * manager must call the ejbActivate method on the instance.
118: *
119: * @param instance the instance to use for the activation
120: *
121: * @throws RemoteException thrown if some system exception occurs
122: */
123: void activateEntity(EntityEnterpriseContext instance)
124: throws RemoteException;
125:
126: /**
127: * This method is called whenever an entity shall be load from the
128: * underlying storage. The persistence manager must load the state from
129: * the underlying storage and then call ejbLoad on the supplied instance.
130: *
131: * @param instance the instance to synchronize
132: *
133: * @throws RemoteException thrown if some system exception occurs
134: */
135: void loadEntity(EntityEnterpriseContext instance)
136: throws RemoteException;
137:
138: /**
139: * This method is used to determine if an entity should be stored.
140: *
141: * @param instance the instance to check
142: * @return true, if the entity has been modified
143: * @throws Exception thrown if some system exception occurs
144: */
145: boolean isStoreRequired(EntityEnterpriseContext instance)
146: throws Exception;
147:
148: /**
149: * This method is used to determined whether the instance was modified.
150: * NOTE, even if the method returns true the isStoreRequired for this same instance
151: * might return false, e.g. a CMR field that doesn't have a foreign key was modified.
152: *
153: * @param ctx
154: * @return
155: * @throws Exception
156: */
157: boolean isModified(EntityEnterpriseContext ctx) throws Exception;
158:
159: /**
160: * This method is called whenever an entity shall be stored to the
161: * underlying storage. The persistence manager must call ejbStore on the
162: * supplied instance and then store the state to the underlying storage.
163: *
164: * @param instance the instance to synchronize
165: *
166: * @throws RemoteException thrown if some system exception occurs
167: */
168: void storeEntity(EntityEnterpriseContext instance)
169: throws RemoteException;
170:
171: /**
172: * Invokes ejbStore on the instance.
173: *
174: * @param instance
175: * @throws RemoteException
176: */
177: void invokeEjbStore(EntityEnterpriseContext instance)
178: throws RemoteException;
179:
180: /**
181: * This method is called when an entity shall be passivate. The persistence
182: * manager must call the ejbPassivate method on the instance.
183: *
184: * @param instance the instance to passivate
185: *
186: * @throws RemoteException thrown if some system exception occurs
187: */
188: void passivateEntity(EntityEnterpriseContext instance)
189: throws RemoteException;
190:
191: /**
192: * This method is called when an entity shall be removed from the
193: * underlying storage. The persistence manager must call ejbRemove on the
194: * instance and then remove its state from the underlying storage.
195: *
196: * @param instance the instance to remove
197: *
198: * @throws RemoteException thrown if some system exception occurs
199: * @throws RemoveException thrown if the instance could not be removed
200: */
201: void removeEntity(EntityEnterpriseContext instance)
202: throws RemoteException, RemoveException;
203: }
|