PortletExternalContextImpl (Apache MyFaces: Impl)

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

All Implemented Interfaces:

ReleaseableExternalContext
```
public class PortletExternalContextImpl
extends javax.faces.context.ExternalContext
implements ReleaseableExternalContext
```
An ExternalContext implementation for JSF applications that run inside a a Portlet.

Version:

$Revision: 215974 $ $Date: 2005-07-12 17:55:45 +0200 (Tue, 12 Jul 2005) $

Author:

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

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
`PortletExternalContextImpl(javax.portlet.PortletContext portletContext, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)` Creates a new instance of PortletFacesContextImpl

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`dispatch(java.lang.String path)`
`java.lang.String`	`encodeActionURL(java.lang.String url)`
`java.lang.String`	`encodeNamespace(java.lang.String name)`
`java.lang.String`	`encodeResourceURL(java.lang.String url)`
`java.util.Map`	`getApplicationMap()`
`java.lang.String`	`getAuthType()`
`java.lang.Object`	`getContext()`
`java.lang.String`	`getInitParameter(java.lang.String name)`
`java.util.Map`	`getInitParameterMap()`
`java.lang.String`	`getRemoteUser()`
`java.lang.Object`	`getRequest()`
`java.lang.String`	`getRequestContextPath()`
`java.util.Map`	`getRequestCookieMap()`
`java.util.Map`	`getRequestHeaderMap()`
`java.util.Map`	`getRequestHeaderValuesMap()`
`java.util.Locale`	`getRequestLocale()`
`java.util.Iterator`	`getRequestLocales()`
`java.util.Map`	`getRequestMap()`
`java.util.Map`	`getRequestParameterMap()`
`java.util.Iterator`	`getRequestParameterNames()`
`java.util.Map`	`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`	`getResourcePaths(java.lang.String path)`
`java.lang.Object`	`getResponse()`
`java.lang.Object`	`getSession(boolean create)`
`java.util.Map`	`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.

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(java.lang.String path)
              throws java.io.IOException
```
    Specified by:
    
    dispatch in class javax.faces.context.ExternalContext
    
    Throws:
    
    java.io.IOException
  - encodeActionURL
```
public java.lang.String encodeActionURL(java.lang.String url)
```
    Specified by:
    
    encodeActionURL in class javax.faces.context.ExternalContext
  - encodeNamespace
```
public java.lang.String encodeNamespace(java.lang.String name)
```
    Specified by:
    
    encodeNamespace 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
  - getApplicationMap
```
public java.util.Map getApplicationMap()
```
    Specified by:
    
    getApplicationMap in class javax.faces.context.ExternalContext
  - getAuthType
```
public java.lang.String getAuthType()
```
    Specified by:
    
    getAuthType in class javax.faces.context.ExternalContext
  - getContext
```
public java.lang.Object getContext()
```
    Specified by:
    
    getContext in class javax.faces.context.ExternalContext
  - getInitParameter
```
public java.lang.String getInitParameter(java.lang.String name)
```
    Specified by:
    
    getInitParameter in class javax.faces.context.ExternalContext
  - getInitParameterMap
```
public java.util.Map getInitParameterMap()
```
    Specified by:
    
    getInitParameterMap in class javax.faces.context.ExternalContext
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in class javax.faces.context.ExternalContext
  - getRequest
```
public java.lang.Object getRequest()
```
    Specified by:
    
    getRequest in class javax.faces.context.ExternalContext
  - getRequestContextPath
```
public java.lang.String getRequestContextPath()
```
    Specified by:
    
    getRequestContextPath in class javax.faces.context.ExternalContext
  - getRequestCookieMap
```
public java.util.Map getRequestCookieMap()
```
    Specified by:
    
    getRequestCookieMap in class javax.faces.context.ExternalContext
  - getRequestHeaderMap
```
public java.util.Map getRequestHeaderMap()
```
    Specified by:
    
    getRequestHeaderMap in class javax.faces.context.ExternalContext
  - getRequestHeaderValuesMap
```
public java.util.Map getRequestHeaderValuesMap()
```
    Specified by:
    
    getRequestHeaderValuesMap 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 getRequestLocales()
```
    Specified by:
    
    getRequestLocales in class javax.faces.context.ExternalContext
  - getRequestMap
```
public java.util.Map getRequestMap()
```
    Specified by:
    
    getRequestMap in class javax.faces.context.ExternalContext
  - getRequestParameterMap
```
public java.util.Map getRequestParameterMap()
```
    Specified by:
    
    getRequestParameterMap in class javax.faces.context.ExternalContext
  - getRequestParameterNames
```
public java.util.Iterator getRequestParameterNames()
```
    Specified by:
    
    getRequestParameterNames in class javax.faces.context.ExternalContext
  - getRequestParameterValuesMap
```
public java.util.Map getRequestParameterValuesMap()
```
    Specified by:
    
    getRequestParameterValuesMap in class javax.faces.context.ExternalContext
  - getRequestPathInfo
```
public java.lang.String getRequestPathInfo()
```
    Specified by:
    
    getRequestPathInfo in class javax.faces.context.ExternalContext
  - getRequestServletPath
```
public java.lang.String getRequestServletPath()
```
    Specified by:
    
    getRequestServletPath in class javax.faces.context.ExternalContext
  - getResource
```
public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException
```
    Specified by:
    
    getResource in class javax.faces.context.ExternalContext
    
    Throws:
    
    java.net.MalformedURLException
  - getResourceAsStream
```
public java.io.InputStream getResourceAsStream(java.lang.String path)
```
    Specified by:
    
    getResourceAsStream in class javax.faces.context.ExternalContext
  - getResourcePaths
```
public java.util.Set getResourcePaths(java.lang.String path)
```
    Specified by:
    
    getResourcePaths in class javax.faces.context.ExternalContext
  - getResponse
```
public java.lang.Object getResponse()
```
    Specified by:
    
    getResponse in class javax.faces.context.ExternalContext
  - getSession
```
public java.lang.Object getSession(boolean create)
```
    Specified by:
    
    getSession in class javax.faces.context.ExternalContext
  - getSessionMap
```
public java.util.Map getSessionMap()
```
    Specified by:
    
    getSessionMap 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
  - 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 exception)
```
    Specified by:
    
    log in class javax.faces.context.ExternalContext
  - 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
  - release
```
public void release()
```
    Description copied from interface: ReleaseableExternalContext
    
    Release resources that the ExternalContext is holding onto.
    
    Specified by:
    
    release in interface ReleaseableExternalContext

Class PortletExternalContextImpl

Field Summary

Fields inherited from class javax.faces.context.ExternalContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortletExternalContextImpl

Method Detail

dispatch

encodeActionURL

encodeNamespace

encodeResourceURL

getApplicationMap

getAuthType

getContext

getInitParameter

getInitParameterMap

getRemoteUser

getRequest

getRequestContextPath

getRequestCookieMap

getRequestHeaderMap

getRequestHeaderValuesMap

getRequestLocale

getRequestLocales

getRequestMap

getRequestParameterMap

getRequestParameterNames

getRequestParameterValuesMap

getRequestPathInfo

getRequestServletPath

getResource

getResourceAsStream

getResourcePaths

getResponse

getSession

getSessionMap

getUserPrincipal

isUserInRole

log

log

redirect

release