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 SummaryFields inherited from class jakarta.faces.context.ExternalContextBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
- 
Constructor SummaryConstructors
- 
Method SummaryModifier 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- 
ExternalContextWrapperDeprecated.
- 
ExternalContextWrapper
 
- 
- 
Method Details- 
addResponseCookie- Overrides:
- addResponseCookiein class- ExternalContext
 
- 
addResponseHeader- Overrides:
- addResponseHeaderin class- ExternalContext
 
- 
dispatch- Specified by:
- dispatchin class- ExternalContext
- Throws:
- IOException
 
- 
encodeActionURL- Specified by:
- encodeActionURLin class- ExternalContext
 
- 
encodeBookmarkableURL- Overrides:
- encodeBookmarkableURLin class- ExternalContext
 
- 
encodeNamespace- Specified by:
- encodeNamespacein class- ExternalContext
 
- 
encodePartialActionURL- Overrides:
- encodePartialActionURLin class- ExternalContext
 
- 
encodeRedirectURL- Overrides:
- encodeRedirectURLin class- ExternalContext
 
- 
encodeResourceURL- Specified by:
- encodeResourceURLin class- ExternalContext
 
- 
getApplicationMap- Specified by:
- getApplicationMapin class- ExternalContext
 
- 
getAuthType- Specified by:
- getAuthTypein class- ExternalContext
 
- 
getContext- Specified by:
- getContextin class- ExternalContext
 
- 
getContextNameDescription copied from class:ExternalContextReturns the name of the underlying context- Overrides:
- getContextNamein class- ExternalContext
- Returns:
- the name or null
 
- 
getFlash- Overrides:
- getFlashin class- ExternalContext
 
- 
getInitParameter- Specified by:
- getInitParameterin class- ExternalContext
 
- 
getInitParameterMap- Specified by:
- getInitParameterMapin class- ExternalContext
 
- 
getMimeType- Overrides:
- getMimeTypein class- ExternalContext
 
- 
getRealPath- Overrides:
- getRealPathin class- ExternalContext
 
- 
getRemoteUser- Specified by:
- getRemoteUserin class- ExternalContext
 
- 
getRequest- Specified by:
- getRequestin class- ExternalContext
 
- 
getRequestCharacterEncoding- Overrides:
- getRequestCharacterEncodingin class- ExternalContext
 
- 
getRequestContentLengthpublic int getRequestContentLength()- Overrides:
- getRequestContentLengthin class- ExternalContext
- Returns:
 
- 
getRequestContentType- Overrides:
- getRequestContentTypein class- ExternalContext
 
- 
getRequestContextPath- Specified by:
- getRequestContextPathin class- ExternalContext
 
- 
getRequestCookieMap- Specified by:
- getRequestCookieMapin class- ExternalContext
 
- 
getRequestHeaderMap- Specified by:
- getRequestHeaderMapin class- ExternalContext
 
- 
getRequestHeaderValuesMap- Specified by:
- getRequestHeaderValuesMapin class- ExternalContext
 
- 
getRequestLocale- Specified by:
- getRequestLocalein class- ExternalContext
 
- 
getRequestLocales- Specified by:
- getRequestLocalesin class- ExternalContext
 
- 
getRequestMap- Specified by:
- getRequestMapin class- ExternalContext
 
- 
getRequestParameterMap- Specified by:
- getRequestParameterMapin class- ExternalContext
 
- 
getRequestParameterNames- Specified by:
- getRequestParameterNamesin class- ExternalContext
 
- 
getRequestParameterValuesMap- Specified by:
- getRequestParameterValuesMapin class- ExternalContext
 
- 
getRequestPathInfo- Specified by:
- getRequestPathInfoin class- ExternalContext
 
- 
getRequestScheme- Overrides:
- getRequestSchemein class- ExternalContext
 
- 
getRequestServerName- Overrides:
- getRequestServerNamein class- ExternalContext
 
- 
getRequestServerPortpublic int getRequestServerPort()- Overrides:
- getRequestServerPortin class- ExternalContext
 
- 
getRequestServletPath- Specified by:
- getRequestServletPathin class- ExternalContext
 
- 
getResource- Specified by:
- getResourcein class- ExternalContext
- Throws:
- MalformedURLException
 
- 
getResourceAsStream- Specified by:
- getResourceAsStreamin class- ExternalContext
 
- 
getResourcePaths- Specified by:
- getResourcePathsin class- ExternalContext
 
