pagecontext.html

jsp doc sun java

<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.REQUEST">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RESPONSE"><!-- --></A><H3>
RESPONSE</H3>
<PRE>
public static final java.lang.String <B>RESPONSE</B></PRE>
<DL>
<DD>Name used to store ServletResponse in PageContext name table.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.RESPONSE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="CONFIG"><!-- --></A><H3>
CONFIG</H3>
<PRE>
public static final java.lang.String <B>CONFIG</B></PRE>
<DL>
<DD>Name used to store ServletConfig in PageContext name table.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.CONFIG">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SESSION"><!-- --></A><H3>
SESSION</H3>
<PRE>
public static final java.lang.String <B>SESSION</B></PRE>
<DL>
<DD>Name used to store HttpSession in PageContext name table.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.SESSION">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="OUT"><!-- --></A><H3>
OUT</H3>
<PRE>
public static final java.lang.String <B>OUT</B></PRE>
<DL>
<DD>Name used to store current JspWriter in PageContext name table.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.OUT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="APPLICATION"><!-- --></A><H3>
APPLICATION</H3>
<PRE>
public static final java.lang.String <B>APPLICATION</B></PRE>
<DL>
<DD>Name used to store ServletContext in PageContext name table.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.APPLICATION">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="EXCEPTION"><!-- --></A><H3>
EXCEPTION</H3>
<PRE>
public static final java.lang.String <B>EXCEPTION</B></PRE>
<DL>
<DD>Name used to store uncaught exception in ServletRequest attribute 
 list and PageContext name table.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.servlet.jsp.PageContext.EXCEPTION">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="PageContext()"><!-- --></A><H3>
PageContext</H3>
<PRE>
public <B>PageContext</B>()</PRE>
<DL>
<DD>Sole constructor. (For invocation by subclass constructors, 
 typically implicit.)
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="initialize(javax.servlet.Servlet, javax.servlet.ServletRequest, javax.servlet.ServletResponse, java.lang.String, boolean, int, boolean)"><!-- --></A><H3>
initialize</H3>
<PRE>
public abstract void <B>initialize</B>(javax.servlet.Servlet&nbsp;servlet,
                                javax.servlet.ServletRequest&nbsp;request,
                                javax.servlet.ServletResponse&nbsp;response,
                                java.lang.String&nbsp;errorPageURL,
                                boolean&nbsp;needsSession,
                                int&nbsp;bufferSize,
                                boolean&nbsp;autoFlush)
                         throws java.io.IOException,
                                java.lang.IllegalStateException,
                                java.lang.IllegalArgumentException</PRE>
<DL>
<DD><p>
 The initialize method is called to initialize an uninitialized PageContext
 so that it may be used by a JSP Implementation class to service an
 incoming request and response within it's _jspService() method.

 <p>
 This method is typically called from JspFactory.getPageContext() in
 order to initialize state.

 <p>
 This method is required to create an initial JspWriter, and associate
 the "out" name in page scope with this newly created object.

 <p>
 This method should not be used by page  or tag library authors.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>servlet</CODE> - The Servlet that is associated with this PageContext<DD><CODE>request</CODE> - The currently pending request for this Servlet<DD><CODE>response</CODE> - The currently pending response for this Servlet<DD><CODE>errorPageURL</CODE> - The value of the errorpage attribute from the page 
     directive or null<DD><CODE>needsSession</CODE> - The value of the session attribute from the 
     page directive<DD><CODE>bufferSize</CODE> - The value of the buffer attribute from the page 
     directive<DD><CODE>autoFlush</CODE> - The value of the autoflush attribute from the page 
     directive
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - during creation of JspWriter
<DD><CODE>java.lang.IllegalStateException</CODE> - if out not correctly initialized
<DD><CODE>java.lang.IllegalArgumentException</CODE> - If one of the given parameters
     is invalid</DL>
</DD>
</DL>
<HR>

<A NAME="release()"><!-- --></A><H3>
release</H3>
<PRE>
public abstract void <B>release</B>()</PRE>
<DL>
<DD><p>
 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().

 <p>
 Subclasses shall envelope this method.

 <p>
 This method should not be used by page  or tag library authors.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSession()"><!-- --></A><H3>
getSession</H3>
<PRE>
public abstract javax.servlet.http.HttpSession <B>getSession</B>()</PRE>
<DL>
<DD>The current value of the session object (an HttpSession).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the HttpSession for this PageContext or null</DL>
</DD>
</DL>
<HR>

<A NAME="getPage()"><!-- --></A><H3>
getPage</H3>
<PRE>
public abstract java.lang.Object <B>getPage</B>()</PRE>
<DL>
<DD>The current value of the page object (In a Servlet environment, 
 this is an instance of javax.servlet.Servlet).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the Page implementation class instance associated 
     with this PageContext</DL>
</DD>
</DL>
<HR>

<A NAME="getRequest()"><!-- --></A><H3>
getRequest</H3>
<PRE>
public abstract javax.servlet.ServletRequest <B>getRequest</B>()</PRE>
<DL>
<DD>The current value of the request object (a ServletRequest).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The ServletRequest for this PageContext</DL>
</DD>
</DL>
<HR>

<A NAME="getResponse()"><!-- --></A><H3>
getResponse</H3>
<PRE>
public abstract javax.servlet.ServletResponse <B>getResponse</B>()</PRE>
<DL>
<DD>The current value of the response object (a ServletResponse).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the ServletResponse for this PageContext</DL>
</DD>
</DL>
<HR>

<A NAME="getException()"><!-- --></A><H3>
getException</H3>
<PRE>
public abstract java.lang.Exception <B>getException</B>()</PRE>
<DL>
<DD>The current value of the exception object (an Exception).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>any exception passed to this as an errorpage</DL>
</DD>
</DL>
<HR>

<A NAME="getServletConfig()"><!-- --></A><H3>
getServletConfig</H3>
<PRE>
public abstract javax.servlet.ServletConfig <B>getServletConfig</B>()</PRE>
<DL>
<DD>The ServletConfig instance.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the ServletConfig for this PageContext</DL>
</DD>
</DL>
<HR>

<A NAME="getServletContext()"><!-- --></A><H3>
getServletContext</H3>
<PRE>
public abstract javax.servlet.ServletContext <B>getServletContext</B>()</PRE>
<DL>
<DD>The ServletContext instance.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the ServletContext for this PageContext</DL>
</DD>
</DL>
<HR>

<A NAME="forward(java.lang.String)"><!-- --></A><H3>
forward</H3>
<PRE>
public abstract void <B>forward</B>(java.lang.String&nbsp;relativeUrlPath)
                      throws javax.servlet.ServletException,
                             java.io.IOException</PRE>
<DL>
<DD><p>
 This method is used to re-direct, or "forward" the current 
 ServletRequest and ServletResponse to another active component in 
 the application.
 </p>
 <p>
 If the <I> relativeUrlPath </I> begins with a "/" then the URL specified
 is calculated relative to the DOCROOT of the <code> ServletContext </code>
 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.
 </p>