PageContext (GNU Servlet API documentation)

JavaScript is disabled on your browser.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

javax.servlet.jsp

Class PageContext

java.lang.Object
- javax.servlet.jsp.JspContext
- - javax.servlet.jsp.PageContext

public abstract class PageContext
extends JspContext

The definition of a page.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION` Key for the servlet context in the name table.
`static int`	`APPLICATION_SCOPE` Denotes application scope.
`static java.lang.String`	`CONFIG` Key for the ServletConfig in the name table.
`static java.lang.String`	`EXCEPTION` Key for an uncaught exception in the name table.
`static java.lang.String`	`OUT` Key for the current JspWriter in the name table.
`static java.lang.String`	`PAGE` Key for the servlet in the name table.
`static int`	`PAGE_SCOPE` Denotes page scope.
`static java.lang.String`	`PAGECONTEXT` Key for the page context itself in the name table.
`static java.lang.String`	`REQUEST` Key for the servlet request in the name table.
`static int`	`REQUEST_SCOPE` Denotes request scope.
`static java.lang.String`	`RESPONSE` Key for the servlet response in the name table.
`static java.lang.String`	`SESSION` Key for the HttpSession in the name table.
`static int`	`SESSION_SCOPE` Denotes session scope.

Constructor Summary

Constructors
Constructor and Description

PageContext ()

Constructors
Constructor and Description
`PageContext ()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`forward (java.lang.String relativeUrlPath)` Forwards the current request/response pair to another servlet for all further processing.
`ErrorData`	`getErrorData ()` Returns error data from the request attributes.
`abstract java.lang.Exception`	`getException ()` Returns the current unhandled exception.
`abstract java.lang.Object`	`getPage ()` Returns the current page (a servlet).
`abstract ServletRequest`	`getRequest ()` Returns the current servlet request object
`abstract ServletResponse`	`getResponse ()` Returns the current servlet response object
`abstract ServletConfig`	`getServletConfig ()` Returns the ServletConfig associated with the page.
`abstract ServletContext`	`getServletContext ()` Returns the servlet context.
`abstract HttpSession`	`getSession ()` Returns the current session object.
`abstract void`	`handlePageException (java.lang.Exception e)` Handle an exception created by the page.
`abstract void`	`handlePageException (java.lang.Throwable t)` Handle an exception created by the page.
`abstract void`	`include (java.lang.String urlPath)` Process the request/response pair using another resource.
`abstract void`	`include (java.lang.String urlPath, boolean flush)` Process the request/response pair using another resource.
`abstract void`	`initialize (Servlet servlet, ServletRequest request, ServletResponse response, java.lang.String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush)` Initialize the JSP page context.
`BodyContent`	`pushBody ()` Calls `JspContext.pushBody(java.io.Writer)` with the current value of `out`, and returns a new BodyContent.
`abstract void`	`release ()` Release this page context.

Methods inherited from class javax.servlet.jsp.JspContext
findAttribute, getAttribute, getAttribute, getAttributeNamesInScope, getAttributesScope, getELContext, getExpressionEvaluator, getOut, getVariableResolver, popBody, pushBody, removeAttribute, removeAttribute, setAttribute, setAttribute

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PAGE_SCOPE
```
public static final int PAGE_SCOPE
```
    Denotes page scope.
    
    See Also:
    Constant Field Values
  - REQUEST_SCOPE
```
public static final int REQUEST_SCOPE
```
    Denotes request scope.
    
    See Also:
    Constant Field Values
  - SESSION_SCOPE
```
public static final int SESSION_SCOPE
```
    Denotes session scope.
    
    See Also:
    Constant Field Values
  - APPLICATION_SCOPE
```
public static final int APPLICATION_SCOPE
```
    Denotes application scope.
    
    See Also:
    Constant Field Values
  - PAGE
```
public static final java.lang.String PAGE
```
    Key for the servlet in the name table.
    
    See Also:
    Constant Field Values
  - PAGECONTEXT
```
public static final java.lang.String PAGECONTEXT
```
    Key for the page context itself in the name table.
    
    See Also:
    Constant Field Values
  - REQUEST
```
public static final java.lang.String REQUEST
```
    Key for the servlet request in the name table.
    
    See Also:
    Constant Field Values
  - RESPONSE
```
public static final java.lang.String RESPONSE
```
    Key for the servlet response in the name table.
    
    See Also:
    Constant Field Values
  - CONFIG
