com.arjuna.mw.wsas.ActivityManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbossxts Show documentation
Narayana: XTS jbossxts
The newest version!
/*
   Copyright The Narayana Authors
   SPDX-License-Identifier: Apache-2.0
 */



package com.arjuna.mw.wsas;

import com.arjuna.mw.wsas.activity.HLS;
import com.arjuna.mw.wsas.exceptions.SystemException;
import com.arjuna.mw.wsas.exceptions.InvalidHLSException;

/**
 * The activity manager is the way in which an HLS can register
 * itself with the activity service. This allows it to be informed
 * of the lifecycle of activities and to augment that lifecyle and
 * associated context.
 *
 * An HLS can be associated with all threads (globally) or with only
 * a specific thread (locally).
 *
 * @author Mark Little ([email protected])
 * @version $Id: ActivityManager.java,v 1.1 2002/11/25 10:51:40 nmcl Exp $
 * @since 1.0.
 */

public interface ActivityManager
{

    /**
     * Register the specified HLS with the activity service.
     *
     * @param service The HLS to register.
     *
     * @exception InvalidHLSException Thrown if the HLS is invalid in the
     * current execution environment.
     * @exception SystemException Thrown if any other error occurs.
     */

    public void addHLS (HLS service) throws InvalidHLSException, SystemException;

    /**
     * Unregister the specified HLS with the activity service.
     *
     * @param service The HLS to unregister.
     *
     * @exception InvalidHLSException Thrown if the HLS is invalid in the
     * current execution environment.
     * @exception SystemException Thrown if any other error occurs.
     */

    public void removeHLS (HLS service) throws InvalidHLSException, SystemException;

    /**
     * Allows an invoker to obtain a list of all registered HLSs.
     * Elements at the start of the array have higher priority than those at
     * the end.
     *
     * @exception SystemException Thrown if any error occurs.
     *
     * @return the list of HLSs.
     *
     */

    public HLS[] allHighLevelServices () throws SystemException;

    /**
     * Allows an invoker to obtain a specific registered HLS supporting a given coordination type.
     *
     * @exception SystemException Thrown if any error occurs.
     *
     * @return the HLS.
     *
     */

    public HLS getHighLevelService (String serviceType) throws SystemException;
}