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 -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidaddResponseHeader(String name, String value) voidencodeActionURL(String url) encodeNamespace(String name) encodeResourceURL(String url) encodeWebsocketURL(String url) Returns the name of the underlying contextgetFlash()getInitParameter(String name) getMimeType(String file) getRealPath(String path) intintgetResource(String path) getResourceAsStream(String path) getResourcePaths(String path) intthrowsUnsupportedOperationExceptionby default.getSession(boolean create) getSessionId(boolean create) intA class that implements this interface uses this method to return an instance of the class being wrapped.voidbooleanbooleanisSecure()booleanisUserInRole(String role) voidvoidvoidvoidrelease()voidvoidvoidresponseSendError(int statusCode, String message) voidsetClientWindow(ClientWindow window) voidsetRequest(Object request) throwsUnsupportedOperationExceptionby default.voidsetRequestCharacterEncoding(String encoding) throwsUnsupportedOperationExceptionby default.voidsetResponse(Object response) throwsUnsupportedOperationExceptionby default.voidsetResponseBufferSize(int size) voidsetResponseCharacterEncoding(String encoding) throwsUnsupportedOperationExceptionby default.voidsetResponseContentLength(int length) voidsetResponseContentLengthLong(long length) voidsetResponseContentType(String contentType) voidsetResponseHeader(String name, String value) voidsetResponseStatus(int statusCode) voidsetSessionMaxInactiveInterval(int interval)
-
Constructor Details
-
ExternalContextWrapper
Deprecated. -
ExternalContextWrapper
-
-
Method Details
-
addResponseCookie
- Overrides:
addResponseCookiein classExternalContext
-
addResponseHeader
- Overrides:
addResponseHeaderin classExternalContext
-
dispatch
- Specified by:
dispatchin classExternalContext- Throws:
IOException
-
encodeActionURL
- Specified by:
encodeActionURLin classExternalContext
-
encodeBookmarkableURL
- Overrides:
encodeBookmarkableURLin classExternalContext
-
encodeNamespace
- Specified by:
encodeNamespacein classExternalContext
-
encodePartialActionURL
- Overrides:
encodePartialActionURLin classExternalContext
-
encodeRedirectURL
- Overrides:
encodeRedirectURLin classExternalContext
-
encodeResourceURL
- Specified by:
encodeResourceURLin classExternalContext
-
getApplicationMap
- Specified by:
getApplicationMapin classExternalContext
-
getAuthType
- Specified by:
getAuthTypein classExternalContext
-
getContext
- Specified by:
getContextin classExternalContext
-
getContextName
Description copied from class:ExternalContextReturns the name of the underlying context- Overrides:
getContextNamein classExternalContext- Returns:
- the name or null
-
getFlash
- Overrides:
getFlashin classExternalContext
-
getInitParameter
- Specified by:
getInitParameterin classExternalContext
-
getInitParameterMap
- Specified by:
getInitParameterMapin classExternalContext
-
getMimeType
- Overrides:
getMimeTypein classExternalContext
-
getRealPath
- Overrides:
getRealPathin classExternalContext
-
getRemoteUser
- Specified by:
getRemoteUserin classExternalContext
-
getRequest
- Specified by:
getRequestin classExternalContext
-
getRequestCharacterEncoding
- Overrides:
getRequestCharacterEncodingin classExternalContext
-
getRequestContentLength
public int getRequestContentLength()- Overrides:
getRequestContentLengthin classExternalContext- Returns:
-
getRequestContentType
- Overrides:
getRequestContentTypein classExternalContext
-
getRequestContextPath
- Specified by:
getRequestContextPathin classExternalContext
-
getRequestCookieMap
- Specified by:
getRequestCookieMapin classExternalContext
-
getRequestHeaderMap
- Specified by:
getRequestHeaderMapin classExternalContext
-
getRequestHeaderValuesMap
- Specified by:
getRequestHeaderValuesMapin classExternalContext
-
getRequestLocale
- Specified by:
getRequestLocalein classExternalContext
-
getRequestLocales
- Specified by:
getRequestLocalesin classExternalContext
-
getRequestMap
- Specified by:
getRequestMapin classExternalContext
-
getRequestParameterMap
- Specified by:
getRequestParameterMapin classExternalContext
-
getRequestParameterNames
- Specified by:
getRequestParameterNamesin classExternalContext
-
getRequestParameterValuesMap
- Specified by:
getRequestParameterValuesMapin classExternalContext
-
getRequestPathInfo
- Specified by:
getRequestPathInfoin classExternalContext
-
getRequestScheme
- Overrides:
getRequestSchemein classExternalContext
-
getRequestServerName
- Overrides:
getRequestServerNamein classExternalContext
-
getRequestServerPort
public int getRequestServerPort()- Overrides:
getRequestServerPortin classExternalContext
-
getRequestServletPath
- Specified by:
getRequestServletPathin classExternalContext
-
getResource
- Specified by:
getResourcein classExternalContext- Throws:
MalformedURLException
-
getResourceAsStream
- Specified by:
getResourceAsStreamin classExternalContext
-
getResourcePaths
- Specified by:
getResourcePathsin classExternalContext
-
getResponse
- Specified by:
getResponsein classExternalContext
-
getResponseBufferSize
public int getResponseBufferSize()- Overrides:
getResponseBufferSizein classExternalContext- Returns:
-
getResponseCharacterEncoding
- Overrides:
getResponseCharacterEncodingin classExternalContext
-
getResponseContentType
Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
getResponseContentTypein classExternalContext
-
getResponseOutputStream
- Overrides:
getResponseOutputStreamin classExternalContext- Throws:
IOException
-
getResponseOutputWriter
- Overrides:
getResponseOutputWriterin classExternalContext- Throws:
IOException
-
getSession
- Specified by:
getSessionin classExternalContext
-
getSessionMap
- Specified by:
getSessionMapin classExternalContext
-
getUserPrincipal
- Specified by:
getUserPrincipalin classExternalContext
-
getWrapped
Description copied from interface:FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.- Specified by:
getWrappedin interfaceFacesWrapper<ExternalContext>- Returns:
- the instance of the class being wrapped
-
invalidateSession
public void invalidateSession()- Overrides:
invalidateSessionin classExternalContext
-
isResponseCommitted
public boolean isResponseCommitted()- Overrides:
isResponseCommittedin classExternalContext
-
isUserInRole
- Specified by:
isUserInRolein classExternalContext
-
log
- Specified by:
login classExternalContext
-
log
- Specified by:
login classExternalContext
-
redirect
- Specified by:
redirectin classExternalContext- Throws:
IOException
-
responseFlushBuffer
- Overrides:
responseFlushBufferin classExternalContext- Throws:
IOException
-
responseReset
public void responseReset()- Overrides:
responseResetin classExternalContext
-
responseSendError
- Overrides:
responseSendErrorin classExternalContext- Throws:
IOException
-
setRequest
Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
setRequestin classExternalContext
-
setRequestCharacterEncoding
Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
setRequestCharacterEncodingin classExternalContext- Throws:
UnsupportedEncodingException
-
setResponse
Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
setResponsein classExternalContext
-
setResponseBufferSize
public void setResponseBufferSize(int size) - Overrides:
setResponseBufferSizein classExternalContext
-
setResponseCharacterEncoding
Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
setResponseCharacterEncodingin classExternalContext
-
setResponseContentLength
public void setResponseContentLength(int length) - Overrides:
setResponseContentLengthin classExternalContext
-
setResponseContentLengthLong
public void setResponseContentLengthLong(long length) - Overrides:
setResponseContentLengthLongin classExternalContext
-
setResponseContentType
- Overrides:
setResponseContentTypein classExternalContext
-
setResponseHeader
- Overrides:
setResponseHeaderin classExternalContext
-
setResponseStatus
public void setResponseStatus(int statusCode) - Overrides:
setResponseStatusin classExternalContext
-
isSecure
public boolean isSecure()- Overrides:
isSecurein classExternalContext- Returns:
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()- Overrides:
getSessionMaxInactiveIntervalin classExternalContext- Returns:
-
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval) - Overrides:
setSessionMaxInactiveIntervalin classExternalContext
-
getClientWindow
- Overrides:
getClientWindowin classExternalContext- Returns:
-
setClientWindow
- Overrides:
setClientWindowin classExternalContext
-
getSessionId
- Overrides:
getSessionIdin classExternalContext- Returns:
-
getApplicationContextPath
- Overrides:
getApplicationContextPathin classExternalContext- Returns:
-
encodeWebsocketURL
- Specified by:
encodeWebsocketURLin classExternalContext- Returns:
-
release
public void release()- Specified by:
releasein classExternalContext- Since:
- 4.0
-