com.cinchapi.concourse.config

Class ConcourseClientConfiguration

Object

Configuration

PreferencesHandler

ConcourseClientPreferences

ConcourseClientConfiguration

public class ConcourseClientConfiguration
extends ConcourseClientPreferences

A wrapper around the configuration files that can be used to configure a client connection.

Instantiate using from(Path...)

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 ConcourseClientConfiguration	from(Path... files) Return a ConcourseClientConfiguration handler that is sourced from the files.
static ConcourseClientConfiguration	fromCurrentWorkingDirectory() Return a ConcourseClientConfiguration handler that is sourced from Concourse client configuration files in the current working directory.
static ConcourseClientConfiguration	fromUserHomeDirectory() Return a ConcourseClientConfiguration handler that is sourced from Concourse client configuration files 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.
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 ConcourseClientPreferences

open

Methods inherited from class PreferencesHandler

getEnum, getSize

Methods inherited from class Configuration

contains, containsIgnoreCaseFormat, get, get, getIgnoreCaseFormat, getIgnoreCaseFormat, getIgnoreCaseFormatOrDefault, getIgnoreCaseFormatOrDefault, 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 ConcourseClientConfiguration from(Path... files)

Return a ConcourseClientConfiguration handler that is sourced from the files.

Parameters:

files -

Returns:

the handler

fromCurrentWorkingDirectory

public static ConcourseClientConfiguration fromCurrentWorkingDirectory()

Return a ConcourseClientConfiguration handler that is sourced from Concourse client configuration files in the current working directory.

Returns:

the handler

fromUserHomeDirectory

public static ConcourseClientConfiguration fromUserHomeDirectory()

Return a ConcourseClientConfiguration handler that is sourced from Concourse client configuration files in the user's home directory.

Returns:

the handler

getEnvironment

public String getEnvironment()

Return the value associated with the environment key.

Specified by:

getEnvironment in class ConcourseClientPreferences

Returns:

the environment

getHost

public String getHost()

Return the value associated with the host key.

Specified by:

getHost in class ConcourseClientPreferences

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.

Specified by:

getPassword in class ConcourseClientPreferences

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.

Specified by:

getPasswordExplicit in class ConcourseClientPreferences

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.

Specified by:

getPort in class ConcourseClientPreferences

Returns:

the port

getUsername

public String getUsername()

Return the value associated with the username key.

Specified by:

getUsername in class ConcourseClientPreferences

Returns:

the username

setEnvironment

public void setEnvironment(String environment)

Set the value associated with the environment key.

Specified by:

setEnvironment in class ConcourseClientPreferences

Parameters:

environment -

setHost

public void setHost(String host)

Set the value associated with the host key.

Specified by:

setHost in class ConcourseClientPreferences

Parameters:

host -

setPassword

public void setPassword(char[] password)

Set the value associated with the password key.

Specified by:

setPassword in class ConcourseClientPreferences

Parameters:

password -

setPort

public void setPort(int port)

Set the value associated with the port key.

Specified by:

setPort in class ConcourseClientPreferences

Parameters:

port -

setUsername

public void setUsername(String username)

Set the value associated with the username key.

Specified by:

setUsername in class ConcourseClientPreferences

Parameters:

username -