com.att.inno.env

Interface Env

All Known Subinterfaces:

EnvJAXB, EnvJAXBProps, EnvProps, EnvStore<TRANS>, Trans, TransJAXB, TransStore

All Known Implementing Classes:

AbsTrans, AbsTransJAXB, BasicEnv, BasicTrans

public interface Env

Env

Env is the basic representation of what can be obtained from the Environment. Environments also need the ability to Log and Track Time, so to keep the interfaces clean, Env Interface inherits from Trans. This does NOT mean that all Environments are Transactions... It only means Environments need to Log and Track Times. .

Using this abstraction, Components can be built on a modular basis, and still have the essentials of functioning within the service mechanism.

Thus, for instance, an Module could be made to work in two separate service types, with substantial differences in choices of logging, or auditing, and still have reasonably deep insight, such as the exact time a remote service was invoked.

There is a bit of an assumption corresponding to the reality of the 2000s that XML plays a part in most service work.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALWAYS
static int	CHECKPOINT
static int	JSON
static int	REMOTE Basic and Common Audit info...
static int	SUB
static int	XML

Method Summary

Modifier and Type	Method and Description
LogTarget	audit() Required Audit statements
LogTarget	debug() Fine-grained informational events useful for debugging
Decryptor	decryptor() Passwords should be encrypted on the disk.
Encryptor	encryptor()
LogTarget	error() Severe Error, but program might continue running
LogTarget	fatal() Very Severe Error may cause program to abort
String	getProperty(String tag)
String	getProperty(String tag, String deflt)
LogTarget	info() Course Grained highlights of program progress
LogTarget	init() Initialization steps...
String	setProperty(String tag, String value)
TimeTaken	start(String name, int flag) Start a Time Trail with differentiation by flag.
LogTarget	trace() Finest grained Informational events...
LogTarget	warn() Potentially harmful situations

Field Detail

REMOTE

static final int REMOTE

Basic and Common Audit info... Note Apps can define, but should use Integers after 0x1F. They can combine with "&"

See Also:

Constant Field Values

XML

static final int XML

See Also:

Constant Field Values

JSON

static final int JSON

See Also:

Constant Field Values

SUB

static final int SUB

See Also:

Constant Field Values

CHECKPOINT

static final int CHECKPOINT

See Also:

Constant Field Values

ALWAYS

static final int ALWAYS

See Also:

Constant Field Values

Method Detail

fatal

LogTarget fatal()

Very Severe Error may cause program to abort

error

LogTarget error()

Severe Error, but program might continue running

audit

LogTarget audit()

Required Audit statements

Returns:

init

LogTarget init()

Initialization steps... Allows a Logger to separate startup info

Returns:

warn

LogTarget warn()

Potentially harmful situations

Returns:

info

LogTarget info()

Course Grained highlights of program progress

Returns:

debug

LogTarget debug()

Fine-grained informational events useful for debugging

Returns:

trace

LogTarget trace()

Finest grained Informational events... more detailed than Debug

Returns:

start

TimeTaken start(String name,
                int flag)

Start a Time Trail with differentiation by flag. This can be Defined By above flags or combined with app flag definitions

Parameters:

string -

flag -

Returns:

setProperty

String setProperty(String tag,
                   String value)

getProperty

String getProperty(String tag)

getProperty

String getProperty(String tag,
                   String deflt)

decryptor

Decryptor decryptor()

Passwords should be encrypted on the disk. Use this method to apply decryption before using. The Implementation should give ways to decrypt

Parameters:

tag -

Returns:

encryptor

Encryptor encryptor()