org.portletfaces.bridge.config
Interface BridgeConfig

public interface BridgeConfig

NOTE: PROPOSE-FOR-STANDARD

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

Author:

Neil Griffin

Method Summary

java.lang.Object	getAttribute(java.lang.String name) Returns the value of the specified (implementation dependent) attribute name.
java.lang.String	getContextParameter(java.lang.String name) Returns the value associated with the specified parameter name from the WEB-INF/web.xml descriptor.
java.util.Set<java.lang.String>	getExcludedBridgeRequestScopeAttributes() Returns the value of the "javax.portlet.faces.excludedRequestAttributes" context parameter from the WEB-INF/web.xml descriptor.
java.util.Map<java.lang.String,java.lang.String[]>	getPublicParameterMappings() Returns an immutable Map of Public Render Parameter mappings as defined in the bridge:public-parameter-mappings element of the WEB-INF/faces-config.xml descriptor.
java.lang.String	getViewIdFromViewPath(java.lang.String viewPath) This method returns the viewId associated with the specified viewPath according to the servlet-mapping entries back to the FacesServlet in the WEB-INF/web.xml descriptor.

Method Detail

getAttribute

java.lang.Object getAttribute(java.lang.String name)

Returns the value of the specified (implementation dependent) attribute name.

getContextParameter

java.lang.String getContextParameter(java.lang.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.

getExcludedBridgeRequestScopeAttributes

java.util.Set<java.lang.String> getExcludedBridgeRequestScopeAttributes()

Returns the value of the "javax.portlet.faces.excludedRequestAttributes" context parameter from the WEB-INF/web.xml descriptor.

getPublicParameterMappings

java.util.Map<java.lang.String,java.lang.String[]> getPublicParameterMappings()

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

getViewIdFromViewPath

java.lang.String getViewIdFromViewPath(java.lang.String viewPath)

This method returns the viewId associated with the specified viewPath according to the servlet-mapping entries back to the FacesServlet in the WEB-INF/web.xml descriptor.