EarServiceImplMBean


1   /**
2    * JOnAS: Java(TM) Open Application Server
3    * Copyright (C) 1999 Bull S.A.
4    * Contact: jonas-team@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   * Initial developer(s): Florent BENOIT & Ludovic BERT
22   * --------------------------------------------------------------------------
23   * $Id: EarServiceImplMBean.java,v 1.8 2004/04/19 14:28:04 benoitf Exp $
24   * --------------------------------------------------------------------------
25   */
26  
27  package org.objectweb.jonas.ear;
28  
29  import java.util.List  ;
30  import java.util.Set  ;
31  
32  /**
33   * JOnAS EAR Service MBean interface. This interface provides a description for
34   * the EAR service management.
35   * @author Florent Benoit
36   * @author Ludovic Bert
37   */
38  
39  public interface EarServiceImplMBean {
40  
41      /**
42       * Deploy an EAR, used by the JMX Management.
43       * @param fileName the fileName of the ear which must be be deployed.
44       * @return The ObjectName of the MBean associated to the deployed J2EE
45       *         Application
46       * @throws Exception if the deployment of the EAR failed.
47       */
48      String   deployEarMBean(String   fileName) throws Exception  ;
49  
50      /**
51       * Undeploy an EAR, used by the JMX Management.
52       * @param fileName the fileName of the ear which must be be undeployed.
53       * @throws Exception if the undeployment of the EAR failed.
54       */
55      void unDeployEarMBean(String   fileName) throws Exception  ;
56  
57      /**
58       * @return current number of ears deployed in the JOnAS server
59       */
60      Integer   getCurrentNumberOfEars();
61  
62      /**
63       * Return the list of installed Applications. The EAR files or the
64       * directories with expanded Applications are searched in JONAS_BASE/apps
65       * and all Applications directories 'autoload'.
66       * @return The list of EAR files or the directories with expanded
67       *         Applications found
68       * @throws Exception if the list can't be retrieved
69       */
70      List   getInstalledEars() throws Exception  ;
71  
72      /**
73       * This method is added temporarily. It will disapear when Ears will have
74       * their associated MBeans (when Ears will become manageable)
75       * @return the names of the ears currently deployed in the JOnAS server
76       */
77      Set   getEarNames();
78  
79      /**
80       * Test if the specified filename is already deployed or not
81       * @param fileName the name of the ear file.
82       * @return true if the ear is deployed, else false.
83       */
84      boolean isEarLoaded(String   fileName);
85  
86      /**
87       * Return the list of all loaded Applications.
88       * @return The list of deployed Applications
89       */
90      List   getDeployedEars();
91  
92      /**
93       * Return the list of installed Applications ready to deploy.
94       * @return The list of deployable Applications
95       * @throws Exception if the list of deployable ears can't be returned
96       */
97      List   getDeployableEars() throws Exception  ;
98  
99      /**
100      * Return the list of "autoload" directories for web applications.
101      * @return The list of all "autoload" directories
102      */
103     List   getAutoloadDirectories();
104 
105     /**
106      * Return the Apps directory.
107      * @return The Apps directory
108      */
109     String   getAppsDirectory();
110 
111 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags