edu.emory.cci.aiw.cvrg.eureka.common.props

Class AbstractProperties

java.lang.Object

edu.emory.cci.aiw.cvrg.eureka.common.props.AbstractProperties

public abstract class AbstractProperties
extends Object

Author:

hrathod

Constructor Summary

Constructors

Constructor and Description
AbstractProperties() Loads the application configuration.

Method Summary

Modifier and Type	Method and Description
String	getApplicationUrl() Get the base URL for the application front-end for external users.
String	getBuildNumber()
String	getCasLoginUrl()
String	getCasLogoutUrl()
String	getCasUrl()
String	getConfigDir()
List<String>	getDefaultSystemPropositions() Gets the default list of system propositions for the application.
String	getIncrementalVersion()
protected int	getIntValue(String propertyName, int defaultValue) Utility method to get an int from the properties file.
String	getMajorVersion()
String	getMinorVersion()
abstract String	getProxyCallbackServer()
String	getQualifier()
String	getStage()
protected List<String>	getStringListValue(String inPropertyName) Reads in a property value as a whitespace-delimited list of items.
protected List<String>	getStringListValue(String inPropertyName, List<String> defaultValue) Reads in a property value as a whitespace-delimited list of items.
SupportUri	getSupportUri() Get the support email address for the application.
protected String	getValue(String propertyName) Returns the String value of the given property name.
protected String	getValue(String propertyName, String defaultValue) Returns the String value of the given property name, or the given default if the given property name does not exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProperties

public AbstractProperties()

Loads the application configuration. There are two potential sources of application configuration. The fallback configuration should always be there. The default configuration directory, /etc/eureka, may optionally have an application.properties file within it that overrides the fallback configuration for each configuration property that is specified. The eureka.config.dir system property allows specifying an alternative configuration directory.

Method Detail

getConfigDir

public String getConfigDir()

getApplicationUrl

public String getApplicationUrl()

Get the base URL for the application front-end for external users. Always ends with a slash ("/").

Returns:

The base URL.

getProxyCallbackServer

public abstract String getProxyCallbackServer()

getCasUrl

public String getCasUrl()

getCasLoginUrl

public String getCasLoginUrl()

getCasLogoutUrl

public String getCasLogoutUrl()

getMajorVersion

public String getMajorVersion()

getMinorVersion

public String getMinorVersion()

getIncrementalVersion

public String getIncrementalVersion()

getQualifier

public String getQualifier()

getBuildNumber

public String getBuildNumber()

getStage

public String getStage()

getSupportUri

public SupportUri getSupportUri()

Get the support email address for the application.

Returns:

The support email address.

getValue

protected String getValue(String propertyName)

Returns the String value of the given property name.

Parameters:

propertyName - The property name to fetch the value for.

Returns:

A String containing the value of the given property name, or null if the property name does not exist.

getValue

protected String getValue(String propertyName,
                          String defaultValue)

Returns the String value of the given property name, or the given default if the given property name does not exist.

Parameters:

propertyName - The name of the property to fetch a value for.

defaultValue - The default value to return if the property name does not exist.

Returns:

A string containing either the value of the property, or the default value.

getStringListValue

protected List<String> getStringListValue(String inPropertyName)

Reads in a property value as a whitespace-delimited list of items.

Parameters:

inPropertyName - The name of the property to read.

Returns:

A list containing the items in the value, or null if the property is not found.

getStringListValue

protected List<String> getStringListValue(String inPropertyName,
                                          List<String> defaultValue)

Reads in a property value as a whitespace-delimited list of items.

Parameters:

inPropertyName - The name of the property to read.

defaultValue - The value to return if the property is not found.

Returns:

A list containing the items in the value.

getIntValue

protected int getIntValue(String propertyName,
                          int defaultValue)

Utility method to get an int from the properties file.

Parameters:

propertyName - The name of the property.

defaultValue - The default value to return, if the property is not found, or is malformed.

Returns:

The property value, as an int.

getDefaultSystemPropositions

public List<String> getDefaultSystemPropositions()

Gets the default list of system propositions for the application.

Returns:

The default list of system propositions.