io.tarantool.driver.cluster.TarantoolClusterDiscoveryConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cartridge-driver Show documentation
Tarantool Cartridge driver for Tarantool versions 1.10+ based on Netty framework
There is a newer version: 0.14.0
package io.tarantool.driver.cluster;

import io.tarantool.driver.exceptions.TarantoolClientException;
import io.tarantool.driver.utils.Assert;

/**
 * Class-container for service discovery configuration.
 * 
 * It is recommended to use the {@link TarantoolClusterDiscoveryConfig.Builder} for constructing the configuration
 *
 * @author Sergey Volgin
 */
public final class TarantoolClusterDiscoveryConfig {

    private TarantoolClusterDiscoveryEndpoint endpoint;
    private int serviceDiscoveryDelay = 60_000; // milliseconds

    /**
     * Get config of service discovery endpoint
     *
     * @return a {@link TarantoolClusterDiscoveryEndpoint} instance
     */
    public TarantoolClusterDiscoveryEndpoint getEndpoint() {
        return endpoint;
    }

    /**
     * Set service discovery endpoint config and enable cluster connection
     *
     * @param endpoint a {@link TarantoolClusterDiscoveryEndpoint} instance
     */
    public void setEndpoint(TarantoolClusterDiscoveryEndpoint endpoint) {
        this.endpoint = endpoint;
    }

    /**
     * Get cluster discovery delay
     *
     * @return cluster discovery delay, milliseconds
     */
    public int getServiceDiscoveryDelay() {
        return serviceDiscoveryDelay;
    }

    /**
     * Set scan period (in milliseconds) of receiving a new list of instances
     *
     * @param serviceDiscoveryDelay period of receiving a new list of instances
     */
    public void setServiceDiscoveryDelay(int serviceDiscoveryDelay) {
        this.serviceDiscoveryDelay = serviceDiscoveryDelay;
    }

    /**
     * Create a builder instance.
     *
     * @return a builder
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * A builder for {@link TarantoolClusterDiscoveryConfig}
     */
    public static class Builder {

        private final TarantoolClusterDiscoveryConfig config;

        public Builder() {
            this.config = new TarantoolClusterDiscoveryConfig();
        }

        /**
         * Specify scan period of receiving a new list of instances
         *
         * @param delay period of receiving a new list of instances, in milliseconds
         * @return this builder instance
         * @see TarantoolClusterDiscoveryConfig#setServiceDiscoveryDelay(int)
         */
        public Builder withDelay(int delay) {
            if (delay <= 0) {
                throw new IllegalArgumentException("Discovery delay must be greater than 0 ms");
            }
            this.config.setServiceDiscoveryDelay(delay);
            return this;
        }

        /**
         * Specify service discovery config and enable using service discovery
         *
         * @param endpoint discovery endpoint config, should not be null
         * @return this builder instance
         * @see TarantoolClusterDiscoveryConfig#setEndpoint(TarantoolClusterDiscoveryEndpoint)
         */
        public Builder withEndpoint(TarantoolClusterDiscoveryEndpoint endpoint) {
            Assert.notNull(endpoint, "Cluster discovery endpoint config should not be null");
            if (this.config.getEndpoint() != null) {
                throw new TarantoolClientException("Cluster discovery endpoint already set");
            }
            this.config.setEndpoint(endpoint);
            return this;
        }

        /**
         * Build a {@link TarantoolClusterDiscoveryConfig} instance
         *
         * @return configured instance
         */
        public TarantoolClusterDiscoveryConfig build() {
            if (config.getEndpoint() == null) {
                throw new TarantoolClientException("Cluster discovery endpoint must be not null");
            }
            return config;
        }
    }
}