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.ExternalContextBASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
- 
 - 
Constructor SummaryConstructors Constructor Description ExternalContextWrapper()Deprecated.ExternalContextWrapper(ExternalContext delegate)
 - 
Method Summary
 
- 
- 
- 
Constructor Detail- 
ExternalContextWrapper@Deprecated public ExternalContextWrapper() Deprecated.
 - 
ExternalContextWrapperpublic ExternalContextWrapper(ExternalContext delegate) 
 
- 
 - 
Method Detail- 
addResponseCookiepublic void addResponseCookie(String name, String value, Map<String,Object> properties) - Overrides:
- addResponseCookiein class- ExternalContext
 
 - 
addResponseHeaderpublic void addResponseHeader(String name, String value) - Overrides:
- addResponseHeaderin class- ExternalContext
 
 - 
dispatchpublic void dispatch(String path) throws IOException - Specified by:
- dispatchin class- ExternalContext
- Throws:
- IOException
 
 - 
encodeActionURLpublic String encodeActionURL(String url) - Specified by:
- encodeActionURLin class- ExternalContext
 
 - 
encodeBookmarkableURLpublic String encodeBookmarkableURL(String baseUrl, Map<String,List<String>> parameters) - Overrides:
- encodeBookmarkableURLin class- ExternalContext
 
 - 
encodeNamespacepublic String encodeNamespace(String name) - Specified by:
- encodeNamespacein class- ExternalContext
 
 - 
encodePartialActionURLpublic String encodePartialActionURL(String url) - Overrides:
- encodePartialActionURLin class- ExternalContext
 
 - 
encodeRedirectURLpublic String encodeRedirectURL(String baseUrl, Map<String,List<String>> parameters) - Overrides:
- encodeRedirectURLin class- ExternalContext
 
 - 
encodeResourceURLpublic String encodeResourceURL(String url) - Specified by:
- encodeResourceURLin class- ExternalContext
 
 - 
getApplicationMappublic Map<String,Object> getApplicationMap() - Specified by:
- getApplicationMapin class- ExternalContext
 
 - 
getAuthTypepublic String getAuthType() - Specified by:
- getAuthTypein class- ExternalContext
 
 - 
getContextpublic Object getContext() - Specified by:
- getContextin class- ExternalContext
 
 - 
getContextNamepublic String getContextName() Description copied from class:ExternalContextReturns the name of the underlying context- Overrides:
- getContextNamein class- ExternalContext
- Returns:
- the name or null
 
 - 
getFlashpublic Flash getFlash() - Overrides:
- getFlashin class- ExternalContext
 
 - 
getInitParameterpublic String getInitParameter(String name) - Specified by:
- getInitParameterin class- ExternalContext
 
 - 
getInitParameterMappublic Map<String,String> getInitParameterMap() - Specified by:
- getInitParameterMapin class- ExternalContext
 
 - 
getMimeTypepublic String getMimeType(String file) - Overrides:
- getMimeTypein class- ExternalContext
 
 - 
getRealPathpublic String getRealPath(String path) - Overrides:
- getRealPathin class- ExternalContext
 
 - 
getRemoteUserpublic String getRemoteUser() - Specified by:
- getRemoteUserin class- ExternalContext
 
 - 
getRequestpublic Object getRequest() - Specified by:
- getRequestin class- ExternalContext
 
 - 
getRequestCharacterEncodingpublic String getRequestCharacterEncoding() - Overrides:
- getRequestCharacterEncodingin class- ExternalContext
 
 - 
getRequestContentLengthpublic int getRequestContentLength() - Overrides:
- getRequestContentLengthin class- ExternalContext
- Returns:
 
 - 
getRequestContentTypepublic String getRequestContentType() - Overrides:
- getRequestContentTypein class- ExternalContext
 
 - 
getRequestContextPathpublic String getRequestContextPath() - Specified by:
- getRequestContextPathin class- ExternalContext
 
 - 
getRequestCookieMappublic Map<String,Object> getRequestCookieMap() - Specified by:
- getRequestCookieMapin class- ExternalContext
 
 - 
getRequestHeaderMappublic Map<String,String> getRequestHeaderMap() - Specified by:
- getRequestHeaderMapin class- ExternalContext
 
 - 
getRequestHeaderValuesMappublic Map<String,String[]> getRequestHeaderValuesMap() - Specified by:
- getRequestHeaderValuesMapin class- ExternalContext
 
 - 
getRequestLocalepublic Locale getRequestLocale() - Specified by:
- getRequestLocalein class- ExternalContext
 
 - 
getRequestLocalespublic Iterator<Locale> getRequestLocales() - Specified by:
- getRequestLocalesin class- ExternalContext
 
 - 
getRequestMappublic Map<String,Object> getRequestMap() - Specified by:
- getRequestMapin class- ExternalContext
 
 - 
getRequestParameterMappublic Map<String,String> getRequestParameterMap() - Specified by:
- getRequestParameterMapin class- ExternalContext
 
 - 
getRequestParameterNamespublic Iterator<String> getRequestParameterNames() - Specified by:
- getRequestParameterNamesin class- ExternalContext
 
 - 
getRequestParameterValuesMappublic Map<String,String[]> getRequestParameterValuesMap() - Specified by:
- getRequestParameterValuesMapin class- ExternalContext
 
 - 
getRequestPathInfopublic String getRequestPathInfo() - Specified by:
- getRequestPathInfoin class- ExternalContext
 
 - 
