ServerProperties (WattDepot 3.1.0 API)

java.lang.Object
- org.wattdepot.server.ServerProperties

```
public class ServerProperties
extends Object
```
ServerProperties - Provides access to the values stored in the wattdepot-server.properties file.

Author:

Cam Moore

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_USER_NAME` Name of property used to store the admin username.
`static String`	`ADMIN_USER_NAME_ENV` The environment variable for storing the admin's name.
`static String`	`ADMIN_USER_PASSWORD` Name of property used to store the admin password.
`static String`	`ADMIN_USER_PASSWORD_ENV` The environment variable for storing the admin's password.
`static String`	`CHECK_SESSIONS` Check the Session opens vs close.
`static String`	`CONTEXT_ROOT_KEY` The context root key.
`static String`	`DATABASE_URL` The database url.
`static String`	`DB_CONNECTION_DRIVER` The database connection driver class.
`static String`	`DB_CONNECTION_URL` The database connection driver url.
`static String`	`DB_CONNECTION_URL_ENV` The database connection driver url environment variable.
`static String`	`DB_PASSWORD` The database password.
`static String`	`DB_SHOW_SQL` The database show sql.
`static String`	`DB_TABLE_UPDATE` The database drop&create tables.
`static String`	`DB_USER_NAME` The database username.
`static String`	`ENABLE_LOGGING_KEY` Enable logging in the server.
`static String`	`FALSE` String for false.
`static String`	`HEROKU_DATABASE_URL_KEY` The heroku database URL.
`static String`	`HEROKU_HOSTNAME_KEY` The hostname for Heroku.
`static String`	`HOSTNAME_KEY` The hostname key.
`static String`	`LOGGING_LEVEL_KEY` The logging level key.
`static String`	`PORT_KEY` The wattdepot server port key.
`static String`	`SERVER_HOME_DIR` The full path to the server's home directory.
`static String`	`SERVER_TIMING_KEY` Enable timing of Server operations.
`static String`	`SSL` The option to enable SSL.
`static String`	`SSL_KEYSTORE_KEY_PASSWORD` The password for the key.
`static String`	`SSL_KEYSTORE_PASSWORD` The password for the keystore.
`static String`	`SSL_KEYSTORE_PATH` The path to the keystore holding the certificate.
`static String`	`SSL_KEYSTORE_TYPE` The type of keystore.
`static String`	`TEST_HEROKU_KEY` Heroku test key.
`static String`	`TEST_PORT_KEY` The wattdepot server port key during testing.
`static String`	`TEST_WATT_DEPOT_IMPL_KEY` The WattDepot implementation class during testing.
`static String`	`TRUE` String for true.
`static String`	`USE_HEROKU_KEY` Heroku key.
`static String`	`WATT_DEPOT_IMPL_KEY` The WattDepot implementation class.
`static String`	`WATTDEPOT_EXTENSION` String for the beginning of the WattDepotServer extension definitions.
`static String`	`WATTDEPOT_EXTENSIONS` Property key that holds all the WattDepotServer extensions defined in the properties file.
`static String`	`WATTDEPOT_SALT_ENV` The environment variable name that holds the salt used for encrypting passwords in WattDepot.

Constructor Summary

Constructors
Constructor and Description
`ServerProperties()` Creates a new ServerProperties instance using the default filename.
`ServerProperties(String serverSubdir)` Creates a new ServerProperties instance loaded from the given filename.

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.
`String`	`getFullHost()` Returns the fully qualified host name, such as "http://localhost:9876/wattdepot/".
`Object`	`getPropertyInstance(Object key)` Returns the instance.
`void`	`set(String key, String value)` Sets the given property.
`void`	`setTestProperties()` Sets the properties to their "test" equivalents and updates the system properties.
`void`	`trimProperties()` Ensures that the there is no leading or trailing whitespace in the property values.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVER_HOME_DIR
```
public static final String SERVER_HOME_DIR
```
    The full path to the server's home directory.
    
    See Also:
    Constant Field Values
  - HOSTNAME_KEY
```
public static final String HOSTNAME_KEY
```
    The hostname key.
    
    See Also:
    Constant Field Values
  - ADMIN_USER_NAME
```
public static final String ADMIN_USER_NAME
```
    Name of property used to store the admin username.
    
    See Also:
    Constant Field Values
  - ADMIN_USER_NAME_ENV
```
public static final String ADMIN_USER_NAME_ENV
```
    The environment variable for storing the admin's name.
    
    See Also:
    Constant Field Values
  - ADMIN_USER_PASSWORD
```
public static final String ADMIN_USER_PASSWORD
```
    Name of property used to store the admin password.
    
    See Also:
    Constant Field Values
  - ADMIN_USER_PASSWORD_ENV
```
public static final String ADMIN_USER_PASSWORD_ENV
```
    The environment variable for storing the admin's password.
    
    See Also:
    Constant Field Values
  - WATTDEPOT_SALT_ENV
```
public static final String WATTDEPOT_SALT_ENV
```
    The environment variable name that holds the salt used for encrypting passwords in WattDepot.
    
    See Also:
    Constant Field Values
  - WATT_DEPOT_IMPL_KEY
```
public static final String WATT_DEPOT_IMPL_KEY
```
    The WattDepot implementation class.
    
    See Also:
    Constant Field Values
  - PORT_KEY
```
public static final String PORT_KEY
```
    The wattdepot server port key.
    
    See Also:
    Constant Field Values
  - CONTEXT_ROOT_KEY
```
public static final String CONTEXT_ROOT_KEY
```
    The context root key.
    
    See Also:
    Constant Field Values
  - SSL
```
public static final String SSL
```
    The option to enable SSL.
    
    See Also:
    Constant Field Values
  - SSL_KEYSTORE_PATH
```
public static final String SSL_KEYSTORE_PATH
```
    The path to the keystore holding the certificate.
    
    See Also:
    Constant Field Values
  - SSL_KEYSTORE_PASSWORD
```
public static final String SSL_KEYSTORE_PASSWORD
```
    The password for the keystore.
    
    See Also:
    Constant Field Values
  - SSL_KEYSTORE_KEY_PASSWORD
```
public static final String SSL_KEYSTORE_KEY_PASSWORD
```
    The password for the key.
    
    See Also:
    Constant Field Values
  - SSL_KEYSTORE_TYPE
```
public static final String SSL_KEYSTORE_TYPE
```
    The type of keystore.
    
    See Also:
    Constant Field Values
  - DB_CONNECTION_DRIVER
```
public static final String DB_CONNECTION_DRIVER
```
    The database connection driver class.
    
    See Also:
    Constant Field Values
  - DB_CONNECTION_URL
```
public static final String DB_CONNECTION_URL
```
    The database connection driver url.
    
    See Also:
    Constant Field Values
  - DB_CONNECTION_URL_ENV
```
public static final String DB_CONNECTION_URL_ENV
```
    The database connection driver url environment variable.
    
    See Also:
    Constant Field Values
  - DATABASE_URL
```
public static final String DATABASE_URL
```
    The database url.
    
    See Also:
    Constant Field Values
  - DB_USER_NAME
```
public static final String DB_USER_NAME
```
    The database username.
    
    See Also:
    Constant Field Values
  - DB_PASSWORD
```
public static final String DB_PASSWORD
```
    The database password.
    
    See Also:
    Constant Field Values
  - DB_SHOW_SQL
```
public static final String DB_SHOW_SQL
```
    The database show sql.
    
    See Also:
    Constant Field Values
  - DB_TABLE_UPDATE
```
public static final String DB_TABLE_UPDATE
```
    The database drop&create tables. valid values are 'validate' | 'update' | 'create' | 'create-drop'.
    
    See Also:
    Constant Field Values
  - ENABLE_LOGGING_KEY
```
public static final String ENABLE_LOGGING_KEY
```
    Enable logging in the server. Logging may hide some stacktraces. Should be True for production.
    
    See Also:
    Constant Field Values
  - CHECK_SESSIONS
```
public static final String CHECK_SESSIONS
```
    Check the Session opens vs close.
    
    See Also:
    Constant Field Values
  - LOGGING_LEVEL_KEY
```
public static final String LOGGING_LEVEL_KEY
```
    The logging level key.
    
    See Also:
    Constant Field Values
  - SERVER_TIMING_KEY
```
public static final String SERVER_TIMING_KEY
```
    Enable timing of Server operations.
    
    See Also:
    Constant Field Values
  - TEST_WATT_DEPOT_IMPL_KEY
```
public static final String TEST_WATT_DEPOT_IMPL_KEY
```
    The WattDepot implementation class during testing.
    
    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
  - USE_HEROKU_KEY
```
public static final String USE_HEROKU_KEY
```
    Heroku key.
    
    See Also:
    Constant Field Values
  - TEST_HEROKU_KEY
```
public static final String TEST_HEROKU_KEY
```
    Heroku test key.
    
    See Also:
    Constant Field Values
  - HEROKU_HOSTNAME_KEY
```
public static final String HEROKU_HOSTNAME_KEY
```
    The hostname for Heroku.
    
    See Also:
    Constant Field Values
  - HEROKU_DATABASE_URL_KEY
```
public static final String HEROKU_DATABASE_URL_KEY
```
    The heroku database URL.
    
    See Also:
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    String for false.
    
    See Also:
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    String for true.
    
    See Also:
    Constant Field Values
  - WATTDEPOT_EXTENSION
```
public static final String WATTDEPOT_EXTENSION
```
    String for the beginning of the WattDepotServer extension definitions.
    
    See Also:
    Constant Field Values
  - WATTDEPOT_EXTENSIONS
```
public static final String WATTDEPOT_EXTENSIONS
```
    Property key that holds all the WattDepotServer extensions defined in the properties file.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ServerProperties
```
public ServerProperties()
                 throws Exception
