KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > ejb > InstancePoolFeeder


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.ejb;
23
24 import org.jboss.metadata.XmlLoadable;
25 import org.jboss.ejb.InstancePool;
26
27 /**
28  * Interface for bean instances Pool Feeder
29  *
30  * @author <a HREF="mailto:vincent.harcq@hubmethods.com">Vincent Harcq</a>
31  * @version $Revision: 37459 $
32  */
33 public interface InstancePoolFeeder
34    extends XmlLoadable
35 {
36    /**
37     * Start the pool feeder.
38     */
39    void start();
40
41    /**
42     * Stop the pool feeder.
43     */
44    void stop();
45
46    /**
47     * Sets the instance pool inside the pool feeder.
48     *
49     * @param ip the instance pool
50     */
51    void setInstancePool(InstancePool ip);
52
53    /**
54     * Tells if the pool feeder is already started.
55     * The reason is that we start the PF at first get() on the pool and we
56     * want to give a warning to the user when the pool is empty.
57     *
58     * @return true if started
59     */
60    boolean isStarted();
61 }
62
Popular Tags