com.liferay.faces.bridge.config
Interface BridgeConfig

All Known Implementing Classes:

BridgeConfigImpl

public interface BridgeConfig

This interface defines a contract for getting portlet bridge configuration values.

Author:

Neil Griffin

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.

Method Detail

getAttributes

Map<String,Object> getAttributes()

Returns a map of bridge configuration attributes.

getConfiguredExtensions

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.

getConfiguredSystemEventListeners

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.

getContextParameter

String getContextParameter(String name)

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

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

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.

getFacesServletMappings

List<ServletMapping> getFacesServletMappings()

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

getPublicParameterMappings

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.

getViewIdRenderParameterName

String getViewIdRenderParameterName()

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

getViewIdResourceParameterName

String getViewIdResourceParameterName()

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

getWriteBehindRenderResponseWrapper

String getWriteBehindRenderResponseWrapper()

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

getWriteBehindResourceResponseWrapper

String getWriteBehindResourceResponseWrapper()

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