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