com.liferay.faces.bridge.config
Class BridgeConfigImpl

java.lang.Object
  com.liferay.faces.bridge.config.BridgeConfigImpl

All Implemented Interfaces:

BridgeConfig

public class BridgeConfigImpl
extends Object
implements BridgeConfig

Author:

Neil Griffin

Constructor Summary

BridgeConfigImpl(javax.portlet.PortletConfig portletConfig)

Method Summary

Map<String,Object>	getAttributes() Returns a map of bridge configuration attributes.
List<String>	getConfiguredExtensions() Returns a list of filename extensions that the developer may have specified in the WEB-INF/web.xml descriptor with the "javax.faces.DEFAULT_SUFFIX" init-param.
List<ConfiguredSystemEventListener>	getConfiguredSystemEventListeners() Returns a list of configured system-event-listener entries that are found in META-INF/faces-config.xml or WEB-INF/faces-config.xml descriptors.
String	getContextParameter(String name) Returns the value associated with the specified parameter name from the WEB-INF/web.xml descriptor.
Set<String>	getExcludedRequestAttributes() Returns a list of attribute names that are to be excluded from the BridgeRequestScope as defined in the bridge:excluded-attributes element within the faces-config.xml descriptor.
List<ServletMapping>	getFacesServletMappings() Returns a list of servlet-mapping entries from the WEB-INF/web.xml descriptor that are mapped to the Faces Servlet.
Map<String,String[]>	getPublicParameterMappings() Returns an immutable Map of Public Render Parameter mappings as defined in the bridge:public-parameter-mappings element of the faces-config.xml descriptor.
String	getViewIdRenderParameterName() Returns the parameter name used for storing the value of the target viewId in a RenderRequest.
String	getViewIdResourceParameterName() Returns the parameter name used for storing the value of the target viewId in a ResourceRequest.
String	getWriteBehindRenderResponseWrapper() Returns the FQCN specified in the render-response-wrapper-class element of the faces-config.xml descriptor.
String	getWriteBehindResourceResponseWrapper() Returns the FQCN specified in the resource-response-wrapper-class element of the faces-config.xml descriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeConfigImpl

public BridgeConfigImpl(javax.portlet.PortletConfig portletConfig)

Method Detail

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: BridgeConfig

Returns a map of bridge configuration attributes.

Specified by:

getAttributes in interface BridgeConfig

getConfiguredExtensions

public List<String> getConfiguredExtensions()

Description copied from interface: BridgeConfig

Returns a list of filename extensions that the developer may have specified in the WEB-INF/web.xml descriptor with the "javax.faces.DEFAULT_SUFFIX" init-param.

Specified by:

getConfiguredExtensions in interface BridgeConfig

getConfiguredSystemEventListeners

public List<ConfiguredSystemEventListener> getConfiguredSystemEventListeners()

Description copied from interface: BridgeConfig

Returns a list of configured system-event-listener entries that are found in META-INF/faces-config.xml or WEB-INF/faces-config.xml descriptors.

Specified by:

getConfiguredSystemEventListeners in interface BridgeConfig

getContextParameter

public String getContextParameter(String name)

Description copied from interface: BridgeConfig

Returns the value associated with the specified parameter name from the WEB-INF/web.xml descriptor.

Specified by:

getContextParameter in interface BridgeConfig

Parameters:

name - The name of the parameter, corresponding to the param-name element nested within the context-param element.

Returns:

The value of the parameter, corresponding to the param-value element nested within the context-param element.

getExcludedRequestAttributes

public Set<String> getExcludedRequestAttributes()

Description copied from interface: BridgeConfig

Returns a list of attribute names that are to be excluded from the BridgeRequestScope as defined in the bridge:excluded-attributes element within the faces-config.xml descriptor.

Specified by:

getExcludedRequestAttributes in interface BridgeConfig

getFacesServletMappings

public List<ServletMapping> getFacesServletMappings()

Description copied from interface: BridgeConfig

Returns a list of servlet-mapping entries from the WEB-INF/web.xml descriptor that are mapped to the Faces Servlet.

Specified by:

getFacesServletMappings in interface BridgeConfig

getPublicParameterMappings

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

Description copied from interface: BridgeConfig

Returns an immutable Map of Public Render Parameter mappings as defined in the bridge:public-parameter-mappings element of the faces-config.xml descriptor.

Specified by:

getPublicParameterMappings in interface BridgeConfig

getViewIdRenderParameterName

public String getViewIdRenderParameterName()

Description copied from interface: BridgeConfig

Returns the parameter name used for storing the value of the target viewId in a RenderRequest.

Specified by:

getViewIdRenderParameterName in interface BridgeConfig

getViewIdResourceParameterName

public String getViewIdResourceParameterName()

Description copied from interface: BridgeConfig

Returns the parameter name used for storing the value of the target viewId in a ResourceRequest.

Specified by:

getViewIdResourceParameterName in interface BridgeConfig

getWriteBehindRenderResponseWrapper

public String getWriteBehindRenderResponseWrapper()

Description copied from interface: BridgeConfig

Returns the FQCN specified in the render-response-wrapper-class element of the faces-config.xml descriptor.

Specified by:

getWriteBehindRenderResponseWrapper in interface BridgeConfig

getWriteBehindResourceResponseWrapper

public String getWriteBehindResourceResponseWrapper()

Description copied from interface: BridgeConfig

Returns the FQCN specified in the resource-response-wrapper-class element of the faces-config.xml descriptor.

Specified by:

getWriteBehindResourceResponseWrapper in interface BridgeConfig