com.cinchapi.concourse.config

Class ConcourseClientPreferences

Object

Configuration

PreferencesHandler

ConcourseClientPreferences

Direct Known Subclasses:

ConcourseClientConfiguration

Deprecated.

Use ConcourseClientConfiguration instead

@Deprecated
public abstract class ConcourseClientPreferences
extends PreferencesHandler

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

Instantiate using open(String)

Method Summary

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

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

Method Detail

from

public static ConcourseClientPreferences from(Path... files)

Deprecated.

Return a ConcourseClientPreferences handler that is sourced from the files.

Parameters:

files -

Returns:

the handler

fromCurrentWorkingDirectory

public static ConcourseClientPreferences fromCurrentWorkingDirectory()

Deprecated.

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()

Deprecated.

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 abstract String getEnvironment()

Deprecated.

Return the value associated with the environment key.

Returns:

the environment

getHost

public abstract String getHost()

Deprecated.

Return the value associated with the host key.

Returns:

the host

getPassword

public abstract char[] getPassword()

Deprecated.

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 abstract char[] getPasswordExplicit()

Deprecated.

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 abstract int getPort()

Deprecated.

Return the value associated with the port key.

Returns:

the port

getUsername

public abstract String getUsername()

Deprecated.

Return the value associated with the username key.

Returns:

the username

setEnvironment

public abstract void setEnvironment(String environment)

Deprecated.

Set the value associated with the environment key.

Parameters:

environment -

setHost

public abstract void setHost(String host)

Deprecated.

Set the value associated with the host key.

Parameters:

host -

setPassword

public abstract void setPassword(char[] password)

Deprecated.

Set the value associated with the password key.

Parameters:

password -

setPort

public abstract void setPort(int port)

Deprecated.

Set the value associated with the port key.

Parameters:

port -

setUsername

public abstract void setUsername(String username)

Deprecated.

Set the value associated with the username key.

Parameters:

username -