org.apache.myfaces.context.portlet
Class PortletExternalContextImpl

java.lang.Object
  javax.faces.context.ExternalContext
      org.apache.myfaces.context.portlet.PortletExternalContextImpl

All Implemented Interfaces:

ReleaseableExternalContext

public class PortletExternalContextImpl
extends ExternalContext
implements ReleaseableExternalContext

An ExternalContext implementation for JSF applications that run inside a a Portlet.

Version:

$Revision: 673803 $ $Date: 2008-07-03 16:07:46 -0500 (Thu, 03 Jul 2008) $

Author:

Stan Silvert (latest modification by $Author: skitching $)

Field Summary

Fields inherited from class javax.faces.context.ExternalContext

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

PortletExternalContextImpl(javax.portlet.PortletContext portletContext, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)
Creates a new instance of PortletFacesContextImpl

Method Summary

void	dispatch(String path)
String	encodeActionURL(String url)
String	encodeNamespace(String name)
String	encodeResourceURL(String url)
Map	getApplicationMap()
String	getAuthType()
Object	getContext()
String	getInitParameter(String name)
Map	getInitParameterMap()
String	getRemoteUser()
Object	getRequest()
String	getRequestContextPath()
Map	getRequestCookieMap()
Map	getRequestHeaderMap()
Map	getRequestHeaderValuesMap()
Locale	getRequestLocale()
Iterator	getRequestLocales()
Map	getRequestMap()
Map	getRequestParameterMap()
Iterator	getRequestParameterNames()
Map	getRequestParameterValuesMap()
String	getRequestPathInfo()
String	getRequestServletPath()
URL	getResource(String path)
InputStream	getResourceAsStream(String path)
Set	getResourcePaths(String path)
Object	getResponse()
Object	getSession(boolean create)
Map	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	setResponse(Object response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletExternalContextImpl

public PortletExternalContextImpl(javax.portlet.PortletContext portletContext,
                                  javax.portlet.PortletRequest portletRequest,
                                  javax.portlet.PortletResponse portletResponse)

Creates a new instance of PortletFacesContextImpl

Method Detail

dispatch

public void dispatch(String path)
              throws IOException

Specified by:

dispatch in class ExternalContext

Throws:

IOException

encodeActionURL

public String encodeActionURL(String url)

Specified by:

encodeActionURL in class ExternalContext

encodeNamespace

public String encodeNamespace(String name)

Specified by:

encodeNamespace in class ExternalContext

encodeResourceURL

public String encodeResourceURL(String url)

Specified by:

encodeResourceURL in class ExternalContext

getApplicationMap

public Map getApplicationMap()

Specified by:

getApplicationMap in class ExternalContext

getAuthType

public String getAuthType()

Specified by:

getAuthType in class ExternalContext

getContext

public Object getContext()

Specified by:

getContext in class ExternalContext

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in class ExternalContext

getInitParameterMap

public Map getInitParameterMap()

Specified by:

getInitParameterMap in class ExternalContext

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in class ExternalContext

getRequest

public Object getRequest()

Specified by:

getRequest in class ExternalContext

getRequestContextPath

public String getRequestContextPath()

Specified by:

getRequestContextPath in class ExternalContext

getRequestCookieMap

public Map getRequestCookieMap()

Specified by:

getRequestCookieMap in class ExternalContext

getRequestHeaderMap

public Map getRequestHeaderMap()

Specified by:

getRequestHeaderMap in class ExternalContext

getRequestHeaderValuesMap

public Map getRequestHeaderValuesMap()

Specified by:

getRequestHeaderValuesMap in class ExternalContext

getRequestLocale

public Locale getRequestLocale()

Specified by:

getRequestLocale in class ExternalContext

getRequestLocales

public Iterator getRequestLocales()

Specified by:

getRequestLocales in class ExternalContext

getRequestMap

public Map getRequestMap()

Specified by:

getRequestMap in class ExternalContext

getRequestParameterMap

public Map getRequestParameterMap()

Specified by:

getRequestParameterMap in class ExternalContext

getRequestParameterNames

public Iterator getRequestParameterNames()

Specified by:

getRequestParameterNames in class ExternalContext

getRequestParameterValuesMap

public Map getRequestParameterValuesMap()

Specified by:

getRequestParameterValuesMap in class ExternalContext

getRequestPathInfo

public String getRequestPathInfo()

Specified by:

getRequestPathInfo in class ExternalContext

getRequestServletPath

public String getRequestServletPath()

Specified by:

getRequestServletPath in class ExternalContext

getResource

public URL getResource(String path)
                throws MalformedURLException

Specified by:

getResource in class ExternalContext

Throws:

MalformedURLException

getResourceAsStream

public InputStream getResourceAsStream(String path)

Specified by:

getResourceAsStream in class ExternalContext

getResourcePaths

public Set getResourcePaths(String path)

Specified by:

getResourcePaths in class ExternalContext

getResponse

public Object getResponse()

Specified by:

getResponse in class ExternalContext

setResponse

public void setResponse(Object response)

getSession

public Object getSession(boolean create)

Specified by:

getSession in class ExternalContext

getSessionMap

public Map getSessionMap()

Specified by:

getSessionMap in class ExternalContext

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in class ExternalContext

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole 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

release

public void release()

Description copied from interface: ReleaseableExternalContext

Release resources that the ExternalContext is holding onto.

Specified by:

release in interface ReleaseableExternalContext