KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > enterprise > deploy > spi > JBoss30TargetModuleID


1 package org.jboss.enterprise.deploy.spi;
2
3 import javax.enterprise.deploy.spi.*;
4
5 /**
6  * A TargetModuleID interface represents a unique identifier for a deployed application module. A deployable application module can be an EAR, JAR, WAR or RAR
7  * file. A TargetModuleID can represent a root module or a child module. A root module TargetModuleID has no parent. It represents a deployed EAR file or stand
8  * alone module. A child module TargetModuleID represents a deployed sub module of a J2EE application. A child TargetModuleID has only one parent, the super
9  * module it was bundled and deployed with. The identifier consists of the target name and the unique identifier for the deployed application module.
10  *
11  * @author letiembl
12  * @created 15 avril 2002
13  */
14 public class JBoss30TargetModuleID implements TargetModuleID
15 {
16    /** Description of the Field */
17    protected String JavaDoc moduleID = null;
18    /** Description of the Field */
19    protected Target target = null;
20
21
22    /**
23     * Constructor for the JBoss30TargetModuleID object
24     *
25     * @param target Description of Parameter
26     * @param moduleID Description of Parameter
27     */
28    public JBoss30TargetModuleID(Target target, String JavaDoc moduleID)
29    {
30       this.target = target;
31       this.moduleID = moduleID;
32    }
33
34
35    /**
36     * Retrieve a list of identifiers of the children of this deployed module.
37     *
38     * @return a list of TargetModuleIDs identifying the childern of this object. A <code>null</code> value means this module has no childern
39     */
40    public TargetModuleID[] getChildTargetModuleID()
41    {
42       return null;
43    }
44
45
46    /**
47     * Retrieve the id assigned to represent the deployed module.
48     *
49     * @return The value of moduleID attribute
50     */
51    public String JavaDoc getModuleID()
52    {
53       return moduleID;
54    }
55
56
57    /**
58     * Retrieve the identifier of the parent object of this deployed module. If there is no parent then this is the root object deployed. The root could
59     * represent an EAR file or it could be a stand alone module that was deployed.
60     *
61     * @return the TargetModuleID of the parent of this object. A <code>null</code> value means this module is the root object deployed.
62     */
63    public TargetModuleID getParentTargetModuleID()
64    {
65       return null;
66    }
67
68
69    /**
70     * Retrieve the name of the target server. this module was deployed to.
71     *
72     * @return Target an object representing a server target.
73     */
74    public Target getTarget()
75    {
76       return target;
77    }
78
79
80    /**
81     * Retrieve the identifier representing the deployed module.
82     *
83     * @return Description of the Returned Value
84     */
85    public String JavaDoc toString()
86    {
87       return moduleID;
88    }
89 }
90
91
Popular Tags