* This method shall "reset" the internal state of a PageContext, releasing * all internal references, and preparing the PageContext for potential * reuse by a later invocation of initialize(). This method is typically * called from JspFactory.releasePageContext(). * *
* Subclasses shall envelope this method. * *
* This method should not be used by page or tag library authors. * */ abstract public void release(); /** * The current value of the session object (an HttpSession). * * @return the HttpSession for this PageContext or null */ abstract public HttpSession getSession(); /** * The current value of the page object (In a Servlet environment, * this is an instance of javax.servlet.Servlet). * * @return the Page implementation class instance associated * with this PageContext */ abstract public Object getPage(); /** * The current value of the request object (a ServletRequest). * * @return The ServletRequest for this PageContext */ abstract public ServletRequest getRequest(); /** * The current value of the response object (a ServletResponse). * * @return the ServletResponse for this PageContext */ abstract public ServletResponse getResponse(); /** * The current value of the exception object (an Exception). * * @return any exception passed to this as an errorpage */ abstract public Exception getException(); /** * The ServletConfig instance. * * @return the ServletConfig for this PageContext */ abstract public ServletConfig getServletConfig(); /** * The ServletContext instance. * * @return the ServletContext for this PageContext */ abstract public ServletContext getServletContext(); /** *
* This method is used to re-direct, or "forward" the current * ServletRequest and ServletResponse to another active component in * the application. *
*
* If the relativeUrlPath begins with a "/" then the URL specified
* is calculated relative to the DOCROOT of the ServletContext
* for this JSP. If the path does not begin with a "/" then the URL
* specified is calculated relative to the URL of the request that was
* mapped to the calling JSP.
*
* It is only valid to call this method from a Thread
* executing within a _jspService(...) method of a JSP.
*
* Once this method has been called successfully, it is illegal for the
* calling Thread to attempt to modify the
* ServletResponse object. Any such attempt to do so, shall result
* in undefined behavior. Typically, callers immediately return from
* _jspService(...) after calling this method.
*
ServletResponse is not
* in a state where a forward can be performed
* @throws ServletException if the page that was forwarded to throws
* a ServletException
* @throws IOException if an I/O error occurred while forwarding
*/
abstract public void forward(String relativeUrlPath)
throws ServletException, IOException;
/**
* * Causes the resource specified to be processed as part of the current * ServletRequest and ServletResponse being processed by the calling Thread. * The output of the target resources processing of the request is written * directly to the ServletResponse output stream. *
** The current JspWriter "out" for this JSP is flushed as a side-effect * of this call, prior to processing the include. *
*
* If the relativeUrlPath begins with a "/" then the URL specified
* is calculated relative to the DOCROOT of the ServletContext
* for this JSP. If the path does not begin with a "/" then the URL
* specified is calculated relative to the URL of the request that was
* mapped to the calling JSP.
*
* It is only valid to call this method from a Thread
* executing within a _jspService(...) method of a JSP.
*
* Causes the resource specified to be processed as part of the current * ServletRequest and ServletResponse being processed by the calling Thread. * The output of the target resources processing of the request is written * directly to the current JspWriter returned by a call to getOut(). *
** If flush is true, The current JspWriter "out" for this JSP * is flushed as a side-effect of this call, prior to processing * the include. Otherwise, the JspWriter "out" is not flushed. *
*
* If the relativeUrlPath begins with a "/" then the URL specified
* is calculated relative to the DOCROOT of the ServletContext
* for this JSP. If the path does not begin with a "/" then the URL
* specified is calculated relative to the URL of the request that was
* mapped to the calling JSP.
*
* It is only valid to call this method from a Thread
* executing within a _jspService(...) method of a JSP.
*
* This method is intended to process an unhandled 'page' level * exception by forwarding the exception to the specified * error page for this JSP. If forwarding is not possible (for * example because the response has already been committed), an * implementation dependent mechanism should be used to invoke * the error page (e.g. "including" the error page instead). * *
* If no error page is defined in the page, the exception should * be rethrown so that the standard servlet error handling * takes over. * *
* A JSP implementation class shall typically clean up any local state * prior to invoking this and will return immediately thereafter. It is * illegal to generate any output to the client, or to modify any * ServletResponse state after invoking this call. * *
* This method is kept for backwards compatiblity reasons. Newly * generated code should use PageContext.handlePageException(Throwable). * * @param e the exception to be handled * * @throws ServletException if an error occurs while invoking the error page * @throws IOException if an I/O error occurred while invoking the error * page * @throws NullPointerException if the exception is null * * @see #handlePageException(Throwable) */ abstract public void handlePageException(Exception e) throws ServletException, IOException; /** *
* This method is intended to process an unhandled 'page' level * exception by forwarding the exception to the specified * error page for this JSP. If forwarding is not possible (for * example because the response has already been committed), an * implementation dependent mechanism should be used to invoke * the error page (e.g. "including" the error page instead). * *
* If no error page is defined in the page, the exception should * be rethrown so that the standard servlet error handling * takes over. * *
* This method is intended to process an unhandled "page" level exception * by redirecting the exception to either the specified error page for this * JSP, or if none was specified, to perform some implementation dependent * action. * *
* A JSP implementation class shall typically clean up any local state * prior to invoking this and will return immediately thereafter. It is * illegal to generate any output to the client, or to modify any * ServletResponse state after invoking this call. * * @param t the throwable to be handled * * @throws ServletException if an error occurs while invoking the error page * @throws IOException if an I/O error occurred while invoking the error * page * @throws NullPointerException if the exception is null * * @see #handlePageException(Exception) */ abstract public void handlePageException(Throwable t) throws ServletException, IOException; /** * Return a new BodyContent object, save the current "out" JspWriter, * and update the value of the "out" attribute in the page scope * attribute namespace of the PageContext. * * @return the new BodyContent */ public BodyContent pushBody() { return null; // XXX to implement } - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - geronimo-jsp_2.2_spec/src/main/java/javax/servlet/jsp/PageContext.java [225:500]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - abstract public void initialize(Servlet servlet, ServletRequest request, ServletResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) throws IOException, IllegalStateException, IllegalArgumentException; /** *
* This method shall "reset" the internal state of a PageContext, releasing * all internal references, and preparing the PageContext for potential * reuse by a later invocation of initialize(). This method is typically * called from JspFactory.releasePageContext(). * *
* Subclasses shall envelope this method. * *
* This method should not be used by page or tag library authors. * */ abstract public void release(); /** * The current value of the session object (an HttpSession). * * @return the HttpSession for this PageContext or null */ abstract public HttpSession getSession(); /** * The current value of the page object (In a Servlet environment, * this is an instance of javax.servlet.Servlet). * * @return the Page implementation class instance associated * with this PageContext */ abstract public Object getPage(); /** * The current value of the request object (a ServletRequest). * * @return The ServletRequest for this PageContext */ abstract public ServletRequest getRequest(); /** * The current value of the response object (a ServletResponse). * * @return the ServletResponse for this PageContext */ abstract public ServletResponse getResponse(); /** * The current value of the exception object (an Exception). * * @return any exception passed to this as an errorpage */ abstract public Exception getException(); /** * The ServletConfig instance. * * @return the ServletConfig for this PageContext */ abstract public ServletConfig getServletConfig(); /** * The ServletContext instance. * * @return the ServletContext for this PageContext */ abstract public ServletContext getServletContext(); /** *
* This method is used to re-direct, or "forward" the current * ServletRequest and ServletResponse to another active component in * the application. *
*
* If the relativeUrlPath begins with a "/" then the URL specified
* is calculated relative to the DOCROOT of the ServletContext
* for this JSP. If the path does not begin with a "/" then the URL
* specified is calculated relative to the URL of the request that was
* mapped to the calling JSP.
*
* It is only valid to call this method from a Thread
* executing within a _jspService(...) method of a JSP.
*
* Once this method has been called successfully, it is illegal for the
* calling Thread to attempt to modify the
* ServletResponse object. Any such attempt to do so, shall result
* in undefined behavior. Typically, callers immediately return from
* _jspService(...) after calling this method.
*
ServletResponse is not
* in a state where a forward can be performed
* @throws ServletException if the page that was forwarded to throws
* a ServletException
* @throws IOException if an I/O error occurred while forwarding
*/
abstract public void forward(String relativeUrlPath)
throws ServletException, IOException;
/**
* * Causes the resource specified to be processed as part of the current * ServletRequest and ServletResponse being processed by the calling Thread. * The output of the target resources processing of the request is written * directly to the ServletResponse output stream. *
** The current JspWriter "out" for this JSP is flushed as a side-effect * of this call, prior to processing the include. *
*
* If the relativeUrlPath begins with a "/" then the URL specified
* is calculated relative to the DOCROOT of the ServletContext
* for this JSP. If the path does not begin with a "/" then the URL
* specified is calculated relative to the URL of the request that was
* mapped to the calling JSP.
*
* It is only valid to call this method from a Thread
* executing within a _jspService(...) method of a JSP.
*
* Causes the resource specified to be processed as part of the current * ServletRequest and ServletResponse being processed by the calling Thread. * The output of the target resources processing of the request is written * directly to the current JspWriter returned by a call to getOut(). *
** If flush is true, The current JspWriter "out" for this JSP * is flushed as a side-effect of this call, prior to processing * the include. Otherwise, the JspWriter "out" is not flushed. *
*
* If the relativeUrlPath begins with a "/" then the URL specified
* is calculated relative to the DOCROOT of the ServletContext
* for this JSP. If the path does not begin with a "/" then the URL
* specified is calculated relative to the URL of the request that was
* mapped to the calling JSP.
*
* It is only valid to call this method from a Thread
* executing within a _jspService(...) method of a JSP.
*
* This method is intended to process an unhandled 'page' level * exception by forwarding the exception to the specified * error page for this JSP. If forwarding is not possible (for * example because the response has already been committed), an * implementation dependent mechanism should be used to invoke * the error page (e.g. "including" the error page instead). * *
* If no error page is defined in the page, the exception should * be rethrown so that the standard servlet error handling * takes over. * *
* A JSP implementation class shall typically clean up any local state * prior to invoking this and will return immediately thereafter. It is * illegal to generate any output to the client, or to modify any * ServletResponse state after invoking this call. * *
* This method is kept for backwards compatiblity reasons. Newly * generated code should use PageContext.handlePageException(Throwable). * * @param e the exception to be handled * * @throws ServletException if an error occurs while invoking the error page * @throws IOException if an I/O error occurred while invoking the error * page * @throws NullPointerException if the exception is null * * @see #handlePageException(Throwable) */ abstract public void handlePageException(Exception e) throws ServletException, IOException; /** *
* This method is intended to process an unhandled 'page' level * exception by forwarding the exception to the specified * error page for this JSP. If forwarding is not possible (for * example because the response has already been committed), an * implementation dependent mechanism should be used to invoke * the error page (e.g. "including" the error page instead). * *
* If no error page is defined in the page, the exception should * be rethrown so that the standard servlet error handling * takes over. * *
* This method is intended to process an unhandled "page" level exception * by redirecting the exception to either the specified error page for this * JSP, or if none was specified, to perform some implementation dependent * action. * *
* A JSP implementation class shall typically clean up any local state * prior to invoking this and will return immediately thereafter. It is * illegal to generate any output to the client, or to modify any * ServletResponse state after invoking this call. * * @param t the throwable to be handled * * @throws ServletException if an error occurs while invoking the error page * @throws IOException if an I/O error occurred while invoking the error * page * @throws NullPointerException if the exception is null * * @see #handlePageException(Exception) */ abstract public void handlePageException(Throwable t) throws ServletException, IOException; /** * Return a new BodyContent object, save the current "out" JspWriter, * and update the value of the "out" attribute in the page scope * attribute namespace of the PageContext. * * @return the new BodyContent */ public BodyContent pushBody() { return null; // XXX to implement } - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -