com.sun.faces.context

Class ExternalContextImpl

java.lang.Object

javax.faces.context.ExternalContext

com.sun.faces.context.ExternalContextImpl

public class ExternalContextImpl
extends javax.faces.context.ExternalContext

This implementation of ExternalContext is specific to the servlet implementation.

Version:

$Id: ExternalContextImpl.java,v 1.55.2.4 2007/05/02 20:28:25 rlubke Exp $

Author:

Brendan Murray

Field Summary

Fields inherited from class javax.faces.context.ExternalContext

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
ExternalContextImpl(javax.servlet.ServletContext sc, javax.servlet.ServletRequest request, javax.servlet.ServletResponse response)

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatch(java.lang.String requestURI)
java.lang.String	encodeActionURL(java.lang.String sb) Force any URL that causes an action to work within a portal/portlet.
java.lang.String	encodeNamespace(java.lang.String aValue)
java.lang.String	encodeResourceURL(java.lang.String sb) Force any URL that references a resource to work within a portal/portlet.
java.lang.String	encodeURL(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 name) Manage attributes associated with the ServletContext instance associated with the current request.
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()
javax.servlet.http.Cookie[]	getRequestCookies()
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 throwable)
void	redirect(java.lang.String requestURI)
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

ExternalContextImpl

public ExternalContextImpl(javax.servlet.ServletContext sc,
                   javax.servlet.ServletRequest request,
                   javax.servlet.ServletResponse response)

Method Detail

getSession

public java.lang.Object getSession(boolean create)

Specified by:

getSession in class javax.faces.context.ExternalContext

getContext

public java.lang.Object getContext()

Specified by:

getContext in class javax.faces.context.ExternalContext

getRequest

public java.lang.Object getRequest()

Specified by:

getRequest in class javax.faces.context.ExternalContext

setRequest

public void setRequest(java.lang.Object request)

Overrides:

setRequest in class javax.faces.context.ExternalContext

setRequestCharacterEncoding

public void setRequestCharacterEncoding(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException

Overrides:

setRequestCharacterEncoding in class javax.faces.context.ExternalContext

Throws:

java.io.UnsupportedEncodingException

getResponse

public java.lang.Object getResponse()

Specified by:

getResponse in class javax.faces.context.ExternalContext

setResponse

public void setResponse(java.lang.Object response)

Overrides:

setResponse in class javax.faces.context.ExternalContext

setResponseCharacterEncoding

public void setResponseCharacterEncoding(java.lang.String encoding)

Overrides:

setResponseCharacterEncoding in class javax.faces.context.ExternalContext

getApplicationMap

public java.util.Map<java.lang.String,java.lang.Object> getApplicationMap()

Specified by:

getApplicationMap in class javax.faces.context.ExternalContext

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

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

getInitParameterMap

public java.util.Map<java.lang.String,java.lang.String> getInitParameterMap()

Specified by:

getInitParameterMap 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

getRequestParameterNames

public java.util.Iterator<java.lang.String> getRequestParameterNames()

Specified by:

getRequestParameterNames in class javax.faces.context.ExternalContext

getRequestLocale

public java.util.Locale getRequestLocale()

Specified by:

getRequestLocale in class javax.faces.context.ExternalContext

getRequestLocales

public java.util.Iterator<java.util.Locale> getRequestLocales()

Specified by:

getRequestLocales in class javax.faces.context.ExternalContext

getRequestPathInfo

public java.lang.String getRequestPathInfo()

Specified by:

getRequestPathInfo in class javax.faces.context.ExternalContext

getRequestCookies

public javax.servlet.http.Cookie[] getRequestCookies()

getRequestContextPath

public java.lang.String getRequestContextPath()

Specified by:

getRequestContextPath in class javax.faces.context.ExternalContext

getRequestServletPath

public java.lang.String getRequestServletPath()

Specified by:

getRequestServletPath in class javax.faces.context.ExternalContext

getRequestCharacterEncoding

public java.lang.String getRequestCharacterEncoding()

Overrides:

getRequestCharacterEncoding in class javax.faces.context.ExternalContext

getRequestContentType

public java.lang.String getRequestContentType()

Overrides:

getRequestContentType in class javax.faces.context.ExternalContext

getResponseCharacterEncoding

public java.lang.String getResponseCharacterEncoding()

Overrides:

getResponseCharacterEncoding in class javax.faces.context.ExternalContext

getResponseContentType

public java.lang.String getResponseContentType()

Overrides:

getResponseContentType in class javax.faces.context.ExternalContext

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Manage attributes associated with the ServletContext instance associated with the current request.

Specified by:

getInitParameter in class javax.faces.context.ExternalContext

getResourcePaths

public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)

Specified by:

getResourcePaths in class javax.faces.context.ExternalContext

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String path)

Specified by:

getResourceAsStream in class javax.faces.context.ExternalContext

getResource

public java.net.URL getResource(java.lang.String path)

Specified by:

getResource in class javax.faces.context.ExternalContext

encodeActionURL

public java.lang.String encodeActionURL(java.lang.String sb)

Force any URL that causes an action to work within a portal/portlet. This causes the URL to have the required redirection for the specific portal to be included

Specified by:

encodeActionURL in class javax.faces.context.ExternalContext

Parameters:

sb - The input URL to be reformatted

encodeResourceURL

public java.lang.String encodeResourceURL(java.lang.String sb)

Force any URL that references a resource to work within a portal/portlet. This causes the URL to have the required redirection for the specific portal to be included. In reality, it simply returns an absolute URL.

Specified by:

encodeResourceURL in class javax.faces.context.ExternalContext

Parameters:

sb - The input URL to be reformatted

encodeNamespace

public java.lang.String encodeNamespace(java.lang.String aValue)

Specified by:

encodeNamespace in class javax.faces.context.ExternalContext

encodeURL

public java.lang.String encodeURL(java.lang.String url)

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

redirect

public void redirect(java.lang.String requestURI)
              throws java.io.IOException

Specified by:

redirect in class javax.faces.context.ExternalContext

Throws:

java.io.IOException

log

public void log(java.lang.String message)

Specified by:

log in class javax.faces.context.ExternalContext

log

public void log(java.lang.String message,
       java.lang.Throwable throwable)

Specified by:

log 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

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in class javax.faces.context.ExternalContext

isUserInRole

public boolean isUserInRole(java.lang.String role)

Specified by:

isUserInRole in class javax.faces.context.ExternalContext