org.graylog.events.processor.EventProcessorException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.events.processor;

import java.util.Optional;

import static java.util.Objects.requireNonNull;

/**
 * This is thrown when an {@link EventProcessor} fails.
 */
public class EventProcessorException extends Exception {
    private final String eventDefinitionId;
    private final boolean permanent;
    private EventDefinition eventDefinition;

    public EventProcessorException(String message, boolean permanent, String eventDefinitionId) {
        super(message);
        this.permanent = permanent;
        this.eventDefinitionId = requireNonNull(eventDefinitionId, "eventDefinitionId cannot be null");
    }

    public EventProcessorException(String message, boolean permanent, EventDefinition eventDefinition) {
        super(message);
        this.permanent = permanent;
        this.eventDefinition = requireNonNull(eventDefinition, "eventDefinition cannot be null");
        this.eventDefinitionId = requireNonNull(eventDefinition.id(), "eventDefinitionId cannot be null");
    }

    public EventProcessorException(String message, boolean permanent, String eventDefinitionId, EventDefinition eventDefinition) {
        super(message);
        this.permanent = permanent;
        this.eventDefinitionId = requireNonNull(eventDefinitionId, "eventDefinitionId cannot be null");
        this.eventDefinition = requireNonNull(eventDefinition, "eventDefinition cannot be null");
    }

    public EventProcessorException(String message, boolean permanent, String eventDefinitionId, EventDefinition eventDefinition, Throwable cause) {
        super(message, cause);
        this.permanent = permanent;
        this.eventDefinitionId = requireNonNull(eventDefinitionId, "eventDefinitionId cannot be null");
        this.eventDefinition = requireNonNull(eventDefinition, "eventDefinition cannot be null");
    }

    public EventProcessorException(String message, boolean permanent, EventDefinition eventDefinition, Throwable cause) {
        super(message, cause);
        this.permanent = permanent;
        this.eventDefinition = requireNonNull(eventDefinition, "eventDefinition cannot be null");
        this.eventDefinitionId = requireNonNull(eventDefinition.id(), "eventDefinitionId cannot be null");
    }

    /**
     * Indicates if an error is permanent or temporary. Temporary errors could be candidates for retries.
     *
     * @return true if the error is permanent, false if temporary
     */
    public boolean isPermanent() {
        return permanent;
    }

    /**
     * Returns the event definition ID that failed to execute.
     *
     * @return the event definition ID
     */
    public String getEventDefinitionId() {
        return eventDefinitionId;
    }

    /**
     * Returns the event definition that failed.
     *
     * @return the event definition for the failed processor or an empty {@link Optional} if absent
     */
    public Optional getEventDefinition() {
        return Optional.ofNullable(eventDefinition);
    }
}