001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.web.spi.webmodule;
042:
043: import org.netbeans.modules.j2ee.dd.api.web.WebAppMetadata;
044: import org.netbeans.modules.j2ee.metadata.model.api.MetadataModel;
045: import org.openide.filesystems.FileObject;
046:
047: /**
048: * SPI for {@link org.netbeans.modules.web.api.webmodule.WebModule}.
049: *
050: * @see WebModuleFactory
051: */
052: public interface WebModuleImplementation {
053:
054: /**
055: * Returns the folder that contains sources of the static documents for
056: * the web module (html, JSPs, etc.).
057: *
058: * @return the static documents folder; can be null.
059: */
060: FileObject getDocumentBase();
061:
062: /**
063: * Returns the context path of the web module.
064: *
065: * @return the context path; can be null.
066: */
067: String getContextPath();
068:
069: /**
070: * Returns the J2EE platform version of this module. The returned value is
071: * one of the constants {@link org.netbeans.modules.web.api.webmodule.WebModule#J2EE_13_LEVEL},
072: * {@link org.netbeans.modules.web.api.webmodule.WebModule#J2EE_14_LEVEL} or
073: * {@link org.netbeans.modules.web.api.webmodule.WebModule#JAVA_EE_5_LEVEL}.
074: *
075: * @return J2EE platform version; never null.
076: */
077: String getJ2eePlatformVersion();
078:
079: /**
080: * WEB-INF folder for the web module.
081: * <div class="nonnormative">
082: * The WEB-INF folder would typically be a child of the folder returned
083: * by {@link #getDocumentBase} but does not need to be.
084: * </div>
085: *
086: * @return the {@link FileObject}; might be <code>null</code>
087: */
088: FileObject getWebInf();
089:
090: /**
091: * Returns the deployment descriptor (<code>web.xml</code> file) of the web module.
092: * <div class="nonnormative">
093: * The web.xml file would typically be a child of the folder returned
094: * by {@link #getWebInf} but does not need to be.
095: * </div>
096: *
097: * @return the <code>web.xml</code> file; can be null.
098: */
099: FileObject getDeploymentDescriptor();
100:
101: /**
102: * Returns the Java source roots associated with the web module.
103: * <div class="nonnormative">
104: * <p>Note that not all the java source roots in the project (e.g. in a freeform project)
105: * belong to the web module.</p>
106: * </div>
107: *
108: * @return this web module's Java source roots; never null.
109: *
110: * @deprecated This method is deprecated, because its return values does
111: * not contain enough information about the source roots. Source roots
112: * are usually implemented by a <code>org.netbeans.api.project.SourceGroup</code>,
113: * which is more than just a container for a {@link org.openide.filesystems.FileObject}.
114: */
115: @Deprecated
116: FileObject[] getJavaSources();
117:
118: /**
119: * Returns a model describing the metadata of this web module (servlets,
120: * resources, etc.).
121: *
122: * @return this web module's metadata model; never null.
123: */
124: MetadataModel<WebAppMetadata> getMetadataModel();
125: }
|