public abstract class ExternalContextWrapper extends ExternalContext implements FacesWrapper<ExternalContext>
Provides a simple implementation of
ExternalContext
that can be subclassed by developers wishing to provide specialized behavior to an existing
ExternalContext
instance. The default implementation of all methods is to call through to the wrapped
ExternalContext
instance.
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped()
to
access the instance being wrapped.
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
Constructor and Description |
---|
ExternalContextWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
ExternalContextWrapper(ExternalContext wrapped)
If this external context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
Modifier and Type | Method and Description |
---|---|
void |
addResponseCookie(java.lang.String name,
java.lang.String value,
java.util.Map<java.lang.String,java.lang.Object> properties)
The default behavior of this method is to call
ExternalContext.addResponseCookie(String, String, Map) on the
wrapped ExternalContext object. |
void |
addResponseHeader(java.lang.String name,
java.lang.String value)
The default behavior of this method is to call
ExternalContext.addResponseHeader(String,String) on the
wrapped ExternalContext object. |
void |
dispatch(java.lang.String path)
The default behavior of this method is to call
ExternalContext.dispatch(String) on the wrapped
ExternalContext object. |
java.lang.String |
encodeActionURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodeActionURL(String) on the wrapped
ExternalContext object. |
java.lang.String |
encodeBookmarkableURL(java.lang.String baseUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The default behavior of this method is to call
ExternalContext.encodeBookmarkableURL(String, java.util.Map) on the wrapped
ExternalContext object. |
java.lang.String |
encodeNamespace(java.lang.String name)
The default behavior of this method is to call
ExternalContext.encodeNamespace(String) on the wrapped
ExternalContext object. |
java.lang.String |
encodePartialActionURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodePartialActionURL(String) on the wrapped
ExternalContext object. |
java.lang.String |
encodeRedirectURL(java.lang.String baseUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The default behavior of this method is to call
ExternalContext.encodeRedirectURL(String, java.util.Map) on the wrapped
ExternalContext object. |
java.lang.String |
encodeResourceURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodeResourceURL(String) on the wrapped
ExternalContext object. |
java.lang.String |
encodeWebsocketURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodeWebsocketURL(String) on the wrapped
ExternalContext object. |
java.lang.String |
getApplicationContextPath()
The default behavior of this method is to call |
java.util.Map<java.lang.String,java.lang.Object> |
getApplicationMap()
The default behavior of this method is to call
ExternalContext.getApplicationMap() on the wrapped
ExternalContext object. |
java.lang.String |
getAuthType()
The default behavior of this method is to call
ExternalContext.getAuthType() on the wrapped
ExternalContext object. |
ClientWindow |
getClientWindow()
The default behavior of this method is to call |
java.lang.Object |
getContext()
The default behavior of this method is to call
ExternalContext.getContext() on the wrapped
ExternalContext object. |
java.lang.String |
getContextName()
The default behavior of this method is to call
ExternalContext.getContextName() on the wrapped
ExternalContext object. |
Flash |
getFlash()
The default behavior of this method is to call
ExternalContext.getFlash() on the wrapped
ExternalContext object. |
java.lang.String |
getInitParameter(java.lang.String name)
The default behavior of this method is to call
ExternalContext.getInitParameter(String) on the wrapped
ExternalContext object. |
java.util.Map |
getInitParameterMap()
The default behavior of this method is to call
ExternalContext.getInitParameterMap() on the wrapped
ExternalContext object. |
java.lang.String |
getMimeType(java.lang.String file)
The default behavior of this method is to call
ExternalContext.getMimeType(String) on the wrapped
ExternalContext object. |
java.lang.String |
getRealPath(java.lang.String path)
The default behavior of this method is to call
ExternalContext.getRealPath(String) on the wrapped
ExternalContext object. |
java.lang.String |
getRemoteUser()
The default behavior of this method is to call
ExternalContext.getRemoteUser() on the wrapped
ExternalContext object. |
java.lang.Object |
getRequest()
The default behavior of this method is to call
ExternalContext.getRequest() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestCharacterEncoding()
The default behavior of this method is to call
ExternalContext.getRequestCharacterEncoding() on the wrapped
ExternalContext object. |
int |
getRequestContentLength()
The default behavior of this method is to call
ExternalContext.getRequestContentLength() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestContentType()
The default behavior of this method is to call
ExternalContext.getRequestContentType() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestContextPath()
The default behavior of this method is to call
ExternalContext.getRequestContextPath() on the wrapped
ExternalContext object. |
java.util.Map<java.lang.String,java.lang.Object> |
getRequestCookieMap()
The default behavior of this method is to call
ExternalContext.getRequestCookieMap() on the wrapped
ExternalContext object. |
java.util.Map<java.lang.String,java.lang.String> |
getRequestHeaderMap()
The default behavior of this method is to call
ExternalContext.getRequestHeaderMap() on the wrapped
ExternalContext object. |
java.util.Map<java.lang.String,java.lang.String[]> |
getRequestHeaderValuesMap()
The default behavior of this method is to call
ExternalContext.getRequestHeaderValuesMap() on the wrapped
ExternalContext object. |
java.util.Locale |
getRequestLocale()
The default behavior of this method is to call
ExternalContext.getRequestLocale() on the wrapped
ExternalContext object. |
java.util.Iterator<java.util.Locale> |
getRequestLocales()
The default behavior of this method is to call
ExternalContext.getRequestLocales() on the wrapped
ExternalContext object. |
java.util.Map<java.lang.String,java.lang.Object> |
getRequestMap()
The default behavior of this method is to call
ExternalContext.getRequestMap() on the wrapped
ExternalContext object. |
java.util.Map<java.lang.String,java.lang.String> |
getRequestParameterMap()
The default behavior of this method is to call
ExternalContext.getRequestParameterMap() on the wrapped
ExternalContext object. |
java.util.Iterator<java.lang.String> |
getRequestParameterNames()
The default behavior of this method is to call
ExternalContext.getRequestParameterNames() on the wrapped
ExternalContext object. |
java.util.Map<java.lang.String,java.lang.String[]> |
getRequestParameterValuesMap()
The default behavior of this method is to call
ExternalContext.getRequestParameterValuesMap() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestPathInfo()
The default behavior of this method is to call
ExternalContext.getRequestPathInfo() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestScheme()
The default behavior of this method is to call
ExternalContext.getRequestScheme() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestServerName()
The default behavior of this method is to call
ExternalContext.getRequestServerName() on the wrapped
ExternalContext object. |
int |
getRequestServerPort()
The default behavior of this method is to call
ExternalContext.getRequestServerPort() on the wrapped
ExternalContext object. |
java.lang.String |
getRequestServletPath()
The default behavior of this method is to call
ExternalContext.getRequestServletPath() on the wrapped
ExternalContext object. |
java.net.URL |
getResource(java.lang.String path)
The default behavior of this method is to call
ExternalContext.getResource(String) on the wrapped
ExternalContext object. |
java.io.InputStream |
getResourceAsStream(java.lang.String path)
The default behavior of this method is to call
ExternalContext.getResourceAsStream(String) on the wrapped
ExternalContext object. |
java.util.Set<java.lang.String> |
getResourcePaths(java.lang.String path)
The default behavior of this method is to call
ExternalContext.getResourcePaths(String) on the wrapped
ExternalContext object. |
java.lang.Object |
getResponse()
The default behavior of this method is to call
ExternalContext.getResponse() on the wrapped
ExternalContext object. |
int |
getResponseBufferSize()
The default behavior of this method is to call
ExternalContext.getResponseBufferSize() on the wrapped
ExternalContext object. |
java.lang.String |
getResponseCharacterEncoding()
The default behavior of this method is to call
ExternalContext.getResponseCharacterEncoding() on the wrapped
ExternalContext object. |
java.lang.String |
getResponseContentType()
The default behavior of this method is to call
ExternalContext.getResponseContentType() on the wrapped
ExternalContext object. |
java.io.OutputStream |
getResponseOutputStream()
The default behavior of this method is to call
ExternalContext.getResponseOutputStream() on the wrapped
ExternalContext object. |
java.io.Writer |
getResponseOutputWriter()
The default behavior of this method is to call
ExternalContext.getResponseOutputWriter() on the wrapped
ExternalContext object. |
java.lang.Object |
getSession(boolean create)
The default behavior of this method is to call
ExternalContext.getSession(boolean) on the wrapped
ExternalContext object. |
java.lang.String |
getSessionId(boolean create)
The default behavior of this method is to call |
java.util.Map<java.lang.String,java.lang.Object> |
getSessionMap()
The default behavior of this method is to call
ExternalContext.getSessionMap() on the wrapped
ExternalContext object. |
int |
getSessionMaxInactiveInterval()
The default behavior of this method is to call |
java.security.Principal |
getUserPrincipal()
The default behavior of this method is to call
ExternalContext.getUserPrincipal() on the wrapped
ExternalContext object. |
ExternalContext |
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped. |
void |
invalidateSession()
The default behavior of this method is to call
ExternalContext.invalidateSession() on the wrapped
ExternalContext object. |
boolean |
isResponseCommitted()
The default behavior of this method is to call
ExternalContext.isResponseCommitted() on the wrapped
ExternalContext object. |
boolean |
isSecure()
The default behavior of this method is to call |
boolean |
isUserInRole(java.lang.String role)
The default behavior of this method is to call
ExternalContext.isUserInRole(String) on the wrapped
ExternalContext object. |
void |
log(java.lang.String message)
The default behavior of this method is to call
ExternalContext.log(String) on the wrapped
ExternalContext object. |
void |
log(java.lang.String message,
java.lang.Throwable exception)
The default behavior of this method is to call
ExternalContext.log(String, Throwable) on the wrapped
ExternalContext object. |
void |
redirect(java.lang.String url)
The default behavior of this method is to call
ExternalContext.redirect(String) on the wrapped
ExternalContext object. |
void |
release()
The default behavior of this method is to call
ExternalContext.release() on the wrapped
ExternalContext object. |
void |
responseFlushBuffer()
The default behavior of this method is to call
ExternalContext.responseFlushBuffer() on
the wrapped ExternalContext object. |
void |
responseReset()
The default behavior of this method is to call
ExternalContext.responseReset() on the wrapped
ExternalContext object. |
void |
responseSendError(int statusCode,
java.lang.String message)
The default behavior of this method is to call
ExternalContext.responseSendError(int,String) on the wrapped
ExternalContext object. |
void |
setClientWindow(ClientWindow window)
The default behavior of this method is to call |
void |
setRequest(java.lang.Object request)
The default behavior of this method is to call
ExternalContext.setRequest(Object) on the wrapped
ExternalContext object. |
void |
setRequestCharacterEncoding(java.lang.String encoding)
The default behavior of this method is to call
ExternalContext.setRequestCharacterEncoding(String) on the
wrapped ExternalContext object. |
void |
setResponse(java.lang.Object response)
The default behavior of this method is to call
ExternalContext.setResponse(Object) on the wrapped
ExternalContext object. |
void |
setResponseBufferSize(int size)
The default behavior of this method is to call
ExternalContext.setResponseBufferSize(int) on the wrapped
ExternalContext object. |
void |
setResponseCharacterEncoding(java.lang.String encoding)
The default behavior of this method is to call
ExternalContext.getResponseCharacterEncoding() on the wrapped
ExternalContext object. |
void |
setResponseContentLength(int length)
The default behavior of this method is to call
ExternalContext.setResponseContentLength(int) on the wrapped ExternalContext
object. |
void |
setResponseContentType(java.lang.String contentType)
The default behavior of this method is to call
ExternalContext.setResponseContentType(String) on the wrapped
ExternalContext object. |
void |
setResponseHeader(java.lang.String name,
java.lang.String value)
The default behavior of this method is to call
ExternalContext.setResponseHeader(String,String) on the
wrapped ExternalContext object. |
void |
setResponseStatus(int statusCode)
The default behavior of this method is to call
ExternalContext.setResponseStatus(int) on the wrapped
ExternalContext object. |
void |
setSessionMaxInactiveInterval(int interval)
The default behavior of this method is to call |
@Deprecated public ExternalContextWrapper()
public ExternalContextWrapper(ExternalContext wrapped)
If this external context has been decorated, the implementation doing the decorating should push the implementation
being wrapped to this constructor. The getWrapped()
will then return the implementation being wrapped.
wrapped
- The implementation being wrapped.public ExternalContext getWrapped()
FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped
in interface FacesWrapper<ExternalContext>
public void dispatch(java.lang.String path) throws java.io.IOException
The default behavior of this method is to call ExternalContext.dispatch(String)
on the wrapped
ExternalContext
object.
dispatch
in class ExternalContext
path
- Context relative path to the specified resource, which must start with a slash ("/") characterjava.io.IOException
- if an input/output error occursExternalContext.dispatch(String)
public java.lang.String encodeActionURL(java.lang.String url)
The default behavior of this method is to call ExternalContext.encodeActionURL(String)
on the wrapped
ExternalContext
object.
encodeActionURL
in class ExternalContext
url
- The input URL to be encodedExternalContext.encodeActionURL(String)
public java.lang.String encodeNamespace(java.lang.String name)
The default behavior of this method is to call ExternalContext.encodeNamespace(String)
on the wrapped
ExternalContext
object.
encodeNamespace
in class ExternalContext
name
- Name to be encodedExternalContext.encodeNamespace(String)
public java.lang.String encodePartialActionURL(java.lang.String url)
The default behavior of this method is to call ExternalContext.encodePartialActionURL(String)
on the wrapped
ExternalContext
object.
encodePartialActionURL
in class ExternalContext
url
- The input URL to be encodedExternalContext.encodePartialActionURL(String)
public java.lang.String encodeResourceURL(java.lang.String url)
The default behavior of this method is to call ExternalContext.encodeResourceURL(String)
on the wrapped
ExternalContext
object.
encodeResourceURL
in class ExternalContext
url
- The input URL to be encodedExternalContext.encodeResourceURL(String)
public java.lang.String encodeWebsocketURL(java.lang.String url)
The default behavior of this method is to call ExternalContext.encodeWebsocketURL(String)
on the wrapped
ExternalContext
object.
encodeWebsocketURL
in class ExternalContext
url
- The input URL to be encoded.ExternalContext.encodeWebsocketURL(String)
public java.util.Map<java.lang.String,java.lang.Object> getApplicationMap()
The default behavior of this method is to call ExternalContext.getApplicationMap()
on the wrapped
ExternalContext
object.
getApplicationMap
in class ExternalContext
ServletContext
.ExternalContext.getApplicationMap()
public java.lang.String getApplicationContextPath()
The default behavior of this method is to call ExternalContext.getApplicationContextPath()
on the wrapped
ExternalContext
object.
getApplicationContextPath
in class ExternalContext
ExternalContext.getApplicationContextPath()
public java.lang.String getAuthType()
The default behavior of this method is to call ExternalContext.getAuthType()
on the wrapped
ExternalContext
object.
getAuthType
in class ExternalContext
ExternalContext.getAuthType()
public java.lang.Object getContext()
The default behavior of this method is to call ExternalContext.getContext()
on the wrapped
ExternalContext
object.
getContext
in class ExternalContext
ServletContext
.ExternalContext.getContext()
public java.lang.String getInitParameter(java.lang.String name)
The default behavior of this method is to call ExternalContext.getInitParameter(String)
on the wrapped
ExternalContext
object.
getInitParameter
in class ExternalContext
name
- Name of the requested initialization parameterExternalContext.getInitParameter(String)
public java.util.Map getInitParameterMap()
The default behavior of this method is to call ExternalContext.getInitParameterMap()
on the wrapped
ExternalContext
object.
getInitParameterMap
in class ExternalContext
ExternalContext.getInitParameterMap()
public java.lang.String getRemoteUser()
The default behavior of this method is to call ExternalContext.getRemoteUser()
on the wrapped
ExternalContext
object.
getRemoteUser
in class ExternalContext
ExternalContext.getRemoteUser()
public java.lang.Object getRequest()
The default behavior of this method is to call ExternalContext.getRequest()
on the wrapped
ExternalContext
object.
getRequest
in class ExternalContext
ExternalContext.getRequest()
public java.lang.String getRequestContextPath()
The default behavior of this method is to call ExternalContext.getRequestContextPath()
on the wrapped
ExternalContext
object.
getRequestContextPath
in class ExternalContext
ExternalContext.getRequestContextPath()
public java.util.Map<java.lang.String,java.lang.Object> getRequestCookieMap()
The default behavior of this method is to call ExternalContext.getRequestCookieMap()
on the wrapped
ExternalContext
object.
getRequestCookieMap
in class ExternalContext
ExternalContext.getRequestCookieMap()
public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()
The default behavior of this method is to call ExternalContext.getRequestHeaderMap()
on the wrapped
ExternalContext
object.
getRequestHeaderMap
in class ExternalContext
ExternalContext.getRequestHeaderMap()
public java.util.Map<java.lang.String,java.lang.String[]> getRequestHeaderValuesMap()
The default behavior of this method is to call ExternalContext.getRequestHeaderValuesMap()
on the wrapped
ExternalContext
object.
getRequestHeaderValuesMap
in class ExternalContext
ExternalContext.getRequestHeaderValuesMap()
public java.util.Locale getRequestLocale()
The default behavior of this method is to call ExternalContext.getRequestLocale()
on the wrapped
ExternalContext
object.
getRequestLocale
in class ExternalContext
Locale
of the current request.ExternalContext.getRequestLocale()
public java.util.Iterator<java.util.Locale> getRequestLocales()
The default behavior of this method is to call ExternalContext.getRequestLocales()
on the wrapped
ExternalContext
object.
getRequestLocales
in class ExternalContext
Iterator
of Locale
s of the current request.ExternalContext.getRequestLocales()
public java.util.Map<java.lang.String,java.lang.Object> getRequestMap()
The default behavior of this method is to call ExternalContext.getRequestMap()
on the wrapped
ExternalContext
object.
getRequestMap
in class ExternalContext
ExternalContext.getRequestMap()
public java.util.Map<java.lang.String,java.lang.String> getRequestParameterMap()
The default behavior of this method is to call ExternalContext.getRequestParameterMap()
on the wrapped
ExternalContext
object.
getRequestParameterMap
in class ExternalContext
ExternalContext.getRequestParameterMap()
public java.util.Iterator<java.lang.String> getRequestParameterNames()
The default behavior of this method is to call ExternalContext.getRequestParameterNames()
on the wrapped
ExternalContext
object.
getRequestParameterNames
in class ExternalContext
Iterator
for the names of the current request parameters.ExternalContext.getRequestParameterNames()
public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterValuesMap()
The default behavior of this method is to call ExternalContext.getRequestParameterValuesMap()
on the wrapped
ExternalContext
object.
getRequestParameterValuesMap
in class ExternalContext
ExternalContext.getRequestParameterValuesMap()
public java.lang.String getRequestPathInfo()
The default behavior of this method is to call ExternalContext.getRequestPathInfo()
on the wrapped
ExternalContext
object.
getRequestPathInfo
in class ExternalContext
ExternalContext.getRequestPathInfo()
public java.lang.String getRequestServletPath()
The default behavior of this method is to call ExternalContext.getRequestServletPath()
on the wrapped
ExternalContext
object.
getRequestServletPath
in class ExternalContext
ExternalContext.getRequestServletPath()
public java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLException
The default behavior of this method is to call ExternalContext.getResource(String)
on the wrapped
ExternalContext
object.
getResource
in class ExternalContext
path
- The path to the requested resource, which must start with a slash ("/" characterjava.net.MalformedURLException
- if the specified path is not in the correct formExternalContext.getResource(String)
public java.io.InputStream getResourceAsStream(java.lang.String path)
The default behavior of this method is to call ExternalContext.getResourceAsStream(String)
on the wrapped
ExternalContext
object.
getResourceAsStream
in class ExternalContext
path
- The path to the requested resource, which must start with a slash ("/" characterInputStream
for the application resource.ExternalContext.getResourceAsStream(String)
public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
The default behavior of this method is to call ExternalContext.getResourcePaths(String)
on the wrapped
ExternalContext
object.
getResourcePaths
in class ExternalContext
path
- Partial path used to match resources, which must start with a slash ("/") characterSet
of resource paths for the application resources.ExternalContext.getResourcePaths(String)
public java.lang.Object getResponse()
The default behavior of this method is to call ExternalContext.getResponse()
on the wrapped
ExternalContext
object.
getResponse
in class ExternalContext
jakarta.servlet.http.HttpServletResponse
.ExternalContext.getResponse()
public java.lang.Object getSession(boolean create)
The default behavior of this method is to call ExternalContext.getSession(boolean)
on the wrapped
ExternalContext
object.
getSession
in class ExternalContext
create
- Flag indicating whether or not a new session should be created if there is no session associated with
the current requestExternalContext.getSession(boolean)
public java.lang.String getSessionId(boolean create)
The default behavior of this method is to call ExternalContext.getSessionId(boolean)
on the wrapped
ExternalContext
object.
getSessionId
in class ExternalContext
create
- Flag indicating whether or not a new session should be created if there is no session associated with
the current requestExternalContext.getSessionId(boolean)
public java.util.Map<java.lang.String,java.lang.Object> getSessionMap()
The default behavior of this method is to call ExternalContext.getSessionMap()
on the wrapped
ExternalContext
object.
getSessionMap
in class ExternalContext
ExternalContext.getSessionMap()
public int getSessionMaxInactiveInterval()
The default behavior of this method is to call ExternalContext.getSessionMaxInactiveInterval()
on the wrapped
ExternalContext
object.
getSessionMaxInactiveInterval
in class ExternalContext
ExternalContext.getSessionMaxInactiveInterval()
public void setSessionMaxInactiveInterval(int interval)
The default behavior of this method is to call ExternalContext.setSessionMaxInactiveInterval(int)
on the
wrapped ExternalContext
object.
setSessionMaxInactiveInterval
in class ExternalContext
interval
- the value to be set.ExternalContext.setSessionMaxInactiveInterval(int)
public void setClientWindow(ClientWindow window)
The default behavior of this method is to call ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow)
on the wrapped
ExternalContext
object.
setClientWindow
in class ExternalContext
window
- the window associated with this request.public java.security.Principal getUserPrincipal()
The default behavior of this method is to call ExternalContext.getUserPrincipal()
on the wrapped
ExternalContext
object.
getUserPrincipal
in class ExternalContext
Principal
object.ExternalContext.getUserPrincipal()
public ClientWindow getClientWindow()
The default behavior of this method is to call ExternalContext.getClientWindow()
on the wrapped
ExternalContext
object.
getClientWindow
in class ExternalContext
ClientWindow
.ExternalContext.getClientWindow()
public boolean isUserInRole(java.lang.String role)
The default behavior of this method is to call ExternalContext.isUserInRole(String)
on the wrapped
ExternalContext
object.
isUserInRole
in class ExternalContext
role
- Logical role name to be checkedExternalContext.isUserInRole(String)
public void log(java.lang.String message)
The default behavior of this method is to call ExternalContext.log(String)
on the wrapped
ExternalContext
object.
log
in class ExternalContext
message
- Message to be loggedExternalContext.log(String)
public void log(java.lang.String message, java.lang.Throwable exception)
The default behavior of this method is to call ExternalContext.log(String, Throwable)
on the wrapped
ExternalContext
object.
log
in class ExternalContext
message
- Message to be loggedexception
- Exception to be loggedExternalContext.log(String, Throwable)
public void redirect(java.lang.String url) throws java.io.IOException
The default behavior of this method is to call ExternalContext.redirect(String)
on the wrapped
ExternalContext
object.
redirect
in class ExternalContext
url
- Absolute URL to which the client should be redirectedjava.io.IOException
- if an input/output error occursExternalContext.redirect(String)
public void addResponseCookie(java.lang.String name, java.lang.String value, java.util.Map<java.lang.String,java.lang.Object> properties)
The default behavior of this method is to call ExternalContext.addResponseCookie(String, String, Map)
on the
wrapped ExternalContext
object.
addResponseCookie
in class ExternalContext
name
- To be passed as the first argument to the Cookie
constructor.value
- To be passed as the second argument to the Cookie
constructor.properties
- A Map
containg key/value pairs to be passed as arguments to the setter methods as
described above.ExternalContext.addResponseCookie(String, String, Map)
public java.lang.String getMimeType(java.lang.String file)
The default behavior of this method is to call ExternalContext.getMimeType(String)
on the wrapped
ExternalContext
object.
getMimeType
in class ExternalContext
file
- The file for which the mime type should be obtained.ExternalContext.getMimeType(String)
public java.lang.String getContextName()
The default behavior of this method is to call ExternalContext.getContextName()
on the wrapped
ExternalContext
object.
getContextName
in class ExternalContext
ServletContext
.ExternalContext.getContextName()
public void setRequest(java.lang.Object request)
The default behavior of this method is to call ExternalContext.setRequest(Object)
on the wrapped
ExternalContext
object.
setRequest
in class ExternalContext
request
- the request object to be set.ExternalContext.setRequest(Object)
public java.lang.String getRequestScheme()
The default behavior of this method is to call ExternalContext.getRequestScheme()
on the wrapped
ExternalContext
object.
getRequestScheme
in class ExternalContext
ExternalContext.getRequestScheme()
public java.lang.String getRequestServerName()
The default behavior of this method is to call ExternalContext.getRequestServerName()
on the wrapped
ExternalContext
object.
getRequestServerName
in class ExternalContext
ExternalContext.getRequestServerName()
public int getRequestServerPort()
The default behavior of this method is to call ExternalContext.getRequestServerPort()
on the wrapped
ExternalContext
object.
getRequestServerPort
in class ExternalContext
ExternalContext.getRequestServerPort()
public void setRequestCharacterEncoding(java.lang.String encoding) throws java.io.UnsupportedEncodingException
The default behavior of this method is to call ExternalContext.setRequestCharacterEncoding(String)
on the
wrapped ExternalContext
object.
setRequestCharacterEncoding
in class ExternalContext
encoding
- the encoding name to be set.java.io.UnsupportedEncodingException
- if this is not a valid encodingExternalContext.setRequestCharacterEncoding(String)
public java.lang.String getRealPath(java.lang.String path)
The default behavior of this method is to call ExternalContext.getRealPath(String)
on the wrapped
ExternalContext
object.
getRealPath
in class ExternalContext
path
- The context of the requested initialization parameterExternalContext.getRealPath(String)
public java.lang.String getRequestCharacterEncoding()
The default behavior of this method is to call ExternalContext.getRequestCharacterEncoding()
on the wrapped
ExternalContext
object.
getRequestCharacterEncoding
in class ExternalContext
ExternalContext.getRequestCharacterEncoding()
public java.lang.String getRequestContentType()
The default behavior of this method is to call ExternalContext.getRequestContentType()
on the wrapped
ExternalContext
object.
getRequestContentType
in class ExternalContext
ExternalContext.getRequestContentType()
public int getRequestContentLength()
The default behavior of this method is to call ExternalContext.getRequestContentLength()
on the wrapped
ExternalContext
object.
getRequestContentLength
in class ExternalContext
ExternalContext.getRequestContentLength()
public java.lang.String getResponseCharacterEncoding()
The default behavior of this method is to call ExternalContext.getResponseCharacterEncoding()
on the wrapped
ExternalContext
object.
getResponseCharacterEncoding
in class ExternalContext
ExternalContext.getResponseCharacterEncoding()
public java.lang.String getResponseContentType()
The default behavior of this method is to call ExternalContext.getResponseContentType()
on the wrapped
ExternalContext
object.
getResponseContentType
in class ExternalContext
ExternalContext.getResponseContentType()
public void setResponse(java.lang.Object response)
The default behavior of this method is to call ExternalContext.setResponse(Object)
on the wrapped
ExternalContext
object.
setResponse
in class ExternalContext
response
- the response instance to be set.ExternalContext.setResponse(Object)
public java.io.OutputStream getResponseOutputStream() throws java.io.IOException
The default behavior of this method is to call ExternalContext.getResponseOutputStream()
on the wrapped
ExternalContext
object.
getResponseOutputStream
in class ExternalContext
OutputStream
for the current response.java.io.IOException
- any IO related exception.ExternalContext.getResponseOutputStream()
public java.io.Writer getResponseOutputWriter() throws java.io.IOException
The default behavior of this method is to call ExternalContext.getResponseOutputWriter()
on the wrapped
ExternalContext
object.
getResponseOutputWriter
in class ExternalContext
Writer
for the current response.java.io.IOException
- any IO related exception.ExternalContext.getResponseOutputWriter()
public void setResponseCharacterEncoding(java.lang.String encoding)
The default behavior of this method is to call ExternalContext.getResponseCharacterEncoding()
on the wrapped
ExternalContext
object.
setResponseCharacterEncoding
in class ExternalContext
encoding
- the character encoding to be sent by the current response.ExternalContext.getResponseCharacterEncoding()
public void setResponseContentType(java.lang.String contentType)
The default behavior of this method is to call ExternalContext.setResponseContentType(String)
on the wrapped
ExternalContext
object.
setResponseContentType
in class ExternalContext
contentType
- The content type to be set as the contentType of the response.ExternalContext.setResponseContentType(String)
public void invalidateSession()
The default behavior of this method is to call ExternalContext.invalidateSession()
on the wrapped
ExternalContext
object.
invalidateSession
in class ExternalContext
ExternalContext.invalidateSession()
public void setResponseHeader(java.lang.String name, java.lang.String value)
The default behavior of this method is to call ExternalContext.setResponseHeader(String,String)
on the
wrapped ExternalContext
object.
setResponseHeader
in class ExternalContext
name
- The name of the response header.value
- The value of the response header.ExternalContext.setResponseHeader(String,String)
public void addResponseHeader(java.lang.String name, java.lang.String value)
The default behavior of this method is to call ExternalContext.addResponseHeader(String,String)
on the
wrapped ExternalContext
object.
addResponseHeader
in class ExternalContext
name
- The name of the response header.value
- The value of the response header.ExternalContext.addResponseHeader(String,String)
public void setResponseBufferSize(int size)
The default behavior of this method is to call ExternalContext.setResponseBufferSize(int)
on the wrapped
ExternalContext
object.
setResponseBufferSize
in class ExternalContext
size
- the new buffer sizeExternalContext.setResponseBufferSize(int)
public int getResponseBufferSize()
The default behavior of this method is to call ExternalContext.getResponseBufferSize()
on the wrapped
ExternalContext
object.
getResponseBufferSize
in class ExternalContext
ExternalContext.getResponseBufferSize()
public boolean isResponseCommitted()
The default behavior of this method is to call ExternalContext.isResponseCommitted()
on the wrapped
ExternalContext
object.
isResponseCommitted
in class ExternalContext
ExternalContext.isResponseCommitted()
public boolean isSecure()
The default behavior of this method is to call ExternalContext.isSecure()
on the wrapped
ExternalContext
object.
isSecure
in class ExternalContext
public void responseReset()
The default behavior of this method is to call ExternalContext.responseReset()
on the wrapped
ExternalContext
object.
responseReset
in class ExternalContext
ExternalContext.responseReset()
public void responseSendError(int statusCode, java.lang.String message) throws java.io.IOException
The default behavior of this method is to call ExternalContext.responseSendError(int,String)
on the wrapped
ExternalContext
object.
responseSendError
in class ExternalContext
statusCode
- an HTTP status codemessage
- an option message to detail the cause of the codejava.io.IOException
- any IO related exceptions.ExternalContext.responseSendError(int,String)
public void setResponseStatus(int statusCode)
The default behavior of this method is to call ExternalContext.setResponseStatus(int)
on the wrapped
ExternalContext
object.
setResponseStatus
in class ExternalContext
statusCode
- an HTTP status codeExternalContext.setResponseStatus(int)
public void responseFlushBuffer() throws java.io.IOException
The default behavior of this method is to call ExternalContext.responseFlushBuffer()
on
the wrapped ExternalContext
object.
responseFlushBuffer
in class ExternalContext
java.io.IOException
- any IO related exception.ExternalContext.responseFlushBuffer()
public void setResponseContentLength(int length)
The default behavior of this method is to call
ExternalContext.setResponseContentLength(int)
on the wrapped ExternalContext
object.
setResponseContentLength
in class ExternalContext
length
- the value to be set.ExternalContext.setResponseContentLength(int)
public java.lang.String encodeBookmarkableURL(java.lang.String baseUrl, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The default behavior of this method is to call
ExternalContext.encodeBookmarkableURL(String, java.util.Map)
on the wrapped
ExternalContext
object.
encodeBookmarkableURL
in class ExternalContext
baseUrl
- The base URL onto which the query string generated by this method will be appended. The URL may
contain query parameters.parameters
- The collection of Parameter objects, representing name=value pairs that are used to produce a query
stringExternalContext.encodeBookmarkableURL(String, java.util.Map)
public java.lang.String encodeRedirectURL(java.lang.String baseUrl, java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
The default behavior of this method is to call
ExternalContext.encodeRedirectURL(String, java.util.Map)
on the wrapped
ExternalContext
object.
encodeRedirectURL
in class ExternalContext
baseUrl
- The base URL onto which the query string generated by this method will be appended. The URL may
contain query parameters.parameters
- The collection of Parameter objects, representing name=value pairs that are used to produce a query
stringExternalContext.encodeRedirectURL(String, java.util.Map)
public Flash getFlash()
The default behavior of this method is to call ExternalContext.getFlash()
on the wrapped
ExternalContext
object.
getFlash
in class ExternalContext
Flash
for this application.ExternalContext.getFlash()
public void release()
The default behavior of this method is to call ExternalContext.release()
on the wrapped
ExternalContext
object.
release
in class ExternalContext
ExternalContext.release()