org.apache.myfaces.context.servlet
Class ServletExternalContextImpl

java.lang.Object
  javax.faces.context.ExternalContext
      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: 1057820 $ $Date: 2011-01-11 14:33:21 -0500 (Tue, 11 Jan 2011) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $), 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(String requestURI)
String	encodeActionURL(String url)
String	encodeNamespace(String s)
String	encodeResourceURL(String url)
Map<String,Object>	getApplicationMap()
String	getAuthType()
Object	getContext()
String	getInitParameter(String s)
Map<String,String>	getInitParameterMap()
String	getRemoteUser()
Object	getRequest()
String	getRequestCharacterEncoding()
String	getRequestContentType()
String	getRequestContextPath()
Map<String,Object>	getRequestCookieMap()
Map<String,String>	getRequestHeaderMap()
Map<String,String[]>	getRequestHeaderValuesMap()
Locale	getRequestLocale()
Iterator<Locale>	getRequestLocales()
Map<String,Object>	getRequestMap()
Map<String,String>	getRequestParameterMap()
Iterator<String>	getRequestParameterNames()
Map<String,String[]>	getRequestParameterValuesMap()
String	getRequestPathInfo()
String	getRequestServletPath()
URL	getResource(String path)
InputStream	getResourceAsStream(String path)
Set<String>	getResourcePaths(String path)
Object	getResponse()
String	getResponseCharacterEncoding()
String	getResponseContentType()
Object	getSession(boolean create)
Map<String,Object>	getSessionMap()
Principal	getUserPrincipal()
boolean	isUserInRole(String role)
void	log(String message)
void	log(String message, Throwable exception)
void	redirect(String url)
void	release() Release resources that the ExternalContext is holding onto.
void	setRequest(Object request)
void	setRequestCharacterEncoding(String encoding)
void	setResponse(Object response)
void	setResponseCharacterEncoding(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 Object getSession(boolean create)

Specified by:

getSession in class ExternalContext

getContext

public Object getContext()

Specified by:

getContext in class ExternalContext

getRequest

public Object getRequest()

Specified by:

getRequest in class ExternalContext

getResponse

public Object getResponse()

Specified by:

getResponse in class ExternalContext

getResponseContentType

public String getResponseContentType()

Overrides:

getResponseContentType in class ExternalContext

getApplicationMap

public Map<String,Object> getApplicationMap()

Specified by:

getApplicationMap in class ExternalContext

getSessionMap

public Map<String,Object> getSessionMap()

Specified by:

getSessionMap in class ExternalContext

getRequestMap

public Map<String,Object> getRequestMap()

Specified by:

getRequestMap in class ExternalContext

getRequestParameterMap

public Map<String,String> getRequestParameterMap()

Specified by:

getRequestParameterMap in class ExternalContext

getRequestParameterValuesMap

public Map<String,String[]> getRequestParameterValuesMap()

Specified by:

getRequestParameterValuesMap in class ExternalContext

getRequestParameterNames

public Iterator<String> getRequestParameterNames()

Specified by:

getRequestParameterNames in class ExternalContext

getRequestHeaderMap

public Map<String,String> getRequestHeaderMap()

Specified by:

getRequestHeaderMap in class ExternalContext

getRequestHeaderValuesMap

public Map<String,String[]> getRequestHeaderValuesMap()

Specified by:

getRequestHeaderValuesMap in class ExternalContext

getRequestCookieMap

public Map<String,Object> getRequestCookieMap()

Specified by:

getRequestCookieMap in class ExternalContext

getRequestLocale

public Locale getRequestLocale()

Specified by:

getRequestLocale in class ExternalContext

getRequestPathInfo

public String getRequestPathInfo()

Specified by:

getRequestPathInfo in class ExternalContext

getRequestContentType

public String getRequestContentType()

Overrides:

getRequestContentType in class ExternalContext

getRequestContextPath

public String getRequestContextPath()

Specified by:

getRequestContextPath in class ExternalContext

getInitParameter

public String getInitParameter(String s)

Specified by:

getInitParameter in class ExternalContext

getInitParameterMap

public Map<String,String> getInitParameterMap()

Specified by:

getInitParameterMap in class ExternalContext

getResourcePaths

public Set<String> getResourcePaths(String path)

Specified by:

getResourcePaths in class ExternalContext

getResourceAsStream

public InputStream getResourceAsStream(String path)

Specified by:

getResourceAsStream in class ExternalContext

encodeActionURL

public String encodeActionURL(String url)

Specified by:

encodeActionURL in class ExternalContext

encodeResourceURL

public String encodeResourceURL(String url)

Specified by:

encodeResourceURL in class ExternalContext

encodeNamespace

public String encodeNamespace(String s)

Specified by:

encodeNamespace in class ExternalContext

dispatch

public void dispatch(String requestURI)
              throws IOException,
                     FacesException

Specified by:

dispatch in class ExternalContext

Throws:

IOException

FacesException

getRequestServletPath

public String getRequestServletPath()

Specified by:

getRequestServletPath in class ExternalContext

getAuthType

public String getAuthType()

Specified by:

getAuthType in class ExternalContext

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in class ExternalContext

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in class ExternalContext

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in class ExternalContext

log

public void log(String message)

Specified by:

log in class ExternalContext

log

public void log(String message,
                Throwable exception)

Specified by:

log in class ExternalContext

redirect

public void redirect(String url)
              throws IOException

Specified by:

redirect in class ExternalContext

Throws:

IOException

getRequestLocales

public Iterator<Locale> getRequestLocales()

Specified by:

getRequestLocales in class ExternalContext

getResource

public URL getResource(String path)
                throws MalformedURLException

Specified by:

getResource in class ExternalContext

Throws:

MalformedURLException

setRequest

public void setRequest(Object request)

Overrides:

setRequest in class ExternalContext

Parameters:

request -

Since:

JSF 1.2

setRequestCharacterEncoding

public void setRequestCharacterEncoding(String encoding)
                                 throws UnsupportedEncodingException

Overrides:

setRequestCharacterEncoding in class ExternalContext

Parameters:

encoding -

Throws:

UnsupportedEncodingException

Since:

JSF 1.2

getRequestCharacterEncoding

public String getRequestCharacterEncoding()

Overrides:

getRequestCharacterEncoding in class ExternalContext

Since:

JSF 1.2

getResponseCharacterEncoding

public String getResponseCharacterEncoding()

Overrides:

getResponseCharacterEncoding in class ExternalContext

Since:

JSF 1.2

setResponse

public void setResponse(Object response)

Overrides:

setResponse in class ExternalContext

Parameters:

response -

Since:

JSF 1.2

setResponseCharacterEncoding

public void setResponseCharacterEncoding(String encoding)

Overrides:

setResponseCharacterEncoding in class ExternalContext

Parameters:

encoding -

Since:

JSF 1.2