|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
ExternalContext.encodeResourceURL(String) that it recognizes as an indication that an URL
referring back to the page which contains this portlet should be encoded in the resource URL.
Bridge interface is used by a portlet to execute a JSF application.GenericFacesPortlet overrides event
processing by dispatching all events to the bridge or delegates all event processing to the
GenericPortlet.
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"
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"
BridgeConfig and PortletConfig.GenericFacesPortlet.DEFAULT_VIEWID.BridgeEventHandler interface defines the class the bridge relies on to process portlet events.FactoryFinder in the JSF API.Bridge.FACES_VIEW_PATH_PARAMETER.doFacesRequest methods even though the Bridge.NONFACES_TARGET_PATH_PARAMETER parameter is present, indicating it is a non-Faces target.BridgePortletConfigFactory that provides a custom instance of PortletConfig, that in turn provides a method Override for PortletConfig.getPortletContext().BridgePreDestroy annotation is used on methods as a callback notification to signal that the
instance is in the process of being removed by the bridge from the bridge request scope.BridgeRequestScopeAttributeAdded annotation is used on methods as a callback notification to signal
that the instance is in the process of being added to the container's request scope and that this attribute will be
managed in the bridge request scope.doFacesRequest methods is called and the bridge is in an
uninitialized state.BridgeURL.PortletRequest.ACTION_PHASE of the portlet lifecycle.
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).
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"
ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action
should be treated as a direct link and hence shouldn't be encoded as a Portlet action.
javax.portlet.faces.automaticNonFacesViewDispatching init-param is true and the
Bridge.NONFACES_TARGET_PATH_PARAMETER render request parameter specifies a value as a non-Faces target
path, then forward to the non-Faces target path.
Bridge.doFacesRequest(RenderRequest, RenderResponse) in order to render the Faces view
associated with PortletMode.EDIT.
Bridge.doFacesRequest(RenderRequest, RenderResponse) in order to render the Faces view
associated with PortletMode.HELP.
Bridge.doFacesRequest(RenderRequest, RenderResponse) in order to render the Faces view
associated with PortletMode.VIEW.
EventNavigationResult is the type of object that can be returned from a BridgeEventHandler.handleEvent(FacesContext, Event) call.EventPayloadWrapper instance.
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"
ExcludeFromManagedRequestScope annotation is used on a class as a signal that instances of this
class are not to be managed by the bridge in the bridge request scope if/when the instance is added to the portlet
container's request scope.ResourceURL.
ResourceURL.
Bridge.FACES_VIEW_ID_PARAMETER or Bridge.FACES_VIEW_PATH_PARAMETER.
GenericFacesPortlet is provided to simplify development of a portlet that in whole or part relies on
the Faces Bridge to process requests.ActionRequest.
ActionRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
ActionResponse.
ActionResponse from the BridgePortletResponseFactory found by the
BridgeFactoryFinder.
Map of bridge configuration attributes.
BridgeURL.
BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
BridgeURL.
BridgeURL from the BridgeURLFactory found by the
BridgeFactoryFinder.
BridgeConfig.
BridgeConfig from the BridgeConfigFactory found by the BridgeFactoryFinder.
BridgeEventHandler.
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.
BridgeEventHandler from the BridgeEventHandlerFactory found by
the BridgeFactoryFinder.
BridgeURL.
BridgeURL from the BridgeURLFactory found by the
BridgeFactoryFinder.
BridgePublicRenderParameterHandler.
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.
BridgePublicRenderParameterHandler from the BridgePublicRenderParameterHandlerFactory found by the BridgeFactoryFinder.
BridgeURL.
BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
BridgeURL.
BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
cacheability attribute description:
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.
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.
EventRequest.
EventRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
EventResponse.
EventResponse from the BridgePortletResponseFactory found by the BridgeFactoryFinder.
Set of attribute names that are to be excluded from the bridge request scope as
defined in the bridge:excluded-attributes element within the faces-config.xml descriptor.
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.
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.
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.
fileUploadListener attribute description:
ResponseWriter.
ResponseWriter from the HeadResponseWriterFactory found by the BridgeFactoryFinder.
id attribute description:
name attribute description:
name attribute description:
name attribute description:
BridgeURL.getParameterMap() with the specified
name.
Map representing the URL parameters.
PortletConfig.
PortletConfig from the BridgePortletConfigFactory found by the
BridgeFactoryFinder.
PortletContext.
PortletContext from the BridgePortletContextFactory found by
the BridgeFactoryFinder.
portletMode attribute description:
Map of Public Render Parameter mappings as defined in the
bridge:public-parameter-mappings element of the faces-config.xml descriptor.
RenderRequest.
RenderRequest from the BridgePortletRequestFactory found by the BridgeFactoryFinder.
RenderResponse.
RenderResponse from the BridgePortletResponseFactory found by the
BridgeFactoryFinder.
RequestAttributeInspector.
RequestAttributeInspector from the RequestAttributeInspectorFactory
found by the BridgeFactoryFinder.
ResourceRequest.
ResourceRequest from the BridgePortletRequestFactory found by the
BridgeFactoryFinder.
ResourceResponse.
ResourceResponse from the BridgePortletResponseFactory found by the
BridgeFactoryFinder.
GenericFacesPortlet but retained in case
a subclass has called it.
GenericFacesPortlet but retained in case
a subclass has called it.
secure attribute description:
value attribute description:
value attribute description:
List of values associated with this preference.
var attribute description:
var attribute description:
RenderRequest.
ResourceRequest.
windowState attribute description:
ExternalContext.encodeResourceURL(String) that it recognizes as an indication that this
resource should be handled in-protocol.
GenericFacesPortlet according to the specified portlet configuration.
GenericFacesPortlet.init(PortletConfig) method sets PortletContext attributes from PortletConfig init-param values, such that they are namespaced with the
portlet name.
auto attribute description:
javax.portlet.faces.autoDispatchEvents if
non-null or true, otherwise.
copyCurrentRenderParameters attribute description:
escapeXml attribute description:
ExcludeFromManagedRequestScope.
bridge:excluded-attributes element within the faces-config.xml
descriptor.
FacesContext.
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.
FacesContext.
ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action
should encode a portlet mode change to the one indicated by the parameter's value.
NamingContainer that ensures all generated ids are namespaced using the consumer
provided unique portlet id.
ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action
should encode a security level change to the one indicated by the parameter's value.
ExternalContext.encodeActionURL(String) that it recognizes as an indication that this action
should encode a window state change to the one indicated by the parameter's value.
PortletNamingContainerUIViewRoot and can be applied to others if
necessary.PortletRequest.ACTION_PHASE originates from an HTTP POST request, and the PortletRequest.RENDER_PHASE is caused by a subsequent HTTP GET request.
Preference interface allows one to access each value from PortletPreferences
as a discrete object.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"
Bridge.doFacesRequest(ActionRequest, ActionResponse).
Bridge.doFacesRequest(EventRequest, EventResponse).
BridgeURL.getParameterMap() according to the specified
name.
SAVESTATE_FIELD_MARKER in use in the given
deployment.
Bridge.doFacesRequest(ResourceRequest, ResourceResponse).
ResourceResponse.HTTP_STATUS_CODE property on the ResourceResponse.
ResourceResponse implementation.
auto attribute description:
cacheability attribute description:
copyCurrentRenderParameters attribute description:
escapeXml attribute description:
fileUploadListener attribute description:
id attribute description:
multiple attribute description:
name attribute description:
name attribute description:
name attribute description:
value of the underlying BridgeURL.getParameterMap() according to the specified
name.
value of the underlying BridgeURL.getParameterMap() according to the specified
name.
portletMode attribute description:
secure attribute description:
value attribute description:
value attribute description:
var attribute description:
var attribute description:
windowState attribute description:
Bridge.doFacesRequest(RenderRequest, RenderResponse) method.
ExternalContext.encodeResourceURL(String) that it recognizes as an indication that this URL
refers to Faces view (navigation) and hence should be encoded as a portlet ActionURL rather then a portlet
ResourceURL.
Bridge.doFacesRequest(RenderRequest, RenderResponse) method.
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||