Class ExternalContextWrapper
- java.lang.Object
-
- javax.faces.context.ExternalContext
-
- javax.faces.context.ExternalContextWrapper
-
- All Implemented Interfaces:
FacesWrapper<ExternalContext>
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 existingExternalContext
instance. The default implementation of all methods is to call through to the wrappedExternalContext
instance.Usage: extend this class and override
getWrapped()
to return the instance being wrapping.- Since:
- 2.0
-
-
Field Summary
-
Fields inherited from class javax.faces.context.ExternalContext
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
-
Constructor Summary
Constructors Constructor Description ExternalContextWrapper()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method 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 callExternalContext.addResponseCookie(String, String, Map)
on the wrappedExternalContext
object.void
addResponseHeader(java.lang.String name, java.lang.String value)
The default behavior of this method is to callExternalContext.addResponseHeader(String,String)
on the wrappedExternalContext
object.void
dispatch(java.lang.String path)
The default behavior of this method is to callExternalContext.dispatch(String)
on the wrappedExternalContext
object.java.lang.String
encodeActionURL(java.lang.String url)
The default behavior of this method is to callExternalContext.encodeActionURL(String)
on the wrappedExternalContext
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 callExternalContext.encodeBookmarkableURL(String, java.util.Map)
on the wrappedExternalContext
object.java.lang.String
encodeNamespace(java.lang.String name)
The default behavior of this method is to callExternalContext.encodeNamespace(String)
on the wrappedExternalContext
object.java.lang.String
encodePartialActionURL(java.lang.String url)
The default behavior of this method is to callExternalContext.encodePartialActionURL(String)
on the wrappedExternalContext
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 callExternalContext.encodeRedirectURL(String, java.util.Map)
on the wrappedExternalContext
object.java.lang.String
encodeResourceURL(java.lang.String url)
The default behavior of this method is to callExternalContext.encodeResourceURL(String)
on the wrappedExternalContext
object.java.lang.String
getApplicationContextPath()
The default behavior of this method is to callExternalContext.getApplicationContextPath()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.Object>
getApplicationMap()
The default behavior of this method is to callExternalContext.getApplicationMap()
on the wrappedExternalContext
object.java.lang.String
getAuthType()
The default behavior of this method is to callExternalContext.getAuthType()
on the wrappedExternalContext
object.ClientWindow
getClientWindow()
The default behavior of this method is to callExternalContext.getClientWindow()
on the wrappedExternalContext
object.java.lang.Object
getContext()
The default behavior of this method is to callExternalContext.getContext()
on the wrappedExternalContext
object.java.lang.String
getContextName()
The default behavior of this method is to callExternalContext.getContextName()
on the wrappedExternalContext
object.Flash
getFlash()
The default behavior of this method is to callExternalContext.getFlash()
on the wrappedExternalContext
object.java.lang.String
getInitParameter(java.lang.String name)
The default behavior of this method is to callExternalContext.getInitParameter(String)
on the wrappedExternalContext
object.java.util.Map
getInitParameterMap()
The default behavior of this method is to callExternalContext.getInitParameterMap()
on the wrappedExternalContext
object.java.lang.String
getMimeType(java.lang.String file)
The default behavior of this method is to callExternalContext.getMimeType(String)
on the wrappedExternalContext
object.java.lang.String
getRealPath(java.lang.String path)
The default behavior of this method is to callExternalContext.getRealPath(String)
on the wrappedExternalContext
object.java.lang.String
getRemoteUser()
The default behavior of this method is to callExternalContext.getRemoteUser()
on the wrappedExternalContext
object.java.lang.Object
getRequest()
The default behavior of this method is to callExternalContext.getRequest()
on the wrappedExternalContext
object.java.lang.String
getRequestCharacterEncoding()
The default behavior of this method is to callExternalContext.getRequestCharacterEncoding()
on the wrappedExternalContext
object.int
getRequestContentLength()
The default behavior of this method is to callExternalContext.getRequestContentLength()
on the wrappedExternalContext
object.java.lang.String
getRequestContentType()
The default behavior of this method is to callExternalContext.getRequestContentType()
on the wrappedExternalContext
object.java.lang.String
getRequestContextPath()
The default behavior of this method is to callExternalContext.getRequestContextPath()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.Object>
getRequestCookieMap()
The default behavior of this method is to callExternalContext.getRequestCookieMap()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.String>
getRequestHeaderMap()
The default behavior of this method is to callExternalContext.getRequestHeaderMap()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.String[]>
getRequestHeaderValuesMap()
The default behavior of this method is to callExternalContext.getRequestHeaderValuesMap()
on the wrappedExternalContext
object.java.util.Locale
getRequestLocale()
The default behavior of this method is to callExternalContext.getRequestLocale()
on the wrappedExternalContext
object.java.util.Iterator<java.util.Locale>
getRequestLocales()
The default behavior of this method is to callExternalContext.getRequestLocales()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.Object>
getRequestMap()
The default behavior of this method is to callExternalContext.getRequestMap()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.String>
getRequestParameterMap()
The default behavior of this method is to callExternalContext.getRequestParameterMap()
on the wrappedExternalContext
object.java.util.Iterator<java.lang.String>
getRequestParameterNames()
The default behavior of this method is to callExternalContext.getRequestParameterNames()
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.String[]>
getRequestParameterValuesMap()
The default behavior of this method is to callExternalContext.getRequestParameterValuesMap()
on the wrappedExternalContext
object.java.lang.String
getRequestPathInfo()
The default behavior of this method is to callExternalContext.getRequestPathInfo()
on the wrappedExternalContext
object.java.lang.String
getRequestScheme()
The default behavior of this method is to callExternalContext.getRequestScheme()
on the wrappedExternalContext
object.java.lang.String
getRequestServerName()
The default behavior of this method is to callExternalContext.getRequestServerName()
on the wrappedExternalContext
object.int
getRequestServerPort()
The default behavior of this method is to callExternalContext.getRequestServerPort()
on the wrappedExternalContext
object.java.lang.String
getRequestServletPath()
The default behavior of this method is to callExternalContext.getRequestServletPath()
on the wrappedExternalContext
object.java.net.URL
getResource(java.lang.String path)
The default behavior of this method is to callExternalContext.getResource(String)
on the wrappedExternalContext
object.java.io.InputStream
getResourceAsStream(java.lang.String path)
The default behavior of this method is to callExternalContext.getResourceAsStream(String)
on the wrappedExternalContext
object.java.util.Set<java.lang.String>
getResourcePaths(java.lang.String path)
The default behavior of this method is to callExternalContext.getResourcePaths(String)
on the wrappedExternalContext
object.java.lang.Object
getResponse()
The default behavior of this method is to callExternalContext.getResponse()
on the wrappedExternalContext
object.int
getResponseBufferSize()
The default behavior of this method is to callExternalContext.getResponseBufferSize()
on the wrappedExternalContext
object.java.lang.String
getResponseCharacterEncoding()
The default behavior of this method is to callExternalContext.getResponseCharacterEncoding()
on the wrappedExternalContext
object.java.lang.String
getResponseContentType()
The default behavior of this method is to callExternalContext.getResponseContentType()
on the wrappedExternalContext
object.java.io.OutputStream
getResponseOutputStream()
The default behavior of this method is to callExternalContext.getResponseOutputStream()
on the wrappedExternalContext
object.java.io.Writer
getResponseOutputWriter()
The default behavior of this method is to callExternalContext.getResponseOutputWriter()
on the wrappedExternalContext
object.java.lang.Object
getSession(boolean create)
The default behavior of this method is to callExternalContext.getSession(boolean)
on the wrappedExternalContext
object.java.lang.String
getSessionId(boolean create)
The default behavior of this method is to callExternalContext.getSessionId(boolean)
on the wrappedExternalContext
object.java.util.Map<java.lang.String,java.lang.Object>
getSessionMap()
The default behavior of this method is to callExternalContext.getSessionMap()
on the wrappedExternalContext
object.int
getSessionMaxInactiveInterval()
The default behavior of this method is to callExternalContext.getSessionMaxInactiveInterval()
on the wrappedExternalContext
object.java.security.Principal
getUserPrincipal()
The default behavior of this method is to callExternalContext.getUserPrincipal()
on the wrappedExternalContext
object.abstract 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 callExternalContext.invalidateSession()
on the wrappedExternalContext
object.boolean
isResponseCommitted()
The default behavior of this method is to callExternalContext.isResponseCommitted()
on the wrappedExternalContext
object.boolean
isSecure()
The default behavior of this method is to callExternalContext.isSecure()
on the wrappedExternalContext
object.boolean
isUserInRole(java.lang.String role)
The default behavior of this method is to callExternalContext.isUserInRole(String)
on the wrappedExternalContext
object.void
log(java.lang.String message)
The default behavior of this method is to callExternalContext.log(String)
on the wrappedExternalContext
object.void
log(java.lang.String message, java.lang.Throwable exception)
The default behavior of this method is to callExternalContext.log(String, Throwable)
on the wrappedExternalContext
object.void
redirect(java.lang.String url)
The default behavior of this method is to callExternalContext.redirect(String)
on the wrappedExternalContext
object.void
responseFlushBuffer()
The default behavior of this method is to callExternalContext.responseFlushBuffer()
on the wrappedExternalContext
object.void
responseReset()
The default behavior of this method is to callExternalContext.responseReset()
on the wrappedExternalContext
object.void
responseSendError(int statusCode, java.lang.String message)
The default behavior of this method is to callExternalContext.responseSendError(int,String)
on the wrappedExternalContext
object.void
setClientWindow(ClientWindow window)
The default behavior of this method is to callExternalContext.setClientWindow(javax.faces.lifecycle.ClientWindow)
on the wrappedExternalContext
object.void
setRequest(java.lang.Object request)
The default behavior of this method is to callExternalContext.setRequest(Object)
on the wrappedExternalContext
object.void
setRequestCharacterEncoding(java.lang.String encoding)
The default behavior of this method is to callExternalContext.setRequestCharacterEncoding(String)
on the wrappedExternalContext
object.void
setResponse(java.lang.Object response)
The default behavior of this method is to callExternalContext.setResponse(Object)
on the wrappedExternalContext
object.void
setResponseBufferSize(int size)
The default behavior of this method is to callExternalContext.setResponseBufferSize(int)
on the wrappedExternalContext
object.void
setResponseCharacterEncoding(java.lang.String encoding)
The default behavior of this method is to callExternalContext.getResponseCharacterEncoding()
on the wrappedExternalContext
object.void
setResponseContentLength(int length)
The default behavior of this method is to callExternalContext.setResponseContentLength(int)
on the wrappedExternalContext
object.void
setResponseContentType(java.lang.String contentType)
The default behavior of this method is to callExternalContext.setResponseContentType(String)
on the wrappedExternalContext
object.void
setResponseHeader(java.lang.String name, java.lang.String value)
The default behavior of this method is to callExternalContext.setResponseHeader(String,String)
on the wrappedExternalContext
object.void
setResponseStatus(int statusCode)
The default behavior of this method is to callExternalContext.setResponseStatus(int)
on the wrappedExternalContext
object.void
setSessionMaxInactiveInterval(int interval)
The default behavior of this method is to callExternalContext.setSessionMaxInactiveInterval(int)
on the wrappedExternalContext
object.
-
-
-
Method Detail
-
getWrapped
public abstract ExternalContext getWrapped()
Description copied from interface:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<ExternalContext>
- Returns:
- the wrapped
ExternalContext
instance - See Also:
FacesWrapper.getWrapped()
-
dispatch
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 wrappedExternalContext
object.- Specified by:
dispatch
in classExternalContext
- Parameters:
path
- Context relative path to the specified resource, which must start with a slash ("/") character- Throws:
java.io.IOException
- if an input/output error occurs- See Also:
ExternalContext.dispatch(String)
-
encodeActionURL
public java.lang.String encodeActionURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodeActionURL(String)
on the wrappedExternalContext
object.- Specified by:
encodeActionURL
in classExternalContext
- Parameters:
url
- The input URL to be encoded- See Also:
ExternalContext.encodeActionURL(String)
-
encodeNamespace
public java.lang.String encodeNamespace(java.lang.String name)
The default behavior of this method is to call
ExternalContext.encodeNamespace(String)
on the wrappedExternalContext
object.- Specified by:
encodeNamespace
in classExternalContext
- Parameters:
name
- Name to be encoded- See Also:
ExternalContext.encodeNamespace(String)
-
encodePartialActionURL
public java.lang.String encodePartialActionURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodePartialActionURL(String)
on the wrappedExternalContext
object.- Overrides:
encodePartialActionURL
in classExternalContext
- Parameters:
url
- The input URL to be encoded- See Also:
ExternalContext.encodePartialActionURL(String)
-
encodeResourceURL
public java.lang.String encodeResourceURL(java.lang.String url)
The default behavior of this method is to call
ExternalContext.encodeResourceURL(String)
on the wrappedExternalContext
object.- Specified by:
encodeResourceURL
in classExternalContext
- Parameters:
url
- The input URL to be encoded- See Also:
ExternalContext.encodeResourceURL(String)
-
getApplicationMap
public java.util.Map<java.lang.String,java.lang.Object> getApplicationMap()
The default behavior of this method is to call
ExternalContext.getApplicationMap()
on the wrappedExternalContext
object.- Specified by:
getApplicationMap
in classExternalContext
- See Also:
ExternalContext.getApplicationMap()
-
getApplicationContextPath
public java.lang.String getApplicationContextPath()
The default behavior of this method is to call
ExternalContext.getApplicationContextPath()
on the wrappedExternalContext
object.- Overrides:
getApplicationContextPath
in classExternalContext
- See Also:
ExternalContext.getApplicationContextPath()
-
getAuthType
public java.lang.String getAuthType()
The default behavior of this method is to call
ExternalContext.getAuthType()
on the wrappedExternalContext
object.- Specified by:
getAuthType
in classExternalContext
- See Also:
ExternalContext.getAuthType()
-
getContext
public java.lang.Object getContext()
The default behavior of this method is to call
ExternalContext.getContext()
on the wrappedExternalContext
object.- Specified by:
getContext
in classExternalContext
- See Also:
ExternalContext.getContext()
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
The default behavior of this method is to call
ExternalContext.getInitParameter(String)
on the wrappedExternalContext
object.- Specified by:
getInitParameter
in classExternalContext
- Parameters:
name
- Name of the requested initialization parameter- See Also:
ExternalContext.getInitParameter(String)
-
getInitParameterMap
public java.util.Map getInitParameterMap()
The default behavior of this method is to call
ExternalContext.getInitParameterMap()
on the wrappedExternalContext
object.- Specified by:
getInitParameterMap
in classExternalContext
- See Also:
ExternalContext.getInitParameterMap()
-
getRemoteUser
public java.lang.String getRemoteUser()
The default behavior of this method is to call
ExternalContext.getRemoteUser()
on the wrappedExternalContext
object.- Specified by:
getRemoteUser
in classExternalContext
- See Also:
ExternalContext.getRemoteUser()
-
getRequest
public java.lang.Object getRequest()
The default behavior of this method is to call
ExternalContext.getRequest()
on the wrappedExternalContext
object.- Specified by:
getRequest
in classExternalContext
- See Also:
ExternalContext.getRequest()
-
getRequestContextPath
public java.lang.String getRequestContextPath()
The default behavior of this method is to call
ExternalContext.getRequestContextPath()
on the wrappedExternalContext
object.- Specified by:
getRequestContextPath
in classExternalContext
- See Also:
ExternalContext.getRequestContextPath()
-
getRequestCookieMap
public java.util.Map<java.lang.String,java.lang.Object> getRequestCookieMap()
The default behavior of this method is to call
ExternalContext.getRequestCookieMap()
on the wrappedExternalContext
object.- Specified by:
getRequestCookieMap
in classExternalContext
- See Also:
ExternalContext.getRequestCookieMap()
-
getRequestHeaderMap
public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()
The default behavior of this method is to call
ExternalContext.getRequestHeaderMap()
on the wrappedExternalContext
object.- Specified by:
getRequestHeaderMap
in classExternalContext
- See Also:
ExternalContext.getRequestHeaderMap()
-
getRequestHeaderValuesMap
public java.util.Map<java.lang.String,java.lang.String[]> getRequestHeaderValuesMap()
The default behavior of this method is to call
ExternalContext.getRequestHeaderValuesMap()
on the wrappedExternalContext
object.- Specified by:
getRequestHeaderValuesMap
in classExternalContext
- See Also:
ExternalContext.getRequestHeaderValuesMap()
-
getRequestLocale
public java.util.Locale getRequestLocale()
The default behavior of this method is to call
ExternalContext.getRequestLocale()
on the wrappedExternalContext
object.- Specified by:
getRequestLocale
in classExternalContext
- See Also:
ExternalContext.getRequestLocale()
-
getRequestLocales
public java.util.Iterator<java.util.Locale> getRequestLocales()
The default behavior of this method is to call
ExternalContext.getRequestLocales()
on the wrappedExternalContext
object.- Specified by:
getRequestLocales
in classExternalContext
- See Also:
ExternalContext.getRequestLocales()
-
getRequestMap
public java.util.Map<java.lang.String,java.lang.Object> getRequestMap()
The default behavior of this method is to call
ExternalContext.getRequestMap()
on the wrappedExternalContext
object.- Specified by:
getRequestMap
in classExternalContext
- See Also:
ExternalContext.getRequestMap()
-
getRequestParameterMap
public java.util.Map<java.lang.String,java.lang.String> getRequestParameterMap()
The default behavior of this method is to call
ExternalContext.getRequestParameterMap()
on the wrappedExternalContext
object.- Specified by:
getRequestParameterMap
in classExternalContext
- See Also:
ExternalContext.getRequestParameterMap()
-
getRequestParameterNames
public java.util.Iterator<java.lang.String> getRequestParameterNames()
The default behavior of this method is to call
ExternalContext.getRequestParameterNames()
on the wrappedExternalContext
object.- Specified by:
getRequestParameterNames
in classExternalContext
- See Also:
ExternalContext.getRequestParameterNames()
-
getRequestParameterValuesMap
public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterValuesMap()
The default behavior of this method is to call
ExternalContext.getRequestParameterValuesMap()
on the wrappedExternalContext
object.- Specified by:
getRequestParameterValuesMap
in classExternalContext
- See Also:
ExternalContext.getRequestParameterValuesMap()
-
getRequestPathInfo
public java.lang.String getRequestPathInfo()
The default behavior of this method is to call
ExternalContext.getRequestPathInfo()
on the wrappedExternalContext
object.- Specified by:
getRequestPathInfo
in classExternalContext
- See Also:
ExternalContext.getRequestPathInfo()
-
getRequestServletPath
public java.lang.String getRequestServletPath()
The default behavior of this method is to call
ExternalContext.getRequestServletPath()
on the wrappedExternalContext
object.- Specified by:
getRequestServletPath
in classExternalContext
- See Also:
ExternalContext.getRequestServletPath()
-
getResource
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 wrappedExternalContext
object.- Specified by:
getResource
in classExternalContext
- Parameters:
path
- The path to the requested resource, which must start with a slash ("/" character- Throws:
java.net.MalformedURLException
- if the specified path is not in the correct form- See Also:
ExternalContext.getResource(String)
-
getResourceAsStream
public java.io.InputStream getResourceAsStream(java.lang.String path)
The default behavior of this method is to call
ExternalContext.getResourceAsStream(String)
on the wrappedExternalContext
object.- Specified by:
getResourceAsStream
in classExternalContext
- Parameters:
path
- The path to the requested resource, which must start with a slash ("/" character- See Also:
ExternalContext.getResourceAsStream(String)
-
getResourcePaths
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 wrappedExternalContext
object.- Specified by:
getResourcePaths
in classExternalContext
- Parameters:
path
- Partial path used to match resources, which must start with a slash ("/") character- See Also:
ExternalContext.getResourcePaths(String)
-
getResponse
public java.lang.Object getResponse()
The default behavior of this method is to call
ExternalContext.getResponse()
on the wrappedExternalContext
object.- Specified by:
getResponse
in classExternalContext
- See Also:
ExternalContext.getResponse()
-
getSession
public java.lang.Object getSession(boolean create)
The default behavior of this method is to call
ExternalContext.getSession(boolean)
on the wrappedExternalContext
object.- Specified by:
getSession
in classExternalContext
- Parameters:
create
- Flag indicating whether or not a new session should be created if there is no session associated with the current request- See Also:
ExternalContext.getSession(boolean)
-
getSessionId
public java.lang.String getSessionId(boolean create)
The default behavior of this method is to call
ExternalContext.getSessionId(boolean)
on the wrappedExternalContext
object.- Overrides:
getSessionId
in classExternalContext
- Parameters:
create
- Flag indicating whether or not a new session should be created if there is no session associated with the current request- Since:
- 2.2
- See Also:
ExternalContext.getSessionId(boolean)
-
getSessionMap
public java.util.Map<java.lang.String,java.lang.Object> getSessionMap()
The default behavior of this method is to call
ExternalContext.getSessionMap()
on the wrappedExternalContext
object.- Specified by:
getSessionMap
in classExternalContext
- See Also:
ExternalContext.getSessionMap()
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()
The default behavior of this method is to call
ExternalContext.getSessionMaxInactiveInterval()
on the wrappedExternalContext
object.- Overrides:
getSessionMaxInactiveInterval
in classExternalContext
- See Also:
ExternalContext.getSessionMaxInactiveInterval()
-
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval)
The default behavior of this method is to call
ExternalContext.setSessionMaxInactiveInterval(int)
on the wrappedExternalContext
object.- Overrides:
setSessionMaxInactiveInterval
in classExternalContext
- See Also:
ExternalContext.setSessionMaxInactiveInterval(int)
-
setClientWindow
public void setClientWindow(ClientWindow window)
The default behavior of this method is to call
ExternalContext.setClientWindow(javax.faces.lifecycle.ClientWindow)
on the wrappedExternalContext
object.- Overrides:
setClientWindow
in classExternalContext
- Parameters:
window
- the window associated with this request.- Since:
- 2.2
-
getUserPrincipal
public java.security.Principal getUserPrincipal()
The default behavior of this method is to call
ExternalContext.getUserPrincipal()
on the wrappedExternalContext
object.- Specified by:
getUserPrincipal
in classExternalContext
- See Also:
ExternalContext.getUserPrincipal()
-
getClientWindow
public ClientWindow getClientWindow()
The default behavior of this method is to call
ExternalContext.getClientWindow()
on the wrappedExternalContext
object.- Overrides:
getClientWindow
in classExternalContext
- Since:
- 2.2
- See Also:
ExternalContext.getClientWindow()
-
isUserInRole
public boolean isUserInRole(java.lang.String role)
The default behavior of this method is to call
ExternalContext.isUserInRole(String)
on the wrappedExternalContext
object.- Specified by:
isUserInRole
in classExternalContext
- Parameters:
role
- Logical role name to be checked- See Also:
ExternalContext.isUserInRole(String)
-
log
public void log(java.lang.String message)
The default behavior of this method is to call
ExternalContext.log(String)
on the wrappedExternalContext
object.- Specified by:
log
in classExternalContext
- Parameters:
message
- Message to be logged- See Also:
ExternalContext.log(String)
-
log
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 wrappedExternalContext
object.- Specified by:
log
in classExternalContext
- Parameters:
message
- Message to be loggedexception
- Exception to be logged- See Also:
ExternalContext.log(String, Throwable)
-
redirect
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 wrappedExternalContext
object.- Specified by:
redirect
in classExternalContext
- Parameters:
url
- Absolute URL to which the client should be redirected- Throws:
java.io.IOException
- if an input/output error occurs- See Also:
ExternalContext.redirect(String)
-
addResponseCookie
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 wrappedExternalContext
object.- Overrides:
addResponseCookie
in classExternalContext
- Parameters:
name
- To be passed as the first argument to theCookie
constructor.value
- To be passed as the second argument to theCookie
constructor.properties
- AMap
containg key/value pairs to be passed as arguments to the setter methods as described above.- See Also:
ExternalContext.addResponseCookie(String, String, Map)
-
getMimeType
public java.lang.String getMimeType(java.lang.String file)
The default behavior of this method is to call
ExternalContext.getMimeType(String)
on the wrappedExternalContext
object.- Overrides:
getMimeType
in classExternalContext
- Parameters:
file
- The file for which the mime type should be obtained.- See Also:
ExternalContext.getMimeType(String)
-
getContextName
public java.lang.String getContextName()
The default behavior of this method is to call
ExternalContext.getContextName()
on the wrappedExternalContext
object.- Overrides:
getContextName
in classExternalContext
- See Also:
ExternalContext.getContextName()
-
setRequest
public void setRequest(java.lang.Object request)
The default behavior of this method is to call
ExternalContext.setRequest(Object)
on the wrappedExternalContext
object.- Overrides:
setRequest
in classExternalContext
- See Also:
ExternalContext.setRequest(Object)
-
getRequestScheme
public java.lang.String getRequestScheme()
The default behavior of this method is to call
ExternalContext.getRequestScheme()
on the wrappedExternalContext
object.- Overrides:
getRequestScheme
in classExternalContext
- See Also:
ExternalContext.getRequestScheme()
-
getRequestServerName
public java.lang.String getRequestServerName()
The default behavior of this method is to call
ExternalContext.getRequestServerName()
on the wrappedExternalContext
object.- Overrides:
getRequestServerName
in classExternalContext
- See Also:
ExternalContext.getRequestServerName()
-
getRequestServerPort
public int getRequestServerPort()
The default behavior of this method is to call
ExternalContext.getRequestServerPort()
on the wrappedExternalContext
object.- Overrides:
getRequestServerPort
in classExternalContext
- See Also:
ExternalContext.getRequestServerPort()
-
setRequestCharacterEncoding
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 wrappedExternalContext
object.- Overrides:
setRequestCharacterEncoding
in classExternalContext
- Throws:
java.io.UnsupportedEncodingException
- if this is not a valid encoding- See Also:
ExternalContext.setRequestCharacterEncoding(String)
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
The default behavior of this method is to call
ExternalContext.getRealPath(String)
on the wrappedExternalContext
object.- Overrides:
getRealPath
in classExternalContext
- Parameters:
path
- The context of the requested initialization parameter- See Also:
ExternalContext.getRealPath(String)
-
getRequestCharacterEncoding
public java.lang.String getRequestCharacterEncoding()
The default behavior of this method is to call
ExternalContext.getRequestCharacterEncoding()
on the wrappedExternalContext
object.- Overrides:
getRequestCharacterEncoding
in classExternalContext
- See Also:
ExternalContext.getRequestCharacterEncoding()
-
getRequestContentType
public java.lang.String getRequestContentType()
The default behavior of this method is to call
ExternalContext.getRequestContentType()
on the wrappedExternalContext
object.- Overrides:
getRequestContentType
in classExternalContext
- See Also:
ExternalContext.getRequestContentType()
-
getRequestContentLength
public int getRequestContentLength()
The default behavior of this method is to call
ExternalContext.getRequestContentLength()
on the wrappedExternalContext
object.- Overrides:
getRequestContentLength
in classExternalContext
- See Also:
ExternalContext.getRequestContentLength()
-
getResponseCharacterEncoding
public java.lang.String getResponseCharacterEncoding()
The default behavior of this method is to call
ExternalContext.getResponseCharacterEncoding()
on the wrappedExternalContext
object.- Overrides:
getResponseCharacterEncoding
in classExternalContext
- See Also:
ExternalContext.getResponseCharacterEncoding()
-
getResponseContentType
public java.lang.String getResponseContentType()
The default behavior of this method is to call
ExternalContext.getResponseContentType()
on the wrappedExternalContext
object.- Overrides:
getResponseContentType
in classExternalContext
- See Also:
ExternalContext.getResponseContentType()
-
setResponse
public void setResponse(java.lang.Object response)
The default behavior of this method is to call
ExternalContext.setResponse(Object)
on the wrappedExternalContext
object.- Overrides:
setResponse
in classExternalContext
- See Also:
ExternalContext.setResponse(Object)
-
getResponseOutputStream
public java.io.OutputStream getResponseOutputStream() throws java.io.IOException
The default behavior of this method is to call
ExternalContext.getResponseOutputStream()
on the wrappedExternalContext
object.- Overrides:
getResponseOutputStream
in classExternalContext
- Throws:
java.io.IOException
- See Also:
ExternalContext.getResponseOutputStream()
-
getResponseOutputWriter
public java.io.Writer getResponseOutputWriter() throws java.io.IOException
The default behavior of this method is to call
ExternalContext.getResponseOutputWriter()
on the wrappedExternalContext
object.- Overrides:
getResponseOutputWriter
in classExternalContext
- Throws:
java.io.IOException
- See Also:
ExternalContext.getResponseOutputWriter()
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(java.lang.String encoding)
The default behavior of this method is to call
ExternalContext.getResponseCharacterEncoding()
on the wrappedExternalContext
object.- Overrides:
setResponseCharacterEncoding
in classExternalContext
- See Also:
ExternalContext.getResponseCharacterEncoding()
-
setResponseContentType
public void setResponseContentType(java.lang.String contentType)
The default behavior of this method is to call
ExternalContext.setResponseContentType(String)
on the wrappedExternalContext
object.- Overrides:
setResponseContentType
in classExternalContext
- Parameters:
contentType
- The content type to be set as the contentType of the response.- See Also:
ExternalContext.setResponseContentType(String)
-
invalidateSession
public void invalidateSession()
The default behavior of this method is to call
ExternalContext.invalidateSession()
on the wrappedExternalContext
object.- Overrides:
invalidateSession
in classExternalContext
- See Also:
ExternalContext.invalidateSession()
-
setResponseHeader
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 wrappedExternalContext
object.- Overrides:
setResponseHeader
in classExternalContext
- Parameters:
name
- The name of the response header.value
- The value of the response header.- See Also:
ExternalContext.setResponseHeader(String,String)
-
addResponseHeader
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 wrappedExternalContext
object.- Overrides:
addResponseHeader
in classExternalContext
- Parameters:
name
- The name of the response header.value
- The value of the response header.- See Also:
ExternalContext.addResponseHeader(String,String)
-
setResponseBufferSize
public void setResponseBufferSize(int size)
The default behavior of this method is to call
ExternalContext.setResponseBufferSize(int)
on the wrappedExternalContext
object.- Overrides:
setResponseBufferSize
in classExternalContext
- Parameters:
size
- the new buffer size- See Also:
ExternalContext.setResponseBufferSize(int)
-
getResponseBufferSize
public int getResponseBufferSize()
The default behavior of this method is to call
ExternalContext.getResponseBufferSize()
on the wrappedExternalContext
object.- Overrides:
getResponseBufferSize
in classExternalContext
- See Also:
ExternalContext.getResponseBufferSize()
-
isResponseCommitted
public boolean isResponseCommitted()
The default behavior of this method is to call
ExternalContext.isResponseCommitted()
on the wrappedExternalContext
object.- Overrides:
isResponseCommitted
in classExternalContext
- See Also:
ExternalContext.isResponseCommitted()
-
isSecure
public boolean isSecure()
The default behavior of this method is to call
ExternalContext.isSecure()
on the wrappedExternalContext
object.- Overrides:
isSecure
in classExternalContext
-
responseReset
public void responseReset()
The default behavior of this method is to call
ExternalContext.responseReset()
on the wrappedExternalContext
object.- Overrides:
responseReset
in classExternalContext
- See Also:
ExternalContext.responseReset()
-
responseSendError
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 wrappedExternalContext
object.- Overrides:
responseSendError
in classExternalContext
- Parameters:
statusCode
- an HTTP status codemessage
- an option message to detail the cause of the code- Throws:
java.io.IOException
- See Also:
ExternalContext.responseSendError(int,String)
-
setResponseStatus
public void setResponseStatus(int statusCode)
The default behavior of this method is to call
ExternalContext.setResponseStatus(int)
on the wrappedExternalContext
object.- Overrides:
setResponseStatus
in classExternalContext
- Parameters:
statusCode
- an HTTP status code- See Also:
ExternalContext.setResponseStatus(int)
-
responseFlushBuffer
public void responseFlushBuffer() throws java.io.IOException
The default behavior of this method is to call
ExternalContext.responseFlushBuffer()
on the wrappedExternalContext
object.- Overrides:
responseFlushBuffer
in classExternalContext
- Throws:
java.io.IOException
- See Also:
ExternalContext.responseFlushBuffer()
-
setResponseContentLength
public void setResponseContentLength(int length)
The default behavior of this method is to call
ExternalContext.setResponseContentLength(int)
on the wrappedExternalContext
object.- Overrides:
setResponseContentLength
in classExternalContext
- See Also:
ExternalContext.setResponseContentLength(int)
-
encodeBookmarkableURL
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 wrappedExternalContext
object.- Overrides:
encodeBookmarkableURL
in classExternalContext
- Parameters:
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 string- See Also:
ExternalContext.encodeBookmarkableURL(String, java.util.Map)
-
encodeRedirectURL
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 wrappedExternalContext
object.- Overrides:
encodeRedirectURL
in classExternalContext
- Parameters:
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 string- See Also:
ExternalContext.encodeRedirectURL(String, java.util.Map)
-
getFlash
public Flash getFlash()
The default behavior of this method is to call
ExternalContext.getFlash()
on the wrappedExternalContext
object.- Overrides:
getFlash
in classExternalContext
- See Also:
ExternalContext.getFlash()
-
-