```
    Creates a new ServerProperties instance using the default filename. Prints an error to the console if problems occur on loading.
    
    Throws:
    
    Exception - if errors occur.
  - ServerProperties
```
public ServerProperties(String serverSubdir)
                 throws Exception
```
    Creates a new ServerProperties instance loaded from the given filename. Prints an error to the console if problems occur on loading.
    
    Parameters:
    serverSubdir - The name of the subdirectory used to store all files for this server.
    
    Throws:
    
    Exception - if errors occur.
- Method Detail
  - setTestProperties
```
public void setTestProperties()
```
    Sets the properties to their "test" equivalents and updates the system properties.
  - 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.
  - getPropertyInstance
```
public Object getPropertyInstance(Object key)
```
    Returns the instance.
    
    Parameters:
    key - The key.
    
    Returns:
    The Object associated with the key.
  - set
```
public void set(String key,
       String value)
```
    Sets the given property.
    
    Parameters:
    key - the key.
    value - the value
  - trimProperties
```
public void trimProperties()
```
    Ensures that the there is no leading or trailing whitespace in the property values. The fact that we need to do this indicates a bug in Java's Properties implementation to me.
  - getFullHost
```
public String getFullHost()
```
    Returns the fully qualified host name, such as "http://localhost:9876/wattdepot/". Note, the String will end with "/", so there is no need to append another if you are constructing a URI.
    
    Returns:
    The fully qualified host name.

Class ServerProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVER_HOME_DIR

HOSTNAME_KEY

ADMIN_USER_NAME

ADMIN_USER_NAME_ENV

ADMIN_USER_PASSWORD

ADMIN_USER_PASSWORD_ENV

WATTDEPOT_SALT_ENV

WATT_DEPOT_IMPL_KEY

PORT_KEY

CONTEXT_ROOT_KEY

SSL

SSL_KEYSTORE_PATH

SSL_KEYSTORE_PASSWORD

SSL_KEYSTORE_KEY_PASSWORD

SSL_KEYSTORE_TYPE

DB_CONNECTION_DRIVER

DB_CONNECTION_URL

DB_CONNECTION_URL_ENV

DATABASE_URL

DB_USER_NAME

DB_PASSWORD

DB_SHOW_SQL

DB_TABLE_UPDATE

ENABLE_LOGGING_KEY

CHECK_SESSIONS

LOGGING_LEVEL_KEY

SERVER_TIMING_KEY

TEST_WATT_DEPOT_IMPL_KEY

TEST_PORT_KEY

USE_HEROKU_KEY

TEST_HEROKU_KEY

HEROKU_HOSTNAME_KEY

HEROKU_DATABASE_URL_KEY

FALSE

TRUE

WATTDEPOT_EXTENSION

WATTDEPOT_EXTENSIONS

Constructor Detail

ServerProperties

ServerProperties

Method Detail

setTestProperties

echoProperties

get

getPropertyInstance

set

trimProperties

getFullHost