IPortletEventCoordinationService.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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 org.apereo.portal.portlet.rendering;

import javax.servlet.http.HttpServletRequest;
import org.apache.pluto.container.EventCoordinationService;
import org.apereo.portal.portlet.om.IPortletWindowId;

/**
 * Service that manages handling and queueing portlet events
 *
 */
public interface IPortletEventCoordinationService extends EventCoordinationService {
    /**
     * Remove events from the Queue determining which {@link IPortletWindowId}s it targets and then
     * add it to the {@link PortletEventQueue}
     */
    public PortletEventQueue getPortletEventQueue(HttpServletRequest request);

    /**
     * Resolve all events returned by {@link PortletEventQueue#getUnresolvedEvents()} and store the
     * resolved event data via {@link PortletEventQueue#offerEvent(IPortletWindowId,
     * javax.portlet.Event)}
     */
    public void resolvePortletEvents(
            HttpServletRequest request, PortletEventQueue portletEventQueue);
}