KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > ejtools > deploy > model > DeployableObjectImpl


1 package net.sourceforge.ejtools.deploy.model;
2
3 import javax.enterprise.deploy.model.DDBean JavaDoc;
4 import javax.enterprise.deploy.model.DDBeanRoot JavaDoc;
5 import javax.enterprise.deploy.model.DeployableObject JavaDoc;
6 import javax.enterprise.deploy.shared.ModuleType JavaDoc;
7
8 /**
9  * The DeployableObject interface is an abstract representation of a J2EE deployable module (JAR, WAR, RAR, EAR). A DeployableObject provides access to the
10  * module's deployment descriptor and class files.
11  *
12  * @author gfink
13  * @created 28 mai 2002
14  * @version 0.1
15  */
16 public class DeployableObjectImpl implements DeployableObject JavaDoc
17 {
18
19    /**
20     * Return an array of standard beans representing the XML content returned based upon the XPath.
21     *
22     * @param xpath An XPath string identifying the data to be extracted from the deployment descriptor.
23     * @return a array of DDBeans or 'null' if no matching data found.
24     */
25    public DDBean JavaDoc[] getChildBean(String JavaDoc xpath)
26    {
27       return null;
28    }
29
30
31    /**
32     * Retrieve the specified class from this deployable module. <p>
33     *
34     * One use: to get all finder methods from an EJB If the tool is attempting to package an module and retrieve a class from the package, the class request may
35     * fail. The class may not yet be available. The tool should respect the manifest cross-path entries.
36     *
37     * @param className Class to retrieve.
38     * @return Class representation of the class
39     */
40    public Class JavaDoc getClassFromScope(String JavaDoc className)
41    {
42       return null;
43    }
44
45
46    /**
47     * Return the top level standard bean representing the root of the deployment descriptor.
48     *
49     * @return A standard bean representing the deployment descriptor.
50     */
51    public DDBeanRoot JavaDoc getDDBeanRoot()
52    {
53       return null;
54    }
55
56
57    /**
58     * Returns the DTD version number given in the XML DOCTYPE text provided in every standard J2EE module's deployment descriptor file.
59     *
60     * @return a string containing the DTD version number <PRE>
61     * A module's deployment descriptor file always contains
62     * a document type identifier, DOCTYPE. The DOCTYPE statement
63     * contains the module DTD version number in the label of the
64     * statement.
65     *
66     * The format of the DOCTYPE statement is:
67     *
68     *
69     *
70     *
71     *
72     * <ul>&lt!DOCTYPE root_element PUBLIC "-//organization//label//language" "location"&gt
73     * </ul>
74     * root_element - is the name of the root document in the DTD. organization - is the name of the organization responsible for the creation and
75     * maintenance of the DTD being referenced. label - is a unique descriptive name for the public text being referenced. language - is the ISO 639
76     * language id representing the natural language encoding of th DTD. location - is the URL of the DTD. An example J2EE deployment descriptor DOCTYPE
77     * statement is:
78     * <ul>&lt!DOCTYPE application-client PUBLIC "-//Sun Microsystems, Inc.//DTD J2EE Application Client 1.3//EN"
79     * "http://java.sun.com/dtd/application-client_1_3.dtd"&gt
80     * </ul>
81     * In this example the label is, "DTD J2EE Application Client 1.3", and the DTD version number is 1.3. A call to getModuleDTDVersion would return a
82     * string containing, "1.3". </PRE>
83     */
84    public String JavaDoc getModuleDTDVersion()
85    {
86       return null;
87    }
88
89
90    /**
91     * Return the XML content associated with the XPath from a deployment descriptor.
92     *
93     * @param xpath An xpath string referring to a location in the deployment descriptor
94     * @return a list XML content or 'null' if no matching data found.
95     */
96    public String JavaDoc[] getText(String JavaDoc xpath)
97    {
98       return null;
99    }
100
101
102    /**
103     * Return the ModuleType of deployment descriptor (i.e., EAR, JAR, WAR, RAR) this deployable object represents. Values are found in DeploymentManager.
104     *
105     * @return The ModuleType of deployable object
106     */
107    public ModuleType JavaDoc getType()
108    {
109       return null;
110    }
111 }
112
113
Popular Tags