JBossTarget


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.deployment.spi;
23  
24  import javax.enterprise.deploy.shared.ModuleType  ;
25  import javax.enterprise.deploy.spi.Target  ;
26  import javax.enterprise.deploy.spi.TargetModuleID  ;
27  import javax.enterprise.deploy.spi.exceptions.TargetException  ;
28  
29  /**
30   * A Target interface represents a single logical core server of one instance of a J2EE platform product.
31   * It is a designator for a server and the implied location to copy a configured application for the server to access.
32   * 
33   * @author thomas.diesler@jboss.org
34   * @author Scott.Stark@jboss.com
35   * @version $Revision: 38480 $
36   */
37  public interface JBossTarget extends Target  
38  {
39     /**
40      * Get the target's host name
41      */
42     abstract String   getHostName();
43  
44     /**
45      * Deploy a given module
46      */
47     abstract void deploy(TargetModuleID   targetModuleID) throws Exception  ;
48  
49     /**
50      * Start a given module
51      */
52     abstract void start(TargetModuleID   targetModuleID) throws Exception  ;
53  
54     /**
55      * Stop a given module
56      */
57     abstract void stop(TargetModuleID   targetModuleID) throws Exception  ;
58  
59     /**
60      * Undeploy a given module
61      */
62     abstract void undeploy(TargetModuleID   targetModuleID) throws Exception  ;
63  
64     /**
65      * Retrieve the list of all J2EE application modules running or not running on the identified targets.
66      */
67     TargetModuleID  [] getAvailableModules(ModuleType   moduleType) throws TargetException  ;
68  }
69
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags