com.liferay.faces.bridge.context.map.internal
Class ContextMapFactory

java.lang.Object
  com.liferay.faces.bridge.context.map.internal.ContextMapFactory

All Implemented Interfaces:

javax.faces.FacesWrapper<ContextMapFactory>

Direct Known Subclasses:

ContextMapFactoryImpl

public abstract class ContextMapFactory
extends Object
implements javax.faces.FacesWrapper<ContextMapFactory>

This abstract class provides a contract for defining a factory that knows how to create Map instances. It is inspired by the factory pattern found in the JSF API like FacesContextFactory and ExternalContextFactory. By implementing the FacesWrapper interface, the class provides implementations with the opportunity to wrap another factory (participate in a chain-of-responsibility pattern). If an implementation wraps a factory, then it should provide a one-arg constructor so that the wrappable factory can be passed at initialization time.

Author:

Neil Griffin

Constructor Summary

ContextMapFactory()

Method Summary

abstract Map<String,Object>	getApplicationScopeMap(BridgeContext bridgeContext) Returns a Map of application-scoped attributes stored in the underlying PortletContext.
abstract Map<String,String>	getFacesViewParameterMap(BridgeContext bridgeContext) Returns a Map of URL parameters that are found in the query-string of the current Faces view.
abstract Map<String,String>	getInitParameterMap(javax.portlet.PortletContext portletContext) Returns a Map of init-param values associated with the portlet context.
abstract Map<String,Object>	getRequestCookieMap(BridgeContext bridgeContext) Returns a Map of cookies associated with the request.
abstract Map<String,String>	getRequestHeaderMap(BridgeContext bridgeContext) Returns a Map of request headers with a single (the first) value for each key.
abstract Map<String,String[]>	getRequestHeaderValuesMap(BridgeContext bridgeContext) Returns a Map of request headers with multiple values for each key.
abstract Map<String,String>	getRequestParameterMap(BridgeContext bridgeContext) Returns a Map of request parameters with a single (the first) value for each key.
abstract Map<String,String[]>	getRequestParameterValuesMap(BridgeContext bridgeContext) Returns a Map of request parameters with multiple values for each key.
abstract Map<String,Object>	getRequestScopeMap(BridgeContext bridgeContext) Returns a Map of request-scoped attributes stored in the underlying PortletRequest.
abstract Map<String,Object>	getServletContextAttributeMap(javax.servlet.ServletContext servletContext) Returns a Map of attributes stored in the underlying ServletContext.
abstract Map<String,Object>	getSessionScopeMap(BridgeContext bridgeContext, int scope) Returns a Map of session-scoped attributes stored in the underlying PortletSession.
abstract Map<String,List<UploadedFile>>	getUploadedFileMap(BridgeContext bridgeContext) Returns a Map of uploaded files.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.FacesWrapper

getWrapped

Constructor Detail

ContextMapFactory

public ContextMapFactory()

Method Detail

getApplicationScopeMap

public abstract Map<String,Object> getApplicationScopeMap(BridgeContext bridgeContext)

Returns a Map of application-scoped attributes stored in the underlying PortletContext.

getFacesViewParameterMap

public abstract Map<String,String> getFacesViewParameterMap(BridgeContext bridgeContext)

Returns a Map of URL parameters that are found in the query-string of the current Faces view.

getInitParameterMap

public abstract Map<String,String> getInitParameterMap(javax.portlet.PortletContext portletContext)

Returns a Map of init-param values associated with the portlet context.

getRequestCookieMap

public abstract Map<String,Object> getRequestCookieMap(BridgeContext bridgeContext)

Returns a Map of cookies associated with the request.

getRequestHeaderMap

public abstract Map<String,String> getRequestHeaderMap(BridgeContext bridgeContext)

Returns a Map of request headers with a single (the first) value for each key.

getRequestHeaderValuesMap

public abstract Map<String,String[]> getRequestHeaderValuesMap(BridgeContext bridgeContext)

Returns a Map of request headers with multiple values for each key.

getRequestParameterMap

public abstract Map<String,String> getRequestParameterMap(BridgeContext bridgeContext)

Returns a Map of request parameters with a single (the first) value for each key.

getRequestParameterValuesMap

public abstract Map<String,String[]> getRequestParameterValuesMap(BridgeContext bridgeContext)

Returns a Map of request parameters with multiple values for each key.

getRequestScopeMap

public abstract Map<String,Object> getRequestScopeMap(BridgeContext bridgeContext)

Returns a Map of request-scoped attributes stored in the underlying PortletRequest.

getServletContextAttributeMap

public abstract Map<String,Object> getServletContextAttributeMap(javax.servlet.ServletContext servletContext)

Returns a Map of attributes stored in the underlying ServletContext.

getSessionScopeMap

public abstract Map<String,Object> getSessionScopeMap(BridgeContext bridgeContext,
                                                      int scope)

Returns a Map of session-scoped attributes stored in the underlying PortletSession.

getUploadedFileMap

public abstract Map<String,List<UploadedFile>> getUploadedFileMap(BridgeContext bridgeContext)

Returns a Map of uploaded files.