com.suse.salt.netapi.config

Class ClientConfig

java.lang.Object

com.suse.salt.netapi.config.ClientConfig

public class ClientConfig
extends Object

A statically typed key/value store for the Salt client configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static com.suse.salt.netapi.config.ClientConfig.Key<Integer>	CONNECT_TIMEOUT Timeout in milliseconds until a connection is established.
static com.suse.salt.netapi.config.ClientConfig.Key<String>	PROXY_HOSTNAME
static com.suse.salt.netapi.config.ClientConfig.Key<String>	PROXY_PASSWORD
static com.suse.salt.netapi.config.ClientConfig.Key<Integer>	PROXY_PORT
static com.suse.salt.netapi.config.ClientConfig.Key<String>	PROXY_USERNAME
static com.suse.salt.netapi.config.ClientConfig.Key<Integer>	SOCKET_TIMEOUT Timeout in milliseconds for waiting for data.
static com.suse.salt.netapi.config.ClientConfig.Key<String>	TOKEN
static com.suse.salt.netapi.config.ClientConfig.Key<URI>	URL
static com.suse.salt.netapi.config.ClientConfig.Key<Integer>	WEBSOCKET_MAX_MESSAGE_LENGTH Maximum websocket message length in characters.

Constructor Summary

Constructors

Constructor and Description
ClientConfig()

Method Summary

Modifier and Type	Method and Description
<T> T	get(com.suse.salt.netapi.config.ClientConfig.Key<T> key) Returns the configured value for the given key.
<T> void	put(com.suse.salt.netapi.config.ClientConfig.Key<T> key, T value) Sets the config for a key to the specified value.
<T> void	remove(com.suse.salt.netapi.config.ClientConfig.Key<T> key) Removes the value for the specified key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

URL

public static final com.suse.salt.netapi.config.ClientConfig.Key<URI> URL

TOKEN

public static final com.suse.salt.netapi.config.ClientConfig.Key<String> TOKEN

CONNECT_TIMEOUT

public static final com.suse.salt.netapi.config.ClientConfig.Key<Integer> CONNECT_TIMEOUT

Timeout in milliseconds until a connection is established. A timeout of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). Default value is 10000ms (10s)

SOCKET_TIMEOUT

public static final com.suse.salt.netapi.config.ClientConfig.Key<Integer> SOCKET_TIMEOUT

Timeout in milliseconds for waiting for data. A timeout of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). Default value is 10000ms (10s)

PROXY_HOSTNAME

public static final com.suse.salt.netapi.config.ClientConfig.Key<String> PROXY_HOSTNAME

PROXY_PORT

public static final com.suse.salt.netapi.config.ClientConfig.Key<Integer> PROXY_PORT

PROXY_USERNAME

public static final com.suse.salt.netapi.config.ClientConfig.Key<String> PROXY_USERNAME

PROXY_PASSWORD

public static final com.suse.salt.netapi.config.ClientConfig.Key<String> PROXY_PASSWORD

WEBSOCKET_MAX_MESSAGE_LENGTH

public static final com.suse.salt.netapi.config.ClientConfig.Key<Integer> WEBSOCKET_MAX_MESSAGE_LENGTH

Maximum websocket message length in characters. The default value corresponds to 10 MB, assuming that one character takes up 2 bytes. This limit can be disabled by setting a value less than or equal to 0.

Constructor Detail

ClientConfig

public ClientConfig()

Method Detail

put

public <T> void put(com.suse.salt.netapi.config.ClientConfig.Key<T> key,
                    T value)

Sets the config for a key to the specified value.

Type Parameters:

T - The type of the value associated with the key.

Parameters:

key - The configuration key to set.

value - The value to associate with the key.

remove

public <T> void remove(com.suse.salt.netapi.config.ClientConfig.Key<T> key)

Removes the value for the specified key. This is equivalent to setting the value to the default value of the key.

Type Parameters:

T - The type of the value associated with the key.

Parameters:

key - The configuration key to remove.

get

public <T> T get(com.suse.salt.netapi.config.ClientConfig.Key<T> key)

Returns the configured value for the given key. If the key is not explicitly set. The default value is for that key is returned.

Type Parameters:

T - The type of the value associated with the key.

Parameters:

key - The configuration key.

Returns:

The current configured value for the key or the default value if not configured.