Class JspFactory
- java.lang.Object
-
- jakarta.servlet.jsp.JspFactory
-
public abstract class JspFactory extends java.lang.ObjectThe JspFactory is an abstract class that defines a number of factory methods available to a JSP page at runtime for the purposes of creating instances of various interfaces and classes used to support the JSP implementation.
A conformant JSP Engine implementation will, during it's initialization instantiate an implementation dependent subclass of this class, and make it globally available for use by JSP implementation classes by registering the instance created with this class via the static
setDefaultFactory()method.The PageContext and the JspEngineInfo classes are the only implementation-dependent classes that can be created from the factory.
JspFactory objects should not be used by JSP page authors.
-
-
Constructor Summary
Constructors Constructor Description JspFactory()Sole constructor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static JspFactorygetDefaultFactory()Returns the default factory for this implementation.abstract JspEngineInfogetEngineInfo()called to get implementation-specific information on the current JSP engine.abstract JspApplicationContextgetJspApplicationContext(jakarta.servlet.ServletContext context)Obtain theJspApplicationContextinstance that was associated within the passedServletContextfor this web application.abstract PageContextgetPageContext(jakarta.servlet.Servlet servlet, jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, java.lang.String errorPageURL, boolean needsSession, int buffer, boolean autoflush)obtains an instance of an implementation dependent jakarta.servlet.jsp.PageContext abstract class for the calling Servlet and currently pending request and response.abstract voidreleasePageContext(PageContext pc)called to release a previously allocated PageContext object.static voidsetDefaultFactory(JspFactory deflt)set the default factory for this implementation.
-
-
-
Method Detail
-
setDefaultFactory
public static void setDefaultFactory(JspFactory deflt)
set the default factory for this implementation. It is illegal for any principal other than the JSP Engine runtime to call this method.
- Parameters:
deflt- The default factory implementation
-
getDefaultFactory
public static JspFactory getDefaultFactory()
Returns the default factory for this implementation.- Returns:
- the default factory for this implementation
-
getPageContext
public abstract PageContext getPageContext(jakarta.servlet.Servlet servlet, jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, java.lang.String errorPageURL, boolean needsSession, int buffer, boolean autoflush)
obtains an instance of an implementation dependent jakarta.servlet.jsp.PageContext abstract class for the calling Servlet and currently pending request and response.
This method is typically called early in the processing of the _jspService() method of a JSP implementation class in order to obtain a PageContext object for the request being processed.
Invoking this method shall result in the PageContext.initialize() method being invoked. The PageContext returned is properly initialized.
All PageContext objects obtained via this method shall be released by invoking releasePageContext().
- Parameters:
servlet- the requesting servletrequest- the current request pending on the servletresponse- the current response pending on the servleterrorPageURL- the URL of the error page for the requesting JSP, or nullneedsSession- true if the JSP participates in a sessionbuffer- size of buffer in bytes,JspWriter.NO_BUFFERif no buffer,JspWriter.DEFAULT_BUFFERif implementation default.autoflush- should the buffer autoflush to the output stream on buffer overflow, or throw an IOException?- Returns:
- the page context
- See Also:
PageContext
-
releasePageContext
public abstract void releasePageContext(PageContext pc)
called to release a previously allocated PageContext object. Results in PageContext.release() being invoked. This method should be invoked prior to returning from the _jspService() method of a JSP implementation class.
- Parameters:
pc- A PageContext previously obtained by getPageContext()
-
getEngineInfo
public abstract JspEngineInfo getEngineInfo()
called to get implementation-specific information on the current JSP engine.
- Returns:
- a JspEngineInfo object describing the current JSP engine
-
getJspApplicationContext
public abstract JspApplicationContext getJspApplicationContext(jakarta.servlet.ServletContext context)
Obtain the
JspApplicationContextinstance that was associated within the passedServletContextfor this web application.- Parameters:
context- the current web application'sServletContext- Returns:
JspApplicationContextinstance- Since:
- JSP 2.1
-
-