com.webmethods.caf.faces.portlet

Class PortletFacesContext.PortletExternalContext

java.lang.Object

javax.faces.context.ExternalContext

javax.faces.context.ExternalContextWrapper

com.webmethods.caf.faces.context.ExternalContextWrapper

com.webmethods.caf.faces.context.BaseFacesContext.BaseExternalContext

com.webmethods.caf.faces.portlet.PortletFacesContext.PortletExternalContext

All Implemented Interfaces:

FacesWrapper<ExternalContext>

Enclosing class:

PortletFacesContext

public class PortletFacesContext.PortletExternalContext
extends BaseFacesContext.BaseExternalContext

This class allows the Faces API to be unaware of the nature of its containing application environment. In particular, this class allows JavaServer Faces based applications to run in a Portlet environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PortletFacesContext.PortletExternalContext.ApplicationAttributeMap
protected class	PortletFacesContext.PortletExternalContext.PortletInitParameterMap
protected class	PortletFacesContext.PortletExternalContext.RequestAttributeMap
protected class	PortletFacesContext.PortletExternalContext.RequestHeaderMap
protected class	PortletFacesContext.PortletExternalContext.RequestHeaderValuesMap
protected class	PortletFacesContext.PortletExternalContext.RequestParameterMap
protected class	PortletFacesContext.PortletExternalContext.RequestParameterValuesMap
protected class	PortletFacesContext.PortletExternalContext.SessionAttributeMap
protected class	PortletFacesContext.PortletExternalContext.WebAppInitParameterMap

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	m_applicationAttributeMap
protected Map<String,Object>	m_cookieMap
protected Map<String,String>	m_initParameterMap
protected Map<String,Object>	m_requestAttributeMap
protected Map<String,String>	m_requestHeaderMap
protected Map<String,String[]>	m_requestHeaderValuesMap
protected List<Locale>	m_requestLocales
protected Map<String,String>	m_requestParameterMap
protected List<String>	m_requestParameterNames
protected Map<String,String[]>	m_requestParameterValuesMap
protected Map<String,Object>	m_sessionAttributeMap

Fields inherited from class com.webmethods.caf.faces.context.ExternalContextWrapper

m_wrapped

Fields inherited from class javax.faces.context.ExternalContext

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
PortletExternalContext() Default constructor.
PortletExternalContext(ExternalContext wrapped) Create a PortletExternalContext with a wrapped ExternalContext.

Method Summary

Modifier and Type	Method and Description
void	dispatch(String path) Dispatch a request to the specified resource to create output for this response.
String	encodeActionURL(String url) Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable action in the current application.
String	encodeNamespace(String ns) Return the specified name, after prefixing it with a namespace that ensures that it will be unique within the context of a particular page.
String	encodeResourceURL(String url) Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable resource in the current application.
Map<String,Object>	getApplicationMap() Return a mutable Map representing the application scope attributes for the current application.
String	getAuthType() Return the name of the authentication scheme used to authenticate the current user, if any; otherwise, return null.
Object	getContext() Return the application environment object instance for the current application.
String	getInitParameter(String name) Return the value of the specified application initialization parameter (if any).
Map<String,String>	getInitParameterMap() Return an immutable Map whose keys are the set of application initialization parameter names configured for this application, and whose values are the corresponding parameter values.
String	getRemoteUser() Return the login name of the user making the current request if any; otherwise, return null.
Object	getRequest() Return the environment-specific object instance for the current request.
String	getRequestContextPath() Return the portion of the request URI that identifies the web application context for this request.
Map<String,Object>	getRequestCookieMap() Return an immutable Map whose keys are the set of cookie names included in the current request, and whose values (of type Cookie) are the first (or only) cookie for each cookie name returned by the underlying request.
Map<String,String>	getRequestHeaderMap() Return an immutable Map whose keys are the set of request header names included in the current request, and whose values (of type String) are the first (or only) value for each header name returned by the underlying request.
Map<String,String[]>	getRequestHeaderValuesMap() Return an immutable Map whose keys are the set of request header names included in the current request, and whose values (of type String[]) are all of the value for each header name returned by the underlying request.
Locale	getRequestLocale() Return the preferred Locale in which the client will accept content.
Iterator<Locale>	getRequestLocales() Return an Iterator over the preferred Locales specified in the request, in decreasing order of preference.
Map<String,Object>	getRequestMap() Return a mutable Map representing the request scope attributes for the current application.
Map<String,String>	getRequestParameterMap() Return an immutable Map whose keys are the set of request parameters names included in the current request, and whose values (of type String) are the first (or only) value for each parameter name returned by the underlying request.
Iterator<String>	getRequestParameterNames() Return an Iterator over the names of all request parameters included in the current request.
Map<String,String[]>	getRequestParameterValuesMap() Return an immutable Map whose keys are the set of request parameters names included in the current request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying request.
String	getRequestPathInfo() Not used with the portlets.
String	getRequestServletPath() Return the current portlet viewId
URL	getResource(String path) Return a URL for the application resource mapped to the specified path, if it exists; otherwise, return null.
InputStream	getResourceAsStream(String path) Return an InputStream for an application resource mapped to the specified path, if it exists; otherwise, return null.
Set<String>	getResourcePaths(String path) Return the Set of resource paths for all application resources whose resource path starts with the specified argument.
Object	getResponse() Return the environment-specific object instance for the current response.
Object	getSession(boolean create) If the create parameter is true, create (if necessary) and return a session instance associated with the current request.
Map<String,Object>	getSessionMap() Return a mutable Map representing the session scope attributes for the current application.
Principal	getUserPrincipal() Return the Principal object containing the name of the current authenticated user, if any; otherwise, return null.
boolean	isUserInRole(String role) Return true if the currently authenticated user is included in the specified role.
void	log(String message) Log the specified message to the application object.
void	log(String message, Throwable exception) Log the specified message to the application object.
void	redirect(String url) Redirect a request to the specified URL, and calls the responseComplete() method on the PortletFacesContext instance for the current request.
protected void	release() Release all the resources held by PortletFacesContext instance for the current request.

Methods inherited from class com.webmethods.caf.faces.context.BaseFacesContext.BaseExternalContext

encodeBookmarkableURL, encodeRedirectURL, getResponseOutputWriter, setResponseOutputWriter

Methods inherited from class com.webmethods.caf.faces.context.ExternalContextWrapper

getWrapped, setWrapped

Methods inherited from class javax.faces.context.ExternalContextWrapper

addResponseCookie, addResponseHeader, encodePartialActionURL, getApplicationContextPath, getClientWindow, getContextName, getFlash, getMimeType, getRealPath, getRequestCharacterEncoding, getRequestContentLength, getRequestContentType, getRequestScheme, getRequestServerName, getRequestServerPort, getResponseBufferSize, getResponseCharacterEncoding, getResponseContentType, getResponseOutputStream, getSessionId, getSessionMaxInactiveInterval, invalidateSession, isResponseCommitted, isSecure, responseFlushBuffer, responseReset, responseSendError, setClientWindow, setRequest, setRequestCharacterEncoding, setResponse, setResponseBufferSize, setResponseCharacterEncoding, setResponseContentLength, setResponseContentType, setResponseHeader, setResponseStatus, setSessionMaxInactiveInterval

Methods inherited from class java.lang.Object

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

Field Detail

m_applicationAttributeMap

protected Map<String,Object> m_applicationAttributeMap

m_initParameterMap

protected Map<String,String> m_initParameterMap

m_cookieMap

protected Map<String,Object> m_cookieMap

m_requestHeaderMap

protected Map<String,String> m_requestHeaderMap

m_requestHeaderValuesMap

protected Map<String,String[]> m_requestHeaderValuesMap

m_requestAttributeMap

protected Map<String,Object> m_requestAttributeMap

m_requestParameterMap

protected Map<String,String> m_requestParameterMap

m_requestParameterValuesMap

protected Map<String,String[]> m_requestParameterValuesMap

m_sessionAttributeMap

protected Map<String,Object> m_sessionAttributeMap

m_requestLocales

protected List<Locale> m_requestLocales

m_requestParameterNames

protected List<String> m_requestParameterNames

Constructor Detail

PortletExternalContext

public PortletExternalContext()

Default constructor.

PortletExternalContext

public PortletExternalContext(ExternalContext wrapped)

Create a PortletExternalContext with a wrapped ExternalContext.

Parameters:

wrapped - ExternalContext

Method Detail

dispatch

public void dispatch(String path)
              throws IOException

Dispatch a request to the specified resource to create output for this response.

This must be accomplished by calling the PortletContext method getRequestDispatcher(), and calling the include() method on the resulting object.

Overrides:

dispatch in class ExternalContextWrapper

Parameters:

path - Context relative path to the specified resource, which must start with a slash ("/") character

Throws:

IOException - if an input/output error occurs

encodeActionURL

public String encodeActionURL(String url)

Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable action in the current application.

This must be the value returned by the PortletResponse.encodeURL(String) method.

Overrides:

encodeActionURL in class ExternalContextWrapper

Parameters:

url - The input URL to be encoded

Returns:

input URL

encodeNamespace

public String encodeNamespace(String ns)

Return the specified name, after prefixing it with a namespace that ensures that it will be unique within the context of a particular page.

Servlet: The input value must be returned unchanged.

Portlet: The returned value must be the input value prefixed by the value returned by the javax.portlet.RenderResponse method getNamespace().

Overrides:

encodeNamespace in class ExternalContextWrapper

Parameters:

name - Name to be encoded

Throws:

IllegalStateException - if this method is called in a portlet environment, and the current response is an ActionResponse instead of a RenderResponse

NullPointerException - if name is null

encodeResourceURL

public String encodeResourceURL(String url)

Return the input URL, after performing any rewriting needed to ensure that it will correctly identify an addressable resource in the current application.

This must be the value returned by the PortletResponse.encodeURL(String) method.

Overrides:

encodeResourceURL in class ExternalContextWrapper

Parameters:

url - the input URL to be encoded

Returns:

the input URL

getApplicationMap

public Map<String,Object> getApplicationMap()

Return a mutable Map representing the application scope attributes for the current application.

This must be the set of attributes available via the PortletContext methods getAttribute(), getAttributeNames(), removeAttribute(), and setAttribute().

Overrides:

getApplicationMap in class ExternalContextWrapper

Returns:

a mutable Map

getAuthType

public String getAuthType()

Return the name of the authentication scheme used to authenticate the current user, if any; otherwise, return null. For standard authentication schemes, the returned value will match one of the following constants: BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, or FORM_AUTH.

This must be the value returned by the PortletRequest.getAuthType().

Overrides:

getAuthType in class ExternalContextWrapper

Returns:

the name of the authentication scheme

getContext

public Object getContext()

Return the application environment object instance for the current application.

Overrides:

getContext in class ExternalContextWrapper

Returns:

PortletConfig or PortletContext

getInitParameter

public String getInitParameter(String name)

Return the value of the specified application initialization parameter (if any). This is the result of the PortletConfig.getInitParameter(String) or PortletContext.getInitParameter(String).

Overrides:

getInitParameter in class ExternalContextWrapper

Parameters:

name - Name of the requested initialization parameter

Returns:

The value

getInitParameterMap

public Map<String,String> getInitParameterMap()

Return an immutable Map whose keys are the set of application initialization parameter names configured for this application, and whose values are the corresponding parameter values.

This result is as if it were synthesized by calling the PortletContext.getInitParameterNames() method , and putting each configured parameter name/value pair into the result.

Overrides:

getInitParameterMap in class ExternalContextWrapper

Returns:

an immutable Map

getRemoteUser

public String getRemoteUser()

Return the login name of the user making the current request if any; otherwise, return null.

This is the value returned by the PortletRequest.getRemoteUser() method.

Overrides:

getRemoteUser in class ExternalContextWrapper

Returns:

the login name

getRequest

public Object getRequest()

Return the environment-specific object instance for the current request.

Overrides:

getRequest in class ExternalContextWrapper

Returns:

PortletRequest

getRequestContextPath

public String getRequestContextPath()

Return the portion of the request URI that identifies the web application context for this request.

Overrides:

getRequestContextPath in class ExternalContextWrapper

Returns:

URI as a String

getRequestCookieMap

public Map<String,Object> getRequestCookieMap()

Return an immutable Map whose keys are the set of cookie names included in the current request, and whose values (of type Cookie) are the first (or only) cookie for each cookie name returned by the underlying request.

Overrides:

getRequestCookieMap in class ExternalContextWrapper

Returns:

an immutable Map

getRequestHeaderMap

public Map<String,String> getRequestHeaderMap()

Return an immutable Map whose keys are the set of request header names included in the current request, and whose values (of type String) are the first (or only) value for each header name returned by the underlying request.

Overrides:

getRequestHeaderMap in class ExternalContextWrapper

Returns:

an immutable Map

getRequestHeaderValuesMap

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

Return an immutable Map whose keys are the set of request header names included in the current request, and whose values (of type String[]) are all of the value for each header name returned by the underlying request.

Overrides:

getRequestHeaderValuesMap in class ExternalContextWrapper

Returns:

an immutable Map

getRequestLocale

public Locale getRequestLocale()

Return the preferred Locale in which the client will accept content.

Overrides:

getRequestLocale in class ExternalContextWrapper

Returns:

the preferred Locale

getRequestLocales

public Iterator<Locale> getRequestLocales()

Return an Iterator over the preferred Locales specified in the request, in decreasing order of preference.

Overrides:

getRequestLocales in class ExternalContextWrapper

Returns:

Iterator

getRequestMap

public Map<String,Object> getRequestMap()

