org.mobicents.slee

Interface SbbExt

All Superinterfaces:

javax.slee.Sbb

All Known Implementing Classes:

CompleteExampleAnnotatedSbb, SimpleExampleAnnotatedSbb

public interface SbbExt
extends javax.slee.Sbb

Extension interface for a JAIN SLEE 1.1 SBB, 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 Sbb.setSbbContext(javax.slee.SbbContext), and after invocation of sbbConfigure(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 sbbUnconfigure(), and upon invocation of Sbb.unsetSbbContext() it goes to Does Not Exists state again.

Author:

Eduardo Martins

Method Summary

Methods

Modifier and Type	Method and Description
void	sbbConfigurationUpdate(ConfigProperties properties) This method is invoked by the SLEE whenever the Administrator successfully updates a Service and SBB with new configuration properties.
void	sbbConfigure(ConfigProperties properties) The SLEE invokes this method on a SBB object in the Unconfigured state to provide it with configuration properties common for any SBB entity that uses the object.
void	sbbUnconfigure() The SLEE invokes this method on a SBB object in the Pooled state, indicating the transition to Unconfigured state.
void	sbbVerifyConfiguration(ConfigProperties properties) This method is invoked by the SLEE whenever a new service, which refers the SBB, is activated by the Administrator, or when the Administrator attempts to update the configuration properties of an existing service which refers the SBB.

Methods inherited from interface javax.slee.Sbb

sbbActivate, sbbCreate, sbbExceptionThrown, sbbLoad, sbbPassivate, sbbPostCreate, sbbRemove, sbbRolledBack, sbbStore, setSbbContext, unsetSbbContext

Method Detail

sbbConfigure

void sbbConfigure(ConfigProperties properties)

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

This method is invoked with an unspecified transaction context.

Parameters:

properties - the configuration properties specified for the SBB object.

sbbUnconfigure

void sbbUnconfigure()

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

This method is invoked with an unspecified transaction context.

sbbVerifyConfiguration

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

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

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

This method is invoked with an unspecified transaction context.

Parameters:

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

Throws:

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

javax.slee.resource.InvalidConfigurationException

sbbConfigurationUpdate

void sbbConfigurationUpdate(ConfigProperties properties)

This method is invoked by the SLEE whenever the Administrator successfully updates a Service and SBB 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 SBB object.

properties -