com.brambolt.wrench

Class ApplicationProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

com.brambolt.Specification

com.brambolt.wrench.ApplicationProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class ApplicationProperties
extends Specification

Encapsulates properties for a single application.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.Object>	application The encapsulated name-value pairs.
java.lang.String	applicationId The application identifier string.
InstanceProperties	instanceProperties The properties for the system instance the application is part of.

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApplicationProperties(InstanceProperties instanceProperties, java.lang.String applicationId) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ApplicationProperties	getFor(java.lang.String systemId, java.lang.String applicationId, java.io.File secretsDir) Primary factory method.
java.util.Map<java.lang.String,java.lang.Object>	getRelativeMap(java.lang.String suffix) Looks up a property value given a property name suffix.
java.lang.Object	getRelativeProperty(java.lang.String suffix) Looks up a property value given a property name suffix.
java.lang.String	getRelativeString(java.lang.String suffix) Looks up a string property value given a property name suffix.
<T> T	instantiate(java.lang.String relativeName, java.lang.Class<?>[] parameterTypes, java.lang.Object[] parameters, java.lang.String description) Instantiates the class identified by the relative property.
<T> T	instantiate(java.lang.String relativeName, java.lang.String description) Instantiates the class identified by the relative property.
<T> T	invokeFactory(java.lang.String relativeFactory, java.lang.Class<?>[] parameterTypes, java.lang.Object[] parameters, java.lang.String description) Instantiates an object using the factory method defined as the value of the application property passed as the relativeFactory.

Methods inherited from class com.brambolt.Specification

containsKey, convertToMap, convertToMap, get, getBoolean, getBoolean, getInteger, getInteger, getKeys, getString, getString, isEmpty, isFalse, isTrue, loadProperties, loadProperties, loadPropertiesFromFile, loadPropertiesFromFile, loadPropertiesFromList, loadPropertiesFromResource, parseListing

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsValue, elements, entrySet, equals, forEach, getOrDefault, hashCode, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

instanceProperties

public final InstanceProperties instanceProperties

The properties for the system instance the application is part of.

applicationId

public final java.lang.String applicationId

The application identifier string.

application

public final java.util.Map<java.lang.String,java.lang.Object> application

The encapsulated name-value pairs.

Constructor Detail

ApplicationProperties

@Deprecated
protected ApplicationProperties(InstanceProperties instanceProperties,
                                            java.lang.String applicationId)

Deprecated.

Constructor.

Parameters:

instanceProperties - The related instance properties.

applicationId - The application identifier.

Method Detail

getFor

public static ApplicationProperties getFor(java.lang.String systemId,
                                           java.lang.String applicationId,
                                           java.io.File secretsDir)

Primary factory method.

Parameters:

systemId - The package that holds the instance properties resource

applicationId - The application identifier

secretsDir - The directory to start looking for secrets in

Returns:

An application properties instance created with the parameters

getRelativeProperty

public java.lang.Object getRelativeProperty(java.lang.String suffix)

Looks up a property value given a property name suffix.

Parameters:

suffix - The suffix appended to the application properties base.

Returns:

The value for the property, if available.

getRelativeMap

public java.util.Map<java.lang.String,java.lang.Object> getRelativeMap(java.lang.String suffix)

Looks up a property value given a property name suffix.

Parameters:

suffix - The suffix appended to the application properties base.

Returns:

The value for the property, if available.

getRelativeString

public java.lang.String getRelativeString(java.lang.String suffix)

Looks up a string property value given a property name suffix.

Parameters:

suffix - The suffix appended to the application properties base.

Returns:

The string value for the property, if available.

instantiate

public <T> T instantiate(java.lang.String relativeName,
                         java.lang.String description)

Instantiates the class identified by the relative property.

Type Parameters:

T - The type to instantiate.

Parameters:

relativeName - The suffix appended to the application properties base.

description - A prefix included in the exception message in case of failure.

Returns:

The value for the property, if available.

Throws:

java.lang.IllegalStateException - If unable to determine the class name.

instantiate

public <T> T instantiate(java.lang.String relativeName,
                         java.lang.Class<?>[] parameterTypes,
                         java.lang.Object[] parameters,
                         java.lang.String description)

Instantiates the class identified by the relative property.

Type Parameters:

T - The type to instantiate.

Parameters:

relativeName - The suffix appended to the application properties base.

parameterTypes - The constructor parameter type array.

parameters - The constructor parameters to pass.

description - A prefix included in the exception message in case of failure.

Returns:

The value for the property, if available.

Throws:

java.lang.IllegalStateException - If unable to determine the class name.

invokeFactory

public <T> T invokeFactory(java.lang.String relativeFactory,
                           java.lang.Class<?>[] parameterTypes,
                           java.lang.Object[] parameters,
                           java.lang.String description)

Instantiates an object using the factory method defined as the value of the application property passed as the relativeFactory.

Type Parameters:

T - The factory method return type

Parameters:

relativeFactory - The application property that defines the factory

parameterTypes - The parameter types for the factory method

parameters - The parameter objects for the factory method

description - The exception message prefix

Returns:

The return value of the factory method