01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03 *
04 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05 *
06 * The contents of this file are subject to the terms of either the GNU
07 * General Public License Version 2 only ("GPL") or the Common
08 * Development and Distribution License("CDDL") (collectively, the
09 * "License"). You may not use this file except in compliance with the
10 * License. You can obtain a copy of the License at
11 * http://www.netbeans.org/cddl-gplv2.html
12 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13 * specific language governing permissions and limitations under the
14 * License. When distributing the software, include this License Header
15 * Notice in each file and include the License file at
16 * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17 * particular file as subject to the "Classpath" exception as provided
18 * by Sun in the GPL Version 2 section of the License file that
19 * accompanied this code. If applicable, add the following below the
20 * License Header, with the fields enclosed by brackets [] replaced by
21 * your own identifying information:
22 * "Portions Copyrighted [year] [name of copyright owner]"
23 *
24 * Contributor(s):
25 *
26 * The Original Software is NetBeans. The Initial Developer of the Original
27 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28 * Microsystems, Inc. All Rights Reserved.
29 *
30 * If you wish your version of this file to be governed by only the CDDL
31 * or only the GPL Version 2, indicate your decision by adding
32 * "[Contributor] elects to include this software in this distribution
33 * under the [CDDL or GPL Version 2] license." If you do not indicate a
34 * single choice of license, a recipient has the option to distribute
35 * your version of this file under either the CDDL, the GPL Version 2 or
36 * to extend the choice of license to its licensees as provided above.
37 * However, if you add GPL Version 2 code and therefore, elected the GPL
38 * Version 2 license, then the option applies only if the new code is
39 * made subject to such option by the copyright holder.
40 */
41
42 package org.netbeans.modules.j2ee.deployment.plugins.spi.config;
43
44 import org.netbeans.modules.j2ee.deployment.devmodules.api.J2eeModule;
45 import org.openide.util.Lookup;
46
47 /**
48 * An interface that defines a container for all the server-specific configuration
49 * information for a single top-level J2EE module. The ModuleConfiguration object
50 * could represent a single stand-alone module or a J2EE application that contains
51 * several sub-modules. The ModuleConfiguration object contains in its lookup a set
52 * of configurations that are used for managing the server-specific settings.
53 *
54 * @since 1.23
55 * @author sherold
56 */
57 public interface ModuleConfiguration extends Lookup.Provider {
58
59 /**
60 * Returns lookup associated with the object. This lookup should contain
61 * implementations of all the supported configurations.
62 * <p>
63 * The configuration are: {@link ContextRootConfiguration}, {@link DatasourceConfiguration},
64 * {@link MappingConfiguration}, {@link EjbResourceConfiguration}, {@link DeploymentPlanConfiguration},
65 * {@link MessageDestinationConfiguration}
66 * <p>
67 * Implementators are advised to use {@link org.openide.util.lookup.Lookups#fixed}
68 * to implement this method.
69 *
70 * @return lookup associated with the object containing all the supported
71 * ConfigurationProvider implementations.
72 */
73 Lookup getLookup();
74
75 /**
76 * Returns a J2EE module associated with this ModuleConfiguration instance.
77 *
78 * @return a J2EE module associated with this ModuleConfiguration instance.
79 */
80 J2eeModule getJ2eeModule();
81
82 /**
83 * The j2eeserver calls this method when it is done using this ModuleConfiguration
84 * instance. The server plug-in should free all the associated resources -
85 * listeners for example.
86 */
87 void dispose();
88 }
|