javax.portlet.faces.BridgeEventHandler Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the License. You may obtain a
* copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable
* law or agreed to in writing, software distributed under the License is distributed on an "AS IS"
* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
* for the specific language governing permissions and limitations under the License.
*/
package javax.portlet.faces;
import javax.faces.context.FacesContext;
import javax.portlet.Event;
import javax.portlet.faces.event.EventNavigationResult;
/**
* The BridgeEventHandler interface defines the class the bridge relies
* on to process portlet events. Because portlet events have arbitrary payloads
* the bridge provides no automated mappings to managed beans. Instead, the bridge
* calls the handleEvent method on the BridgeEventHandler
* instance passed to it (via a PortletContext attrbiute at init time.
* This method is expected to update any models based on the event's payload
* and then to perform any needed application recomputation to ensure a
* consistent state. The method is called after the FacesContext
* has been established and the Lifecycle has restored the view.
* A view navigation can be affected by returning a non-null EventNavigationResult.
* Such an object will contain two String values: a fromAction and
* an outcome. These correspond to the from action and outcomes in Faces
* navigation rules. Using this information the bridge affects the navigation
* by calling the Faces NavigationHandler.
*/
public interface BridgeEventHandler
{
/**
* Called by the bridge when it needs to process a portlet event.
*
* Because portlet events have arbitrary payloads
* the bridge provides no automated mappings to managed beans. Instead, the bridge
* calls the handleEvent method on the BridgeEventHandler
* instance passed to it (via a PortletContext attrbiute at init time.
* This method is expected to update any models based on the event's payload
* and then to perform any needed application recomputation to ensure a
* consistent state. The method is called after the FacesContext
* has been established and the Lifecycle has restored the view.
* A view navigation can be affected by returning a non-null EventNavigationResult.
* Such an object will contain two String values: a fromAction and
* an outcome. These correspond to the from action and outcomes in Faces
* navigation rules. Using this information the bridge affects the navigation
* by calling the Faces NavigationHandler.
*
* @param context
* current FacesContext. A Lifecycle has been acquired and the current view restored.
* @param event
* the portlet event. Other portlet information (request/response) is accessed via the ExternalContext.
* @return an object containing the fromAction and outcome of any navigation that resulted from this event.
* If the event doesn't cause a navigation, return null.
*/
public EventNavigationResult handleEvent(FacesContext context, Event event);
}