Factory


1   /**
2    * EasyBeans
3    * Copyright (C) 2006 Bull S.A.S.
4    * Contact: easybeans@objectweb.org
5    *
6    * This library is free software; you can redistribute it and/or
7    * modify it under the terms of the GNU Lesser General Public
8    * License as published by the Free Software Foundation; either
9    * version 2.1 of the License, or any later version.
10   *
11   * This library is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   * Lesser General Public License for more details.
15   *
16   * You should have received a copy of the GNU Lesser General Public
17   * License along with this library; if not, write to the Free Software
18   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
19   * USA
20   *
21   * --------------------------------------------------------------------------
22   * $Id: Factory.java 1121 2006-09-27 08:51:06Z benoitf $
23   * --------------------------------------------------------------------------
24   */
25  
26  package org.objectweb.easybeans.api;
27  
28  import javax.naming.Context  ;
29  
30  import org.objectweb.easybeans.api.bean.info.IBeanInfo;
31  import org.objectweb.easybeans.api.pool.Pool;
32  import org.objectweb.easybeans.rpc.api.EJBRequest;
33  import org.objectweb.easybeans.rpc.api.EJBResponse;
34  
35  /**
36   * This interface is used by all bean factories of EJB 3 container.
37   * @param <PoolType> The type of the pool.
38   * @param <Clue> The clue used by the pool.
39   * @author Florent Benoit
40   *
41   */
42  public interface Factory<PoolType, Clue> {
43  
44      /**
45       * A remote request comes to the bean factory and needs to be handled.<br>
46       * A response is done which contains the answer.
47       * @param request the EJB request.
48       * @return a response that have been processed by the factory.
49       */
50      EJBResponse rpcInvoke(final EJBRequest request);
51  
52      /**
53       * Do a local call on a method of this factory.
54       * @param hash the hash of the method to execute.
55       * @param methodArgs the arguments of the method
56       * @param beanId the id of the bean that we want (stateful).
57       * @return response container new id (if any) and value.
58       */
59      EJBResponse localCall(final long hash, final Object  [] methodArgs, Long   beanId);
60  
61      /**
62       * Init the factory.
63       * @throws FactoryException if the initialization fails.
64       */
65      void init() throws FactoryException;
66  
67      /**
68       * Stops the factory.
69       */
70      void stop();
71  
72      /**
73       * Gets the className used by this factory.
74       * @return classname that will be instantiated to build bean instance.
75       */
76      String   getClassName();
77  
78      /**
79       * Gets the container used by this factory.
80       * @return container of this factory
81       */
82      EZBContainer getContainer();
83  
84      /**
85       * Gets the java: context.
86       * @return java: context.
87       */
88       Context   getJavaContext();
89  
90       /**
91        * Sets the java: context.
92        * @param javaContext the java: context.
93        */
94       void setJavaContext(final Context   javaContext);
95  
96       /**
97        * Gets the bean information.
98        * @return bean information
99        */
100       IBeanInfo getBeanInfo();
101 
102       /**
103        * Gets the pool used by this factory.
104        * @return pool.
105        */
106       Pool<PoolType, Clue> getPool();
107 }
108
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags