com.cinchapi.concourse.config

Class ConcourseClientPreferences

Object

Configuration

PreferencesHandler

ConcourseClientPreferences

public class ConcourseClientPreferences
extends PreferencesHandler

A wrapper around the concourse_client.prefs file that is used to configure a client connection.

Instantiate using open(String)

Field Summary

Fields

Modifier and Type	Field and Description
protected static char[]	NO_PASSWORD_DEFINED An empty char array to return if there is no password defined in the prefs file during a call to getPasswordExplicit().

Method Summary

Modifier and Type	Method and Description
static ConcourseClientPreferences	from(Path... files) Return a ConcourseClientPreferences handler that is sourced from the files.
static ConcourseClientPreferences	fromCurrentWorkingDirectory() Return a ConcourseClientPreferences handler that is sourced from a concourse_client.prefs file in the current working directory.
static ConcourseClientPreferences	fromUserHomeDirectory() Return a ConcourseClientPreferences handler that is sourced from a concourse_client.prefs file in the user's home directory.
String	getEnvironment() Return the value associated with the environment key.
String	getHost() Return the value associated with the host key.
char[]	getPassword() Return the value associated with the password key.
char[]	getPasswordExplicit() Return the value associated with the password key, if it is explicitly defined in the prefs file.
int	getPort() Return the value associated with the port key.
String	getUsername() Return the value associated with the username key.
static ConcourseClientPreferences	open(String file) Deprecated. use ConcourseServerPreferences.from(Path...) instead
void	setEnvironment(String environment) Set the value associated with the environment key.
void	setHost(String host) Set the value associated with the host key.
void	setPassword(char[] password) Set the value associated with the password key.
void	setPort(int port) Set the value associated with the port key.
void	setUsername(String username) Set the value associated with the username key.

Methods inherited from class PreferencesHandler

getEnum, getSize

Methods inherited from class Configuration

get, get, getOrDefault, getOrDefault, override, set

Methods inherited from class Object

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

Field Detail

NO_PASSWORD_DEFINED

protected static final char[] NO_PASSWORD_DEFINED

An empty char array to return if there is no password defined in the prefs file during a call to getPasswordExplicit().

Method Detail

from

public static ConcourseClientPreferences from(Path... files)

Return a ConcourseClientPreferences handler that is sourced from the files.

Parameters:

files -

Returns:

the handler

fromCurrentWorkingDirectory

public static ConcourseClientPreferences fromCurrentWorkingDirectory()

Return a ConcourseClientPreferences handler that is sourced from a concourse_client.prefs file in the current working directory.

Returns:

the handler

fromUserHomeDirectory

public static ConcourseClientPreferences fromUserHomeDirectory()

Return a ConcourseClientPreferences handler that is sourced from a concourse_client.prefs file in the user's home directory.

Returns:

the handler

open

@Deprecated
public static ConcourseClientPreferences open(String file)

Deprecated. use ConcourseServerPreferences.from(Path...) instead

Return a ConcourseClientPreferences wrapper that is backed by the configuration information in file.

Parameters:

file - the absolute path to the preferences file (relative paths will resolve to the user's home directory)

Returns:

the preferences

getEnvironment

public String getEnvironment()

Return the value associated with the environment key.

Returns:

the environment

getHost

public String getHost()

Return the value associated with the host key.

Returns:

the host

getPassword

public char[] getPassword()

Return the value associated with the password key.

NOTE: This method returns the password as a char array so that the caller can null out the data immediately after use. This is generally advised to limit the amount of time that the sensitive data remains in memory.

Returns:

the password

getPasswordExplicit

public char[] getPasswordExplicit()

Return the value associated with the password key, if it is explicitly defined in the prefs file. Unlike the getPassword() method, this one will not return the default password if one is not explicitly defined in the file.

NOTE: This method returns the password as a char array so that the caller can null out the data immediately after use. This is generally advised to limit the amount of time that the sensitive data remains in memory.

Returns:

the password or an empty character array if it is not defined

getPort

public int getPort()

Return the value associated with the port key.

Returns:

the port

getUsername

public String getUsername()

Return the value associated with the username key.

Returns:

the username

setEnvironment

public void setEnvironment(String environment)

Set the value associated with the environment key.

Parameters:

environment -

setHost

public void setHost(String host)

Set the value associated with the host key.

Parameters:

host -

setPassword

public void setPassword(char[] password)

Set the value associated with the password key.

Parameters:

password -

setPort

public void setPort(int port)

Set the value associated with the port key.

Parameters:

port -

setUsername

public void setUsername(String username)

Set the value associated with the username key.

Parameters:

username -