Package jakarta.faces.context
Class ExternalContext
java.lang.Object
jakarta.faces.context.ExternalContext
- Direct Known Subclasses:
- ExternalContextWrapper
see Javadoc of Faces Specification
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidvoidaddResponseHeader(String name, String value) abstract voidabstract StringencodeActionURL(String url) abstract StringencodeNamespace(String name) abstract StringencodeResourceURL(String url) abstract StringencodeWebsocketURL(String url) abstract Stringabstract ObjectReturns the name of the underlying contextgetFlash()abstract StringgetInitParameter(String name) getMimeType(String file) getRealPath(String path) abstract Stringabstract Objectintabstract Stringabstract Localeabstract Stringintabstract Stringabstract URLgetResource(String path) abstract InputStreamgetResourceAsStream(String path) getResourcePaths(String path) abstract ObjectintthrowsUnsupportedOperationExceptionby default.abstract ObjectgetSession(boolean create) getSessionId(boolean create) intabstract PrincipalvoidbooleanbooleanisSecure()abstract booleanisUserInRole(String role) abstract voidabstract voidabstract voidabstract voidrelease()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) 
- 
Field Details- 
BASIC_AUTH- See Also:
 
- 
CLIENT_CERT_AUTH- See Also:
 
- 
DIGEST_AUTH- See Also:
 
- 
FORM_AUTH- See Also:
 
 
- 
- 
Constructor Details- 
ExternalContextpublic ExternalContext()
 
- 
- 
Method Details- 
addResponseCookie- Parameters:
- name-
- value-
- properties-
- Since:
- 2.0
 
- 
addResponseHeader- Parameters:
- name-
- value-
- Since:
- 2.0
 
- 
dispatch- Throws:
- IOException
 
- 
encodeActionURL
- 
encodeBookmarkableURL- Parameters:
- baseUrl-
- parameters-
- Since:
- 2.0
 
- 
encodeNamespace
- 
encodePartialActionURL- Since:
- 2.0
 
- 
encodeRedirectURL- Parameters:
- baseUrl-
- parameters-
- Since:
- 2.0
 
- 
encodeResourceURL
- 
getApplicationMap
- 
getAuthType
- 
getContext
- 
getContextNameReturns the name of the underlying context- Returns:
- the name or null
- Since:
- 2.0
 
- 
getFlash- Since:
- 2.0
 
- 
getInitParameter
- 
getInitParameterMap
- 
getMimeType- Since:
- Faces 2.0
 
- 
getRealPath- Since:
- Faces 2.0
 
- 
getRemoteUser
- 
getRequest
- 
getRequestCharacterEncoding
- 
getRequestContentLengthpublic int getRequestContentLength()- Returns:
- Since:
- 2.0
 
- 
getRequestContentType
- 
getRequestContextPath
- 
getRequestCookieMap
- 
getRequestHeaderMap
- 
getRequestHeaderValuesMap
- 
getRequestLocale
- 
getRequestLocales
- 
getRequestMap
- 
getRequestParameterMap
- 
getRequestParameterNames
- 
getRequestParameterValuesMap
- 
getRequestPathInfo
- 
getRequestScheme- Since:
- Faces 2.0
 
- 
getRequestServerName- Since:
- Faces 2.0
 
- 
getRequestServerPortpublic int getRequestServerPort()- Since:
- Faces 2.0
 
- 
getRequestServletPath
- 
getResource- Throws:
- MalformedURLException
 
- 
getResourceAsStream
- 
getResourcePaths
- 
getResponse
- 
getResponseBufferSizepublic int getResponseBufferSize()- Returns:
- Since:
- 2.0
 
- 
getResponseCharacterEncoding
- 
getResponseContentTypethrowsUnsupportedOperationExceptionby default.- Since:
- Faces 1.2
 
- 
getResponseOutputStream- Throws:
- IOException
- Since:
- Faces 2.0
 
- 
getResponseOutputWriter- Throws:
- IOException
- Since:
- Faces 2.0
 
- 
getSession
- 
getSessionMap
- 
getUserPrincipal
- 
invalidateSessionpublic void invalidateSession()- Since:
- 2.0
 
- 
isResponseCommittedpublic boolean isResponseCommitted()- Since:
- 2.0
 
- 
isUserInRole
- 
log- Since:
- 2.0
 
- 
log- Since:
- 2.0
 
- 
redirect- Throws:
- IOException
 
- 
responseFlushBuffer- Throws:
- IOException
- Since:
- 2.0
 
- 
responseResetpublic void responseReset()- Since:
- 2.0
 
- 
responseSendError- Parameters:
- statusCode-
- message-
- Throws:
- IOException
- Since:
- 2.0
 
- 
setRequestthrowsUnsupportedOperationExceptionby default.- Parameters:
- request-
- Since:
- Faces 1.2
 
- 
setRequestCharacterEncodingthrowsUnsupportedOperationExceptionby default.- Parameters:
- encoding-
- Throws:
- UnsupportedEncodingException
- Since:
- Faces 1.2
 
- 
setResponsethrowsUnsupportedOperationExceptionby default.- Parameters:
- response-
- Since:
- Faces 1.2
 
- 
setResponseBufferSizepublic void setResponseBufferSize(int size) - Parameters:
- size-
- Since:
- 2.0
 
- 
setResponseCharacterEncodingthrowsUnsupportedOperationExceptionby default.- Parameters:
- encoding-
- Since:
- Faces 1.2
 
- 
setResponseContentLengthpublic void setResponseContentLength(int length) - Parameters:
- length-
- Since:
- 2.0
 
- 
setResponseContentLengthLongpublic void setResponseContentLengthLong(long length) - Parameters:
- length-
- Since:
- 4.1
 
- 
setResponseContentType- Parameters:
- contentType-
- Since:
- 2.0
 
- 
setResponseHeader- 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
 
- 
getClientWindow- Returns:
- Since:
- 2.2
 
- 
setClientWindow- Parameters:
- window-
- Since:
- 2.2
 
- 
getSessionId- Parameters:
- create-
- Returns:
- Since:
- 2.2
 
- 
getApplicationContextPath- Returns:
- Since:
- 2.2
 
- 
encodeWebsocketURL- Parameters:
- url-
- Returns:
- Since:
- 2.3
 
- 
releasepublic abstract void release()- Since:
- 4.0
 
 
-