com.att.inno.env

Interface EnvProps

All Superinterfaces:

Env

All Known Subinterfaces:

EnvJAXBProps

public interface EnvProps
extends Env

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EnvProps.EnvProperty

Field Summary

Fields inherited from interface com.att.inno.env.Env

ALWAYS, CHECKPOINT, JSON, REMOTE, SUB, XML

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getProperties() Get all of the properties in the Environment
String	getProperty(String key) Obtain a Property (String) based on a Key.
String	getProperty(String tag, String defaultValue) Obtain a Property (String) based on a Key.
Map<String,String>	getSubProperties(String key, boolean includePrefix) Get the SubProperties based on key.
String	setProperty(String key, String value) Set a Property (String) based on a Key accessible to all in Env.

Methods inherited from interface com.att.inno.env.Env

audit, debug, decryptor, encryptor, error, fatal, info, init, start, trace, warn

Method Detail

getProperty

String getProperty(String key)

Obtain a Property (String) based on a Key. Implementor decides how that works, i.e. from a complex set of Configurations, or just "System" (Java standard)

Specified by:

getProperty in interface Env

Parameters:

key -

Returns:

APIException

getProperty

String getProperty(String tag,
                   String defaultValue)

Obtain a Property (String) based on a Key. Implementor decides how that works, i.e. from a complex set of Configurations, or just "System" (Java standard) If Property Value is null, then default will be used.

Specified by:

getProperty in interface Env

Parameters:

key -

Returns:

APIException

setProperty

String setProperty(String key,
                   String value)

Set a Property (String) based on a Key accessible to all in Env. Implementor decides how that works, i.e. from a complex set of Configurations, or just "System" (Java standard)

Specified by:

setProperty in interface Env

Parameters:

key -

Returns:

APIException

getSubProperties

Map<String,String> getSubProperties(String key,
                                    boolean includePrefix)

Get the SubProperties based on key. use "false" to remove prefix, "true" to leave prefix in.

Parameters:

key -

Returns:

APIException Given a known property set (or in this case, properties starting with key), return map of all properties with appropriate key names

getProperties

Map<String,String> getProperties()

Get all of the properties in the Environment

Returns: