- java.lang.Object
-
- javax.servlet.jsp.JspFactory
-
public abstract class JspFactory extends Object
The 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 only implementation-dependent classes that can be created from the factory are: PageContext, JspEngineInfo, and JspApplicationContext.
With the exception of JspApplicationContext, JspFactory objects should not be used by JSP application developers.
-
-
Constructor Summary
Constructors Constructor and Description JspFactory()
Sole constructor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description static JspFactory
getDefaultFactory()
Returns the default factory for this implementation.abstract JspEngineInfo
getEngineInfo()
called to get implementation-specific information on the current JSP engine.abstract JspApplicationContext
getJspApplicationContext(ServletContext context)
Obtains theJspApplicationContext
instance associated with the web application for the givenServletContext
.abstract PageContext
getPageContext(Servlet servlet, ServletRequest request, ServletResponse response, String errorPageURL, boolean needsSession, int buffer, boolean autoflush)
obtains an instance of an implementation dependent javax.servlet.jsp.PageContext abstract class for the calling Servlet and currently pending request and response.abstract void
releasePageContext(PageContext pc)
called to release a previously allocated PageContext object.static void
setDefaultFactory(JspFactory deflt)
set the default factory for this implementation.
-
-
-
Constructor Detail
-
JspFactory
public JspFactory()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
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(Servlet servlet, ServletRequest request, ServletResponse response, String errorPageURL, boolean needsSession, int buffer, boolean autoflush)
obtains an instance of an implementation dependent javax.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_BUFFER if no buffer, JspWriter.DEFAULT_BUFFER if 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(ServletContext context)
Obtains theJspApplicationContext
instance associated with the web application for the givenServletContext
.- Parameters:
context
- TheServletContext
for the web application the desiredJspApplicationContext
is associated with.- Returns:
- The
JspApplicationContext
associated with the web application. - Since:
- 2.1
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/jsp/JspFactory.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.