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 TypeMethodDescriptionvoidvoidaddResponseHeader(String name, String value) voidencodeActionURL(String url) encodeResourceURL(String url) encodeWebsocketURL(String url) protected FacesContextgetFlash()intintintgetSession(boolean create) getSessionId(boolean create) intvoidbooleanbooleanisSecure()booleanisUserInRole(String role) protected voidpushResource(String resourceUrl) voidvoidrelease()voidvoidvoidresponseSendError(int statusCode, String message) voidsetRequest(Object request) voidsetRequestCharacterEncoding(String encoding) voidsetResponse(Object response) voidsetResponseBufferSize(int size) voidsetResponseCharacterEncoding(String encoding) voidsetResponseContentLength(int length) voidsetResponseContentLengthLong(long length) voidsetResponseContentType(String contentType) voidsetResponseHeader(String name, String value) voidsetResponseStatus(int statusCode) voidsetSessionMaxInactiveInterval(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:
releasein classServletExternalContextImplBase- Since:
- 4.0
-
getSession
- Specified by:
getSessionin classExternalContext
-
getSessionId
- Overrides:
getSessionIdin classExternalContext
-
getRequest
- Specified by:
getRequestin classExternalContext
-
getRequestContentLength
public int getRequestContentLength()- Overrides:
getRequestContentLengthin classExternalContext- Since:
- 2.0
-
getResponse
- Specified by:
getResponsein classExternalContext
-
getResponseBufferSize
public int getResponseBufferSize()- Overrides:
getResponseBufferSizein classExternalContext- Since:
- 2.0
-
getResponseContentType
- Overrides:
getResponseContentTypein classExternalContext
-
getResponseOutputStream
- Overrides:
getResponseOutputStreamin classExternalContext- Throws:
IOException
-
getResponseOutputWriter
- Overrides:
getResponseOutputWriterin classExternalContext- Throws:
IOException- Since:
- Faces 2.0
-
getSessionMap
- Specified by:
getSessionMapin classExternalContext
-
getRequestMap
- Specified by:
getRequestMapin classExternalContext
-
getRequestParameterMap
- Specified by:
getRequestParameterMapin classExternalContext
-
getRequestParameterValuesMap
- Specified by:
getRequestParameterValuesMapin classExternalContext
-
getRequestServerPort
public int getRequestServerPort()- Overrides:
getRequestServerPortin classExternalContext
-
getRequestParameterNames
- Specified by:
getRequestParameterNamesin classExternalContext
-
getRequestHeaderMap
- Specified by:
getRequestHeaderMapin classExternalContext
-
getRequestHeaderValuesMap
- Specified by:
getRequestHeaderValuesMapin classExternalContext
-
getRequestCookieMap
- Specified by:
getRequestCookieMapin classExternalContext
-
getRequestLocale
- Specified by:
getRequestLocalein classExternalContext
-
getRequestPathInfo
- Specified by:
getRequestPathInfoin classExternalContext
-
getRequestContentType
- Overrides:
getRequestContentTypein classExternalContext
-
getRequestContextPath
- Specified by:
getRequestContextPathin classExternalContext
-
getRequestScheme
- Overrides:
getRequestSchemein classExternalContext
-
encodeActionURL
- Specified by:
encodeActionURLin classExternalContext
-
encodeBookmarkableURL
- Overrides:
encodeBookmarkableURLin classExternalContext
-
encodeResourceURL
- Specified by:
encodeResourceURLin classExternalContext
-
pushResource
-
encodeNamespace
- Specified by:
encodeNamespacein classExternalContext
-
encodePartialActionURL
- Overrides:
encodePartialActionURLin classExternalContext
-
encodeRedirectURL
- Overrides:
encodeRedirectURLin classExternalContext
-
encodeWebsocketURL
- Specified by:
encodeWebsocketURLin classExternalContext
-
dispatch
- Specified by:
dispatchin classExternalContext- Throws:
IOExceptionFacesException
-
getRequestServerName
- Overrides:
getRequestServerNamein classExternalContext
-
getRequestServletPath
- Specified by:
getRequestServletPathin classExternalContext
-
getAuthType
- Specified by:
getAuthTypein classExternalContext
-
getRemoteUser
- Specified by:
getRemoteUserin classExternalContext
-
isUserInRole
- Specified by:
isUserInRolein classExternalContext
-
getUserPrincipal
- Specified by:
getUserPrincipalin classExternalContext
-
invalidateSession
public void invalidateSession()- Overrides:
invalidateSessionin classExternalContext
-
isResponseCommitted
public boolean isResponseCommitted()- Overrides:
isResponseCommittedin classExternalContext- Since:
- 2.0
-
redirect
- Specified by:
redirectin classExternalContext- Throws:
IOException
-
responseFlushBuffer
- Overrides:
responseFlushBufferin classExternalContext- Throws:
IOException- Since:
- 2.0
-
responseReset
public void responseReset()- Overrides:
responseResetin classExternalContext- Since:
- 2.0
-
responseSendError
- Overrides:
responseSendErrorin classExternalContext- Throws:
IOException- Since:
- 2.0
-
getRequestLocales
- Specified by:
getRequestLocalesin classExternalContext
-
setRequest
- Overrides:
setRequestin classExternalContext- Parameters:
request-- Since:
- Faces 1.2
-
setRequestCharacterEncoding
- Overrides:
setRequestCharacterEncodingin classExternalContext- Parameters:
encoding-- Throws:
UnsupportedEncodingException- Since:
- Faces 1.2
-
getRequestCharacterEncoding
- Overrides:
getRequestCharacterEncodingin classExternalContext- Since:
- Faces 1.2
-
getResponseCharacterEncoding
- Overrides:
getResponseCharacterEncodingin classExternalContext- Since:
- Faces 1.2
-
setResponse
- Overrides:
setResponsein classExternalContext- Parameters:
response-- Since:
- Faces 1.2
-
setResponseBufferSize
public void setResponseBufferSize(int size) - Overrides:
setResponseBufferSizein classExternalContext- Since:
- 2.0
-
setResponseCharacterEncoding
- Overrides:
setResponseCharacterEncodingin classExternalContext- Parameters:
encoding-- Since:
- Faces 1.2
-
setResponseContentLength
public void setResponseContentLength(int length) - Overrides:
setResponseContentLengthin classExternalContext- Since:
- 2.0
-
setResponseContentLengthLong
public void setResponseContentLengthLong(long length) - Overrides:
setResponseContentLengthLongin classExternalContext- Since:
- 4.1
-
setResponseContentType
- Overrides:
setResponseContentTypein classExternalContext
-
setResponseHeader
- Overrides:
setResponseHeaderin classExternalContext- Since:
- 2.0
-
setResponseStatus
public void setResponseStatus(int statusCode) - Overrides:
setResponseStatusin classExternalContext
-
addResponseCookie
- Overrides:
addResponseCookiein classExternalContext- Since:
- Faces 2.0
-
addResponseHeader
- Overrides:
addResponseHeaderin classExternalContext
-
getFlash
- Overrides:
getFlashin classExternalContext- Since:
- 2.0
-
isSecure
public boolean isSecure()- Overrides:
isSecurein classExternalContext
-
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()- Overrides:
getSessionMaxInactiveIntervalin classExternalContext
-
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval) - Overrides:
setSessionMaxInactiveIntervalin classExternalContext
-
getCurrentFacesContext
-