org.eclipse.ditto.internal.utils.ddata.DistributedDataConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ditto-internal-utils-ddata Show documentation
Eclipse Ditto is a framework for creating and managing digital twins in the IoT.
The newest version!
/*
 * Copyright (c) 2019 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.internal.utils.ddata;

import java.time.Duration;

import javax.annotation.concurrent.Immutable;

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

import org.apache.pekko.cluster.ddata.Replicator;

/**
 * Provides configuration settings for {@link DistributedData}.
 */
@Immutable
public interface DistributedDataConfig {

    /**
     * Returns the timeout of GET-messages of the replicator.
     *
     * @return the timeout of reads.
     */
    Duration getReadTimeout();

    /**
     * Returns the timeout of UPDATE-messages of the replicator.
     *
     * @return the timeout of writes.
     */
    Duration getWriteTimeout();

    /**
     * Returns the write consistency for topic subscription.
     *
     * @return the write consistency.
     */
    Replicator.WriteConsistency getSubscriptionWriteConsistency();

    /**
     * Returns the delay for subscriptions.
     *
     * @return the subscription delay.
     */
    Duration getSubscriptionDelay();

    /**
     * Returns the config to use for creating the {@link org.apache.pekko.cluster.ddata.Replicator}.
     *
     * @return the Pekko replicator config to use.
     */
    PekkoReplicatorConfig getPekkoReplicatorConfig();

    /**
     * The number of shards Ditto's ddata extension applies for Map keys.
     *
     * @return the number of shards to apply.
     */
    int getNumberOfShards();

    /**
     * The number of subscribers in each subscriber pool.
     *
     * @return the number of subscribers.
     */
    int getSubscriberPoolSize();

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

        /**
         * The read timeout duration: the timeout of GET-messages of the replicator.
         */
        READ_TIMEOUT("read-timeout", Duration.ofSeconds(5)),

        /**
         * The write timeout duration: the timeout of UPDATE-messages of the replicator.
         */
        WRITE_TIMEOUT("write-timeout", Duration.ofSeconds(25)),

        /**
         * The write consistency of subscriptions.
         */
        SUBSCRIPTION_WRITE_CONSISTENCY("subscription-write-consistency", "all"),

        /**
         * Local delay for topic subscription to account for replication and notification delay.
         */
        SUBSCRIPTION_DELAY("subscription-delay", Duration.ofSeconds(2L)),

        /**
         * The number of shards Ditto's ddata extension applies for Map keys.
         */
        NUMBER_OF_SHARDS("number-of-shards", 5),

        /**
         * The number of subscribers in each subscriber pool.
         */
        SUBSCRIBER_POOL_SIZE("subscriber-pool-size", 1);

        private final String path;
        private final Object defaultValue;

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

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

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

    }

}