Package jakarta.faces.context
Class ExternalContext
- java.lang.Object
- 
- jakarta.faces.context.ExternalContext
 
- 
- Direct Known Subclasses:
- ExternalContextWrapper
 
 public abstract class ExternalContext extends Object see Javadoc of JSF Specification
- 
- 
Field SummaryFields Modifier and Type Field Description static StringBASIC_AUTHstatic StringCLIENT_CERT_AUTHstatic StringDIGEST_AUTHstatic StringFORM_AUTH
 - 
Constructor SummaryConstructors Constructor Description ExternalContext()
 - 
Method Summary
 
- 
- 
- 
Field Detail- 
BASIC_AUTHpublic static final String BASIC_AUTH - See Also:
- Constant Field Values
 
 - 
CLIENT_CERT_AUTHpublic static final String CLIENT_CERT_AUTH - See Also:
- Constant Field Values
 
 - 
DIGEST_AUTHpublic static final String DIGEST_AUTH - See Also:
- Constant Field Values
 
 - 
FORM_AUTHpublic static final String FORM_AUTH - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
addResponseCookiepublic void addResponseCookie(String name, String value, Map<String,Object> properties) - Parameters:
- name-
- value-
- properties-
- Since:
- 2.0
 
 - 
addResponseHeaderpublic void addResponseHeader(String name, String value) - Parameters:
- name-
- value-
- Since:
- 2.0
 
 - 
dispatchpublic abstract void dispatch(String path) throws IOException - Throws:
- IOException
 
 - 
encodeBookmarkableURLpublic String encodeBookmarkableURL(String baseUrl, Map<String,List<String>> parameters) - Parameters:
- baseUrl-
- parameters-
- Since:
- 2.0
 
 - 
encodeRedirectURLpublic String encodeRedirectURL(String baseUrl, Map<String,List<String>> parameters) - Parameters:
- baseUrl-
- parameters-
- Since:
- 2.0
 
 - 
getAuthTypepublic abstract String getAuthType() 
 - 
getContextpublic abstract Object getContext() 
 - 
getContextNamepublic String getContextName() Returns the name of the underlying context- Returns:
- the name or null
- Since:
- 2.0
 
 - 
getFlashpublic Flash getFlash() - Since:
- 2.0
 
 - 
getRemoteUserpublic abstract String getRemoteUser() 
 - 
getRequestpublic abstract Object getRequest() 
 - 
getRequestCharacterEncodingpublic String getRequestCharacterEncoding() 
 - 
getRequestContentLengthpublic int getRequestContentLength() - Returns:
- Since:
- 2.0
 
 - 
getRequestContentTypepublic String getRequestContentType() 
 - 
getRequestContextPathpublic abstract String getRequestContextPath() 
 - 
getRequestLocalepublic abstract Locale getRequestLocale() 
 - 
getRequestPathInfopublic abstract String getRequestPathInfo() 
 - 
getRequestSchemepublic String getRequestScheme() - Since:
- JSF 2.0
 
 - 
getRequestServerNamepublic String getRequestServerName() - Since:
- JSF 2.0
 
 - 
getRequestServerPortpublic int getRequestServerPort() - Since:
- JSF 2.0
 
 - 
getRequestServletPathpublic abstract String getRequestServletPath() 
 - 
getResourcepublic abstract URL getResource(String path) throws MalformedURLException - Throws:
- MalformedURLException
 
 - 
getResourceAsStreampublic abstract InputStream getResourceAsStream(String path) 
 - 
getResponsepublic abstract Object getResponse() 
 - 
getResponseBufferSizepublic int getResponseBufferSize() - Returns:
- Since:
- 2.0
 
 - 
getResponseCharacterEncodingpublic String getResponseCharacterEncoding() 
 - 
getResponseContentTypepublic String getResponseContentType() throwsUnsupportedOperationExceptionby default.- Since:
- JSF 1.2
 
 - 
