01: /*
02: * Copyright (c) 1998-2004 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: * Free SoftwareFoundation, Inc.
23: * 59 Temple Place, Suite 330
24: * Boston, MA 02111-1307 USA
25: *
26: * @author Scott Ferguson
27: */
28:
29: package javax.enterprise.deploy.model;
30:
31: import javax.enterprise.deploy.model.exceptions.DDBeanCreateException;
32: import javax.enterprise.deploy.shared.ModuleType;
33: import java.io.FileNotFoundException;
34: import java.io.InputStream;
35: import java.util.Enumeration;
36:
37: /**
38: * Representds a J2EE deployable module (JAR, WAR, etc)
39: */
40: public interface DeployableObject {
41: /**
42: * Returns the module type.
43: */
44: public ModuleType getType();
45:
46: /**
47: * Returns the deployment descriptor root.
48: */
49: public DDBeanRoot getDDBeanRoot();
50:
51: /**
52: * Returns the array of standard beans for the XML content based
53: * on the XPath.
54: */
55: public DDBean[] getChildBean(String xpath);
56:
57: /**
58: * Returns the XML content matching the xpath.
59: */
60: public String[] getText(String xpath);
61:
62: /**
63: * Returns the class from the module.
64: */
65: public Class getClassFromScope(String className);
66:
67: /**
68: * Deprecated method to get the version.
69: */
70: public String getModuleDTDVersion();
71:
72: /**
73: * Returns the Deployment descriptor root.
74: */
75: public DDBeanRoot getDDBeanRoot(String filename)
76: throws FileNotFoundException, DDBeanCreateException;
77:
78: /**
79: * Returns an enumeration of the entries, which are filenames relative
80: * to the module root.
81: */
82: public Enumeration entries();
83:
84: /**
85: * Returns the InputStream for a given entry. The filename is relative
86: * to the module root.
87: */
88: public InputStream getEntry(String name);
89: }
|