/**
 * 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.rendering;

import java.util.Collection;
import javax.servlet.http.HttpServletRequest;
import javax.xml.stream.events.StartElement;
import org.apereo.portal.character.stream.BasePlaceholderEventSource;
import org.apereo.portal.character.stream.events.CharacterEvent;
import org.apereo.portal.character.stream.events.PortletAnalyticsDataPlaceholderEvent;

/**
 * Replaces <portlet-analytics-data> elements in the XML stream with {@link
 * PortletAnalyticsDataPlaceholderEvent}
 */
public class PortletAnalyticsDataPlaceholderEventSource extends BasePlaceholderEventSource {
    /** Represents <portlet-analytics-data> layout element */
    public static final String PORTLET_ANALYTICS_SCRIPT = "portlet-analytics-data";

    @Override
    protected void generateCharacterEvents(
            HttpServletRequest servletRequest,
            StartElement event,
            Collection<CharacterEvent> eventBuffer) {
        eventBuffer.add(PortletAnalyticsDataPlaceholderEvent.INSTANCE);
    }
}