Package jakarta.faces.context
Class ExternalContextWrapper
- java.lang.Object
-
- jakarta.faces.context.ExternalContext
-
- jakarta.faces.context.ExternalContextWrapper
-
- All Implemented Interfaces:
FacesWrapper<ExternalContext>
public abstract class ExternalContextWrapper extends ExternalContext implements FacesWrapper<ExternalContext>
- Since:
- 2.0
-
-
Field Summary
-
Fields inherited from class jakarta.faces.context.ExternalContext
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
-
Constructor Summary
Constructors Constructor Description ExternalContextWrapper()
Deprecated.ExternalContextWrapper(ExternalContext delegate)
-
Method Summary
-
-
-
Constructor Detail
-
ExternalContextWrapper
@Deprecated public ExternalContextWrapper()
Deprecated.
-
ExternalContextWrapper
public ExternalContextWrapper(ExternalContext delegate)
-
-
Method Detail
-
addResponseCookie
public void addResponseCookie(String name, String value, Map<String,Object> properties)
- Overrides:
addResponseCookie
in classExternalContext
-
addResponseHeader
public void addResponseHeader(String name, String value)
- Overrides:
addResponseHeader
in classExternalContext
-
dispatch
public void dispatch(String path) throws IOException
- Specified by:
dispatch
in classExternalContext
- Throws:
IOException
-
encodeActionURL
public String encodeActionURL(String url)
- Specified by:
encodeActionURL
in classExternalContext
-
encodeBookmarkableURL
public String encodeBookmarkableURL(String baseUrl, Map<String,List<String>> parameters)
- Overrides:
encodeBookmarkableURL
in classExternalContext
-
encodeNamespace
public String encodeNamespace(String name)
- Specified by:
encodeNamespace
in classExternalContext
-
encodePartialActionURL
public String encodePartialActionURL(String url)
- Overrides:
encodePartialActionURL
in classExternalContext
-
encodeRedirectURL
public String encodeRedirectURL(String baseUrl, Map<String,List<String>> parameters)
- Overrides:
encodeRedirectURL
in classExternalContext
-
encodeResourceURL
public String encodeResourceURL(String url)
- Specified by:
encodeResourceURL
in classExternalContext
-
getApplicationMap
public Map<String,Object> getApplicationMap()
- Specified by:
getApplicationMap
in classExternalContext
-
getAuthType
public String getAuthType()
- Specified by:
getAuthType
in classExternalContext
-
getContext
public Object getContext()
- Specified by:
getContext
in classExternalContext
-
getContextName
public String getContextName()
Description copied from class:ExternalContext
Returns the name of the underlying context- Overrides:
getContextName
in classExternalContext
- Returns:
- the name or null
-
getFlash
public Flash getFlash()
- Overrides:
getFlash
in classExternalContext
-
getInitParameter
public String getInitParameter(String name)
- Specified by:
getInitParameter
in classExternalContext
-
getInitParameterMap
public Map getInitParameterMap()
- Specified by:
getInitParameterMap
in classExternalContext
-
getMimeType
public String getMimeType(String file)
- Overrides:
getMimeType
in classExternalContext
-
getRealPath
public String getRealPath(String path)
- Overrides:
getRealPath
in classExternalContext
-
getRemoteUser
public String getRemoteUser()
- Specified by:
getRemoteUser
in classExternalContext
-
getRequest
public Object getRequest()
- Specified by:
getRequest
in classExternalContext
-
getRequestCharacterEncoding
public String getRequestCharacterEncoding()
- Overrides:
getRequestCharacterEncoding
in classExternalContext
-
getRequestContentLength
public int getRequestContentLength()
- Overrides:
getRequestContentLength
in classExternalContext
- Returns:
-
getRequestContentType
public String getRequestContentType()
- Overrides:
getRequestContentType
in classExternalContext
-
getRequestContextPath
public String getRequestContextPath()
- Specified by:
getRequestContextPath
in classExternalContext
-
getRequestCookieMap
public Map<String,Object> getRequestCookieMap()
- Specified by:
getRequestCookieMap
in classExternalContext
-
getRequestHeaderMap
public Map<String,String> getRequestHeaderMap()
- Specified by:
getRequestHeaderMap
in classExternalContext
-
getRequestHeaderValuesMap
public Map<String,String[]> getRequestHeaderValuesMap()
- Specified by:
getRequestHeaderValuesMap
in classExternalContext
-
getRequestLocale
public Locale getRequestLocale()
- Specified by:
getRequestLocale
in classExternalContext
-
getRequestLocales
public Iterator<Locale> getRequestLocales()
- Specified by:
getRequestLocales
in classExternalContext
-
getRequestMap
public Map<String,Object> getRequestMap()
- Specified by:
getRequestMap
in classExternalContext
-
getRequestParameterMap
public Map<String,String> getRequestParameterMap()
- Specified by:
getRequestParameterMap
in classExternalContext
-
getRequestParameterNames
public Iterator<String> getRequestParameterNames()
- Specified by:
getRequestParameterNames
in classExternalContext
-
getRequestParameterValuesMap
public Map<String,String[]> getRequestParameterValuesMap()
- Specified by:
getRequestParameterValuesMap
in classExternalContext
-
getRequestPathInfo
public String getRequestPathInfo()
- Specified by:
getRequestPathInfo
in classExternalContext
-
getRequestScheme
public String getRequestScheme()
- Overrides:
getRequestScheme
in classExternalContext
-
getRequestServerName
public String getRequestServerName()
- Overrides:
getRequestServerName
in classExternalContext
-
getRequestServerPort
public int getRequestServerPort()
- Overrides:
getRequestServerPort
in classExternalContext
-
getRequestServletPath
public String getRequestServletPath()
- Specified by:
getRequestServletPath
in classExternalContext
-
getResource
public URL getResource(String path) throws MalformedURLException
- Specified by:
getResource
in classExternalContext
- Throws:
MalformedURLException
-
getResourceAsStream
public InputStream getResourceAsStream(String path)
- Specified by:
getResourceAsStream
in classExternalContext
-
getResourcePaths
public Set<String> getResourcePaths(String path)
- Specified by:
getResourcePaths
in classExternalContext
-
getResponse
public Object getResponse()
- Specified by:
getResponse
in classExternalContext
-
getResponseBufferSize
public int getResponseBufferSize()
- Overrides:
getResponseBufferSize
in classExternalContext
- Returns:
-
getResponseCharacterEncoding
public String getResponseCharacterEncoding()
- Overrides:
getResponseCharacterEncoding
in classExternalContext
-
getResponseContentType
public String getResponseContentType()
Description copied from class:ExternalContext
throwsUnsupportedOperationException
by default.- Overrides:
getResponseContentType
in classExternalContext
-
getResponseOutputStream
public OutputStream getResponseOutputStream() throws IOException
- Overrides:
getResponseOutputStream
in classExternalContext
- Throws:
IOException
-
getResponseOutputWriter
public Writer getResponseOutputWriter() throws IOException
- Overrides:
getResponseOutputWriter
in classExternalContext
- Throws:
IOException
-
getSession
public Object getSession(boolean create)
- Specified by:
getSession
in classExternalContext
-
getSessionMap
public Map<String,Object> getSessionMap()
- Specified by:
getSessionMap
in classExternalContext
-
getUserPrincipal
public Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in classExternalContext
-
getWrapped
public 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 instance of the class being wrapped
-
invalidateSession
public void invalidateSession()
- Overrides:
invalidateSession
in classExternalContext
-
isResponseCommitted
public boolean isResponseCommitted()
- Overrides:
isResponseCommitted
in classExternalContext
-
isUserInRole
public boolean isUserInRole(String role)
- Specified by:
isUserInRole
in classExternalContext
-
log
public void log(String message, Throwable exception)
- Specified by:
log
in classExternalContext
-
log
public void log(String message)
- Specified by:
log
in classExternalContext
-
redirect
public void redirect(String url) throws IOException
- Specified by:
redirect
in classExternalContext
- Throws:
IOException
-
responseFlushBuffer
public void responseFlushBuffer() throws IOException
- Overrides:
responseFlushBuffer
in classExternalContext
- Throws:
IOException
-
responseReset
public void responseReset()
- Overrides:
responseReset
in classExternalContext
-
responseSendError
public void responseSendError(int statusCode, String message) throws IOException
- Overrides:
responseSendError
in classExternalContext
- Throws:
IOException
-
setRequest
public void setRequest(Object request)
Description copied from class:ExternalContext
throwsUnsupportedOperationException
by default.- Overrides:
setRequest
in classExternalContext
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(String encoding) throws UnsupportedEncodingException
Description copied from class:ExternalContext
throwsUnsupportedOperationException
by default.- Overrides:
setRequestCharacterEncoding
in classExternalContext
- Throws:
UnsupportedEncodingException
-
setResponse
public void setResponse(Object response)
Description copied from class:ExternalContext
throwsUnsupportedOperationException
by default.- Overrides:
setResponse
in classExternalContext
-
setResponseBufferSize
public void setResponseBufferSize(int size)
- Overrides:
setResponseBufferSize
in classExternalContext
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(String encoding)
Description copied from class:ExternalContext
throwsUnsupportedOperationException
by default.- Overrides:
setResponseCharacterEncoding
in classExternalContext
-
setResponseContentLength
public void setResponseContentLength(int length)
- Overrides:
setResponseContentLength
in classExternalContext
-
setResponseContentType
public void setResponseContentType(String contentType)
- Overrides:
setResponseContentType
in classExternalContext
-
setResponseHeader
public void setResponseHeader(String name, String value)
- Overrides:
setResponseHeader
in classExternalContext
-
setResponseStatus
public void setResponseStatus(int statusCode)
- Overrides:
setResponseStatus
in classExternalContext
-
isSecure
public boolean isSecure()
- Overrides:
isSecure
in classExternalContext
- Returns:
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()
- Overrides:
getSessionMaxInactiveInterval
in classExternalContext
- Returns:
-
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval)
- Overrides:
setSessionMaxInactiveInterval
in classExternalContext
-
getClientWindow
public ClientWindow getClientWindow()
- Overrides:
getClientWindow
in classExternalContext
- Returns:
-
setClientWindow
public void setClientWindow(ClientWindow window)
- Overrides:
setClientWindow
in classExternalContext
-
getSessionId
public String getSessionId(boolean create)
- Overrides:
getSessionId
in classExternalContext
- Returns:
-
getApplicationContextPath
public String getApplicationContextPath()
- Overrides:
getApplicationContextPath
in classExternalContext
- Returns:
-
encodeWebsocketURL
public String encodeWebsocketURL(String url)
- Specified by:
encodeWebsocketURL
in classExternalContext
- Returns:
-
release
public void release()
- Specified by:
release
in classExternalContext
- Since:
- 4.0
-
-