getResponseOutputStreampublic OutputStream getResponseOutputStream() throws IOException - Throws:
- IOException
- Since:
- JSF 2.0
 
 - 
getResponseOutputWriterpublic Writer getResponseOutputWriter() throws IOException - Throws:
- IOException
- Since:
- JSF 2.0
 
 - 
getSessionpublic abstract Object getSession(boolean create) 
 - 
getUserPrincipalpublic abstract Principal getUserPrincipal() 
 - 
invalidateSessionpublic void invalidateSession() - Since:
- 2.0
 
 - 
isResponseCommittedpublic boolean isResponseCommitted() - Since:
- 2.0
 
 - 
isUserInRolepublic abstract boolean isUserInRole(String role) 
 - 
logpublic abstract void log(String message) - Since:
- 2.0
 
 - 
redirectpublic abstract void redirect(String url) throws IOException - Throws:
- IOException
 
 - 
responseFlushBufferpublic void responseFlushBuffer() throws IOException- Throws:
- IOException
- Since:
- 2.0
 
 - 
responseResetpublic void responseReset() - Since:
- 2.0
 
 - 
responseSendErrorpublic void responseSendError(int statusCode, String message) throws IOException- Parameters:
- statusCode-
- message-
- Throws:
- IOException
- Since:
- 2.0
 
 - 
setRequestpublic void setRequest(Object request) throwsUnsupportedOperationExceptionby default.- Parameters:
- request-
- Since:
- JSF 1.2
 
 - 
setRequestCharacterEncodingpublic void setRequestCharacterEncoding(String encoding) throws UnsupportedEncodingException throwsUnsupportedOperationExceptionby default.- Parameters:
- encoding-
- Throws:
- UnsupportedEncodingException
- Since:
- JSF 1.2
 
 - 
setResponsepublic void setResponse(Object response) throwsUnsupportedOperationExceptionby default.- Parameters:
- response-
- Since:
- JSF 1.2
 
 - 
setResponseBufferSizepublic void setResponseBufferSize(int size) - Parameters:
- size-
- Since:
- 2.0
 
 - 
setResponseCharacterEncodingpublic void setResponseCharacterEncoding(String encoding) throwsUnsupportedOperationExceptionby default.- Parameters:
- encoding-
- Since:
- JSF 1.2
 
 - 
setResponseContentLengthpublic void setResponseContentLength(int length) - Parameters:
- length-
- Since:
- 2.0
 
 - 
setResponseContentTypepublic void setResponseContentType(String contentType) - Parameters:
- contentType-
- Since:
- 2.0
 
 - 
setResponseHeaderpublic void setResponseHeader(String name, String value) - Parameters:
- name-
- value-
- Since:
- 2.0
 
 - 
setResponseStatuspublic void setResponseStatus(int statusCode) - Parameters:
- statusCode-
- Since:
- 2.0
 
 - 
isSecurepublic boolean isSecure() - Returns:
- Since:
- 2.1
 
 - 
getSessionMaxInactiveIntervalpublic int getSessionMaxInactiveInterval() - Returns:
- Since:
- 2.1
 
 - 
setSessionMaxInactiveIntervalpublic void setSessionMaxInactiveInterval(int interval) - Parameters:
- interval-
- Since:
- 2.1
 
 - 
getClientWindowpublic ClientWindow getClientWindow() - Returns:
- Since:
- 2.2
 
 - 
setClientWindowpublic void setClientWindow(ClientWindow window) - Parameters:
- window-
- Since:
- 2.2
 
 - 
getSessionIdpublic String getSessionId(boolean create) - Parameters:
- create-
- Returns:
- Since:
- 2.2
 
 - 
getApplicationContextPathpublic String getApplicationContextPath() - Returns:
- Since:
- 2.2
 
 - 
encodeWebsocketURLpublic abstract String encodeWebsocketURL(String url) - Parameters:
- url-
- Returns:
- Since:
- 2.3
 
 - 
releasepublic abstract void release() - Since:
- 4.0
 
 
- 
 
-