com.liferay.faces.bridge.config
Interface BridgeConfig

All Known Implementing Classes:

BridgeConfigWrapper

public interface BridgeConfig

Author:

Neil Griffin

Method Summary

Map<String,Object>	getAttributes() Returns a map of bridge configuration attributes.
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.
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.

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.

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.