getRequestSchemepublic String getRequestScheme() - Overrides:
- getRequestSchemein class- ExternalContext
 
 - 
getRequestServerNamepublic String getRequestServerName() - Overrides:
- getRequestServerNamein class- ExternalContext
 
 - 
getRequestServerPortpublic int getRequestServerPort() - Overrides:
- getRequestServerPortin class- ExternalContext
 
 - 
getRequestServletPathpublic String getRequestServletPath() - Specified by:
- getRequestServletPathin class- ExternalContext
 
 - 
getResourcepublic URL getResource(String path) throws MalformedURLException - Specified by:
- getResourcein class- ExternalContext
- Throws:
- MalformedURLException
 
 - 
getResourceAsStreampublic InputStream getResourceAsStream(String path) - Specified by:
- getResourceAsStreamin class- ExternalContext
 
 - 
getResourcePathspublic Set<String> getResourcePaths(String path) - Specified by:
- getResourcePathsin class- ExternalContext
 
 - 
getResponsepublic Object getResponse() - Specified by:
- getResponsein class- ExternalContext
 
 - 
getResponseBufferSizepublic int getResponseBufferSize() - Overrides:
- getResponseBufferSizein class- ExternalContext
- Returns:
 
 - 
getResponseCharacterEncodingpublic String getResponseCharacterEncoding() - Overrides:
- getResponseCharacterEncodingin class- ExternalContext
 
 - 
getResponseContentTypepublic String getResponseContentType() Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- getResponseContentTypein class- ExternalContext
 
 - 
getResponseOutputStreampublic OutputStream getResponseOutputStream() throws IOException - Overrides:
- getResponseOutputStreamin class- ExternalContext
- Throws:
- IOException
 
 - 
getResponseOutputWriterpublic Writer getResponseOutputWriter() throws IOException - Overrides:
- getResponseOutputWriterin class- ExternalContext
- Throws:
- IOException
 
 - 
getSessionpublic Object getSession(boolean create) - Specified by:
- getSessionin class- ExternalContext
 
 - 
getSessionMappublic Map<String,Object> getSessionMap() - Specified by:
- getSessionMapin class- ExternalContext
 
 - 
getUserPrincipalpublic Principal getUserPrincipal() - Specified by:
- getUserPrincipalin class- ExternalContext
 
 - 
getWrappedpublic ExternalContext 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 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
 
 - 
isUserInRolepublic boolean isUserInRole(String role) - Specified by:
- isUserInRolein class- ExternalContext
 
 - 
logpublic void log(String message, Throwable exception) - Specified by:
- login class- ExternalContext
 
 - 
logpublic void log(String message) - Specified by:
- login class- ExternalContext
 
 - 
redirectpublic void redirect(String url) throws IOException - Specified by:
- redirectin class- ExternalContext
- Throws:
- IOException
 
 - 
responseFlushBufferpublic void responseFlushBuffer() throws IOException- Overrides:
- responseFlushBufferin class- ExternalContext
- Throws:
- IOException
 
 - 
responseResetpublic void responseReset() - Overrides:
- responseResetin class- ExternalContext
 
 - 
responseSendErrorpublic void responseSendError(int statusCode, String message) throws IOException- Overrides:
- responseSendErrorin class- ExternalContext
- Throws:
- IOException
 
 - 
setRequestpublic void setRequest(Object request) Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setRequestin class- ExternalContext
 
 - 
setRequestCharacterEncodingpublic void setRequestCharacterEncoding(String encoding) throws UnsupportedEncodingException Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setRequestCharacterEncodingin class- ExternalContext
- Throws:
- UnsupportedEncodingException
 
 - 
setResponsepublic void setResponse(Object response) Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setResponsein class- ExternalContext
 
 - 
setResponseBufferSizepublic void setResponseBufferSize(int size) - Overrides:
- setResponseBufferSizein class- ExternalContext
 
 - 
setResponseCharacterEncodingpublic void setResponseCharacterEncoding(String encoding) Description copied from class:ExternalContextthrowsUnsupportedOperationExceptionby default.- Overrides:
- setResponseCharacterEncodingin class- ExternalContext
 
 - 
setResponseContentLengthpublic void setResponseContentLength(int length) - Overrides:
- setResponseContentLengthin class- ExternalContext
 
 - 
setResponseContentTypepublic void setResponseContentType(String contentType) - Overrides:
- setResponseContentTypein class- ExternalContext
 
 - 
setResponseHeaderpublic void setResponseHeader(String name, String value) - 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
 
 - 
getClientWindowpublic ClientWindow getClientWindow() - Overrides:
- getClientWindowin class- ExternalContext
- Returns:
 
 - 
setClientWindowpublic void setClientWindow(ClientWindow window) - Overrides:
- setClientWindowin class- ExternalContext
 
 - 
getSessionIdpublic String getSessionId(boolean create) - Overrides:
- getSessionIdin class- ExternalContext
- Returns:
 
 - 
getApplicationContextPathpublic String getApplicationContextPath() - Overrides:
- getApplicationContextPathin class- ExternalContext
- Returns:
 
 - 
encodeWebsocketURLpublic String encodeWebsocketURL(String url) - Specified by:
- encodeWebsocketURLin class- ExternalContext
- Returns:
 
 - 
releasepublic void release() - Specified by:
- releasein class- ExternalContext
- Since:
- 4.0
 
 
- 
 
-