Save This Page
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 package javax.enterprise.deploy.spi;
38
39 /**
40 * A TargetModuleID interface represents a unique
41 * identifier for a deployed application module.
42 * A deployable application module can be an EAR,
43 * JAR, WAR or RAR file.
44 *
45 * A TargetModuleID can represent a root module or
46 * a child module. A root module TargetModuleID
47 * has no parent. It represents a deployed EAR
48 * file or stand alone module. A child module
49 * TargetModuleID represents a deployed sub module
50 * of a J2EE application.
51 *
52 * A child TargetModuleID has only one parent,
53 * the super module it was bundled and deployed
54 * with.
55 *
56 * The identifier consists of the target name
57 * and the unique identifier for the deployed
58 * application module.
59 */
60 public interface TargetModuleID
61 {
62 /**
63 * Retrieve the name of the target server.
64 * this module was deployed to.
65 *
66 * @return Target an object representing
67 * a server target.
68 */
69 public Target getTarget();
70
71 /**
72 * Retrieve the id assigned to represent
73 * the deployed module.
74 */
75 public String getModuleID();
76
77
78 /**
79 * If this TargetModulID represents a web
80 * module retrieve the URL for it.
81 *
82 * @return the URL of a web module or null
83 * if the module is not a web module.
84 */
85 public String getWebURL();
86
87 /**
88 * Retrieve the identifier representing
89 * the deployed module.
90 */
91 public String toString();
92
93 /**
94 * Retrieve the identifier of the parent
95 * object of this deployed module. If there
96 * is no parent then this is the root object
97 * deployed. The root could represent an EAR
98 * file or it could be a stand alone module
99 * that was deployed.
100 *
101 * @return the TargetModuleID of the parent
102 * of this object. A <code>null</code>
103 * value means this module is the root
104 * object deployed.
105 */
106 public TargetModuleID getParentTargetModuleID();
107
108 /**
109 * Retrieve a list of identifiers of the children
110 * of this deployed module.
111 *
112 * @return a list of TargetModuleIDs identifying the
113 * childern of this object. A <code>null</code>
114 * value means this module has no childern
115 */
116 public TargetModuleID[] getChildTargetModuleID();
117 }