KickJava   Java API By Example, From Geeks To Geeks.

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


1 package org.jboss.enterprise.deploy.spi;
2
3 import java.io.InputStream JavaDoc;
4 import java.io.OutputStream JavaDoc;
5 import javax.enterprise.deploy.model.*;
6 import javax.enterprise.deploy.spi.*;
7 import javax.enterprise.deploy.spi.DeploymentConfiguration JavaDoc;
8 import javax.enterprise.deploy.spi.exceptions.BeanNotFoundException JavaDoc;
9 import javax.enterprise.deploy.spi.exceptions.ConfigurationException JavaDoc;
10
11 /**
12  * An interface that defines a container for all the server-specific configuration information for a single top-level J2EE module. The DeploymentConfiguration
13  * object could represent a single stand alone module or an EAR file that contains several sub-modules.
14  *
15  * @author letiembl
16  * @created 15 avril 2002
17  */
18 public class JBoss30DeploymentConfiguration implements DeploymentConfiguration JavaDoc
19 {
20
21    /**
22     * Returns the top level configuration bean, DConfigBeanRoot, associated with the deployment descriptor represented by the designated DDBeanRoot bean.
23     *
24     * @param bean The top level bean that represents the associated deployment descriptor.
25     * @return the DConfigBeanRoot for editing the server-specific properties required by the module.
26     * @throws ConfigurationException reports errors in generating a configuration bean
27     */
28    public DConfigBeanRoot getDConfigBeanRoot(DDBeanRoot bean) throws ConfigurationException JavaDoc
29    {
30       return null;
31    }
32
33
34    /**
35     * Returns an object that provides access to the deployment descriptor data and classes of a J2EE module.
36     *
37     * @return DeployableObject
38     */
39    public DeployableObject getDeployableObject()
40    {
41       return null;
42    }
43
44
45    /**
46     * Remove the root DConfigBean and all its children.
47     *
48     * @param bean the top leve DConfigBean to remove.
49     * @throws BeanNotFoundException the bean provides is not in this beans child list.
50     */
51    public void removeDConfigBean(DConfigBeanRoot bean) throws BeanNotFoundException JavaDoc { }
52
53
54    /**
55     * Restore from disk to a full set of configuration beans previously stored.
56     *
57     * @param inputArchive The input stream from which to restore the Configuration.
58     * @throws ConfigurationException reports errors in generating a configuration bean
59     */
60    public void restore(InputStream JavaDoc inputArchive) throws ConfigurationException JavaDoc { }
61
62
63    /**
64     * Restore from disk to instantated objects all the DConfigBeans associated with a specific deployment descriptor. The beans may be fully or partially
65     * configured.
66     *
67     * @param inputArchive The input stream for the file from which the DConfigBeans should be restored.
68     * @param bean The DDBeanRoot bean associated with the deployment descriptor file.
69     * @return The top most parent configuration bean, DConfigBeanRoot
70     * @throws ConfigurationException reports errors in generating a configuration bean
71     */
72    public DConfigBeanRoot restoreDConfigBean(InputStream JavaDoc inputArchive, DDBeanRoot bean) throws ConfigurationException JavaDoc
73    {
74       return null;
75    }
76
77
78    /**
79     * Save to disk the current set configuration beans created for this deployable module. It is recommended the file format be XML.
80     *
81     * @param outputArchive The output stream to which to save the Configuration.
82     * @throws ConfigurationException
83     */
84    public void save(OutputStream JavaDoc outputArchive) throws ConfigurationException JavaDoc { }
85
86
87    /**
88     * Save to disk all the configuration beans associated with a particular deployment descriptor file. The saved data may be fully or partially configured
89     * DConfigBeans. The output file format is recommended to be XML.
90     *
91     * @param outputArchive The output stream to which the DConfigBeans should be saved.
92     * @param bean The top level bean, DConfigBeanRoot, from which to be save.
93     * @throws ConfigurationException reports errors in generating a configuration bean
94     */
95    public void saveDConfigBean(OutputStream JavaDoc outputArchive, DConfigBeanRoot bean) throws ConfigurationException JavaDoc { }
96 }
97
98
Popular Tags