Package org.topbraidlive.client.java

Class ClientConfiguration

java.lang.Object

org.topbraidlive.client.java.ClientConfiguration

public final class ClientConfiguration
extends Object

Immutable client configuration object.

Instances can be created with a constructor or by using the builder pattern (builder()).

Validates on construction rather than in builder setters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_PREFIX	The prefix for configuration keys that come from a global namespace, such as system properties or environment variables.
static ClientConfiguration	LOCALHOST_TEST
static ClientConfiguration	TBC

Constructor Summary

Constructors

Constructor	Description
ClientConfiguration()	Construct a configuration by reading it from the environment.
ClientConfiguration(org.apache.commons.configuration2.Configuration configuration)	Construct a configuration by reading it from a commons-configuration Configuration instance.

Method Summary

Modifier and Type	Method	Description
static ClientConfiguration.Builder	builder()
boolean	equals(Object o)
ClientAuthenticationMethod	getAuthenticationMethod()	Get the authentication method the client should use.
ClientCredentials	getCredentials()	Get the credentials the client should use.
String	getServerBaseUrl()	Get the server base URL.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

KEY_PREFIX

public static final String KEY_PREFIX

The prefix for configuration keys that come from a global namespace, such as system properties or environment variables. With this prefix the property "foo" is specified as "edg.client.foo".

See Also:

Constant Field Values

LOCALHOST_TEST

public static final ClientConfiguration LOCALHOST_TEST

TBC

public static final ClientConfiguration TBC

Constructor Detail

ClientConfiguration

public ClientConfiguration()

Construct a configuration by reading it from the environment.

See Also:

AbstractConfigurationBuilder.setFromEnvironment()

ClientConfiguration

public ClientConfiguration(org.apache.commons.configuration2.Configuration configuration)

Construct a configuration by reading it from a commons-configuration Configuration instance.

See Also:

ClientConfiguration.Builder.setFromConfiguration(Configuration)

Method Detail

builder

public static final ClientConfiguration.Builder builder()

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getAuthenticationMethod

public final ClientAuthenticationMethod getAuthenticationMethod()

Get the authentication method the client should use.

getCredentials

public final ClientCredentials getCredentials()

Get the credentials the client should use.

getServerBaseUrl

public final String getServerBaseUrl()

Get the server base URL. It is guaranteed to be properly formed and end with a / e.g., http://localhost:8080/.

toString

public final String toString()

Overrides:

toString in class Object