001: /**
002: * JOnAS: Java(TM) Open Application Server
003: * Copyright (C) 1999 Bull S.A.
004: * Contact: jonas-team@objectweb.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: BeanFactory.java 9238 2006-07-26 08:52:36Z coqp $
023: * --------------------------------------------------------------------------
024: */package org.objectweb.jonas_ejb.container;
025:
026: import java.util.Hashtable;
027:
028: import javax.naming.InitialContext;
029: import javax.transaction.Transaction;
030:
031: import org.objectweb.jonas_ejb.deployment.api.BeanDesc;
032: import org.objectweb.transaction.jta.TransactionManager;
033:
034: /**
035: * Interface to the Bean Factories
036: * used by the Container, JMX, or generic parts of this package.
037: * @author Philippe Durieux, Philippe Coq (Bull)
038: */
039: public interface BeanFactory {
040:
041: /**
042: * get the bean name
043: * @return The name of the bean
044: */
045: String getEJBName();
046:
047: /**
048: * Get the Deployement descriptor of this Ejb
049: * @return BeanDesc The bean deployment descriptor
050: */
051: BeanDesc getDeploymentDescriptor();
052:
053: /**
054: * Get the size of the instance pool for this bean
055: * @return number of instances in the pool
056: */
057: int getPoolSize();
058:
059: /**
060: * stop this EJB (unregister it in JNDI)
061: */
062: void stop();
063:
064: /**
065: * synchronize bean instances if needed
066: * @param alwaysStore True if store even if passivation timeout not elapsed
067: */
068: void syncDirty(boolean alwaysStore);
069:
070: /**
071: * reduce cache of instances
072: */
073: void reduceCache();
074:
075: /**
076: * returns the home if exist or null if not
077: * @return Home for that bean, if exists.
078: */
079: JHome getHome();
080:
081: /**
082: * returns the local home if exist or null if not
083: * @return LocalHome for that bean, if exists.
084: */
085: JLocalHome getLocalHome();
086:
087: /**
088: * returns the TransactionManager
089: * @return The Transaction Manager
090: */
091: TransactionManager getTransactionManager();
092:
093: /**
094: * Returns the JContainer
095: * @return The Container where the bean lives.
096: */
097: JContainer getContainer();
098:
099: /**
100: * Return the JNDI Environment
101: * @return List of Environment used by the bean
102: */
103: Hashtable getEnv();
104:
105: /**
106: * Returns the InitialContext
107: * @return JNDI Initial Context
108: */
109: InitialContext getInitialContext();
110:
111: /**
112: * Init the pool of instances
113: */
114: void initInstancePool();
115:
116: /**
117: * Restart the Timers after jonas restart
118: */
119: void restartTimers();
120:
121: /**
122: * Store intances modified (used before finder ou select methods)
123: */
124: void storeInstances(Transaction tx);
125: }
|