com.att.inno.env

Interface LifeCycle

All Known Subinterfaces:

IOObjectifier<T>, IOObjectifier<T>, IOStringifier<T>, IOStringifier<T>, Objectifier<T>, Objectifier<T>, Stringifier<T>, Stringifier<T>

All Known Implementing Classes:

JAXBDF, JAXBObjectifier, JAXBStringifier, NullLifeCycle

public interface LifeCycle

Method Summary

Modifier and Type	Method and Description
void	refresh(Env env) The Service will call this when (service-defined) configurations change.
void	serviceDestroy(Env env) Parallel to servicePrestart, serviceDestroy tells the implementor that the service is ending, and to take this opportunity to close out any content under it's control that can or should be closed explicitly.
void	servicePrestart(Env env) The Service using LifeCycle Elements is required to call this method at the appropriate startup time.
void	threadDestroy(Env env) Parallel to threadPrestart, threadDestroy tells the implementor that the service is ending this particular thread, and to take this opportunity to close out any content specific to this thread that can be closed.
void	threadPrestart(Env env) Many cases of implementations are not thread safe, and mechanisms must be derived to accomodate them by holding per Thread.

Method Detail

servicePrestart

void servicePrestart(Env env)
              throws APIException

The Service using LifeCycle Elements is required to call this method at the appropriate startup time. This is better for services than a simple static call, because the exact moment of starting can be determined programatically.

An excellent use is to establish security credentials with a backend after appropriate configurations have been read and available as part of the Env Object.

Parameters:

env -

Throws:

APIException

threadPrestart

void threadPrestart(Env env)
             throws APIException

Many cases of implementations are not thread safe, and mechanisms must be derived to accomodate them by holding per Thread.

ThreadLocal is a valuable resource, but start up times within the thread, depending on what it is, can be substantial.

Use ThreadPrestart to do all that is possible before actually performing work, i.e. inside of a client transaction.

Parameters:

env -

Throws:

APIException

refresh

void refresh(Env env)
      throws APIException

The Service will call this when (service-defined) configurations change.

This mechanism allows the Service to recognize events, such as file changes, and pass on the event to all LifeCycle implementors.

The code should take the opportunity to evaluate configuration and change as necessary.

IMPORTANT:

The LifeCycle implementor cannot guarantee it will not be in the middle of a transaction, so it would behoove the implementor to construct content that does not affect anything until finished, then apply to an appropriate atomic action (i.e. setting an Object to a field), or even synchronizing. If you are using Java's "ThreadLocal", consider RefreshableThreadObject, because it implements LifeCycle, and responds to the refresh command.

Parameters:

env -

Throws:

APIException

threadDestroy

void threadDestroy(Env env)
            throws APIException

Parallel to threadPrestart, threadDestroy tells the implementor that the service is ending this particular thread, and to take this opportunity to close out any content specific to this thread that can be closed.

Parameters:

env -

Throws:

APIException

serviceDestroy

void serviceDestroy(Env env)
             throws APIException

Parallel to servicePrestart, serviceDestroy tells the implementor that the service is ending, and to take this opportunity to close out any content under it's control that can or should be closed explicitly.

Throws:

APIException