TriggerMetricCollectionEvent.java

/**
 * JBoss, Home of Professional Open Source
 * Copyright Red Hat, Inc., and individual contributors.
 *
 * Licensed 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 org.jboss.aerogear.unifiedpush.message.event;

import org.jboss.aerogear.unifiedpush.api.PushMessageInformation;
import org.jboss.aerogear.unifiedpush.message.MetricsCollector;

import java.io.Serializable;

/**
 * Event that triggers {@link MetricsCollector} processing.
 *
 * @see org.jboss.aerogear.unifiedpush.message.jms.TriggerMetricCollectionConsumer
 */
public class TriggerMetricCollectionEvent implements Serializable {

    private static final long serialVersionUID = 1036025116554796512L;

    public static final long REDELIVERY_DELAY_MS = 1000L;

    private String pushMessageInformationId;
    private boolean allVariantsProcessed;

    public TriggerMetricCollectionEvent(PushMessageInformation pushMessageInformation) {
        this.pushMessageInformationId = pushMessageInformation.getId();
    }

    public TriggerMetricCollectionEvent(String pushMessageInformationId) {
        this.pushMessageInformationId = pushMessageInformationId;
    }

    public String getPushMessageInformationId() {
        return pushMessageInformationId;
    }

    /**
     * Marks that all batches are known to be loaded and so that the metric collection process can stop.
     */
    public void markAllVariantsProcessed() {
        allVariantsProcessed = true;
    }

    /**
     * @return true if all batches are known to be loaded; false otherwise
     */
    public boolean areAllVariantsProcessed() {
        return allVariantsProcessed;
    }

}