org.apache.myfaces.context.servlet
Class ServletExternalContextImpl

java.lang.Object
  extended by javax.faces.context.ExternalContext
      extended by org.apache.myfaces.context.servlet.ServletExternalContextImpl
All Implemented Interfaces:
ReleaseableExternalContext

public final class ServletExternalContextImpl
extends ExternalContext
implements ReleaseableExternalContext

Implements the external context for servlet request. JSF 1.2, 6.1.3

Version:
$Revision: 693059 $ $Date: 2008-09-08 06:42:28 -0500 (Mon, 08 Sep 2008) $
Author:
Manfred Geiler (latest modification by $Author: bommel $), Anton Koinov

Field Summary
 
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 dispatch(java.lang.String requestURI)
           
 java.lang.String encodeActionURL(java.lang.String url)
           
 java.lang.String encodeNamespace(java.lang.String s)
           
 java.lang.String encodeResourceURL(java.lang.String url)
           
 java.util.Map<java.lang.String,java.lang.Object> getApplicationMap()
           
 java.lang.String getAuthType()
           
 java.lang.Object getContext()
           
 java.lang.String getInitParameter(java.lang.String s)
           
 java.util.Map<java.lang.String,java.lang.String> getInitParameterMap()
           
 java.lang.String getRemoteUser()
           
 java.lang.Object getRequest()
           
 java.lang.String getRequestCharacterEncoding()
           
 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 getRequestServletPath()
           
 java.net.URL getResource(java.lang.String path)
           
 java.io.InputStream getResourceAsStream(java.lang.String path)
           
 java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
           
 java.lang.Object getResponse()
           
 java.lang.String getResponseCharacterEncoding()
           
 java.lang.String getResponseContentType()
           
 java.lang.Object getSession(boolean create)
           
 java.util.Map<java.lang.String,java.lang.Object> getSessionMap()
           
 java.security.Principal getUserPrincipal()
           
 boolean isUserInRole(java.lang.String role)
           
 void log(java.lang.String message)
           
 void log(java.lang.String message, java.lang.Throwable exception)
           
 void redirect(java.lang.String url)
           
 void release()
          Release resources that the ExternalContext is holding onto.
 void setRequest(java.lang.Object request)
           
 void setRequestCharacterEncoding(java.lang.String encoding)
           
 void setResponse(java.lang.Object response)
           
 void setResponseCharacterEncoding(java.lang.String encoding)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletExternalContextImpl

public ServletExternalContextImpl(javax.servlet.ServletContext servletContext,
                                  javax.servlet.ServletRequest servletRequest,
                                  javax.servlet.ServletResponse servletResponse)
Method Detail

release

public void release()
Description copied from interface: ReleaseableExternalContext
Release resources that the ExternalContext is holding onto.

Specified by:
release in interface ReleaseableExternalContext

getSession

public java.lang.Object getSession(boolean create)
Specified by:
getSession in class ExternalContext

getContext

public java.lang.Object getContext()
Specified by:
getContext in class ExternalContext

getRequest

public java.lang.Object getRequest()
Specified by:
getRequest in class ExternalContext

getResponse

public java.lang.Object getResponse()
Specified by:
getResponse in class ExternalContext

getResponseContentType

public java.lang.String getResponseContentType()
Overrides:
getResponseContentType in class ExternalContext

getApplicationMap

public java.util.Map<java.lang.String,java.lang.Object> getApplicationMap()
Specified by:
getApplicationMap in class ExternalContext

getSessionMap

public java.util.Map<java.lang.String,java.lang.Object> getSessionMap()
Specified by:
getSessionMap in class ExternalContext

getRequestMap

public java.util.Map<java.lang.String,java.lang.Object> getRequestMap()
Specified by:
getRequestMap in class ExternalContext

getRequestParameterMap

public java.util.Map<java.lang.String,java.lang.String> getRequestParameterMap()
Specified by:
getRequestParameterMap in class ExternalContext

getRequestParameterValuesMap

public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterValuesMap()
Specified by:
getRequestParameterValuesMap in class ExternalContext

getRequestParameterNames

public java.util.Iterator<java.lang.String> getRequestParameterNames()
Specified by:
getRequestParameterNames in class ExternalContext

getRequestHeaderMap

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()
Specified by:
getRequestHeaderMap in class ExternalContext

getRequestHeaderValuesMap

public java.util.Map<java.lang.String,java.lang.String[]> getRequestHeaderValuesMap()
Specified by:
getRequestHeaderValuesMap in class ExternalContext

getRequestCookieMap

public java.util.Map<java.lang.String,java.lang.Object> getRequestCookieMap()
Specified by:
getRequestCookieMap in class ExternalContext

getRequestLocale

public java.util.Locale getRequestLocale()
Specified by:
getRequestLocale in class ExternalContext

getRequestPathInfo

public java.lang.String getRequestPathInfo()
Specified by:
getRequestPathInfo in class ExternalContext

getRequestContentType

public java.lang.String getRequestContentType()
Overrides:
getRequestContentType in class ExternalContext

getRequestContextPath

public java.lang.String getRequestContextPath()
Specified by:
getRequestContextPath in class ExternalContext

getInitParameter

public java.lang.String getInitParameter(java.lang.String s)
Specified by:
getInitParameter in class ExternalContext

getInitParameterMap

public java.util.Map<java.lang.String,java.lang.String> getInitParameterMap()
Specified by:
getInitParameterMap in class ExternalContext

getResourcePaths

public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
Specified by:
getResourcePaths in class ExternalContext

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String path)
Specified by:
getResourceAsStream in class ExternalContext

encodeActionURL

public java.lang.String encodeActionURL(java.lang.String url)
Specified by:
encodeActionURL in class ExternalContext

encodeResourceURL

public java.lang.String encodeResourceURL(java.lang.String url)
Specified by:
encodeResourceURL in class ExternalContext

encodeNamespace

public java.lang.String encodeNamespace(java.lang.String s)
Specified by:
encodeNamespace in class ExternalContext

dispatch

public void dispatch(java.lang.String requestURI)
              throws java.io.IOException,
                     FacesException
Specified by:
dispatch in class ExternalContext
Throws:
java.io.IOException
FacesException

getRequestServletPath

public java.lang.String getRequestServletPath()
Specified by:
getRequestServletPath in class ExternalContext

getAuthType

public java.lang.String getAuthType()
Specified by:
getAuthType in class ExternalContext

getRemoteUser

public java.lang.String getRemoteUser()
Specified by:
getRemoteUser in class ExternalContext

isUserInRole

public boolean isUserInRole(java.lang.String role)
Specified by:
isUserInRole in class ExternalContext

getUserPrincipal

public java.security.Principal getUserPrincipal()
Specified by:
getUserPrincipal in class ExternalContext

log

public void log(java.lang.String message)
Specified by:
log in class ExternalContext

log

public void log(java.lang.String message,
                java.lang.Throwable exception)
Specified by:
log in class ExternalContext

redirect

public void redirect(java.lang.String url)
              throws java.io.IOException
Specified by:
redirect in class ExternalContext
Throws:
java.io.IOException

getRequestLocales

public java.util.Iterator<java.util.Locale> getRequestLocales()
Specified by:
getRequestLocales in class ExternalContext

getResource

public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException
Specified by:
getResource in class ExternalContext
Throws:
java.net.MalformedURLException

setRequest

public void setRequest(java.lang.Object request)
Overrides:
setRequest in class ExternalContext
Parameters:
request -
Since:
JSF 1.2

setRequestCharacterEncoding

public void setRequestCharacterEncoding(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException
Overrides:
setRequestCharacterEncoding in class ExternalContext
Parameters:
encoding -
Throws:
java.io.UnsupportedEncodingException
Since:
JSF 1.2

getRequestCharacterEncoding

public java.lang.String getRequestCharacterEncoding()
Overrides:
getRequestCharacterEncoding in class ExternalContext
Since:
JSF 1.2

getResponseCharacterEncoding

public java.lang.String getResponseCharacterEncoding()
Overrides:
getResponseCharacterEncoding in class ExternalContext
Since:
JSF 1.2

setResponse

public void setResponse(java.lang.Object response)
Overrides:
setResponse in class ExternalContext
Parameters:
response -
Since:
JSF 1.2

setResponseCharacterEncoding

public void setResponseCharacterEncoding(java.lang.String encoding)
Overrides:
setResponseCharacterEncoding in class ExternalContext
Parameters:
encoding -
Since:
JSF 1.2


Copyright © 2010 The Apache Software Foundation. All Rights Reserved.