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-2006 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;
43
44 import java.io.File;
45
46 /** This interface allows plugins to specify the location of servlets generated
47 * for JSPs.
48 *
49 * @author Petr Jiricka
50 */
51 public interface FindJSPServlet {
52
53 /** Returns the temporary directory where the server writes servlets generated
54 * from JSPs. The servlets placed in this directory must honor the Java
55 * directory naming conventions, i.e. the servlet must be placed in subdirectories
56 * of this directory corresponding to the servlet package name.
57 * @param moduleContextPath web module for which the temporary directory is requested.
58 * @return the root temp directory containing servlets generated from JSPs for this module.
59 */
60 public File getServletTempDirectory(String moduleContextPath);
61
62 /** Returns the resource path of the servlet generated for a particular JSP, relatively
63 * to the main temporary directory.
64 * @param moduleContextPath context path of web module in which the JSP is located.
65 * @param jspResourcePath the path of the JSP for which the servlet is requested, e.g.
66 * "pages/login.jsp". Never starts with a '/'.
67 * @return the resource name of the servlet generated for the JSP in the module, e.g.
68 * "org/apache/jsps/pages/login$jsp.java". Must never start with a '/'.
69 * The servlet file itself does not need to exist at this point -
70 * if this particular page was not compiled yet.
71 */
72 public String getServletResourcePath(String moduleContextPath,
73 String jspResourcePath);
74
75 /** Returns the encoding of the generated servlet file.
76 * @param moduleContextPath context path of web module in which the JSP is located.
77 * @param jspResourcePath the path of the JSP for which the servlet is requested, e.g.
78 * "pages/login.jsp". Never starts with a '/'.
79 * @return the encoding of the servlet generated for the JSP in the module,
80 * e.g. "UTF8".
81 * The servlet file itself does not need to exist at this point -
82 * if this particular page was not compiled yet.
83 */
84 public String getServletEncoding(String moduleContextPath,
85 String jspResourcePath);
86
87 }
|