Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods

Deprecated Classes

com.liferay.faces.bridge.filter.BridgePortletContextFactory
Instead, register a custom BridgePortletConfigFactory that provides a custom instance of PortletConfig, that in turn provides a method Override for PortletConfig.getPortletContext().

Deprecated Fields

javax.portlet.faces.Bridge.BRIDGE_EVENT_HANDLER
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.bridgeEventHandler" instead.

Portlet context attribute that a portlet can set prior to calling Bridge.init(PortletConfig) to configure the bridge to use/call the associated BridgeEventHandler when processing an event. Value is an instance of BridgeEventHandler. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".bridgeEventHandler"

javax.portlet.faces.Bridge.BRIDGE_PUBLIC_RENDER_PARAMETER_HANDLER
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.bridgePublicRenderParameterHandler" instead.

Portlet context attribute that a portlet can set prior to calling the Bridge.init(PortletConfig) method to configure the bridge to use/call the associated BridgePublicRenderParameterHandler. This handler is used to process updates that result from public render parameter changes passed in a request. The bridge first pushs all the public render parameter values into the models and then calls this handler's processUpdates method. The handler can then compute further model changes based on the changes. Value is an instance of BridgePublicRenderParameterHandler. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".bridgeEventHandler"

javax.portlet.faces.GenericFacesPortlet.DEFAULT_CHARACTERSET_ENCODING
Portlet init parameter that defines the render response CharacterSetEncoding the bridge sets prior to rendering. Typcially only set when the jsp outputs an encoding other then the portlet container's and the portlet container supports response encoding transformation. It is deprecated because bridge implementations (since JSR 329) no longer utilize it.

javax.portlet.faces.GenericFacesPortlet.DEFAULT_CONTENT_TYPE
Portlet init parameter that defines the render response ContentType the bridge sets prior to rendering. If not set the bridge uses the request's preferred content type. It is deprecated because bridge implementations (since JSR 329) no longer utilize it.

javax.portlet.faces.Bridge.DEFAULT_RENDERKIT_ID
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.defaultRenderKitId" instead.

Portlet context attribute that a portlet can set prior to calling the Bridge.init(PortletConfig) method to configure the bridge to default the renderKitId used for rendering this portlet to the named Id. In Faces, the default renderKitId is set in the faces-config.xml and is application wide. In 1.2 this can be overidden by a specially named request parameter. To allow differing portlets in the same app to use different default render kits, without having to add this parameter, the portlet can set this attribute prior to the bridge init(). The bridge will recognize this configuration value and on each request add the special faces request parameter to the request (if its not already present).

javax.portlet.faces.Bridge.DEFAULT_VIEWID_MAP
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.defaultViewId.view", "javax.portlet.faces.defaultViewId.edit", or "javax.portlet.faces.defaultViewId.help", etc.

Portlet context attribute that a portlet must set prior to calling Bridge.init(PortletConfig) to convey to the bridge the set of default viewIds that correspond to this portlet's supported portlet modes. Its value is a Map with one entry per mode. The mode name is the key. The entry's value is the corresponding default viewId the bridge should use for this mode. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".defaultViewIdMap"

javax.portlet.faces.Bridge.EXCLUDED_REQUEST_ATTRIBUTES
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.excludedRequestAttributes" instead.

Portlet context attribute that a portlet can set prior to calling Bridge.init(PortletConfig) to configure the bridge to exclude specific attributes from its bridge request scope. Value is a comma delimited list containing either a fully qualified attribute name or package name terminated with a ".*" wildcard indicator. In this later case, all attributes in the package name which precedes the ".*" are excluded, non recursive. As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".excludedRequestAttributes"

javax.portlet.faces.Bridge.PRESERVE_ACTION_PARAMS
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.preserveActionParams" instead.

Portlet context attribute that a portlet can set prior to calling Bridge.init(PortletConfig) to configure the bridge to preserve action parameters received by this portlet along with bridge's request scope so that they may be restored and acessed in subsequent renders. If true, the action parameters are preserved. If false, they are not preserved. The bridge default is false.
As this attribute is scoped to a specific portlet in an application-wide context the attribute name must be include the portlet name as follows:

"javax.portlet.faces." + portletContext.getPortletName() + ".preserveActionParams"

Deprecated Methods

javax.portlet.faces.GenericFacesPortlet.getBridgeEventHandler()
Call BridgeEventHandlerFactory.getBridgeEventHandler(PortletConfig) instead.

Returns an instance of a BridgeEventHandler used to process portlet events in a JSF environment. This default implementation looks for a portlet initParameter that names the class used to instantiate the handler.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

javax.portlet.faces.GenericFacesPortlet.getBridgePublicRenderParameterHandler()
Call BridgePublicRenderParameterHandlerFactory.getBridgePublicRenderParameterHandler(PortletConfig) instead.

Returns an instance of a BridgePublicRenderParameterHandler used to post process public render parameter changes that the bridge has pushed into mapped models. This default implementation looks for a portlet initParameter that names the class used to instantiate the handler.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

javax.portlet.faces.GenericFacesPortlet.getDefaultRenderKitId()
Call ExternalContext.getInitParameter(String) with parameter value "javax.portlet.faces.defaultRenderKitId" instead.

Returns a String defining the default render kit id the bridge should ensure for this portlet. If non-null, this value is used to override any default render kit id set on an app wide basis in the faces-config.xml. This default implementation reads the values from the portlet init-param javax.portlet.faces.defaultRenderKitId. If not present, null is returned.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

javax.portlet.faces.GenericFacesPortlet.getDefaultViewIdMap()
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.defaultViewId.view", "javax.portlet.faces.defaultViewId.edit", or "javax.portlet.faces.defaultViewId.help", etc.

Returns a map of default viewIds that the bridge should use when it is unable to resolve to a specific target in the incoming request. There is one entry per support PortletMode. The entry key is the name of the mode. The entry value is the default viewId for that mode.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

javax.portlet.faces.GenericFacesPortlet.getExcludedRequestAttributes()
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.excludedRequestAttributes" instead.

Returns the set of RequestAttribute names that the portlet wants the bridge to exclude from its managed request scope. This default implementation picks up this list from the comma delimited init-param javax.portlet.faces.excludedRequestAttributes.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.

com.liferay.faces.bridge.BridgeFactoryFinder.getFactory(Class)
Call BridgeFactoryFinder.getFactory(PortletContext, Class) instead.

Returns the factory instance associated with the specified factory class from the portlet context associated with the current portlet request.

com.liferay.faces.bridge.BridgeFactoryFinder.getFactoryInstance(Class)
Call BridgeFactoryFinder.getFactory(PortletContext, Class) instead.

Returns the factory instance associated with the specified factory class from the portlet context associated with the current portlet request.

javax.portlet.faces.GenericFacesPortlet.getResponseCharacterSetEncoding(PortletRequest)
This method is no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.

javax.portlet.faces.GenericFacesPortlet.getResponseContentType(PortletRequest)
This method is no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.

javax.portlet.faces.GenericFacesPortlet.isPreserveActionParameters()
Call ExternalContext.getInitParameter(String) with parameter "javax.portlet.faces.preserveActionParams" instead.

Returns a boolean indicating whether or not the bridge should preserve all the action parameters in the subsequent renders that occur in the same scope. This default implementation reads the values from the portlet init-param javax.portlet.faces.preserveActionParams. If not present, false is returned.

Note that this method will only be called by GenericFacesPortlet.init(PortletConfig) if the GenericFacesPortlet.INITIALIZE_NAMESPACED_CONTEXT_ATTRIBUTES init-param is true in WEB-INF/portlet.xml.