Package jakarta.faces.context
Class ExternalContext
java.lang.Object
jakarta.faces.context.ExternalContext
- Direct Known Subclasses:
ExternalContextWrapper
see Javadoc of Faces Specification
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addResponseHeader
(String name, String value) abstract void
abstract String
encodeActionURL
(String url) abstract String
encodeNamespace
(String name) abstract String
encodeResourceURL
(String url) abstract String
encodeWebsocketURL
(String url) abstract String
abstract Object
Returns the name of the underlying contextgetFlash()
abstract String
getInitParameter
(String name) getMimeType
(String file) getRealPath
(String path) abstract String
abstract Object
int
abstract String
abstract Locale
abstract String
int
abstract String
abstract URL
getResource
(String path) abstract InputStream
getResourceAsStream
(String path) getResourcePaths
(String path) abstract Object
int
throwsUnsupportedOperationException
by default.abstract Object
getSession
(boolean create) getSessionId
(boolean create) int
abstract Principal
void
boolean
boolean
isSecure()
abstract boolean
isUserInRole
(String role) abstract void
abstract void
abstract void
abstract void
release()
void
void
void
responseSendError
(int statusCode, String message) void
setClientWindow
(ClientWindow window) void
setRequest
(Object request) throwsUnsupportedOperationException
by default.void
setRequestCharacterEncoding
(String encoding) throwsUnsupportedOperationException
by default.void
setResponse
(Object response) throwsUnsupportedOperationException
by default.void
setResponseBufferSize
(int size) void
setResponseCharacterEncoding
(String encoding) throwsUnsupportedOperationException
by default.void
setResponseContentLength
(int length) void
setResponseContentLengthLong
(long length) void
setResponseContentType
(String contentType) void
setResponseHeader
(String name, String value) void
setResponseStatus
(int statusCode) void
setSessionMaxInactiveInterval
(int interval)
-
Field Details
-
BASIC_AUTH
- See Also:
-
CLIENT_CERT_AUTH
- See Also:
-
DIGEST_AUTH
- See Also:
-
FORM_AUTH
- See Also:
-
-
Constructor Details
-
ExternalContext
public 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
-
getContextName
Returns 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
-
getRequestContentLength
public 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
-
getRequestServerPort
public int getRequestServerPort()- Since:
- Faces 2.0
-
getRequestServletPath
-
getResource
- Throws:
MalformedURLException
-
getResourceAsStream
-
getResourcePaths
-
getResponse
-
getResponseBufferSize
public int getResponseBufferSize()- Returns:
- Since:
- 2.0
-
getResponseCharacterEncoding
-
getResponseContentType
throwsUnsupportedOperationException
by default.- Since:
- Faces 1.2
-
getResponseOutputStream
- Throws:
IOException
- Since:
- Faces 2.0
-
getResponseOutputWriter
- Throws:
IOException
- Since:
- Faces 2.0
-
getSession
-
getSessionMap
-
getUserPrincipal
-
invalidateSession
public void invalidateSession()- Since:
- 2.0
-
isResponseCommitted
public boolean isResponseCommitted()- Since:
- 2.0
-
isUserInRole
-
log
- Since:
- 2.0
-
log
- Since:
- 2.0
-
redirect
- Throws:
IOException
-
responseFlushBuffer
- Throws:
IOException
- Since:
- 2.0
-
responseReset
public void responseReset()- Since:
- 2.0
-
responseSendError
- Parameters:
statusCode
-message
-- Throws:
IOException
- Since:
- 2.0
-
setRequest
throwsUnsupportedOperationException
by default.- Parameters:
request
-- Since:
- Faces 1.2
-
setRequestCharacterEncoding
throwsUnsupportedOperationException
by default.- Parameters:
encoding
-- Throws:
UnsupportedEncodingException
- Since:
- Faces 1.2
-
setResponse
throwsUnsupportedOperationException
by default.- Parameters:
response
-- Since:
- Faces 1.2
-
setResponseBufferSize
public void setResponseBufferSize(int size) - Parameters:
size
-- Since:
- 2.0
-
setResponseCharacterEncoding
throwsUnsupportedOperationException
by default.- Parameters:
encoding
-- Since:
- Faces 1.2
-
setResponseContentLength
public void setResponseContentLength(int length) - Parameters:
length
-- Since:
- 2.0
-
setResponseContentLengthLong
public void setResponseContentLengthLong(long length) - Parameters:
length
-- Since:
- 4.1
-
setResponseContentType
- Parameters:
contentType
-- Since:
- 2.0
-
setResponseHeader
- Parameters:
name
-value
-- Since:
- 2.0
-
setResponseStatus
public void setResponseStatus(int statusCode) - Parameters:
statusCode
-- Since:
- 2.0
-
isSecure
public boolean isSecure()- Returns:
- Since:
- 2.1
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()- Returns:
- Since:
- 2.1
-
setSessionMaxInactiveInterval
public 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
-
release
public abstract void release()- Since:
- 4.0
-