com.brambolt.wrench

Class InstanceProperties

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.InstanceProperties

All Implemented Interfaces:

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

public class InstanceProperties
extends Specification

Specifies the properties of an instance of, something. Anything, really.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SECRETS_PROPERTIES_RESOURCE_NAME Default base name for properties file in file system for reading secrets.

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InstanceProperties(java.util.Properties defaults, java.lang.String resourcePath, java.io.File secretsDir, java.lang.String id) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationsKey() Returns the application listing key.
java.lang.String	getEnvironmentsKey() Returns the environment listing key.
static InstanceProperties	getFor(java.lang.String id, java.io.File secretsDir) Primary factory.
static InstanceProperties	getFor(java.lang.String id, java.util.Properties systemProperties, java.io.File secretsDir) Factory.
static InstanceProperties	getFor(java.lang.String id, java.util.Properties systemProperties, java.lang.String instancePropertiesResourcePath, java.io.File secretsDir) Factory.
static InstanceProperties	getFor(java.lang.String systemPropertiesResourcePath, java.lang.String instancePropertiesResourcePath, java.lang.String id, java.io.File secretsDir) Factory.
java.lang.String	getHostsKey() Returns the host listing key.
java.lang.String	getId() The instance identifier, such as some.example.system.
static java.lang.String	getInstancePropertiesResourcePath(java.lang.String id) Looks up the resource path for the instance properties.
java.lang.String	getResourcePath() Returns the resource path to the instance.properties file.
java.lang.String	getRunbooksKey() Returns the runbook listing key.
java.util.Map<java.lang.String,java.lang.Object>	getSystem() Accessor for the system properties.
static java.lang.String	getSystemPropertiesResourcePath(java.lang.String id) Looks up the resource path for the system properties.
java.lang.String	getSystemResourcePath() The system resource path, derived from the system identifier.
static java.lang.String	getSystemResourcePath(java.lang.String id) Converts the id to the system resource path.
java.util.Map<java.lang.String,java.lang.Object>	getTargets() Accessor for the targets.
java.lang.String	getUnitKey(java.lang.String unitType) Returns the key that lists the units with the parameter unit type.

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

SECRETS_PROPERTIES_RESOURCE_NAME

public static final java.lang.String SECRETS_PROPERTIES_RESOURCE_NAME

Default base name for properties file in file system for reading secrets.

See Also:

Constant Field Values

Constructor Detail

InstanceProperties

protected InstanceProperties(java.util.Properties defaults,
                             java.lang.String resourcePath,
                             java.io.File secretsDir,
                             java.lang.String id)

Constructor.

Parameters:

defaults - Property defaults to apply.

resourcePath - The resource path to read the instance properties from.

secretsDir - The directory to look for secrets in.

id - The system identifier to read instance properties for.

Method Detail

getSystemResourcePath

public static java.lang.String getSystemResourcePath(java.lang.String id)

Converts the id to the system resource path.

If the id is some.example.system the system resource path will be some/example/system.

Parameters:

id - The system identifier.

Returns:

The system resource path for the identifier. .

getSystemPropertiesResourcePath

public static java.lang.String getSystemPropertiesResourcePath(java.lang.String id)

Looks up the resource path for the system properties.

Parameters:

id - The system identifier.

Returns:

The system properties resource path.

getInstancePropertiesResourcePath

public static java.lang.String getInstancePropertiesResourcePath(java.lang.String id)

Looks up the resource path for the instance properties.

Parameters:

id - The system identifier.

Returns:

The instance properties resource path.

getFor

public static InstanceProperties getFor(java.lang.String id,
                                        java.io.File secretsDir)

Primary factory. Use this function when possible, not the other #getFor functions.

The resource paths for the application and instance properties will be derived from the id parameter.

The instance identifier coincides with the package that holds the instance properties resource.

Parameters:

id - The instance identifier

secretsDir - The directory to start looking for secrets in

Returns:

A properties instance created with the parameters

See Also:

getFor(String, String, String, File)

getFor

public static InstanceProperties getFor(java.lang.String systemPropertiesResourcePath,
                                        java.lang.String instancePropertiesResourcePath,
                                        java.lang.String id,
                                        java.io.File secretsDir)

Factory. The getFor(String, File) function is preferred.

The instance identifier coincides with the package that holds the instance properties resource.

Parameters:

systemPropertiesResourcePath - The resource path for the system properties resource

instancePropertiesResourcePath - The resource path for the instance properties resource

id - The instance identifier

secretsDir - The directory to start looking for secrets in

Returns:

A properties instance created with the parameters

getFor

public static InstanceProperties getFor(java.lang.String id,
                                        java.util.Properties systemProperties,
                                        java.io.File secretsDir)

Factory. The getFor(String, File) function is preferred.

The identifier must coincide with the package that holds the instance properties resource.

Parameters:

id - The instance identifier.

systemProperties - The system properties.

secretsDir - The directory to start looking for secrets in.

Returns:

A properties instance created with the parameters.

getFor

public static InstanceProperties getFor(java.lang.String id,
                                        java.util.Properties systemProperties,
                                        java.lang.String instancePropertiesResourcePath,
                                        java.io.File secretsDir)

Factory. The getFor(String, File) function is preferred.

Parameters:

id - The instance identifier.

systemProperties - The system properties.

instancePropertiesResourcePath - The instance properties resource path.

secretsDir - The directory to start looking for secrets in.

Returns:

A properties instance created with the parameters.

getResourcePath

public java.lang.String getResourcePath()

Returns the resource path to the instance.properties file.

Returns:

The resource path to instance.properties

getId

public java.lang.String getId()

The instance identifier, such as some.example.system.

All properties for the instance are prefixed with the identifier.

Returns:

The instance identifier

getSystemResourcePath

public java.lang.String getSystemResourcePath()

The system resource path, derived from the system identifier.

If the system identifier is some.example.system then the system resource path is some/example/system.

Returns:

The system resource path

getUnitKey

public java.lang.String getUnitKey(java.lang.String unitType)

Returns the key that lists the units with the parameter unit type.

The unitType must be in singular form, e.g. environment, not environments.

The intended key ends with .listing but if the shorter key without that suffix is available then it will be returned. That form is deprecated and the shorter key should not be used. The behavior is only present for backwards compatibility.

For example, if the parameter unit type is host and the system identifier is some.example.system then the returned key will be some.example.system.hosts if that key is available. If it is not available then the newer form will be returned, some.example.system.hosts.listing. The newer form should always be used.

Parameters:

unitType - The type to get the listing key for

Returns:

The key listing the units of the parameter type

getEnvironmentsKey

public java.lang.String getEnvironmentsKey()

Returns the environment listing key.

Returns:

The environment listing key

getHostsKey

public java.lang.String getHostsKey()

Returns the host listing key.

Returns:

The host listing key

getApplicationsKey

public java.lang.String getApplicationsKey()

Returns the application listing key.

Returns:

The application listing key

getRunbooksKey

public java.lang.String getRunbooksKey()

Returns the runbook listing key.

Returns:

The runbook listing key

getSystem

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

Accessor for the system properties.

Returns:

The system properties for the instance.

getTargets

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

Accessor for the targets.

Returns:

The targets for the instance.