org.apache.myfaces.webapp.filter.portlet
Class PortletExternalContextWrapper

java.lang.Object
  extended by javax.faces.context.ExternalContext
      extended by org.apache.myfaces.webapp.filter.portlet.PortletExternalContextWrapper

public class PortletExternalContextWrapper
extends javax.faces.context.ExternalContext

This class encapsulate the ExternalContext given, adding support for inputFileUpload (necessary when this is encapsulated with MultipartRequestWrapper). For make available the parameters map on a multipart content request, it is necessary to encapsulate the original request with MultipartRequestWrapper, but the original ExternalContext is tied with the original request so we need to do this wrapper using the delegate pattern starting with TomahawkFacesContextFactory.

NOTE: This class should is used(instantiated) only by TomahawkFacesContextWrapper. By that reason, it could change in the future.

Since:
1.1.7
Author:
Martin Marinschek

Field Summary
 
Fields inherited from class javax.faces.context.ExternalContext
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
PortletExternalContextWrapper(javax.faces.context.ExternalContext delegate, Object request, Object response, boolean multipartContent)
           
 
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 getRequestCharacterEncoding()
           
 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()
           
 String getResponseCharacterEncoding()
           
 String getResponseContentType()
           
 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 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

PortletExternalContextWrapper

public PortletExternalContextWrapper(javax.faces.context.ExternalContext delegate,
                                     Object request,
                                     Object response,
                                     boolean multipartContent)
Method Detail

dispatch

public void dispatch(String path)
              throws IOException
Specified by:
dispatch in class javax.faces.context.ExternalContext
Throws:
IOException

encodeActionURL

public String encodeActionURL(String url)
Specified by:
encodeActionURL in class javax.faces.context.ExternalContext

encodeNamespace

public String encodeNamespace(String name)
Specified by:
encodeNamespace in class javax.faces.context.ExternalContext

encodeResourceURL

public String encodeResourceURL(String url)
Specified by:
encodeResourceURL in class javax.faces.context.ExternalContext

getApplicationMap

public Map getApplicationMap()
Specified by:
getApplicationMap in class javax.faces.context.ExternalContext

getAuthType

public String getAuthType()
Specified by:
getAuthType in class javax.faces.context.ExternalContext

getContext

public Object getContext()
Specified by:
getContext in class javax.faces.context.ExternalContext

getInitParameter

public String getInitParameter(String name)
Specified by:
getInitParameter in class javax.faces.context.ExternalContext

getInitParameterMap

public Map getInitParameterMap()
Specified by:
getInitParameterMap in class javax.faces.context.ExternalContext

getRemoteUser

public String getRemoteUser()
Specified by:
getRemoteUser in class javax.faces.context.ExternalContext

getRequest

public Object getRequest()
Specified by:
getRequest in class javax.faces.context.ExternalContext

getRequestContextPath

public String getRequestContextPath()
Specified by:
getRequestContextPath in class javax.faces.context.ExternalContext

getRequestCookieMap

public Map getRequestCookieMap()
Specified by:
getRequestCookieMap in class javax.faces.context.ExternalContext

getRequestHeaderMap

public Map getRequestHeaderMap()
Specified by:
getRequestHeaderMap in class javax.faces.context.ExternalContext

getRequestHeaderValuesMap

public Map getRequestHeaderValuesMap()
Specified by:
getRequestHeaderValuesMap in class javax.faces.context.ExternalContext

getRequestLocale

public Locale getRequestLocale()
Specified by:
getRequestLocale in class javax.faces.context.ExternalContext

getRequestLocales

public Iterator getRequestLocales()
Specified by:
getRequestLocales in class javax.faces.context.ExternalContext

getRequestMap

public Map getRequestMap()
Specified by:
getRequestMap in class javax.faces.context.ExternalContext

getRequestParameterMap

public Map getRequestParameterMap()
Specified by:
getRequestParameterMap in class javax.faces.context.ExternalContext

getRequestParameterNames

public Iterator getRequestParameterNames()
Specified by:
getRequestParameterNames in class javax.faces.context.ExternalContext

getRequestParameterValuesMap

public Map getRequestParameterValuesMap()
Specified by:
getRequestParameterValuesMap in class javax.faces.context.ExternalContext

getRequestPathInfo

public String getRequestPathInfo()
Specified by:
getRequestPathInfo in class javax.faces.context.ExternalContext

getRequestServletPath

public String getRequestServletPath()
Specified by:
getRequestServletPath in class javax.faces.context.ExternalContext

getResource

public URL getResource(String path)
                throws MalformedURLException
Specified by:
getResource in class javax.faces.context.ExternalContext
Throws:
MalformedURLException

getResourceAsStream

public InputStream getResourceAsStream(String path)
Specified by:
getResourceAsStream in class javax.faces.context.ExternalContext

getResourcePaths

public Set getResourcePaths(String path)
Specified by:
getResourcePaths in class javax.faces.context.ExternalContext

getResponse

public Object getResponse()
Specified by:
getResponse in class javax.faces.context.ExternalContext

getSession

public Object getSession(boolean create)
Specified by:
getSession in class javax.faces.context.ExternalContext

getSessionMap

public Map getSessionMap()
Specified by:
getSessionMap in class javax.faces.context.ExternalContext

getUserPrincipal

public Principal getUserPrincipal()
Specified by:
getUserPrincipal in class javax.faces.context.ExternalContext

isUserInRole

public boolean isUserInRole(String role)
Specified by:
isUserInRole in class javax.faces.context.ExternalContext

log

public void log(String message)
Specified by:
log in class javax.faces.context.ExternalContext

log

public void log(String message,
                Throwable exception)
Specified by:
log in class javax.faces.context.ExternalContext

redirect

public void redirect(String url)
              throws IOException
Specified by:
redirect in class javax.faces.context.ExternalContext
Throws:
IOException

getResponseContentType

public String getResponseContentType()

setRequest

public void setRequest(Object request)

setRequestCharacterEncoding

public void setRequestCharacterEncoding(String encoding)
                                 throws UnsupportedEncodingException
Throws:
UnsupportedEncodingException

setResponse

public void setResponse(Object response)

setResponseCharacterEncoding

public void setResponseCharacterEncoding(String encoding)

getResponseCharacterEncoding

public String getResponseCharacterEncoding()

getRequestCharacterEncoding

public String getRequestCharacterEncoding()


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