View Javadoc

1   /**
2    *
3    * Copyright 2003-2004 The Apache Software Foundation
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  //
19  // This source code implements specifications defined by the Java
20  // Community Process. In order to remain compliant with the specification
21  // DO NOT add / change / or delete method signatures!
22  //
23  
24  package javax.enterprise.deploy.spi;
25  
26  import javax.enterprise.deploy.model.DDBeanRoot;
27  
28  /**
29   * The DConfigBeanRoot interface represent the root of a deployment descriptor.
30   * A DConfigBeanRoot is associated with a DDRoot object which in turn is associated
31   * with a specific deployment descriptor file.
32   *
33   * <p>Only DConfigBeanRoots are saved or restored by methods in
34   * DeploymentConfiguration.</p>
35   *
36   * @see DeploymentConfiguration
37   *
38   * @version $Rev: 46019 $ $Date: 2004-09-14 02:56:06 -0700 (Tue, 14 Sep 2004) $
39   */
40  public interface DConfigBeanRoot extends DConfigBean {
41      /**
42       * Return a DConfigBean for a deployment descriptor that is not the module's
43       * primary deployment descriptor.   Web services provides a deployment descriptor
44       * in addition to the module's primary deployment descriptor.  Only the DDBeanRoot
45       * for this category of secondary deployment descriptors are to be passed as arguments
46       * through this method.
47       *
48       * Web service has two deployment descriptor files, one that defines the web service
49       * and one that defines a client of a web service.  See the Web Service specification for
50       * the details.
51       *
52       * @since 1.1
53       *
54       * @param ddBeanRoot represents the root element of a deployment descriptor file.
55       *
56       * @return a DConfigBean to be used for processing this deployment descriptor data. Null may be returned
57       *         if no DConfigBean is required for this deployment descriptor.
58       */
59      public DConfigBean getDConfigBean(DDBeanRoot ddBeanRoot);
60  }