org.netbeans.modules.j2ee.deployment.plugins.spi

Interface FindJSPServlet

All Known Subinterfaces:

FindJSPServlet2, OldJSPDebug

public interface FindJSPServlet

This interface allows plugins to specify the location of servlets generated for JSPs.

Method Summary

Modifier and Type	Method and Description
String	getServletEncoding(String moduleContextPath, String jspResourcePath) Returns the encoding of the generated servlet file.
String	getServletResourcePath(String moduleContextPath, String jspResourcePath) Returns the resource path of the servlet generated for a particular JSP, relatively to the main temporary directory.
File	getServletTempDirectory(String moduleContextPath) Returns the temporary directory where the server writes servlets generated from JSPs.

Method Detail

getServletTempDirectory

File getServletTempDirectory(String moduleContextPath)

Returns the temporary directory where the server writes servlets generated from JSPs. The servlets placed in this directory must honor the Java directory naming conventions, i.e. the servlet must be placed in subdirectories of this directory corresponding to the servlet package name.

Parameters:

moduleContextPath - web module for which the temporary directory is requested.

Returns:

the root temp directory containing servlets generated from JSPs for this module.

getServletResourcePath

String getServletResourcePath(String moduleContextPath,
                              String jspResourcePath)

Returns the resource path of the servlet generated for a particular JSP, relatively to the main temporary directory.

Parameters:

moduleContextPath - context path of web module in which the JSP is located.

jspResourcePath - the path of the JSP for which the servlet is requested, e.g. "pages/login.jsp". Never starts with a '/'.

Returns:

the resource name of the servlet generated for the JSP in the module, e.g. "org/apache/jsps/pages/login$jsp.java". Must never start with a '/'. The servlet file itself does not need to exist at this point - if this particular page was not compiled yet.

getServletEncoding

String getServletEncoding(String moduleContextPath,
                          String jspResourcePath)

Returns the encoding of the generated servlet file.

Parameters:

moduleContextPath - context path of web module in which the JSP is located.

jspResourcePath - the path of the JSP for which the servlet is requested, e.g. "pages/login.jsp". Never starts with a '/'.

Returns:

the encoding of the servlet generated for the JSP in the module, e.g. "UTF8". The servlet file itself does not need to exist at this point - if this particular page was not compiled yet.