javax.slee.nullactivity.NullActivityContextInterfaceFactory Maven / Gradle / Ivy
package javax.slee.nullactivity;
import javax.slee.ActivityContextInterface;
import javax.slee.FactoryException;
import javax.slee.UnrecognizedActivityException;
import javax.slee.TransactionRequiredLocalException;
/**
* The Null Activity Context Interface Factory is used by SBBs to obtain
* an ActivityContextInterface object for a null activity.
*
* An SBB obtains access to a NullActivityContextInterfaceFactory
* object via its JNDI environment. The Null Activity Context Interface Factory
* is bound into JNDI using the name specified by {@link #JNDI_NAME}.
*
* @see NullActivity
* @see NullActivityFactory
*/
public interface NullActivityContextInterfaceFactory {
/**
* Constant declaring the JNDI name where a NullActivityContextInterfaceFactory
* object is bound into an SBB's JNDI environment.
*
* The value of this constant is "java:comp/env/slee/nullactivity/activitycontextinterfacefactory".
* @since SLEE 1.1
*/
public static final String JNDI_NAME = "java:comp/env/slee/nullactivity/activitycontextinterfacefactory";
/**
* Get an ActivityContextInterface object for a null activity.
*
* This method is a mandatory transactional method.
* @param activity the null activity.
* @return an ActivityContextInterface object that encapsulates the
* null activity.
* @throws NullPointerException if activity is null.
* @throws TransactionRequiredLocalException if this method is invoked without a valid transaction
* context.
* @throws UnrecognizedActivityException if activity is not a
* valid null activity created by the SLEE.
* @throws FactoryException if the ActivityContextInterface object
* could not be created due to a system-level failure.
*/
public ActivityContextInterface getActivityContextInterface(NullActivity activity)
throws NullPointerException, TransactionRequiredLocalException, UnrecognizedActivityException,
FactoryException;
}