org.mobicents.slee

Interface ProfileExt

All Superinterfaces:

javax.slee.profile.Profile

All Known Implementing Classes:

CompleteExampleAnnotatedProfile

public interface ProfileExt
extends javax.slee.profile.Profile

Extension interface for a JAIN SLEE 1.1 Profile, provides lifecycles methods to deal with config properties, in a similar way as Resource Adaptors work. A new state is introduced, Unconfigured, which stands between Does Not Exists and Pooled states. Unconfigured is reached from Does Not Exists after invocation of Profile.setProfileContext(ProfileContext), and after invocation of profileConfigure(ConfigProperties) the Pooled state is reached. In the reverse direction of the state machine, instead of moving from Pooled to Does Not Exists state, now it goes from Pooled to Unconfigured, upon invocation of profileUnconfigure(), and upon invocation of Profile.unsetProfileContext() it goes to Does Not Exists state again.

Author:

Eduardo Martins

Method Summary

Methods

Modifier and Type	Method and Description
void	profileConfigurationUpdate(ConfigProperties properties) This method is invoked by the SLEE whenever the Administrator successfully updates a Profile Spec with new configuration properties.
void	profileConfigure(ConfigProperties properties) The SLEE invokes this method on a Profile object in the Unconfigured state to provide it with configuration properties common for any Profile entity that uses the object.
void	profileUnconfigure() The SLEE invokes this method on a Profile object in the Pooled state, indicating the transition to Unconfigured state.
void	profileVerifyConfiguration(ConfigProperties properties) This method is invoked by the SLEE whenever a new Profile Spec, which refers the abstract Profile class, is activated by the Administrator, or when the Administrator attempts to update the configuration properties.

Methods inherited from interface javax.slee.profile.Profile

profileActivate, profileInitialize, profileLoad, profilePassivate, profilePostCreate, profileRemove, profileStore, profileVerify, setProfileContext, unsetProfileContext

Method Detail

profileConfigure

void profileConfigure(ConfigProperties properties)

The SLEE invokes this method on a Profile object in the Unconfigured state to provide it with configuration properties common for any Profile entity that uses the object.

This method is invoked with an unspecified transaction context.

Parameters:

properties - the configuration properties specified for the Profile object.

profileUnconfigure

void profileUnconfigure()

The SLEE invokes this method on a Profile object in the Pooled state, indicating the transition to Unconfigured state. The object should release any resources acquired when invocation of profileConfigure(ConfigProperties) or profileConfigurationUpdate(ConfigProperties).

This method is invoked with an unspecified transaction context.

profileVerifyConfiguration

void profileVerifyConfiguration(ConfigProperties properties)
                                throws javax.slee.resource.InvalidConfigurationException

This method is invoked by the SLEE whenever a new Profile Spec, which refers the abstract Profile class, is activated by the Administrator, or when the Administrator attempts to update the configuration properties. The implementation of this method should examine the configuration properties supplied and verify that the configuration properties are valid for the Profile.

This method may be invoked on a Profile object in any valid state, therefore the implementation of this method should assume nothing about the internal state of the Profile object.

This method is invoked with an unspecified transaction context.

Parameters:

properties - contains the proposed new values for all configuration properties specified for the Profile object.

Throws:

InvalidConfigurationException - if the configuration properties are not valid for some reason.

javax.slee.resource.InvalidConfigurationException

profileConfigurationUpdate

void profileConfigurationUpdate(ConfigProperties properties)

This method is invoked by the SLEE whenever the Administrator successfully updates a Profile Spec with new configuration properties. The implementation of this method should apply the new configuration properties to its internal state.

This method is invoked with an unspecified transaction context.

Parameters:

properties - contains the new values for all configuration properties specified for the Profile object.

properties -