javax.portlet.EventPortlet Maven / Gradle / Ivy
Show all versions of portlet-api Show documentation
/* 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.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
package javax.portlet;
import java.io.IOException;
/**
* The EventPortlet
interface allows
* portlets receiving events.
*
* Events are part of the action processing and must
* be finished before the rendering phase can start.
* Portlets can receive events issued by other portlets or
* portlet container defined events.
*
* Portlets should declare the events it would like to receive
* via the supported-processing-event
tag and events published
* via the supported-publishing-event
tag in the portlet
* deployment descriptor.
*
* The event model is a loosely coupled model where the wiring between
* published and receiving events is done at the portal / portlet container
* level.
*
* @since 2.0
*/
public interface EventPortlet {
/**
* Called by the portlet container requesting the portlet
* to process a specific event.
*
* @param request the event request
* @param response the event response
* @exception PortletException
* if the portlet has problems fulfilling the
* request
* @exception UnavailableException
* if the portlet is unavailable to process the event at this time
* @exception PortletSecurityException
* if the portlet cannot fulfill this request due to security reasons
* @exception IOException
* if the streaming causes an I/O problem
*/
public void processEvent (EventRequest request, EventResponse response)
throws PortletException, java.io.IOException;
}