Class ServletExternalContextImpl
- java.lang.Object
-
- jakarta.faces.context.ExternalContext
-
- org.apache.myfaces.context.servlet.ServletExternalContextImplBase
-
- org.apache.myfaces.context.servlet.ServletExternalContextImpl
-
public final class ServletExternalContextImpl extends ServletExternalContextImplBase
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
Constructors Constructor Description ServletExternalContextImpl(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
-
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 Detail
-
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 Detail
-
release
public void release()
- Overrides:
releasein classServletExternalContextImplBase- Since:
- 4.0
-
getSession
public Object getSession(boolean create)
- Specified by:
getSessionin classExternalContext
-
getSessionId
public String getSessionId(boolean create)
- Overrides:
getSessionIdin classExternalContext
-
getRequest
public Object getRequest()
- Specified by:
getRequestin classExternalContext
-
getRequestContentLength
public int getRequestContentLength()
- Overrides:
getRequestContentLengthin classExternalContext- Since:
- 2.0
-
getResponse
public Object getResponse()
- Specified by:
getResponsein classExternalContext
-
getResponseBufferSize
public int getResponseBufferSize()
- Overrides:
getResponseBufferSizein classExternalContext- Since:
- 2.0
-
getResponseContentType
public String getResponseContentType()
- Overrides:
getResponseContentTypein classExternalContext
-
getResponseOutputStream
public OutputStream getResponseOutputStream() throws IOException
- Overrides:
getResponseOutputStreamin classExternalContext- Throws:
IOException
-
getResponseOutputWriter
public Writer getResponseOutputWriter() throws IOException
- Overrides:
getResponseOutputWriterin classExternalContext- Throws:
IOException- Since:
- Faces 2.0
-
getSessionMap
public Map<String,Object> getSessionMap()
- Specified by:
getSessionMapin classExternalContext
-
getRequestMap
public Map<String,Object> getRequestMap()
- Specified by:
getRequestMapin classExternalContext
-
getRequestParameterMap
public Map<String,String> getRequestParameterMap()
- Specified by:
getRequestParameterMapin classExternalContext
-
getRequestParameterValuesMap
public Map<String,String[]> getRequestParameterValuesMap()
- Specified by:
getRequestParameterValuesMapin classExternalContext
-
getRequestServerPort
public int getRequestServerPort()
- Overrides:
getRequestServerPortin classExternalContext
-
getRequestParameterNames
public Iterator<String> getRequestParameterNames()
- Specified by:
getRequestParameterNamesin classExternalContext
-
getRequestHeaderMap
public Map<String,String> getRequestHeaderMap()
- Specified by:
getRequestHeaderMapin classExternalContext
-
getRequestHeaderValuesMap
public Map<String,String[]> getRequestHeaderValuesMap()
- Specified by:
getRequestHeaderValuesMapin classExternalContext
-
getRequestCookieMap
public Map<String,Object> getRequestCookieMap()
- Specified by:
getRequestCookieMapin classExternalContext
-
getRequestLocale
public Locale getRequestLocale()
- Specified by:
getRequestLocalein classExternalContext
-
getRequestPathInfo
public String getRequestPathInfo()
- Specified by:
getRequestPathInfoin classExternalContext
-
getRequestContentType
public String getRequestContentType()
- Overrides:
getRequestContentTypein classExternalContext
-
getRequestContextPath
public String getRequestContextPath()
- Specified by:
getRequestContextPathin classExternalContext
-
getRequestScheme
public String getRequestScheme()
- Overrides:
getRequestSchemein classExternalContext
-
encodeActionURL
public String encodeActionURL(String url)
- Specified by:
encodeActionURLin classExternalContext
-
encodeBookmarkableURL
public String encodeBookmarkableURL(String baseUrl, Map<String,List<String>> parameters)
- Overrides:
encodeBookmarkableURLin classExternalContext
-
encodeResourceURL
public String encodeResourceURL(String url)
- Specified by:
encodeResourceURLin classExternalContext
-
pushResource
protected void pushResource(String resourceUrl)
-
encodeNamespace
public String encodeNamespace(String s)
- Specified by:
encodeNamespacein classExternalContext
-
encodePartialActionURL
public String encodePartialActionURL(String url)
- Overrides:
encodePartialActionURLin classExternalContext
-
encodeRedirectURL
public String encodeRedirectURL(String baseUrl, Map<String,List<String>> parameters)
- Overrides:
encodeRedirectURLin classExternalContext
-
encodeWebsocketURL
public String encodeWebsocketURL(String url)
- Specified by:
encodeWebsocketURLin classExternalContext
-
dispatch
public void dispatch(String requestURI) throws IOException, FacesException
- Specified by:
dispatchin classExternalContext- Throws:
IOExceptionFacesException
-
getRequestServerName
public String getRequestServerName()
- Overrides:
getRequestServerNamein classExternalContext
-
getRequestServletPath
public String getRequestServletPath()
- Specified by:
getRequestServletPathin classExternalContext
-
getAuthType
public String getAuthType()
- Specified by:
getAuthTypein classExternalContext
-
getRemoteUser
public String getRemoteUser()
- Specified by:
getRemoteUserin classExternalContext
-
isUserInRole
public boolean isUserInRole(String role)
- Specified by:
isUserInRolein classExternalContext
-
getUserPrincipal
public Principal getUserPrincipal()
- Specified by:
getUserPrincipalin classExternalContext
-
invalidateSession
public void invalidateSession()
- Overrides:
invalidateSessionin classExternalContext
-
isResponseCommitted
public boolean isResponseCommitted()
- Overrides:
isResponseCommittedin classExternalContext- Since:
- 2.0
-
redirect
public void redirect(String url) throws IOException
- Specified by:
redirectin classExternalContext- Throws:
IOException
-
responseFlushBuffer
public void responseFlushBuffer() throws IOException- Overrides:
responseFlushBufferin classExternalContext- Throws:
IOException- Since:
- 2.0
-
responseReset
public void responseReset()
- Overrides:
responseResetin classExternalContext- Since:
- 2.0
-
responseSendError
public void responseSendError(int statusCode, String message) throws IOException- Overrides:
responseSendErrorin classExternalContext- Throws:
IOException- Since:
- 2.0
-
getRequestLocales
public Iterator<Locale> getRequestLocales()
- Specified by:
getRequestLocalesin classExternalContext
-
setRequest
public void setRequest(Object request)
- Overrides:
setRequestin classExternalContext- Parameters:
request-- Since:
- Faces 1.2
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(String encoding) throws UnsupportedEncodingException
- Overrides:
setRequestCharacterEncodingin classExternalContext- Parameters:
encoding-- Throws:
UnsupportedEncodingException- Since:
- Faces 1.2
-
getRequestCharacterEncoding
public String getRequestCharacterEncoding()
- Overrides:
getRequestCharacterEncodingin classExternalContext- Since:
- Faces 1.2
-
getResponseCharacterEncoding
public String getResponseCharacterEncoding()
- Overrides:
getResponseCharacterEncodingin classExternalContext- Since:
- Faces 1.2
-
setResponse
public void setResponse(Object response)
- Overrides:
setResponsein classExternalContext- Parameters:
response-- Since:
- Faces 1.2
-
setResponseBufferSize
public void setResponseBufferSize(int size)
- Overrides:
setResponseBufferSizein classExternalContext- Since:
- 2.0
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(String encoding)
- Overrides:
setResponseCharacterEncodingin classExternalContext- Parameters:
encoding-- Since:
- Faces 1.2
-
setResponseContentLength
public void setResponseContentLength(int length)
- Overrides:
setResponseContentLengthin classExternalContext- Since:
- 2.0
-
setResponseContentType
public void setResponseContentType(String contentType)
- Overrides:
setResponseContentTypein classExternalContext
-
setResponseHeader
public void setResponseHeader(String name, String value)
- Overrides:
setResponseHeaderin classExternalContext- Since:
- 2.0
-
setResponseStatus
public void setResponseStatus(int statusCode)
- Overrides:
setResponseStatusin classExternalContext
-
addResponseCookie
public void addResponseCookie(String name, String value, Map<String,Object> properties)
- Overrides:
addResponseCookiein classExternalContext- Since:
- Faces 2.0
-
addResponseHeader
public void addResponseHeader(String name, String value)
- Overrides:
addResponseHeaderin classExternalContext
-
getFlash
public Flash 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
protected FacesContext getCurrentFacesContext()
-
-