public class JspContextWrapper extends PageContext implements VariableResolver
APPLICATION, APPLICATION_SCOPE, CONFIG, EXCEPTION, OUT, PAGE, PAGE_SCOPE, PAGECONTEXT, REQUEST, REQUEST_SCOPE, RESPONSE, SESSION, SESSION_SCOPE
Constructor and Description |
---|
JspContextWrapper(JspContext jspContext,
ArrayList<String> nestedVars,
ArrayList<String> atBeginVars,
ArrayList<String> atEndVars,
Map<String,String> aliases) |
Modifier and Type | Method and Description |
---|---|
Object |
findAttribute(String name)
Searches for the named attribute in page, request, session (if valid),
and application scope(s) in order and returns the value associated or
null.
|
void |
forward(String relativeUrlPath)
This method is used to re-direct, or "forward" the current
ServletRequest and ServletResponse to another active component in
the application.
|
Object |
getAttribute(String name)
Returns the object associated with the name in the page scope or null
if not found.
|
Object |
getAttribute(String name,
int scope)
Return the object associated with the name in the specified
scope or null if not found.
|
Enumeration<String> |
getAttributeNamesInScope(int scope)
Enumerate all the attributes in a given scope.
|
int |
getAttributesScope(String name)
Get the scope where a given attribute is defined.
|
ELContext |
getELContext() |
Exception |
getException()
The current value of the exception object (an Exception).
|
ExpressionEvaluator |
getExpressionEvaluator()
Deprecated.
|
JspWriter |
getOut()
The current value of the out object (a JspWriter).
|
Object |
getPage()
The current value of the page object (In a Servlet environment,
this is an instance of javax.servlet.Servlet).
|
ServletRequest |
getRequest()
The current value of the request object (a ServletRequest).
|
ServletResponse |
getResponse()
The current value of the response object (a ServletResponse).
|
ServletConfig |
getServletConfig()
The ServletConfig instance.
|
ServletContext |
getServletContext()
The ServletContext instance.
|
HttpSession |
getSession()
The current value of the session object (an HttpSession).
|
VariableResolver |
getVariableResolver()
Deprecated.
|
void |
handlePageException(Exception ex)
This method is intended to process an unhandled 'page' level
exception by forwarding the exception to the specified
error page for this JSP.
|
void |
handlePageException(Throwable t)
This method is intended to process an unhandled 'page' level
exception by forwarding the exception to the specified
error page for this JSP.
|
void |
include(String relativeUrlPath)
Causes the resource specified to be processed as part of the current
ServletRequest and ServletResponse being processed by the calling Thread.
|
void |
include(String relativeUrlPath,
boolean flush)
Causes the resource specified to be processed as part of the current
ServletRequest and ServletResponse being processed by the calling Thread.
|
void |
initialize(Servlet servlet,
ServletRequest request,
ServletResponse response,
String errorPageURL,
boolean needsSession,
int bufferSize,
boolean autoFlush)
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.
|
JspWriter |
popBody()
Return the previous JspWriter "out" saved by the matching
pushBody(), and update the value of the "out" attribute in
the page scope attribute namespace of the JspContext.
|
BodyContent |
pushBody()
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.
|
JspWriter |
pushBody(Writer writer)
Return a new JspWriter object that sends output to the
provided Writer.
|
void |
release()
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().
|
void |
removeAttribute(String name)
Remove the object reference associated with the given name
from all scopes.
|
void |
removeAttribute(String name,
int scope)
Remove the object reference associated with the specified name
in the given scope.
|
Object |
resolveVariable(String pName)
Deprecated.
|
void |
setAttribute(String name,
Object value)
Register the name and value specified with page scope semantics.
|
void |
setAttribute(String name,
Object value,
int scope)
Register the name and value specified with appropriate
scope semantics.
|
void |
syncBeforeInvoke()
Synchronize variables before fragment invocation
|
void |
syncBeginTagFile()
Synchronize variables at begin of tag file
|
void |
syncEndTagFile()
Synchronize variables at end of tag file
|
getErrorData
public void initialize(Servlet servlet, ServletRequest request, ServletResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) throws IOException, IllegalStateException, IllegalArgumentException
javax.servlet.jsp.PageContext
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.
This method is typically called from JspFactory.getPageContext() in order to initialize state.
This method is required to create an initial JspWriter, and associate the "out" name in page scope with this newly created object.
This method should not be used by page or tag library authors.
initialize
in class PageContext
servlet
- The Servlet that is associated with this PageContextrequest
- The currently pending request for this Servletresponse
- The currently pending response for this ServleterrorPageURL
- The value of the errorpage attribute from the page
directive or nullneedsSession
- The value of the session attribute from the
page directivebufferSize
- The value of the buffer attribute from the page
directiveautoFlush
- The value of the autoflush attribute from the page
directiveIOException
- during creation of JspWriterIllegalStateException
- if out not correctly initializedIllegalArgumentException
- If one of the given parameters
is invalidpublic Object getAttribute(String name)
javax.servlet.jsp.JspContext
getAttribute
in class JspContext
name
- the name of the attribute to getpublic Object getAttribute(String name, int scope)
javax.servlet.jsp.JspContext
getAttribute
in class JspContext
name
- the name of the attribute to setscope
- the scope with which to associate the name/objectpublic void setAttribute(String name, Object value)
javax.servlet.jsp.JspContext
null
, this has the same
effect as calling
removeAttribute( name, PageContext.PAGE_SCOPE )
.setAttribute
in class JspContext
name
- the name of the attribute to setvalue
- the value to associate with the name, or null if the
attribute is to be removed from the page scope.public void setAttribute(String name, Object value, int scope)
javax.servlet.jsp.JspContext
null
,
this has the same effect as calling
removeAttribute( name, scope )
.setAttribute
in class JspContext
name
- the name of the attribute to setvalue
- the object to associate with the name, or null if
the attribute is to be removed from the specified scope.scope
- the scope with which to associate the name/objectpublic Object findAttribute(String name)
javax.servlet.jsp.JspContext
findAttribute
in class JspContext
name
- the name of the attribute to search forpublic void removeAttribute(String name)
javax.servlet.jsp.JspContext
removeAttribute
in class JspContext
name
- The name of the object to remove.public void removeAttribute(String name, int scope)
javax.servlet.jsp.JspContext
removeAttribute
in class JspContext
name
- The name of the object to remove.scope
- The scope where to look.public int getAttributesScope(String name)
javax.servlet.jsp.JspContext
getAttributesScope
in class JspContext
name
- the name of the attribute to return the scope forpublic Enumeration<String> getAttributeNamesInScope(int scope)
javax.servlet.jsp.JspContext
getAttributeNamesInScope
in class JspContext
scope
- the scope to enumerate all the attributes forpublic void release()
javax.servlet.jsp.PageContext
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.
release
in class PageContext
public JspWriter getOut()
javax.servlet.jsp.JspContext
getOut
in class JspContext
public HttpSession getSession()
javax.servlet.jsp.PageContext
getSession
in class PageContext
public Object getPage()
javax.servlet.jsp.PageContext
getPage
in class PageContext
public ServletRequest getRequest()
javax.servlet.jsp.PageContext
getRequest
in class PageContext
public ServletResponse getResponse()
javax.servlet.jsp.PageContext
getResponse
in class PageContext
public Exception getException()
javax.servlet.jsp.PageContext
getException
in class PageContext
public ServletConfig getServletConfig()
javax.servlet.jsp.PageContext
getServletConfig
in class PageContext
public ServletContext getServletContext()
javax.servlet.jsp.PageContext
getServletContext
in class PageContext
public void forward(String relativeUrlPath) throws ServletException, IOException
javax.servlet.jsp.PageContext
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.
forward
in class PageContext
relativeUrlPath
- specifies the relative URL path to the target
resource as described aboveServletException
- if the page that was forwarded to throws
a ServletExceptionIOException
- if an I/O error occurred while forwardingpublic void include(String relativeUrlPath) throws ServletException, IOException
javax.servlet.jsp.PageContext
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.
include
in class PageContext
relativeUrlPath
- specifies the relative URL path to the target
resource to be includedServletException
- if the page that was forwarded to throws
a ServletExceptionIOException
- if an I/O error occurred while forwardingpublic void include(String relativeUrlPath, boolean flush) throws ServletException, IOException
javax.servlet.jsp.PageContext
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.
include
in class PageContext
relativeUrlPath
- specifies the relative URL path to the
target resource to be includedflush
- True if the JspWriter is to be flushed before the include,
or false if not.ServletException
- if the page that was forwarded to throws
a ServletExceptionIOException
- if an I/O error occurred while forwarding@Deprecated public VariableResolver getVariableResolver()
javax.servlet.jsp.JspContext
getVariableResolver
in class JspContext
public BodyContent pushBody()
javax.servlet.jsp.PageContext
pushBody
in class PageContext
public JspWriter pushBody(Writer writer)
javax.servlet.jsp.JspContext
The returned JspWriter must implement all methods and behave as though it were unbuffered. More specifically:
pushBody
in class JspContext
writer
- The Writer for the returned JspWriter to send
output to.public JspWriter popBody()
javax.servlet.jsp.JspContext
popBody
in class JspContext
@Deprecated public ExpressionEvaluator getExpressionEvaluator()
javax.servlet.jsp.JspContext
getExpressionEvaluator
in class JspContext
public void handlePageException(Exception ex) throws IOException, ServletException
javax.servlet.jsp.PageContext
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 compatibility reasons. Newly generated code should use PageContext.handlePageException(Throwable).
handlePageException
in class PageContext
ex
- the exception to be handledIOException
- if an I/O error occurred while invoking the error
pageServletException
- if an error occurs while invoking the error pagePageContext.handlePageException(Throwable)
public void handlePageException(Throwable t) throws IOException, ServletException
javax.servlet.jsp.PageContext
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.
handlePageException
in class PageContext
t
- the throwable to be handledIOException
- if an I/O error occurred while invoking the error
pageServletException
- if an error occurs while invoking the error pagePageContext.handlePageException(Exception)
@Deprecated public Object resolveVariable(String pName) throws ELException
resolveVariable
in interface VariableResolver
pName
- the name of the variable to resolveELException
- if a failure occurred while trying to resolve the given
variablepublic void syncBeginTagFile()
public void syncBeforeInvoke()
public void syncEndTagFile()
public ELContext getELContext()
getELContext
in class JspContext
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.