FileDocCategorySizeDatePackage
JspFactory.javaAPI DocGlassfish v2 API7279Fri May 04 22:34:26 BST 2007javax.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.

Fields Summary
private static JspFactory
deflt
Constructors Summary
public JspFactory()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Methods Summary
public static synchronized javax.servlet.jsp.JspFactorygetDefaultFactory()
Returns the default factory for this implementation.

return
the default factory for this implementation

        if (deflt == null) {
            try {
                Class factory = Class.forName("org.apache.jasper.runtime.JspFactoryImpl");
                if (factory != null) {
                    deflt = (JspFactory) factory.newInstance();
                }
            } catch (Exception ex) {
            }
        }
	return deflt;
public abstract JspEngineInfogetEngineInfo()

called to get implementation-specific information on the current JSP engine.

return
a JspEngineInfo object describing the current JSP engine

public abstract JspApplicationContextgetJspApplicationContext(javax.servlet.ServletContext context)
Obtains the JspApplicationContext instance associated
with the web application for the given ServletContext.
param
context The ServletContext for the web
application the desired JspApplicationContext is
associated with.
return
The JspApplicationContext associated with the
web application.
since
2.1
public abstract javax.servlet.jsp.PageContextgetPageContext(javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, java.lang.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().

param
servlet the requesting servlet
param
request the current request pending on the servlet
param
response the current response pending on the servlet
param
errorPageURL the URL of the error page for the requesting JSP, or null
param
needsSession true if the JSP participates in a session
param
buffer size of buffer in bytes, PageContext.NO_BUFFER if no buffer,
PageContext.DEFAULT_BUFFER if implementation default.
param
autoflush should the buffer autoflush to the output stream on buffer
overflow, or throw an IOException?
return
the page context
see
javax.servlet.jsp.PageContext
public abstract voidreleasePageContext(javax.servlet.jsp.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.

param
pc A PageContext previously obtained by getPageContext()
public static synchronized voidsetDefaultFactory(javax.servlet.jsp.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.

param
deflt The default factory implementation
	JspFactory.deflt = deflt;