org.wattdepot.client

Class ClientProperties

java.lang.Object

org.wattdepot.client.ClientProperties

public class ClientProperties
extends Object

ClientProperties - Provides access to the values stored in the wattdepot-client.properties file.

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_HOME_DIR The full path to the client's home directory.
static String	LOGGING_LEVEL_KEY The logging level key.
static String	PORT_KEY The wattdepot server port key.
static String	TEST_PORT_KEY The wattdepot server port key during testing.
static String	USER_NAME Name of property used to store the username.
static String	USER_PASSWORD Name of property used to store the password.
static String	WATTDEPOT_SERVER_HOST The wattdepot server host.

Constructor Summary

Constructors

Constructor and Description
ClientProperties() Creates a new ClientProperties instance using the default filename.
ClientProperties(String clientSubdir) Creates a new ClientProperties instance loaded from the given directory name.

Method Summary

Methods

Modifier and Type	Method and Description
String	echoProperties() Returns a string containing all current properties in alphabetical order.
String	get(String key) Returns the value of the Server Property specified by the key.
void	setTestProperties() Sets the properties to their "test" equivalents and updates the system properties.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_HOME_DIR

public static final String CLIENT_HOME_DIR

The full path to the client's home directory.

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

Name of property used to store the username.

See Also:

Constant Field Values

USER_PASSWORD

public static final String USER_PASSWORD

Name of property used to store the password.

See Also:

Constant Field Values

WATTDEPOT_SERVER_HOST

public static final String WATTDEPOT_SERVER_HOST

The wattdepot server host.

See Also:

Constant Field Values

PORT_KEY

public static final String PORT_KEY

The wattdepot server port key.

See Also:

Constant Field Values

TEST_PORT_KEY

public static final String TEST_PORT_KEY

The wattdepot server port key during testing.

See Also:

Constant Field Values

LOGGING_LEVEL_KEY

public static final String LOGGING_LEVEL_KEY

The logging level key.

See Also:

Constant Field Values

Constructor Detail

ClientProperties

public ClientProperties()

Creates a new ClientProperties instance using the default filename. Prints an error to the console if problems occur on loading.

ClientProperties

public ClientProperties(String clientSubdir)

Creates a new ClientProperties instance loaded from the given directory name. Prints an error to the console if problems occur on loading.

Parameters:

clientSubdir - The name of the subdirectory used to store all files for the client.

Method Detail

echoProperties

public String echoProperties()

Returns a string containing all current properties in alphabetical order. Properties with the word "password" in their key list "((hidden))" rather than their actual value for security reasons. This is not super sophisticated - other properties such as database URLs might benefit from being hidden too - but it should work for now.

Returns:

A string with the properties.

get

public String get(String key)

Returns the value of the Server Property specified by the key.

Parameters:

key - Should be one of the public static final strings in this class.

Returns:

The value of the key, or null if not found.

setTestProperties

public void setTestProperties()

Sets the properties to their "test" equivalents and updates the system properties.