001: /**
002: * EasyBeans
003: * Copyright (C) 2006 Bull S.A.S.
004: * Contact: easybeans@ow2.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * --------------------------------------------------------------------------
022: * $Id: Factory.java 1970 2007-10-16 11:49:25Z benoitf $
023: * --------------------------------------------------------------------------
024: */package org.ow2.easybeans.api;
025:
026: import javax.ejb.Timer;
027: import javax.ejb.TimerService;
028: import javax.naming.Context;
029:
030: import org.ow2.easybeans.api.bean.info.IBeanInfo;
031: import org.ow2.easybeans.api.pool.Pool;
032: import org.ow2.easybeans.rpc.api.EJBRequest;
033: import org.ow2.easybeans.rpc.api.EJBResponse;
034:
035: /**
036: * This interface is used by all bean factories of EJB 3 container.
037: * @param <PoolType> The type of the pool.
038: * @param <Clue> The clue used by the pool.
039: * @author Florent Benoit
040: *
041: */
042: public interface Factory<PoolType, Clue> {
043:
044: /**
045: * A remote request comes to the bean factory and needs to be handled.<br>
046: * A response is done which contains the answer.
047: * @param request the EJB request.
048: * @return a response that have been processed by the factory.
049: */
050: EJBResponse rpcInvoke(final EJBRequest request);
051:
052: /**
053: * Do a local call on a method of this factory.
054: * @param hash the hash of the method to execute.
055: * @param methodArgs the arguments of the method
056: * @param beanId the id of the bean that we want (stateful).
057: * @return response container new id (if any) and value.
058: */
059: EJBResponse localCall(final long hash, final Object[] methodArgs,
060: Long beanId);
061:
062: /**
063: * Notified when the timer service send a Timer object.
064: * It has to call the Timed method.
065: * @param timer the given timer object that will be given to the timer method.
066: */
067: void notifyTimeout(final Timer timer);
068:
069: /**
070: * Init the factory.
071: * @throws FactoryException if the initialization fails.
072: */
073: void init() throws FactoryException;
074:
075: /**
076: * Stops the factory.
077: */
078: void stop();
079:
080: /**
081: * Gets the className used by this factory.
082: * @return classname that will be instantiated to build bean instance.
083: */
084: String getClassName();
085:
086: /**
087: * Gets the container used by this factory.
088: * @return container of this factory
089: */
090: EZBContainer getContainer();
091:
092: /**
093: * Gets the java: context.
094: * @return java: context.
095: */
096: Context getJavaContext();
097:
098: /**
099: * Sets the java: context.
100: * @param javaContext the java: context.
101: */
102: void setJavaContext(final Context javaContext);
103:
104: /**
105: * Gets the bean information.
106: * @return bean information
107: */
108: IBeanInfo getBeanInfo();
109:
110: /**
111: * Gets the pool used by this factory.
112: * @return pool.
113: */
114: Pool<PoolType, Clue> getPool();
115:
116: /**
117: * Gets an id for this factory.
118: * @return string id.
119: */
120: String getId();
121:
122: /**
123: * Gets the timer service of this factory.
124: * @return the timer service.
125: */
126: TimerService getTimerService();
127: }
|