EventFloodRegulator.java

package org.ovirt.engine.core.dal.dbbroker.auditloghandling;

import java.util.concurrent.TimeUnit;

import org.ovirt.engine.core.common.AuditLogType;
import org.ovirt.engine.core.dal.utils.CacheManager;

public class EventFloodRegulator {

    private final AuditLogable event;
    private final AuditLogType logType;
    private boolean useTimeout;
    private long endTime;
    private String timeoutObjectId;

    public EventFloodRegulator(AuditLogable event, AuditLogType logType) {
        this.event = event;
        this.logType = logType;
        updateTimeoutLogableObject();
    }

    /**
     * Checks if timeout is used and if it is, checks the timeout. If no timeout set, then it will set this object as
     * timeout.
     *
     * @return should the action be logged again
     */
    public boolean isLegal() {
        if (useTimeout) {
            String key = "".equals(timeoutObjectId) ? logType.toString() : timeoutObjectId;
            String oldValue = CacheManager.getTimeoutBaseCache().putIfAbsent(
                    key,
                    key,
                    endTime,
                    TimeUnit.MILLISECONDS);
            return oldValue == null;
        }
        return true;
    }

    /**
     * Update the logged object timeout attribute by log type definition
     */
    private void updateTimeoutLogableObject() {
        int eventFloodRate = (event.isExternal() && event.getEventFloodInSec() == 0)
                ? 30 // Minimal default duration for External Events is 30 seconds.
                : logType.getEventFloodRate();
        if (eventFloodRate > 0) {
            setEndTime(TimeUnit.SECONDS.toMillis(eventFloodRate));
            timeoutObjectId = composeObjectId();
        } else {
            timeoutObjectId = "";
        }
    }

    private String composeObjectId() {
        return EventKeyComposer.composeObjectId(event, logType);
    }

    public void evict() {
        CacheManager.getTimeoutBaseCache().computeIfPresent(composeObjectId(), (k, v) -> null);
    }

    private void setEndTime(long value) {
        useTimeout = true;
        endTime = value;
    }
}