org.apache.myfaces.context.servlet
Class ServletExternalContextImpl
java.lang.Object
javax.faces.context.ExternalContext
org.apache.myfaces.context.servlet.ServletExternalContextImplBase
org.apache.myfaces.context.servlet.ServletExternalContextImpl
- All Implemented Interfaces:
- ReleaseableExternalContext
public final class ServletExternalContextImpl
- extends ServletExternalContextImplBase
Implements the external context for servlet request. JSF 1.2, 6.1.3
- Version:
- $Revision: 1087885 $ $Date: 2011-04-01 15:26:47 -0500 (Fri, 01 Apr 2011) $
- Author:
- Manfred Geiler (latest modification by $Author: lu4242 $), Anton Koinov
Fields inherited from class javax.faces.context.ExternalContext |
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Constructor Summary |
ServletExternalContextImpl(javax.servlet.ServletContext servletContext,
javax.servlet.ServletRequest servletRequest,
javax.servlet.ServletResponse servletResponse)
|
Method Summary |
void |
addResponseCookie(java.lang.String name,
java.lang.String value,
java.util.Map<java.lang.String,java.lang.Object> properties)
|
void |
addResponseHeader(java.lang.String name,
java.lang.String value)
|
void |
dispatch(java.lang.String requestURI)
|
java.lang.String |
encodeActionURL(java.lang.String url)
|
java.lang.String |
encodeBookmarkableURL(java.lang.String baseUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
|
java.lang.String |
encodeNamespace(java.lang.String s)
|
java.lang.String |
encodePartialActionURL(java.lang.String url)
|
java.lang.String |
encodeRedirectURL(java.lang.String baseUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
|
java.lang.String |
encodeResourceURL(java.lang.String url)
|
java.lang.String |
getAuthType()
|
javax.faces.context.Flash |
getFlash()
|
java.lang.String |
getRemoteUser()
|
java.lang.Object |
getRequest()
|
java.lang.String |
getRequestCharacterEncoding()
|
int |
getRequestContentLength()
|
java.lang.String |
getRequestContentType()
|
java.lang.String |
getRequestContextPath()
|
java.util.Map<java.lang.String,java.lang.Object> |
getRequestCookieMap()
|
java.util.Map<java.lang.String,java.lang.String> |
getRequestHeaderMap()
|
java.util.Map<java.lang.String,java.lang.String[]> |
getRequestHeaderValuesMap()
|
java.util.Locale |
getRequestLocale()
|
java.util.Iterator<java.util.Locale> |
getRequestLocales()
|
java.util.Map<java.lang.String,java.lang.Object> |
getRequestMap()
|
java.util.Map<java.lang.String,java.lang.String> |
getRequestParameterMap()
|
java.util.Iterator<java.lang.String> |
getRequestParameterNames()
|
java.util.Map<java.lang.String,java.lang.String[]> |
getRequestParameterValuesMap()
|
java.lang.String |
getRequestPathInfo()
|
java.lang.String |
getRequestScheme()
|
java.lang.String |
getRequestServerName()
|
int |
getRequestServerPort()
|
java.lang.String |
getRequestServletPath()
|
java.lang.Object |
getResponse()
|
int |
getResponseBufferSize()
|
java.lang.String |
getResponseCharacterEncoding()
|
java.lang.String |
getResponseContentType()
|
java.io.OutputStream |
getResponseOutputStream()
|
java.io.Writer |
getResponseOutputWriter()
|
java.lang.Object |
getSession(boolean create)
|
java.util.Map<java.lang.String,java.lang.Object> |
getSessionMap()
|
int |
getSessionMaxInactiveInterval()
|
java.security.Principal |
getUserPrincipal()
|
void |
invalidateSession()
|
boolean |
isResponseCommitted()
|
boolean |
isSecure()
|
boolean |
isUserInRole(java.lang.String role)
|
void |
redirect(java.lang.String url)
|
void |
release()
Release resources that the ExternalContext is holding onto. |
void |
responseFlushBuffer()
|
void |
responseReset()
|
void |
responseSendError(int statusCode,
java.lang.String message)
|
void |
setRequest(java.lang.Object request)
|
void |
setRequestCharacterEncoding(java.lang.String encoding)
|
void |
setResponse(java.lang.Object response)
|
void |
setResponseBufferSize(int size)
|
void |
setResponseCharacterEncoding(java.lang.String encoding)
|
void |
setResponseContentLength(int length)
|
void |
setResponseContentType(java.lang.String contentType)
|
void |
setResponseHeader(java.lang.String name,
java.lang.String value)
|
void |
setResponseStatus(int statusCode)
|
void |
setSessionMaxInactiveInterval(int interval)
|
Methods inherited from class org.apache.myfaces.context.servlet.ServletExternalContextImplBase |
checkNull, getApplicationMap, getContext, getContextName, getInitParameter, getInitParameterMap, getMimeType, getRealPath, getResource, getResourceAsStream, getResourcePaths, log, log |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ServletExternalContextImpl
public ServletExternalContextImpl(javax.servlet.ServletContext servletContext,
javax.servlet.ServletRequest servletRequest,
javax.servlet.ServletResponse servletResponse)
release
public void release()
- Description copied from interface:
ReleaseableExternalContext
- Release resources that the ExternalContext is holding onto.
- Specified by:
release
in interface ReleaseableExternalContext
- Overrides:
release
in class ServletExternalContextImplBase
getSession
public java.lang.Object getSession(boolean create)
- Specified by:
getSession
in class javax.faces.context.ExternalContext
getRequest
public java.lang.Object getRequest()
- Specified by:
getRequest
in class javax.faces.context.ExternalContext
getRequestContentLength
public int getRequestContentLength()
- Overrides:
getRequestContentLength
in class javax.faces.context.ExternalContext
- Since:
- 2.0
getResponse
public java.lang.Object getResponse()
- Specified by:
getResponse
in class javax.faces.context.ExternalContext
getResponseBufferSize
public int getResponseBufferSize()
- Overrides:
getResponseBufferSize
in class javax.faces.context.ExternalContext
- Since:
- 2.0
getResponseContentType
public java.lang.String getResponseContentType()
- Overrides:
getResponseContentType
in class javax.faces.context.ExternalContext
getResponseOutputStream
public java.io.OutputStream getResponseOutputStream()
throws java.io.IOException
- Overrides:
getResponseOutputStream
in class javax.faces.context.ExternalContext
- Throws:
java.io.IOException
getResponseOutputWriter
public java.io.Writer getResponseOutputWriter()
throws java.io.IOException
- Overrides:
getResponseOutputWriter
in class javax.faces.context.ExternalContext
- Throws:
java.io.IOException
- Since:
- JSF 2.0
getSessionMap
public java.util.Map<java.lang.String,java.lang.Object> getSessionMap()
- Specified by:
getSessionMap
in class javax.faces.context.ExternalContext
getRequestMap
public java.util.Map<java.lang.String,java.lang.Object> getRequestMap()
- Specified by:
getRequestMap
in class javax.faces.context.ExternalContext
getRequestParameterMap
public java.util.Map<java.lang.String,java.lang.String> getRequestParameterMap()
- Specified by:
getRequestParameterMap
in class javax.faces.context.ExternalContext
getRequestParameterValuesMap
public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterValuesMap()
- Specified by:
getRequestParameterValuesMap
in class javax.faces.context.ExternalContext
getRequestServerPort
public int getRequestServerPort()
- Overrides:
getRequestServerPort
in class javax.faces.context.ExternalContext
getRequestParameterNames
public java.util.Iterator<java.lang.String> getRequestParameterNames()
- Specified by:
getRequestParameterNames
in class javax.faces.context.ExternalContext
getRequestHeaderMap
public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()
- Specified by:
getRequestHeaderMap
in class javax.faces.context.ExternalContext
getRequestHeaderValuesMap
public java.util.Map<java.lang.String,java.lang.String[]> getRequestHeaderValuesMap()
- Specified by:
getRequestHeaderValuesMap
in class javax.faces.context.ExternalContext
getRequestCookieMap
public java.util.Map<java.lang.String,java.lang.Object> getRequestCookieMap()
- Specified by:
getRequestCookieMap
in class javax.faces.context.ExternalContext
getRequestLocale
public java.util.Locale getRequestLocale()
- Specified by:
getRequestLocale
in class javax.faces.context.ExternalContext
getRequestPathInfo
public java.lang.String getRequestPathInfo()
- Specified by:
getRequestPathInfo
in class javax.faces.context.ExternalContext
getRequestContentType
public java.lang.String getRequestContentType()
- Overrides:
getRequestContentType
in class javax.faces.context.ExternalContext
getRequestContextPath
public java.lang.String getRequestContextPath()
- Specified by:
getRequestContextPath
in class javax.faces.context.ExternalContext
getRequestScheme
public java.lang.String getRequestScheme()
- Overrides:
getRequestScheme
in class javax.faces.context.ExternalContext
encodeActionURL
public java.lang.String encodeActionURL(java.lang.String url)
- Specified by:
encodeActionURL
in class javax.faces.context.ExternalContext
encodeBookmarkableURL
public java.lang.String encodeBookmarkableURL(java.lang.String baseUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
- Overrides:
encodeBookmarkableURL
in class javax.faces.context.ExternalContext
encodeResourceURL
public java.lang.String encodeResourceURL(java.lang.String url)
- Specified by:
encodeResourceURL
in class javax.faces.context.ExternalContext
encodeNamespace
public java.lang.String encodeNamespace(java.lang.String s)
- Specified by:
encodeNamespace
in class javax.faces.context.ExternalContext
encodePartialActionURL
public java.lang.String encodePartialActionURL(java.lang.String url)
- Overrides:
encodePartialActionURL
in class javax.faces.context.ExternalContext
encodeRedirectURL
public java.lang.String encodeRedirectURL(java.lang.String baseUrl,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> parameters)
- Overrides:
encodeRedirectURL
in class javax.faces.context.ExternalContext
dispatch
public void dispatch(java.lang.String requestURI)
throws java.io.IOException,
javax.faces.FacesException
- Specified by:
dispatch
in class javax.faces.context.ExternalContext
- Throws:
java.io.IOException
javax.faces.FacesException
getRequestServerName
public java.lang.String getRequestServerName()
- Overrides:
getRequestServerName
in class javax.faces.context.ExternalContext
getRequestServletPath
public java.lang.String getRequestServletPath()
- Specified by:
getRequestServletPath
in class javax.faces.context.ExternalContext
getAuthType
public java.lang.String getAuthType()
- Specified by:
getAuthType
in class javax.faces.context.ExternalContext
getRemoteUser
public java.lang.String getRemoteUser()
- Specified by:
getRemoteUser
in class javax.faces.context.ExternalContext
isUserInRole
public boolean isUserInRole(java.lang.String role)
- Specified by:
isUserInRole
in class javax.faces.context.ExternalContext
getUserPrincipal
public java.security.Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in class javax.faces.context.ExternalContext
invalidateSession
public void invalidateSession()
- Overrides:
invalidateSession
in class javax.faces.context.ExternalContext
isResponseCommitted
public boolean isResponseCommitted()
- Overrides:
isResponseCommitted
in class javax.faces.context.ExternalContext
- Since:
- 2.0
redirect
public void redirect(java.lang.String url)
throws java.io.IOException
- Specified by:
redirect
in class javax.faces.context.ExternalContext
- Throws:
java.io.IOException
responseFlushBuffer
public void responseFlushBuffer()
throws java.io.IOException
- Overrides:
responseFlushBuffer
in class javax.faces.context.ExternalContext
- Throws:
java.io.IOException
- Since:
- 2.0
responseReset
public void responseReset()
- Overrides:
responseReset
in class javax.faces.context.ExternalContext
- Since:
- 2.0
responseSendError
public void responseSendError(int statusCode,
java.lang.String message)
throws java.io.IOException
- Overrides:
responseSendError
in class javax.faces.context.ExternalContext
- Throws:
java.io.IOException
- Since:
- 2.0
getRequestLocales
public java.util.Iterator<java.util.Locale> getRequestLocales()
- Specified by:
getRequestLocales
in class javax.faces.context.ExternalContext
setRequest
public void setRequest(java.lang.Object request)
- Overrides:
setRequest
in class javax.faces.context.ExternalContext
- Parameters:
request
- - Since:
- JSF 1.2
setRequestCharacterEncoding
public void setRequestCharacterEncoding(java.lang.String encoding)
throws java.io.UnsupportedEncodingException
- Overrides:
setRequestCharacterEncoding
in class javax.faces.context.ExternalContext
- Parameters:
encoding
-
- Throws:
java.io.UnsupportedEncodingException
- Since:
- JSF 1.2
getRequestCharacterEncoding
public java.lang.String getRequestCharacterEncoding()
- Overrides:
getRequestCharacterEncoding
in class javax.faces.context.ExternalContext
- Since:
- JSF 1.2
getResponseCharacterEncoding
public java.lang.String getResponseCharacterEncoding()
- Overrides:
getResponseCharacterEncoding
in class javax.faces.context.ExternalContext
- Since:
- JSF 1.2
setResponse
public void setResponse(java.lang.Object response)
- Overrides:
setResponse
in class javax.faces.context.ExternalContext
- Parameters:
response
- - Since:
- JSF 1.2
setResponseBufferSize
public void setResponseBufferSize(int size)
- Overrides:
setResponseBufferSize
in class javax.faces.context.ExternalContext
- Since:
- 2.0
setResponseCharacterEncoding
public void setResponseCharacterEncoding(java.lang.String encoding)
- Overrides:
setResponseCharacterEncoding
in class javax.faces.context.ExternalContext
- Parameters:
encoding
- - Since:
- JSF 1.2
setResponseContentLength
public void setResponseContentLength(int length)
- Overrides:
setResponseContentLength
in class javax.faces.context.ExternalContext
- Since:
- 2.0
setResponseContentType
public void setResponseContentType(java.lang.String contentType)
- Overrides:
setResponseContentType
in class javax.faces.context.ExternalContext
setResponseHeader
public void setResponseHeader(java.lang.String name,
java.lang.String value)
- Overrides:
setResponseHeader
in class javax.faces.context.ExternalContext
- Since:
- 2.0
setResponseStatus
public void setResponseStatus(int statusCode)
- Overrides:
setResponseStatus
in class javax.faces.context.ExternalContext
addResponseCookie
public void addResponseCookie(java.lang.String name,
java.lang.String value,
java.util.Map<java.lang.String,java.lang.Object> properties)
- Overrides:
addResponseCookie
in class javax.faces.context.ExternalContext
- Since:
- JSF 2.0
addResponseHeader
public void addResponseHeader(java.lang.String name,
java.lang.String value)
- Overrides:
addResponseHeader
in class javax.faces.context.ExternalContext
getFlash
public javax.faces.context.Flash getFlash()
- Overrides:
getFlash
in class javax.faces.context.ExternalContext
- Since:
- 2.0
isSecure
public boolean isSecure()
- Overrides:
isSecure
in class javax.faces.context.ExternalContext
getSessionMaxInactiveInterval
public int getSessionMaxInactiveInterval()
- Overrides:
getSessionMaxInactiveInterval
in class javax.faces.context.ExternalContext
setSessionMaxInactiveInterval
public void setSessionMaxInactiveInterval(int interval)
- Overrides:
setSessionMaxInactiveInterval
in class javax.faces.context.ExternalContext
Copyright © 2011 The Apache Software Foundation. All Rights Reserved.