org.eclipse.ditto.edge.service.acknowledgements.AcknowledgementConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ditto-edge-service Show documentation
Eclipse Ditto is a framework for creating and managing digital twins in the IoT.
There is a newer version: 3.6.3
/*
 * Copyright (c) 2020 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.edge.service.acknowledgements;

import java.time.Duration;

import javax.annotation.concurrent.Immutable;

import org.eclipse.ditto.internal.utils.config.KnownConfigValue;

/**
 * Provides configuration settings for {@code Acknowledgement}s to be applied.
 *
 * @since 1.1.0
 */
@Immutable
public interface AcknowledgementConfig {

    /**
     * Returns the default/fallback timeout to apply when correlating Acknowledgements via the
     * {@code AcknowledgementForwarderActor}.
     *
     * @return the fallback timeout to apply when correlating Acknowledgements.
     */
    Duration getForwarderFallbackTimeout();

    /**
     * Returns the default/fallback lifetime to apply to {@code ResponseCollectorActor} when
     * collecting Acknowledgements.
     *
     * @return the fallback lifetime to apply when collecting Acknowledgements.
     * @since 1.2.0
     */
    Duration getCollectorFallbackLifetime();

    /**
     * Returns the default/fallback timeout to apply when asking {@code ResponseCollectorActor} for its output.
     *
     * @return the fallback lifetime to apply when collecting Acknowledgements.
     * @since 1.2.0
     */
    Duration getCollectorFallbackAskTimeout();

    /**
     * Returns the max size of the payload of an automatically issued acknowledgement in bytes.
     *
     * @return the max size of an issued acknowledgement.
     * @since 1.2.0
     */
    int getIssuedMaxBytes();

    /**
     * An enumeration of the known config path expressions and their associated default values for
     * {@code AcknowledgementConfig}.
     */
    enum AcknowledgementConfigValue implements KnownConfigValue {

        /**
         * The fallback timeout to apply when forwarding Acknowledgements.
         */
        FORWARDER_FALLBACK_TIMEOUT("forwarder-fallback-timeout", Duration.ofSeconds(65)),

        /**
         * The fallback lifetime to apply when collecting Acknowledgements.
         */
        COLLECTOR_FALLBACK_LIFETIME("collector-fallback-lifetime", Duration.ofSeconds(100)),

        /**
         * The fallback timeout to apply when waiting for {@code ResponseCollectorActor} output.
         */
        COLLECTOR_FALLBACK_ASK_TIMEOUT("collector-fallback-ask-timeout", Duration.ofSeconds(120)),

        /**
         * The maximum number of bytes for the payload of an automatically issued acknowledgement.
         */
        ISSUED_MAX_BYTES("issued-max-bytes", 100_000);

        private final String path;
        private final Object defaultValue;

        AcknowledgementConfigValue(final String thePath, final Object theDefaultValue) {
            path = thePath;
            defaultValue = theDefaultValue;
        }

        @Override
        public Object getDefaultValue() {
            return defaultValue;
        }

        @Override
        public String getConfigPath() {
            return path;
        }

    }

}