Class PageContextImpl
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate JspWriterImpl
private int
private javax.servlet.ServletConfig
private javax.servlet.ServletContext
private int
private javax.el.ELContext
private javax.el.ELResolver
private String
private JspFactory
private boolean
private JspApplicationContextImpl
private static Logger
private boolean
private JspWriter
private BodyContentImpl[]
private javax.servlet.ServletRequest
private javax.servlet.ServletResponse
private javax.servlet.Servlet
private javax.servlet.http.HttpSession
Fields inherited from class javax.servlet.jsp.PageContext
APPLICATION, APPLICATION_SCOPE, CONFIG, EXCEPTION, OUT, PAGE, PAGE_SCOPE, PAGECONTEXT, REQUEST, REQUEST_SCOPE, RESPONSE, SESSION, SESSION_SCOPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
_initialize
(javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) private Object
doFindAttribute
(String name) private Object
doGetAttribute
(String name) private Object
doGetAttribute
(String name, int scope) private Enumeration
<String> doGetAttributeNamesInScope
(int scope) private int
doGetAttributeScope
(String name) private void
private void
doRemoveAttribute
(String name) private void
doRemoveAttribute
(String name, int scope) private void
doSetAttribute
(String name, Object attribute) private void
doSetAttribute
(String name, Object o, int scope) static Object
evaluateExpression
(String expression, Class expectedType, PageContext pageContext, ProtectedFunctionMapper functionMap) Evaluates an EL expressionfindAttribute
(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
This method is used to re-direct, or "forward" the current ServletRequest and ServletResponse to another active component in the application.private final String
getAbsolutePathRelativeToContext
(String relativeUrlPath) getAttribute
(String name) Returns the object associated with the name in the page scope or null if not found.getAttribute
(String name, int scope) Return the object associated with the name in the specified scope or null if not found.getAttributeNamesInScope
(int scope) Enumerate all the attributes in a given scope.int
getAttributesScope
(String name) Get the scope where a given attribute is defined.javax.el.ELContext
Returns theELContext
associated with thisJspContext
.private javax.el.ELResolver
Returns the exception associated with this page context, if any.Provides programmatic access to the ExpressionEvaluator.private static javax.el.ExpressionFactory
getExpressionFactory
(PageContext pageContext) (package private) JspApplicationContextImpl
static javax.el.MethodExpression
getMethodExpression
(String expression, PageContext pageContext, javax.el.FunctionMapper functionMap, Class expectedType, Class[] paramTypes) getOut()
The current value of the out object (a JspWriter).getPage()
The current value of the page object (In a Servlet environment, this is an instance of javax.servlet.Servlet).javax.servlet.ServletRequest
The current value of the request object (a ServletRequest).javax.servlet.ServletResponse
The current value of the response object (a ServletResponse).javax.servlet.Servlet
javax.servlet.ServletConfig
The ServletConfig instance.javax.servlet.ServletContext
The ServletContext instance.javax.servlet.http.HttpSession
The current value of the session object (an HttpSession).static javax.el.ValueExpression
getValueExpression
(String expression, PageContext pageContext, Class expectedType, javax.el.FunctionMapper functionMap) Returns an instance of a VariableResolver that provides access to the implicit objects specified in the JSP specification using this JspContext as the context object.void
This method is intended to process an unhandled 'page' level exception by forwarding the exception to the specified error page for this JSP.void
This method is intended to process an unhandled 'page' level exception by forwarding the exception to the specified error page for this JSP.void
Causes the resource specified to be processed as part of the current ServletRequest and ServletResponse being processed by the calling Thread.void
Causes the resource specified to be processed as part of the current ServletRequest and ServletResponse being processed by the calling Thread.void
initialize
(javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.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.private void
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.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.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.void
setAttribute
(String name, Object attribute) Register the name and value specified with page scope semantics.void
setAttribute
(String name, Object o, int scope) Register the name and value specified with appropriate scope semantics.static void
setMethodVariable
(PageContext pageContext, String variable, javax.el.MethodExpression expression) static void
setValueVariable
(PageContext pageContext, String variable, javax.el.ValueExpression expression) Methods inherited from class javax.servlet.jsp.PageContext
getErrorData
-
Field Details
-
log
-
outs
-
depth
private int depth -
servlet
private javax.servlet.Servlet servlet -
config
private javax.servlet.ServletConfig config -
context
private javax.servlet.ServletContext context -
factory
-
needsSession
private boolean needsSession -
errorPageURL
-
bufferSize
private int bufferSize -
jspApplicationContext
-
elResolver
private javax.el.ELResolver elResolver -
elContext
private javax.el.ELContext elContext -
attributes
-
isNametableInitialized
private boolean isNametableInitialized -
request
private javax.servlet.ServletRequest request -
response
private javax.servlet.ServletResponse response -
session
private javax.servlet.http.HttpSession session -
out
-
baseOut
-
-
Constructor Details
-
PageContextImpl
PageContextImpl(JspFactory factory)
-
-
Method Details
-
initialize
public void initialize(javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) throws IOException Description copied from class: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.
- Specified by:
initialize
in classPageContext
- Parameters:
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 directive- Throws:
IOException
- during creation of JspWriter
-
_initialize
private void _initialize(javax.servlet.Servlet servlet, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) throws IOException - Throws:
IOException
-
initializePageScopeNameTable
private void initializePageScopeNameTable() -
release
public void release()Description copied from class: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.
- Specified by:
release
in classPageContext
-
getAttribute
Description copied from class:JspContext
Returns the object associated with the name in the page scope or null if not found.- Specified by:
getAttribute
in classJspContext
- Parameters:
name
- the name of the attribute to get- Returns:
- the object associated with the name in the page scope or null if not found.
-
doGetAttribute
-
getAttribute
Description copied from class:JspContext
Return the object associated with the name in the specified scope or null if not found.- Specified by:
getAttribute
in classJspContext
- Parameters:
name
- the name of the attribute to setscope
- the scope with which to associate the name/object- Returns:
- the object associated with the name in the specified scope or null if not found.
-
doGetAttribute
-
setAttribute
Description copied from class:JspContext
Register the name and value specified with page scope semantics. If the value passed in isnull
, this has the same effect as callingremoveAttribute( name, PageContext.PAGE_SCOPE )
.- Specified by:
setAttribute
in classJspContext
- Parameters:
name
- the name of the attribute to setattribute
- the value to associate with the name, or null if the attribute is to be removed from the page scope.
-
doSetAttribute
-
setAttribute
Description copied from class:JspContext
Register the name and value specified with appropriate scope semantics. If the value passed in isnull
, this has the same effect as callingremoveAttribute( name, scope )
.- Specified by:
setAttribute
in classJspContext
- Parameters:
name
- the name of the attribute to seto
- 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/object
-
doSetAttribute
-
removeAttribute
Description copied from class:JspContext
Remove the object reference associated with the specified name in the given scope. Does nothing if there is no such object.- Specified by:
removeAttribute
in classJspContext
- Parameters:
name
- The name of the object to remove.scope
- The scope where to look.
-
doRemoveAttribute
-
getAttributesScope
Description copied from class:JspContext
Get the scope where a given attribute is defined.- Specified by:
getAttributesScope
in classJspContext
- Parameters:
name
- the name of the attribute to return the scope for- Returns:
- the scope of the object associated with the name specified or 0
-
doGetAttributeScope
-
findAttribute
Description copied from class:JspContext
Searches for the named attribute in page, request, session (if valid), and application scope(s) in order and returns the value associated or null.- Specified by:
findAttribute
in classJspContext
- Parameters:
name
- the name of the attribute to search for- Returns:
- the value associated or null
-
doFindAttribute
-
getAttributeNamesInScope
Description copied from class:JspContext
Enumerate all the attributes in a given scope.- Specified by:
getAttributeNamesInScope
in classJspContext
- Parameters:
scope
- the scope to enumerate all the attributes for- Returns:
- an enumeration of names (java.lang.String) of all the attributes the specified scope
-
doGetAttributeNamesInScope
-
removeAttribute
Description copied from class:JspContext
Remove the object reference associated with the given name from all scopes. Does nothing if there is no such object.- Specified by:
removeAttribute
in classJspContext
- Parameters:
name
- The name of the object to remove.
-
doRemoveAttribute
-
getOut
Description copied from class:JspContext
The current value of the out object (a JspWriter).- Specified by:
getOut
in classJspContext
- Returns:
- the current JspWriter stream being used for client response
-
getSession
public javax.servlet.http.HttpSession getSession()Description copied from class:PageContext
The current value of the session object (an HttpSession).- Specified by:
getSession
in classPageContext
- Returns:
- the HttpSession for this PageContext or null
-
getServlet
public javax.servlet.Servlet getServlet() -
getServletConfig
public javax.servlet.ServletConfig getServletConfig()Description copied from class:PageContext
The ServletConfig instance.- Specified by:
getServletConfig
in classPageContext
- Returns:
- the ServletConfig for this PageContext
-
getServletContext
public javax.servlet.ServletContext getServletContext()Description copied from class:PageContext
The ServletContext instance.- Specified by:
getServletContext
in classPageContext
- Returns:
- the ServletContext for this PageContext
-
getRequest
public javax.servlet.ServletRequest getRequest()Description copied from class:PageContext
The current value of the request object (a ServletRequest).- Specified by:
getRequest
in classPageContext
- Returns:
- The ServletRequest for this PageContext
-
getResponse
public javax.servlet.ServletResponse getResponse()Description copied from class:PageContext
The current value of the response object (a ServletResponse).- Specified by:
getResponse
in classPageContext
- Returns:
- the ServletResponse for this PageContext
-
getException
Returns the exception associated with this page context, if any. Added wrapping for Throwables to avoid ClassCastException (see Bugzilla 31171 for details).- Specified by:
getException
in classPageContext
- Returns:
- The Exception associated with this page context, if any.
-
getPage
Description copied from class:PageContext
The current value of the page object (In a Servlet environment, this is an instance of javax.servlet.Servlet).- Specified by:
getPage
in classPageContext
- Returns:
- the Page implementation class instance associated with this PageContext
-
getAbsolutePathRelativeToContext
-
include
Description copied from class: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.- Specified by:
include
in classPageContext
- Parameters:
relativeUrlPath
- specifies the relative URL path to the target resource to be included- Throws:
javax.servlet.ServletException
- if the page that was forwarded to throws a ServletExceptionIOException
- if an I/O error occurred while forwarding
-
include
public void include(String relativeUrlPath, boolean flush) throws javax.servlet.ServletException, IOException Description copied from class: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.- Specified by:
include
in classPageContext
- Parameters:
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.- Throws:
javax.servlet.ServletException
- if the page that was forwarded to throws a ServletExceptionIOException
- if an I/O error occurred while forwarding
-
getVariableResolver
Description copied from class:JspContext
Returns an instance of a VariableResolver that provides access to the implicit objects specified in the JSP specification using this JspContext as the context object.- Specified by:
getVariableResolver
in classJspContext
- Returns:
- A valid instance of a VariableResolver.
-
getELResolver
private javax.el.ELResolver getELResolver() -
getELContext
public javax.el.ELContext getELContext()Description copied from class:JspContext
Returns theELContext
associated with thisJspContext
.The
ELContext
is created lazily and is reused if it already exists. There is a newELContext
for eachJspContext
.The
ELContext
must contain theELResolver
described in the JSP specification (and in the javadocs forJspApplicationContext.addELResolver(javax.el.ELResolver)
).- Specified by:
getELContext
in classJspContext
- Returns:
- The
ELContext
associated with thisJspContext
.
-
getJspApplicationContext
JspApplicationContextImpl getJspApplicationContext() -
forward
Description copied from class: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 theServletResponse
object. Any such attempt to do so, shall result in undefined behavior. Typically, callers immediately return from_jspService(...)
after calling this method.- Specified by:
forward
in classPageContext
- Parameters:
relativeUrlPath
- specifies the relative URL path to the target resource as described above- Throws:
javax.servlet.ServletException
- if the page that was forwarded to throws a ServletExceptionIOException
- if an I/O error occurred while forwarding
-
pushBody
Description copied from class:PageContext
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.- Overrides:
pushBody
in classPageContext
- Returns:
- the new BodyContent
-
pushBody
Description copied from class:JspContext
Return a new JspWriter object that sends output to the provided Writer. Saves the current "out" JspWriter, and updates the value of the "out" attribute in the page scope attribute namespace of the JspContext.The returned JspWriter must implement all methods and behave as though it were unbuffered. More specifically:
- clear() must throw an IOException
- clearBuffer() does nothing
- getBufferSize() always returns 0
- getRemaining() always returns 0
- Overrides:
pushBody
in classJspContext
- Parameters:
writer
- The Writer for the returned JspWriter to send output to.- Returns:
- a new JspWriter that writes to the given Writer.
-
popBody
Description copied from class:JspContext
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.- Overrides:
popBody
in classJspContext
- Returns:
- the saved JspWriter.
-
getExpressionEvaluator
Provides programmatic access to the ExpressionEvaluator. The JSP Container must return a valid instance of an ExpressionEvaluator that can parse EL expressions.- Specified by:
getExpressionEvaluator
in classJspContext
- Returns:
- A valid instance of an ExpressionEvaluator.
-
handlePageException
Description copied from class: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 compatiblity reasons. Newly generated code should use PageContext.handlePageException(Throwable).
- Specified by:
handlePageException
in classPageContext
- Parameters:
ex
- the exception to be handled- Throws:
IOException
- if an I/O error occurred while invoking the error pagejavax.servlet.ServletException
- if an error occurs while invoking the error page- See Also:
-
handlePageException
Description copied from class: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.
- Specified by:
handlePageException
in classPageContext
- Parameters:
t
- the throwable to be handled- Throws:
IOException
- if an I/O error occurred while invoking the error pagejavax.servlet.ServletException
- if an error occurs while invoking the error page- See Also:
-
doHandlePageException
- Throws:
IOException
javax.servlet.ServletException
-
getExpressionFactory
-
evaluateExpression
public static Object evaluateExpression(String expression, Class expectedType, PageContext pageContext, ProtectedFunctionMapper functionMap) throws javax.el.ELException Evaluates an EL expression- Parameters:
expression
- The expression to be evaluatedexpectedType
- The expected resulting typepageContext
- The page contextfunctionMap
- Maps prefix and name to Method- Returns:
- The result of the evaluation
- Throws:
javax.el.ELException
-
getValueExpression
public static javax.el.ValueExpression getValueExpression(String expression, PageContext pageContext, Class expectedType, javax.el.FunctionMapper functionMap) -
getMethodExpression
public static javax.el.MethodExpression getMethodExpression(String expression, PageContext pageContext, javax.el.FunctionMapper functionMap, Class expectedType, Class[] paramTypes) -
setValueVariable
public static void setValueVariable(PageContext pageContext, String variable, javax.el.ValueExpression expression) -
setMethodVariable
public static void setMethodVariable(PageContext pageContext, String variable, javax.el.MethodExpression expression)
-