Package oracle.kv

Class KVStoreConfig

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, KVSecurityConstants
    public class KVStoreConfig
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, KVSecurityConstants
    Represents the configuration parameters used to create a handle to an existing KV store.
    See Also:
    Serialized Form

    • Field Detail

      • DEFAULT_REQUEST_TIMEOUT

        public static final int DEFAULT_REQUEST_TIMEOUT
        The default timeout in ms associated with KVStore requests.
        See Also:
        Constant Field Values

      • DEFAULT_OPEN_TIMEOUT

        public static final int DEFAULT_OPEN_TIMEOUT
        The default open timeout in ms associated with the sockets used to make KVStore requests.
        See Also:
        Constant Field Values

      • DEFAULT_READ_TIMEOUT

        public static final int DEFAULT_READ_TIMEOUT
        The default read timeout in ms associated with the sockets used to make KVStore requests.

        If the async network protocol is disabled, the default read timeout value must be larger than DEFAULT_REQUEST_TIMEOUT to ensure that read requests are not timed out by the socket.

        See Also:
        Constant Field Values

      • DEFAULT_REGISTRY_OPEN_TIMEOUT

        public static final int DEFAULT_REGISTRY_OPEN_TIMEOUT
        The default open timeout in ms associated with the sockets used to make registry requests.
        See Also:
        Constant Field Values

      • DEFAULT_REGISTRY_READ_TIMEOUT

        public static final int DEFAULT_REGISTRY_READ_TIMEOUT
        The default read timeout associated with the sockets used to make registry requests.
        See Also:
        Constant Field Values

      • DEFAULT_LOB_TIMEOUT

        public static final int DEFAULT_LOB_TIMEOUT
        The default timeout value (10000 ms) associated with internal LOB access during operations on LOBs.
        Since:
        2.0
        See Also:
        Constant Field Values

      • DEFAULT_SG_CACHED_ATTRS_TIMEOUT

        public static int DEFAULT_SG_CACHED_ATTRS_TIMEOUT
        Default value for the timeout of cached sequence generator attributes in milliseconds.

      • USE_ASYNC

        public static final java.lang.String USE_ASYNC
        The name of the system property that controls whether to use the async network protocol by default.
        Since:
        19.5
        See Also:
        Constant Field Values

      • DEFAULT_USE_ASYNC

        public static final boolean DEFAULT_USE_ASYNC
        Whether to use the async network protocol by default.
        Since:
        19.5
        See Also:
        Constant Field Values

    • Constructor Detail

      • KVStoreConfig

        public KVStoreConfig​(java.lang.String storeName,
                     java.lang.String... helperHostPort)
              throws java.lang.IllegalArgumentException
        Creates a config object with the minimum required properties.
        Parameters:
        storeName - the name of the KVStore. The store name is used to guard against accidental use of the wrong host or port. The store name must consist entirely of upper or lowercase, letters and digits.
        helperHostPort - one or more strings containing the host and port of an active node in the KVStore. Each string has the format: hostname:port. It is good practice to pass multiple hosts so that if one host is down, the system will attempt to open the next one, and so on.
        Throws:
        java.lang.IllegalArgumentException - if an argument has an illegal value. This may be thrown if the "oracle.kv.security" property is set and an error occurs while attempting to read that file.

    • Method Detail

      • clone

        public KVStoreConfig clone()
        Overrides:
        clone in class java.lang.Object

      • setStoreName

        public KVStoreConfig setStoreName​(java.lang.String storeName)
                           throws java.lang.IllegalArgumentException
        Configures the store name.
        Parameters:
        storeName - the name of the KVStore. The store name is used to guard against accidental use of the wrong host or port. The store name must consist entirely of upper or lowercase, letters and digits.
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException

      • getStoreName

        public java.lang.String getStoreName()
        Returns the store name.

        If it is not overridden by calling setStoreName(java.lang.String), the default value is the one specified to the KVStoreConfig constructor.

        Returns:
        the store name.

      • setHelperHosts

        public KVStoreConfig setHelperHosts​(java.lang.String... helperHostPort)
                             throws java.lang.IllegalArgumentException
        Configures the helper host/port pairs.
        Parameters:
        helperHostPort - one or more strings containing the host and port of an active node in the KVStore. Each string has the format: hostname:port. It is good practice to pass multiple hosts so that if one host is down, the system will attempt to open the next one, and so on.
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if no helperHostPort is specified.

      • getHelperHosts

        public java.lang.String[] getHelperHosts()
        Returns the helper host/port pairs.

        If it is not overridden by calling setHelperHosts(java.lang.String...), the default value is the one specified to the KVStoreConfig constructor.

        Returns:
        the helper hosts.

      • setSocketOpenTimeout

        public KVStoreConfig setSocketOpenTimeout​(long timeout,
                                          java.util.concurrent.TimeUnit unit)
                                   throws java.lang.IllegalArgumentException
        Configures the open timeout used when establishing sockets used to make client requests. Shorter timeouts result in more rapid failure detection and recovery. The default open timeout (3000 milliseconds) should be adequate for most applications.

        The client does not directly open sockets when making requests. KVStore manages the network connections used to make client requests opening and closing connections as needed.

        Please note that the socket timeout applies to any duplicate KVStore handles to the same KVStore within this process.

        Parameters:
        timeout - the socket open timeout.
        unit - the TimeUnit of the timeout value.
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if the timeout value is negative or zero.
        Since:
        2.0
        See Also:
        DEFAULT_OPEN_TIMEOUT

      • getSocketOpenTimeout

        public long getSocketOpenTimeout​(java.util.concurrent.TimeUnit unit)
        Returns the socket open timeout.

        If it is not overridden by calling setOpenTimeout(long, java.util.concurrent.TimeUnit), the default value is 3000 milliseconds.

        Parameters:
        unit - the TimeUnit of the returned value. May not be null.
        Returns:
        The socket open timeout.
        Since:
        2.0

      • setSocketReadTimeout

        public KVStoreConfig setSocketReadTimeout​(long timeout,
                                          java.util.concurrent.TimeUnit unit)
                                   throws java.lang.IllegalArgumentException
        Configures the read timeout associated with the underlying sockets used to make client requests. Shorter timeouts result in more rapid failure detection and recovery. If the async network protocol is disabled, then this timeout should be sufficiently long so as to allow for the longest timeout associated with a request.

        The client does not directly manage sockets when making requests. KVStore manages the network connections used to make client requests opening and closing connections as needed.

        Please note that the socket timeout applies to any duplicate KVStore handles to the same KVStore within this process.

        Parameters:
        timeout - the socket read timeout
        unit - the TimeUnit of the timeout value
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if the timeout is invalid
        Since:
        2.0

      • getSocketReadTimeout

        public long getSocketReadTimeout​(java.util.concurrent.TimeUnit unit)
        Returns the read timeout associated with the sockets used to make requests.

        If it is not overridden by calling setSocketReadTimeout(long, java.util.concurrent.TimeUnit), the default value is 30000 milliseconds.

        Parameters:
        unit - the TimeUnit of the returned value. May not be null.
        Returns:
        The socket read timeout
        Since:
        2.0

      • setLocalAddress

        public KVStoreConfig setLocalAddress​(java.net.InetSocketAddress localAddr)
        Configures the local address used to establish connections to the store. Use this method on machines with multiple NICs to restrict traffic to KVStore to a specific NIC, or to chose a more desirable network path. Setting localAddr can be beneficial in the following circumstances:
        1. When there are multiple network paths through the NICs to the store's nodes and the routing rules are insufficient to disambiguate amongst them. Setting the address explicitly ensures the best choice of network path based on knowledge of the overall application behavior and network configuration.
        2. To isolate store traffic to a specific NIC, for latency-sensitive applications, for example, when the client is used in the web tier to isolate client/store request response http request traffic.
        Parameters:
        localAddr - the local address identifying the NIC. If null, any local address is chosen. Similarly, if the port is zero any free local port (associated with the address) is used to bind the connection.
        Since:
        18.3

      • getLocalAddress

        public java.net.InetSocketAddress getLocalAddress()
        Gets the local address. If user does not specify it, returns null
        Returns:
        the host port of local address or null.
        Since:
        18.3

      • setRequestTimeout

        public KVStoreConfig setRequestTimeout​(long timeout,
                                       java.util.concurrent.TimeUnit unit)
                                throws java.lang.IllegalArgumentException
        Configures the default request timeout.
        Parameters:
        timeout - the default request timeout.
        unit - the TimeUnit of the timeout value.
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if the timeout value is negative or zero.

      • setNetworkRoundtripTimeout

        public KVStoreConfig setNetworkRoundtripTimeout​(long timeout,
                                                java.util.concurrent.TimeUnit unit)
        Configures the amount of time to allow for a single roundtrip network communication with the server. This value is added to the request timeout to determine the total amount of time that the client should wait for a request to complete before timing out.

        Specifying a smaller value, or to zero, will reduce the amount of time it takes for the client to report a request that fails to complete within the requested timeout, but increases the chance that the resulting exception will be a RequestTimeoutException rather than an exception the reflects more specific information about the failure on the server, for example, a ConsistencyException. Specifying a longer value will increase the chance that the client will be able to throw an exception based on more specific information from the server in case of longer network communication delays.

        Parameters:
        timeout - the roundtrip network communication timeout
        unit - the TimeUnit of the timeout value
        Throws:
        java.lang.IllegalArgumentException - if the timeout value is negative
        Since:
        19.5
        See Also:
        setRequestTimeout(long, java.util.concurrent.TimeUnit)

      • getNetworkRoundtripTimeout

        public long getNetworkRoundtripTimeout​(java.util.concurrent.TimeUnit unit)
        Returns the amount of time to allow for a single roundtrip network communication with the server. This value is added to the request timeout to determine the total amount of time that the client should wait for a request to complete before timing out.

        If it is not overridden by calling setNetworkRoundtripTimeout(long, java.util.concurrent.TimeUnit), the default value is 25.

        Parameters:
        unit - the Timeout to use for the return value
        Returns:
        the network roundtrip timeout
        Since:
        19.5

      • setConsistency

        public KVStoreConfig setConsistency​(Consistency consistency)
                             throws java.lang.IllegalArgumentException
        Configures the default read Consistency to be used when a Consistency is not specified for a particular read operation.
        Parameters:
        consistency - the default read Consistency.
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException

      • setDurability

        public KVStoreConfig setDurability​(Durability durability)
                            throws java.lang.IllegalArgumentException
        Configures the default write Durability to be used when a Durability is not specified for a particular write operation.
        Parameters:
        durability - the default write Durability.
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException

      • setRequestLimit

        public KVStoreConfig setRequestLimit​(RequestLimitConfig requestLimitConfig)
        Configures the maximum number of requests that can be active for a node in the KVStore. Limiting requests in this way helps minimize the possibility of thread starvation in situations where one or more nodes in the KVStore exhibits long service times and as a result retains threads, making them unavailable to service requests to other reachable and healthy nodes.

        The long service times can be due to problems at the node itself, or in the network path to that node. The KVStore request dispatcher will, whenever possible, minimize use of nodes with long service times automatically, by re-routing requests to other nodes that can handle them. So this mechanism provides an additional margin of safety when such re-routing of requests is not possible.

        Returns:
        this

      • getLOBSuffix

        public java.lang.String getLOBSuffix()
        Returns the default suffix associated with LOB keys.
        Since:
        2.0
        See Also:
        KVLargeObject

      • setLOBSuffix

        public KVStoreConfig setLOBSuffix​(java.lang.String lobSuffix)
        Configures the default suffix associated with LOB keys. The application must ensure that the suffix is used consistently across all KVStore handles. The suffix is used by the KVStore APIs to ensure that any value-changing non-LOB APIs are not invoked on LOB objects and vice versa. Failure to use the LOB suffix consistently can result in IllegalArgumentException being thrown if a LOB object is created with one LOB suffix and is subsequently accessed when a different suffix is in effect. Write operations using inconsistent LOB suffixes may result in LOB storage not being reclaimed.

        This method should only be used in the rare case that the default LOB suffix value ".lob" is unsuitable.

        Parameters:
        lobSuffix - the LOB suffix string. It must be non-null and have a length > 0.
        Returns:
        this
        Since:
        2.0
        See Also:
        KVLargeObject

      • getLOBVerificationBytes

        public long getLOBVerificationBytes()
        Returns the number of trailing bytes of a partial LOB that must be verified against the user supplied LOB stream when resuming a LOB put operation.
        Since:
        2.0
        See Also:
        KVLargeObject

      • setLOBVerificationBytes

        public KVStoreConfig setLOBVerificationBytes​(long lobVerificationBytes)
        Configures the number of trailing bytes of a partial LOB that must be verified against the user supplied LOB stream when resuming a putLOB operation.
        Parameters:
        lobVerificationBytes - the number of bytes to be verified. A value <=0 disables verification.
        Returns:
        this
        Since:
        2.0
        See Also:
        KVLargeObject

      • getReadZones

        public java.lang.String[] getReadZones()
        Returns the zones in which nodes must be located to be used for read operations, or null if read operations can be performed on nodes in any zone.
        Returns:
        the zones or null
        Since:
        3.0

      • setReadZones

        public KVStoreConfig setReadZones​(java.lang.String... zones)
        Sets the zones in which nodes must be located to be used for read operations. If the argument is null, or this method has not been called, then read operations can be performed on nodes in any zone.

        The specified zones must exist at the time that this configuration object is used to create a store, or else KVStoreFactory.getStore(oracle.kv.KVStoreConfig) will throw an IllegalArgumentException.

        Zones specified for read operations can include primary and secondary zones. If the master is not located in any of the specified zones, either because the zones are all secondary zones or because the master node is not currently in one of the specified primary zones, then read operations with Consistency.ABSOLUTE will fail.

        Parameters:
        zones - the zones or null
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if the array argument is not null and is either empty or contains null or duplicate elements
        Since:
        3.0

      • getUseAsync

        public boolean getUseAsync()
        Whether calls to the store should use the async network protocol.

        If it is not overridden by calling setUseAsync(boolean), the default value is true, unless the USE_ASYNC system property is set, in which case that value is parsed by calling Boolean.getBoolean(java.lang.String).

        Since:
        19.5

      • setUseAsync

        public KVStoreConfig setUseAsync​(boolean useAsync)
        Specifies whether calls to the store should use the async network protocol.
        Since:
        19.5

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • setSecurityProperties

        public KVStoreConfig setSecurityProperties​(java.util.Properties securityProps)
        Configures security properties for the client. The supported properties include both authentication properties and transport properties. See KVSecurityConstants for the supported properties.
        Returns:
        this

      • getSecurityProperties

        public java.util.Properties getSecurityProperties()
        Returns a copy of the current security properties. This reflects both the properties explicitly set through setSecurityProperties as well as any properties obtained from a security property file. Changes to the returned object have no effect on configuration settings.
        Returns:
        the current security properties

      • setSGAttrsCacheTimeout

        public KVStoreConfig setSGAttrsCacheTimeout​(int sgAttrsCacheTimeout)
        Sets the timeout of cached sequence generator attributes in milliseconds.

      • getSGAttrsCacheTimeout

        public int getSGAttrsCacheTimeout()
        Gets the timeout of cached sequence generator attributes in milliseconds.