Class ServletExternalContextImpl
java.lang.Object
jakarta.faces.context.ExternalContext
org.apache.myfaces.context.servlet.ServletExternalContextImplBase
org.apache.myfaces.context.servlet.ServletExternalContextImpl
Implements the external context for servlet request. Faces 1.2, 6.1.3
- Version:
- $Revision$ $Date$
- Author:
- Manfred Geiler (latest modification by $Author$), Anton Koinov
-
Field Summary
Fields inherited from class jakarta.faces.context.ExternalContext
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
Constructor Summary
ConstructorsConstructorDescriptionServletExternalContextImpl
(jakarta.servlet.ServletContext servletContext, jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) ServletExternalContextImpl
(jakarta.servlet.ServletContext servletContext, jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse, FlashFactory flashFactory) -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
addResponseHeader
(String name, String value) void
encodeActionURL
(String url) encodeResourceURL
(String url) encodeWebsocketURL
(String url) protected FacesContext
getFlash()
int
int
int
getSession
(boolean create) getSessionId
(boolean create) int
void
boolean
boolean
isSecure()
boolean
isUserInRole
(String role) protected void
pushResource
(String resourceUrl) void
void
release()
void
void
void
responseSendError
(int statusCode, String message) void
setRequest
(Object request) void
setRequestCharacterEncoding
(String encoding) void
setResponse
(Object response) void
setResponseBufferSize
(int size) void
setResponseCharacterEncoding
(String encoding) 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) Methods inherited from class org.apache.myfaces.context.servlet.ServletExternalContextImplBase
getApplicationContextPath, getApplicationMap, getClientWindow, getContext, getContextName, getInitParameter, getInitParameterMap, getMimeType, getRealPath, getResource, getResourceAsStream, getResourcePaths, log, log, setClientWindow
-
Constructor Details
-
ServletExternalContextImpl
public ServletExternalContextImpl(jakarta.servlet.ServletContext servletContext, jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse) -
ServletExternalContextImpl
public ServletExternalContextImpl(jakarta.servlet.ServletContext servletContext, jakarta.servlet.ServletRequest servletRequest, jakarta.servlet.ServletResponse servletResponse, FlashFactory flashFactory)
-
-
Method Details
-
release
public void release()- Overrides:
release
in classServletExternalContextImplBase
- Since:
- 4.0
-
getSession
- Specified by:
getSession
in classExternalContext
-
getSessionId
- Overrides:
getSessionId
in classExternalContext
-
getRequest
- Specified by:
getRequest
in classExternalContext
-
getRequestContentLength
public int getRequestContentLength()- Overrides:
getRequestContentLength
in classExternalContext
- Since:
- 2.0
-
getResponse
- Specified by:
getResponse
in classExternalContext
-
getResponseBufferSize
public int getResponseBufferSize()- Overrides:
getResponseBufferSize
in classExternalContext
- Since:
- 2.0
-
getResponseContentType
- Overrides:
getResponseContentType
in classExternalContext
-
getResponseOutputStream
- Overrides:
getResponseOutputStream
in classExternalContext
- Throws:
IOException
-
getResponseOutputWriter
- Overrides:
getResponseOutputWriter
in classExternalContext
- Throws:
IOException
- Since:
- Faces 2.0
-
getSessionMap
- Specified by:
getSessionMap
in classExternalContext
-
getRequestMap
- Specified by:
getRequestMap
in classExternalContext
-
getRequestParameterMap
- Specified by:
getRequestParameterMap
in classExternalContext
-
getRequestParameterValuesMap
- Specified by:
getRequestParameterValuesMap
in classExternalContext
-
getRequestServerPort
public int getRequestServerPort()- Overrides:
getRequestServerPort
in classExternalContext
-
getRequestParameterNames
- Specified by:
getRequestParameterNames
in classExternalContext
-
getRequestHeaderMap
- Specified by:
getRequestHeaderMap
in classExternalContext
-
getRequestHeaderValuesMap
- Specified by:
getRequestHeaderValuesMap
in classExternalContext
-
getRequestCookieMap
- Specified by:
getRequestCookieMap
in classExternalContext
-
getRequestLocale
- Specified by:
getRequestLocale
in classExternalContext
-
getRequestPathInfo
- Specified by:
getRequestPathInfo
in classExternalContext
-
getRequestContentType
- Overrides:
getRequestContentType
in classExternalContext
-
getRequestContextPath
- Specified by:
getRequestContextPath
in classExternalContext
-
getRequestScheme
- Overrides:
getRequestScheme
in classExternalContext
-
encodeActionURL
- Specified by:
encodeActionURL
in classExternalContext
-
encodeBookmarkableURL
- Overrides:
encodeBookmarkableURL
in classExternalContext
-
encodeResourceURL
- Specified by:
encodeResourceURL
in classExternalContext
-
pushResource
-
encodeNamespace
- Specified by:
encodeNamespace
in classExternalContext
-
encodePartialActionURL
- Overrides:
encodePartialActionURL
in classExternalContext
-
encodeRedirectURL
- Overrides:
encodeRedirectURL
in classExternalContext
-
encodeWebsocketURL
- Specified by:
encodeWebsocketURL
in classExternalContext
-
dispatch
- Specified by:
dispatch
in classExternalContext
- Throws:
IOException
FacesException
-
getRequestServerName
- Overrides:
getRequestServerName
in classExternalContext
-
getRequestServletPath
- Specified by:
getRequestServletPath
in classExternalContext
-
getAuthType
- Specified by:
getAuthType
in classExternalContext
-
getRemoteUser
- Specified by:
getRemoteUser
in classExternalContext
-
isUserInRole
- Specified by:
isUserInRole
in classExternalContext
-
getUserPrincipal
- Specified by:
getUserPrincipal
in classExternalContext
-
invalidateSession
public void invalidateSession()- Overrides:
invalidateSession
in classExternalContext
-
isResponseCommitted
public boolean isResponseCommitted()- Overrides:
isResponseCommitted
in classExternalContext
- Since:
- 2.0
-
redirect
- Specified by:
redirect
in classExternalContext
- Throws:
IOException
-
responseFlushBuffer
- Overrides:
responseFlushBuffer
in classExternalContext
- Throws:
IOException
- Since:
- 2.0
-
responseReset
public void responseReset()- Overrides:
responseReset
in classExternalContext
- Since:
- 2.0
-
responseSendError
- Overrides:
responseSendError
in classExternalContext
- Throws:
IOException
- Since:
- 2.0
-
getRequestLocales
- Specified by:
getRequestLocales
in classExternalContext
-
setRequest
- Overrides:
setRequest
in classExternalContext
- Parameters:
request
-- Since:
- Faces 1.2
-
setRequestCharacterEncoding
- Overrides:
setRequestCharacterEncoding
in classExternalContext
- Parameters:
encoding
-- Throws:
UnsupportedEncodingException
- Since:
- Faces 1.2
-
getRequestCharacterEncoding
- Overrides:
getRequestCharacterEncoding
in classExternalContext
- Since:
- Faces 1.2
-
getResponseCharacterEncoding
- Overrides:
getResponseCharacterEncoding
in classExternalContext
- Since:
- Faces 1.2
-
setResponse
- Overrides:
setResponse
in classExternalContext
- Parameters:
response
-- Since:
- Faces 1.2
-
setResponseBufferSize
public void setResponseBufferSize(int size) - Overrides:
setResponseBufferSize
in classExternalContext
- Since:
- 2.0
-
setResponseCharacterEncoding
- Overrides:
setResponseCharacterEncoding
in classExternalContext
- Parameters:
encoding
-- Since:
- Faces 1.2
-
setResponseContentLength
public void setResponseContentLength(int length) - Overrides:
setResponseContentLength
in classExternalContext
- Since:
- 2.0
-
setResponseContentLengthLong
public void setResponseContentLengthLong(long length) - Overrides:
setResponseContentLengthLong
in classExternalContext
- Since:
- 4.1
-
setResponseContentType
- Overrides:
setResponseContentType
in classExternalContext
-
setResponseHeader
- Overrides:
setResponseHeader
in classExternalContext
- Since:
- 2.0
-
setResponseStatus
public void setResponseStatus(int statusCode) - Overrides:
setResponseStatus
in classExternalContext
-
addResponseCookie
- Overrides:
addResponseCookie
in classExternalContext
- Since:
- Faces 2.0
-
addResponseHeader
- Overrides:
addResponseHeader
in classExternalContext
-
getFlash
- Overrides:
getFlash
in classExternalContext
- Since:
- 2.0
-
isSecure
public boolean isSecure()- Overrides:
isSecure
in classExternalContext
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()- Overrides:
getSessionMaxInactiveInterval
in classExternalContext
-
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval) - Overrides:
setSessionMaxInactiveInterval
in classExternalContext
-
getCurrentFacesContext
-