oracle.kv.impl.async.EndpointConfigBuilder Maven / Gradle / Ivy

Go to download
/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv.impl.async;

import java.util.HashMap;
import java.util.Map;

import oracle.kv.impl.security.ssl.SSLControl;

/**
 * A builder to build the endpoint configuration.
 */
public class EndpointConfigBuilder {

    /**
     * Allow overriding defaults by setting a system property with the
     * specified prefix followed by the option name.
     */
    private static final String DEFAULT_OVERRIDE_PROPERTY_PREFIX =
        "oracle.kv.async.endpoint.config.default.";

    private static final Map, Object> optionDefaults =
        new HashMap, Object>();

    static {
        optionDefault(AsyncOption.SO_KEEPALIVE, null);
        optionDefault(AsyncOption.SO_LINGER, null);
        optionDefault(AsyncOption.SO_RCVBUF, null);
        optionDefault(AsyncOption.SO_REUSEADDR, false);
        optionDefault(AsyncOption.SO_SNDBUF, null);
        optionDefault(AsyncOption.TCP_NODELAY, true);
        optionDefault(AsyncOption.DLG_LOCAL_MAXDLGS, 1024);
        optionDefault(AsyncOption.DLG_LOCAL_MAXLEN, 1024);
        optionDefault(AsyncOption.DLG_LOCAL_MAXTOTLEN, 1024 * 1024);
        optionDefault(AsyncOption.DLG_REMOTE_MAXDLGS, 1024);
        optionDefault(AsyncOption.DLG_REMOTE_MAXLEN, 1024);
        optionDefault(AsyncOption.DLG_REMOTE_MAXTOTLEN, 1024 * 1024);
        optionDefault(AsyncOption.DLG_CONNECT_TIMEOUT, 10000);
        optionDefault(AsyncOption.DLG_HEARTBEAT_TIMEOUT, 10);
        optionDefault(AsyncOption.DLG_HEARTBEAT_INTERVAL, 1000);
        optionDefault(AsyncOption.DLG_IDLE_TIMEOUT, 10000);
        optionDefault(AsyncOption.DLG_FLUSH_BATCHSZ, 64);
        optionDefault(AsyncOption.DLG_FLUSH_NBATCH, 4);
    }

    private final Map, Object> options =
        new HashMap, Object>();
    private SSLControl sslControl = null;
    private Object configId = null;

    /**
     * Creates an instance of this class.
     */
    public EndpointConfigBuilder() {
    }

    /**
     * Sets the endpoint option.
     *
     * @param option the option
     * @param value the value
     * @return this builder
     *
     */
    public 
        EndpointConfigBuilder option(AsyncOption option, T value) {

        options.put(option, value);
        return this;
    }

    /**
     * Sets the sslControl.
     *
     * @param sslCtrl the ssl control info
     * @return the builder
     */
    public EndpointConfigBuilder sslControl(SSLControl sslCtrl) {

        this.sslControl = sslCtrl;
        return this;
    }

    /**
     * Sets the configuration ID, which can be used to control sharing of
     * endpoints.
     *
     * @param cfgId the configuration ID
     * @return the builder
     */
    public EndpointConfigBuilder configId(Object cfgId) {
        configId = cfgId;
        return this;
    }

    /**
     * Builds the configuration.
     */
    public EndpointConfig build() {
        return new EndpointConfig(options, optionDefaults, sslControl,
                                  configId);
    }

    /**
     * Sets the endpoint option default value.
     */
    private static  void optionDefault(AsyncOption option, T value) {
        final String propertyOverride = System.getProperty(
            DEFAULT_OVERRIDE_PROPERTY_PREFIX + option.name());
        if (propertyOverride != null) {
            value = option.parseStringValue(propertyOverride);
        }
        optionDefaults.put(option, value);
    }

    /**
     * Returns the endpoint option default value.
     *
     * @param option the option
     * @return the default value
     * @throws IllegalArgumentException if the option has no default value
     */
    public static  T getOptionDefault(AsyncOption option) {
        if (!optionDefaults.containsKey(option)) {
            throw new IllegalArgumentException(
                "Option has no default value: " + option);
        }
        return option.type().cast(optionDefaults.get(option));
    }
}