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.model;
38
39 import javax.enterprise.deploy.shared.ModuleType;
40
41 /**
42 * J2eeApplicationObject is an interface that represents a J2EE
43 * application (EAR); it maintains a DeployableObject for each
44 * module in the archive.
45 */
46 public interface J2eeApplicationObject extends DeployableObject {
47
48 /**
49 * Return the DeployableObject of the specified URI designator.
50 * @param uri Describes where to get the module from.
51 * @return the DeployableObject describing the j2ee module at this uri
52 * or 'null' if there is not match.
53 */
54 public DeployableObject getDeployableObject(String uri);
55
56 /**
57 * Return the all DeployableObjects of the specified type.
58 * @param type The type of module to return.
59 * @return the list of DeployableObjects describing the j2ee module
60 * at this uri or 'null' if there are no matches.
61 */
62 public DeployableObject[] getDeployableObjects(ModuleType type);
63
64 /**
65 * Return the all DeployableObjects in this application.
66 * @return the DeployableObject describing the j2ee module at this uri
67 * or 'null' if there are no matches.
68 */
69 public DeployableObject[] getDeployableObjects();
70
71 /**
72 * Return the list of URIs of the designated module type.
73 * @param type The type of module to return.
74 * @return the Uris of the contained modules or 'null' if there
75 * are no matches.
76 */
77 public String[] getModuleUris(ModuleType type);
78
79 /**
80 * Return the list of URIs for all modules in the application.
81 * @return the Uris of the contained modules or 'null' if there
82 * are no matches.
83 */
84 public String[] getModuleUris();
85
86 /**
87 * Return a list of DDBean based upon an XPath; all
88 * deployment descriptors of the specified type are searched.
89 *
90 * @param type The type of deployment descriptor to query.
91 * @param xpath An XPath string referring to a location in the
92 * deployment descriptor
93 * @return The list of DDBeans or 'null' of there are no matches.
94 */
95 public DDBean[] getChildBean(ModuleType type, String xpath);
96
97 /**
98 * Return the text value from the XPath; search only the
99 * deployment descriptors of the specified type.
100 *
101 * @param type The type of deployment descriptor to query.
102 * @param xpath An xpath string referring to a location in the
103 * deployment descriptor
104 * @return The text values of this xpath or 'null' if there are no
105 * matches.
106 */
107 public String[] getText(ModuleType type, String xpath);
108
109 /**
110 * Register a listener for changes in XPath that are related
111 * to this deployableObject.
112 *
113 * @param type The type of deployment descriptor to query.
114 * @param xpath The xpath to listen for.
115 * @param xpl The listener.
116 */
117 public void addXpathListener(ModuleType type, String xpath,
118 XpathListener xpl);
119
120 /**
121 * Unregister the listener for an XPath.
122 *
123 * @param type The type of deployment descriptor to query.
124 * @param xpath he XPath to listen for
125 * @param xpl The listener
126 */
127 public void removeXpathListener(ModuleType type, String xpath,
128 XpathListener xpl);
129
130 }
131