RequestScopedEventsTracker.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.events;

import java.util.Set;
import javax.portlet.PortletRequest;
import javax.servlet.http.HttpServletRequest;

/**
 * Tracks events that have been fired during this request and provides a thread-safe read-only set
 * of those events.
 *
 */
public interface RequestScopedEventsTracker {

    /**
     * Return a read-only set of all events that have been fired so far during the handling of the
     * portal's request
     */
    Set<PortalEvent> getRequestEvents(PortletRequest portletRequest);

    /**
     * Return a read-only set of all events that have been fired so far during the handling of the
     * portal's request
     */
    Set<PortalEvent> getRequestEvents(HttpServletRequest request);
}