KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > deployment > spi > DeploymentConfigurationImpl


1 /*
2  * JBoss, Home of Professional Open Source
3  * Copyright 2005, JBoss Inc., and individual contributors as indicated
4  * by the @authors tag. See the copyright.txt in the distribution for a
5  * full listing of individual contributors.
6  *
7  * This is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22 package org.jboss.deployment.spi;
23
24 import java.io.InputStream JavaDoc;
25 import java.io.OutputStream JavaDoc;
26
27 import javax.enterprise.deploy.model.DDBeanRoot JavaDoc;
28 import javax.enterprise.deploy.model.DeployableObject JavaDoc;
29 import javax.enterprise.deploy.spi.DConfigBeanRoot JavaDoc;
30 import javax.enterprise.deploy.spi.DeploymentConfiguration JavaDoc;
31 import javax.enterprise.deploy.spi.exceptions.BeanNotFoundException JavaDoc;
32 import javax.enterprise.deploy.spi.exceptions.ConfigurationException JavaDoc;
33
34 /**
35  * An interface that defines a container for all the server-specific configuration information for a single top-level
36  * J2EE module. The DeploymentConfiguration object could represent a single stand alone module or an EAR file
37  * that contains several sub-modules.
38  *
39  * @author thomas.diesler@jboss.org
40  * @version $Revision: 38480 $
41  */
42 public class DeploymentConfigurationImpl implements DeploymentConfiguration JavaDoc
43 {
44    /**
45     * Return an object that provides access to the deployment descriptor
46     *
47     * @return the deployable object
48     */
49    public DeployableObject JavaDoc getDeployableObject()
50    {
51       return null; //[todo] implement method
52 }
53
54    /**
55     * Return the top level configuration for a deployment descriptor
56     *
57     * @param bean the root of the deployment descriptor
58     * @return the configuration
59     * @throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
60     * for an error in the deployment descriptor
61     */
62    public DConfigBeanRoot JavaDoc getDConfigBeanRoot(DDBeanRoot JavaDoc bean) throws ConfigurationException JavaDoc
63    {
64       return null; //[todo] implement method
65 }
66
67    /**
68     * Remove a root configuration and all its children
69     *
70     * @param bean the configuration
71     * @throws javax.enterprise.deploy.spi.exceptions.BeanNotFoundException
72     * when the bean is not found
73     */
74    public void removeDConfigBean(DConfigBeanRoot JavaDoc bean) throws BeanNotFoundException JavaDoc
75    {
76       //[todo] implement method
77 }
78
79    /**
80     * Restore a configuration from an input stream
81     *
82     * @param input the input stream
83     * @param bean the deployment descriptor
84     * @return the configuration
85     * @throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
86     * when there is an error in the configuration
87     */
88    public DConfigBeanRoot JavaDoc restoreDConfigBean(InputStream JavaDoc input, DDBeanRoot JavaDoc bean) throws ConfigurationException JavaDoc
89    {
90       return null; //[todo] implement method
91 }
92
93    /**
94     * Save a configuration to an output stream
95     *
96     * @param output the output stream
97     * @param bean the configuration
98     * @throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
99     * when there is an error in the configuration
100     */
101    public void saveDConfigBean(OutputStream JavaDoc output, DConfigBeanRoot JavaDoc bean) throws ConfigurationException JavaDoc
102    {
103       //[todo] implement method
104 }
105
106    /**
107     * Restores a full set of configuration beans
108     *
109     * @param input the input stream
110     * @throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
111     * for an error in the configuration
112     */
113    public void restore(InputStream JavaDoc input) throws ConfigurationException JavaDoc
114    {
115       //[todo] implement method
116 }
117
118    /**
119     * Saves the fulls set of configuration beans
120     *
121     * @param output the output stream
122     * @throws javax.enterprise.deploy.spi.exceptions.ConfigurationException
123     * for an error in the configuration
124     */
125    public void save(OutputStream JavaDoc output) throws ConfigurationException JavaDoc
126    {
127       //[todo] implement method
128 }
129 }
130
Popular Tags