```
public static final java.lang.String CONFIG
```
    Key for the ServletConfig in the name table.
    
    See Also:
    Constant Field Values
  - SESSION
```
public static final java.lang.String SESSION
```
    Key for the HttpSession in the name table.
    
    See Also:
    Constant Field Values
  - OUT
```
public static final java.lang.String OUT
```
    Key for the current JspWriter in the name table.
    
    See Also:
    Constant Field Values
  - APPLICATION
```
public static final java.lang.String APPLICATION
```
    Key for the servlet context in the name table.
    
    See Also:
    Constant Field Values
  - EXCEPTION
```
public static final java.lang.String EXCEPTION
```
    Key for an uncaught exception in the name table.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - PageContext
```
public PageContext()
```
- Method Detail
  - initialize
```
public abstract void initialize(Servlet servlet,
 ServletRequest request,
 ServletResponse response,
 java.lang.String errorPageURL,
 boolean needsSession,
 int bufferSize,
 boolean autoFlush)
 throws java.io.IOException,
 java.lang.IllegalStateException,
 java.lang.IllegalArgumentException
```
    Initialize the JSP page context.
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalStateException
    
    java.lang.IllegalArgumentException
  - release
```
public abstract void release()
```
    Release this page context.
  - getSession
```
public abstract HttpSession getSession()
```
    Returns the current session object.
  - getPage
```
public abstract java.lang.Object getPage()
```
    Returns the current page (a servlet).
  - getRequest
```
public abstract ServletRequest getRequest()
```
    Returns the current servlet request object
  - getResponse
```
public abstract ServletResponse getResponse()
```
    Returns the current servlet response object
  - getException
```
public abstract java.lang.Exception getException()
```
    Returns the current unhandled exception.
  - getServletConfig
```
public abstract ServletConfig getServletConfig()
```
    Returns the ServletConfig associated with the page.
  - getServletContext
```
public abstract ServletContext getServletContext()
```
    Returns the servlet context.
  - forward
```
public abstract void forward(java.lang.String relativeUrlPath)
 throws java.io.IOException,
 ServletException 
```
    Forwards the current request/response pair to another servlet for all further processing. This page will not subsequently modify the response.
    
    Parameters:
    relativeUrlPath - the URL path to the target resource relative to this page
    
    Throws:
    
    java.io.IOException
    
    ServletException
  - include
```
public abstract void include(java.lang.String urlPath)
 throws java.io.IOException,
 ServletException 
```
    Process the request/response pair using another resource. This page may subsequently modify the response.
    
    Parameters:
    relativeUrlPath - the URL path to the target resource relative to this page
    
    Throws:
    
    java.io.IOException
    
    ServletException
  - include
```
public abstract void include(java.lang.String urlPath,
 boolean flush)
 throws java.io.IOException,
 ServletException 
```
    Process the request/response pair using another resource. This page may subsequently modify the response. If flush is true, the current out for this page is flushed prior to include processing.
    
    Parameters:
    relativeUrlPath - the URL path to the target resource relative to this page
    
    Throws:
    
    java.io.IOException
    
    ServletException
    Since:
    
    2.0
  - handlePageException
```
public abstract void handlePageException(java.lang.Exception e)
 throws ServletException,
 java.io.IOException
```
    Handle an exception created by the page.
    
    Throws:
    
    ServletException
    
    java.io.IOException
  - handlePageException
```
public abstract void handlePageException(java.lang.Throwable t)
 throws ServletException,
 java.io.IOException
```
    Handle an exception created by the page.
    
    Throws:
    
    ServletException
    
    java.io.IOException
  - pushBody
```
public BodyContent pushBody()
```
    Calls JspContext.pushBody(java.io.Writer) with the current value of out, and returns a new BodyContent.
  - getErrorData
```
public ErrorData getErrorData()
```
    Returns error data from the request attributes.
    
    Since:
    
    2.0

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class PageContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.jsp.JspContext

Methods inherited from class java.lang.Object

Field Detail

PAGE_SCOPE

REQUEST_SCOPE

SESSION_SCOPE

APPLICATION_SCOPE

PAGE

PAGECONTEXT

REQUEST

RESPONSE

CONFIG

SESSION

OUT

APPLICATION

EXCEPTION

Constructor Detail

PageContext

Method Detail

initialize

release

getSession

getPage

getRequest

getResponse

getException

getServletConfig

getServletContext

forward

include

include

handlePageException

handlePageException

pushBody

getErrorData