- 
getResponse- Specified by:
- getResponsein class- ExternalContext
 
- 
getResponseBufferSizepublic int getResponseBufferSize()- Overrides:
- getResponseBufferSizein class- ExternalContext
- Returns:
 
- 
getResponseCharacterEncoding- Overrides:
- getResponseCharacterEncodingin class- ExternalContext
 
- 
getResponseContentTypeDescription copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- getResponseContentTypein class- ExternalContext
 
- 
getResponseOutputStream- Overrides:
- getResponseOutputStreamin class- ExternalContext
- Throws:
- IOException
 
- 
getResponseOutputWriter- Overrides:
- getResponseOutputWriterin class- ExternalContext
- Throws:
- IOException
 
- 
getSession- Specified by:
- getSessionin class- ExternalContext
 
- 
getSessionMap- Specified by:
- getSessionMapin class- ExternalContext
 
- 
getUserPrincipal- Specified by:
- getUserPrincipalin class- ExternalContext
 
- 
getWrappedDescription copied from interface:FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.- Specified by:
- getWrappedin interface- FacesWrapper<ExternalContext>
- Returns:
- the instance of the class being wrapped
 
- 
invalidateSessionpublic void invalidateSession()- Overrides:
- invalidateSessionin class- ExternalContext
 
- 
isResponseCommittedpublic boolean isResponseCommitted()- Overrides:
- isResponseCommittedin class- ExternalContext
 
- 
isUserInRole- Specified by:
- isUserInRolein class- ExternalContext
 
- 
log- Specified by:
- login class- ExternalContext
 
- 
log- Specified by:
- login class- ExternalContext
 
- 
redirect- Specified by:
- redirectin class- ExternalContext
- Throws:
- IOException
 
- 
responseFlushBuffer- Overrides:
- responseFlushBufferin class- ExternalContext
- Throws:
- IOException
 
- 
responseResetpublic void responseReset()- Overrides:
- responseResetin class- ExternalContext
 
- 
responseSendError- Overrides:
- responseSendErrorin class- ExternalContext
- Throws:
- IOException
 
- 
setRequestDescription copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setRequestin class- ExternalContext
 
- 
setRequestCharacterEncodingDescription copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setRequestCharacterEncodingin class- ExternalContext
- Throws:
- UnsupportedEncodingException
 
- 
setResponseDescription copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setResponsein class- ExternalContext
 
- 
setResponseBufferSizepublic void setResponseBufferSize(int size) - Overrides:
- setResponseBufferSizein class- ExternalContext
 
- 
setResponseCharacterEncodingDescription copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setResponseCharacterEncodingin class- ExternalContext
 
- 
setResponseContentLengthpublic void setResponseContentLength(int length) - Overrides:
- setResponseContentLengthin class- ExternalContext
 
- 
setResponseContentLengthLongpublic void setResponseContentLengthLong(long length) - Overrides:
- setResponseContentLengthLongin class- ExternalContext
 
- 
setResponseContentType- Overrides:
- setResponseContentTypein class- ExternalContext
 
- 
setResponseHeader- Overrides:
- setResponseHeaderin class- ExternalContext
 
- 
setResponseStatuspublic void setResponseStatus(int statusCode) - Overrides:
- setResponseStatusin class- ExternalContext
 
- 
isSecurepublic boolean isSecure()- Overrides:
- isSecurein class- ExternalContext
- Returns:
 
- 
getSessionMaxInactiveIntervalpublic int getSessionMaxInactiveInterval()- Overrides:
- getSessionMaxInactiveIntervalin class- ExternalContext
- Returns:
 
- 
setSessionMaxInactiveIntervalpublic void setSessionMaxInactiveInterval(int interval) - Overrides:
- setSessionMaxInactiveIntervalin class- ExternalContext
 
- 
getClientWindow- Overrides:
- getClientWindowin class- ExternalContext
- Returns:
 
- 
setClientWindow- Overrides:
- setClientWindowin class- ExternalContext
 
- 
getSessionId- Overrides:
- getSessionIdin class- ExternalContext
- Returns:
 
- 
getApplicationContextPath- Overrides:
- getApplicationContextPathin class- ExternalContext
- Returns:
 
- 
encodeWebsocketURL- Specified by:
- encodeWebsocketURLin class- ExternalContext
- Returns:
 
- 
releasepublic void release()- Specified by:
- releasein class- ExternalContext
- Since:
- 4.0
 
 
-