001    /**
002     *
003     * Copyright 2003-2004 The Apache Software Foundation
004     *
005     *  Licensed under the Apache License, Version 2.0 (the "License");
006     *  you may not use this file except in compliance with the License.
007     *  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    
018    //
019    // This source code implements specifications defined by the Java
020    // Community Process. In order to remain compliant with the specification
021    // DO NOT add / change / or delete method signatures!
022    //
023    
024    package javax.enterprise.deploy.spi;
025    
026    import javax.enterprise.deploy.model.DDBeanRoot;
027    
028    /**
029     * The DConfigBeanRoot interface represent the root of a deployment descriptor.
030     * A DConfigBeanRoot is associated with a DDRoot object which in turn is associated
031     * with a specific deployment descriptor file.
032     *
033     * <p>Only DConfigBeanRoots are saved or restored by methods in
034     * DeploymentConfiguration.</p>
035     *
036     * @see DeploymentConfiguration
037     *
038     * @version $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $
039     */
040    public interface DConfigBeanRoot extends DConfigBean {
041        /**
042         * Return a DConfigBean for a deployment descriptor that is not the module's
043         * primary deployment descriptor.   Web services provides a deployment descriptor
044         * in addition to the module's primary deployment descriptor.  Only the DDBeanRoot
045         * for this category of secondary deployment descriptors are to be passed as arguments
046         * through this method.
047         *
048         * Web service has two deployment descriptor files, one that defines the web service
049         * and one that defines a client of a web service.  See the Web Service specification for
050         * the details.
051         *
052         * @since 1.1
053         *
054         * @param ddBeanRoot represents the root element of a deployment descriptor file.
055         *
056         * @return a DConfigBean to be used for processing this deployment descriptor data. Null may be returned
057         *         if no DConfigBean is required for this deployment descriptor.
058         */
059        public DConfigBean getDConfigBean(DDBeanRoot ddBeanRoot);
060    }