com.netegrity.imapi
Interface LifeCycle

All Known Implementing Classes:

BLTHAdapter, EventListenerAdapter, ForgottenPasswordHandler, LogicalAttributeAdapter, NotificationRuleAdapter, OrgSelectorAdapter, ParticipantResolverAdapter

public interface LifeCycle

Contains user-defined properties applicable to a particular custom object and/or to an entire Identity Manager environment. These properties are defined in the Identity Manager Management Console. Also provides a custom object with basic implementations for startup and shutdown methods, and optionally, access to the managed object providers.

LifeCycle methods are called when Identity Manager starts up the environment and loads objects (including custom objects), and also when Identity Manager shuts down the environment. These methods give the custom object an opportunity to connect to and disconnect from external objects, and to perform any other startup and shutdown operations that it might require.

All LifeCycle methods throw an exception. If an exception is thrown, Identity Manager logs the exception, and processing continues.

The LifeCycle interface is part of the core Identity Manager API architecture. The ...Adapter object in each Identity Manager API inherits LifeCycle methods.

Since:

IdentityMinder 5.6

Method Summary

void	init(java.util.Hashtable imeProperties) Passes user-defined properties into the custom object.
void	init(java.util.Hashtable imeProperties, ProviderAccessor providerAccessor) Passes user-defined properties and access to the providers into the custom object.
void	shutdown() Identity Manager calls this method just before it destroys all objects in the Identity Manager environment and shuts down services in the Identity Manager environment.
void	startup() Identity Manager calls this method when it is starting up the environment.
void	uninit() Identity Manager calls this method just before shutting down services for the Identity Manager environment.

Method Detail

startup

void startup()
             throws java.lang.Exception

Identity Manager calls this method when it is starting up the environment. At this stage, Identity Manager is creating classes and loading its core services.

You can perform whatever startup operations you require at this stage -- for example, establishing a connection to an external data source.

Throws:

java.lang.Exception

shutdown

void shutdown()
              throws java.lang.Exception

Identity Manager calls this method just before it destroys all objects in the Identity Manager environment and shuts down services in the Identity Manager environment.

Throws:

java.lang.Exception

init

void init(java.util.Hashtable imeProperties)
          throws java.lang.Exception

Passes user-defined properties into the custom object. Properties can be defined specifically for this object and/or for the entire Identity Manager environment.

User-defined properties are passed into a custom object only once, during initialization. The custom object is responsible for managing the properties for the remainder of the environment session.

User-defined properties are defined in the Identity Manager Management Console, as follows:

• Environment properties. The properties defined on the Miscellaneous screen are passed into the init() method of all custom objects. You access the Miscellaneous screen by clicking Miscellaneous on the Advanced Settings screen.
• Object-specific properties. These are defined in the Properties screen for a particular custom object -- for example, a logical attribute handler named MyHandler.

Environment-wide properties and object-specific properties are passed together in a single call to init().

Object-specific properties take precedence over the environment properties that are passed into the init() method. For example, if a CreditRating property is defined on the Miscellaneous screen, and also in the User Defined Properties section of the Properties screen for a particular event listener, the CreditRating value as defined on the latter screen is passed into the init() method of the event listener adapter. The CreditRating value defined on the Miscellaneous screen is passed into the init() method of all other event listeners as well as all other types of custom objects.

Identity Manager calls this method after startup() is called and after the class is loaded.

Parameters:

imeProperties - Properties data for the Identity Manager environment.

Throws:

java.lang.Exception

init

void init(java.util.Hashtable imeProperties,
          ProviderAccessor providerAccessor)
          throws java.lang.Exception

Passes user-defined properties and access to the providers into the custom object. The providers give you direct access to the managed objects in the data store.

Implementing this init() method is useful if you need to use a managed object multiple times -- for example, if multiple Create User tasks will assign each new user to the same role. In that case, you can cache the role object during initialization rather than retrieving it through the ProviderService passed into each task context.

For information about the user-defined properties passed into this method, see init(Hashtable).

Throws:

java.lang.Exception

Since:

IdentityMinder 6.0

uninit

void uninit()
            throws java.lang.Exception

Identity Manager calls this method just before shutting down services for the Identity Manager environment. This method gives the custom object the opportunity to disconnect from any data sources before objects are destroyed and the environment is shut down.

If multiple adapters exist, all the uninit() methods are called before any of the shutdown() methods are called.

Throws:

java.lang.Exception