javax.slee.facilities

Interface ActivityContextNamingFacility

public interface ActivityContextNamingFacility

The Activity Context Naming Facility provides a global flat namespace for naming Activity Contexts. It allows an SBB entity to bind a name to an Activity Context, and other SBB entities to lookup the Activity Context by this name. An Activity Context can be bound to zero or more names.

This facility is transactional in nature. Naming operations only take effect once the enclosing transaction commits.

An SBB obtains access to an ActivityContextNamingFacility object via its JNDI environment. The Activity Context Naming Facility is bound into JNDI using the name specified by JNDI_NAME.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JNDI_NAME Constant declaring the JNDI name where an ActivityContextNamingFacility object is bound into an SBB's JNDI environment.

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(ActivityContextInterface aci, String name) Bind an Activity Context to a name.
ActivityContextInterface	lookup(String name) Get a reference to the Activity Context bound to a particular name.
void	unbind(String name) Unbind a bound name.

Field Detail

JNDI_NAME

static final String JNDI_NAME

Constant declaring the JNDI name where an ActivityContextNamingFacility object is bound into an SBB's JNDI environment.

The value of this constant is "java:comp/env/slee/facilities/activitycontextnaming".

Since:

SLEE 1.1

See Also:

Constant Field Values

Method Detail

bind

void bind(ActivityContextInterface aci,
        String name)
          throws NullPointerException,
                 IllegalArgumentException,
                 TransactionRequiredLocalException,
                 NameAlreadyBoundException,
                 FacilityException

Bind an Activity Context to a name.

This method is a mandatory transactional method.

Parameters:

aci - an ActivityContextInterface object that encapsulates the Activity Context to bind.

name - the name to bind the Activity Context to.

Throws:

NullPointerException - if any argument is null.

IllegalArgumentException - if name is zero-length.

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

NameAlreadyBoundException - if the specified name is already bound to some Activity Context.

FacilityException - if the activity context could not be bound due to a system-level failure.

unbind

void unbind(String name)
            throws NullPointerException,
                   TransactionRequiredLocalException,
                   NameNotBoundException,
                   FacilityException

Unbind a bound name.

This method is a mandatory transactional method.

Parameters:

name - the name that should be unbound.

Throws:

NullPointerException - if name is null.

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

NameNotBoundException - if the specified name is not currently bound to an Activity Context.

FacilityException - if the name could not be unbound due to a system-level failure.

lookup

ActivityContextInterface lookup(String name)
                                throws NullPointerException,
                                       TransactionRequiredLocalException,
                                       FacilityException

Get a reference to the Activity Context bound to a particular name.

This method is a mandatory transactional method.

Parameters:

name - the name the Activity Context is bound to.

Returns:

an ActivityContextInterface object that encapsulates the Activity Context bound to the specified name. If no Activity Context is bound to the name, this method returns null.

Throws:

NullPointerException - if name is null.

TransactionRequiredLocalException - if this method is invoked without a valid transaction context.

FacilityException - if the lookup failed due to a system-level failure.