Return a mutable Map representing the request scope attributes for the current application.

Overrides:

getRequestMap in class ExternalContextWrapper

Returns:

a mutable Map

getRequestParameterMap

public Map<String,String> getRequestParameterMap()

Return an immutable Map whose keys are the set of request parameters names included in the current request, and whose values (of type String) are the first (or only) value for each parameter name returned by the underlying request.

Overrides:

getRequestParameterMap in class ExternalContextWrapper

Returns:

an immutable Map

getRequestParameterNames

public Iterator<String> getRequestParameterNames()

Return an Iterator over the names of all request parameters included in the current request.

Overrides:

getRequestParameterNames in class ExternalContextWrapper

Returns:

Iterator

getRequestParameterValuesMap

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

Return an immutable Map whose keys are the set of request parameters names included in the current request, and whose values (of type String[]) are all of the values for each parameter name returned by the underlying request.

Overrides:

getRequestParameterValuesMap in class ExternalContextWrapper

Returns:

an immutable Map

getRequestPathInfo

public String getRequestPathInfo()

Not used with the portlets.

Overrides:

getRequestPathInfo in class ExternalContextWrapper

Returns:

null

getRequestServletPath

public String getRequestServletPath()

Return the current portlet viewId

Overrides:

getRequestServletPath in class ExternalContextWrapper

Returns:

the current portlet viewId

getResource

public URL getResource(String path)
                throws MalformedURLException

Return a URL for the application resource mapped to the specified path, if it exists; otherwise, return null.

Overrides:

getResource in class ExternalContextWrapper

Parameters:

path - String path

Returns:

URL

Throws:

MalformedURLException - if the specified path is not in the correct form

NullPointerException - if path is null

getResourceAsStream

public InputStream getResourceAsStream(String path)

Return an InputStream for an application resource mapped to the specified path, if it exists; otherwise, return null.

Overrides:

getResourceAsStream in class ExternalContextWrapper

Parameters:

path - String path

Returns:

InputStream

getResourcePaths

public Set<String> getResourcePaths(String path)

Return the Set of resource paths for all application resources whose resource path starts with the specified argument.

Overrides:

getResourcePaths in class ExternalContextWrapper

Parameters:

path - String path

Returns:

Set

getResponse

public Object getResponse()

Return the environment-specific object instance for the current response.

Overrides:

getResponse in class ExternalContextWrapper

Returns:

PortletResponse

getSession

public Object getSession(boolean create)

If the create parameter is true, create (if necessary) and return a session instance associated with the current request. If the create parameter is false return any existing session instance associated with the current request, or return null if there is no such session.

Overrides:

getSession in class ExternalContextWrapper

Parameters:

create - Flag indicating whether or not a new session should be created if there is no session associated with the current request

Returns:

PortletSession or null

getSessionMap

public Map<String,Object> getSessionMap()

Return a mutable Map representing the session scope attributes for the current application. Accessing attributes via this Map creates a session associated with the current request, if such a session does not already exist.

Overrides:

getSessionMap in class ExternalContextWrapper

Returns:

a mutable Map

getUserPrincipal

public Principal getUserPrincipal()

Return the Principal object containing the name of the current authenticated user, if any; otherwise, return null.

Overrides:

getUserPrincipal in class ExternalContextWrapper

Returns:

the Principal

isUserInRole

public boolean isUserInRole(String role)

Return true if the currently authenticated user is included in the specified role. Otherwise, return false.

Overrides:

isUserInRole in class ExternalContextWrapper

Parameters:

role - Logical role name to be checked

log

public void log(String message,
                Throwable exception)

Log the specified message to the application object.

Overrides:

log in class ExternalContextWrapper

Parameters:

message - Message to be logged

exception - Exception to be logged

Throws:

NullPointerException - if message or exception is null

log

public void log(String message)

Log the specified message to the application object.

Overrides:

log in class ExternalContextWrapper

Parameters:

message - Message to be logged

Throws:

NullPointerException - if message is null

redirect

public void redirect(String url)
              throws IOException

Redirect a request to the specified URL, and calls the responseComplete() method on the PortletFacesContext instance for the current request.

Overrides:

redirect in class ExternalContextWrapper

Parameters:

url - Absolute URL to which the client should be redirected

Throws:

IOException - if an input/output error occurs

IllegalArgumentException - if the specified url is relative

IllegalStateException - if, in a portlet environment, the current response object is a RenderResponse instead of an ActionResponse

IllegalStateException - if, in a servlet environment, the current response has already been committed

release

protected void release()

Release all the resources held by PortletFacesContext instance for the current request.

Overrides:

release in class BaseFacesContext.BaseExternalContext