org.ow2.proactive.scheduler.signal

Class SignalApiImpl

java.lang.Object

org.ow2.proactive.scheduler.signal.SignalApiImpl

All Implemented Interfaces:

Serializable, SignalApi

public class SignalApiImpl
extends Object
implements SignalApi

SignalApiImpl acts as a high level signal service that uses the synchronization API. It enables workflow tasks handle signals in an easy manner. It implements the methods defined in the interface @see org.ow2.proactive.scheduler.signal.SignalApi.

Since:

24/11/2020

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	READY_PREFIX

Constructor Summary

Constructors

Constructor and Description
SignalApiImpl(String originator, TaskId taskId, SynchronizationInternal synchronizationInternal)

Method Summary

Modifier and Type	Method and Description
String	checkForSignals(Set<String> signalsSubSet) Check if any of the signals given as input exist among the set of job signals
void	clearJobSignals() Remove the entry corresponding to job signals from the signals channel
Set<String>	getJobSignals() Return the set of job signals
boolean	isReceived(String signalName) Check if the given signal exists among the set of job signals
boolean	readyForSignal(String signalName) Add a new signal to the set of job signals The new signal is composed of a prefix (i.e., "ready_") and the given signal
boolean	removeManySignals(Set<String> signalsSubSet) Remove the given set of signals from job signals
boolean	removeSignal(String signalName) Remove the given signal from the set of job signals
boolean	sendManySignals(Set<String> signalsSubSet) Add the given set of signals to job signals
boolean	sendSignal(String signalName) Add the given signal to the set of job signals
void	waitFor(String signalName) Wait until the given signal is added to the set of job signals
void	waitForAll(Set<String> signalsSubSet) Wait until all the input signals are added to the set of job signals
String	waitForAny(Set<String> signalsSubSet) Wait until one signal (among those of the given signalsSubSet) is added to the set of job signals

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

READY_PREFIX

public static final String READY_PREFIX

See Also:

Constant Field Values

Constructor Detail

SignalApiImpl

public SignalApiImpl(String originator,
                     TaskId taskId,
                     SynchronizationInternal synchronizationInternal)

Method Detail

readyForSignal

public boolean readyForSignal(String signalName)
                       throws SignalApiException

Description copied from interface: SignalApi

Add a new signal to the set of job signals The new signal is composed of a prefix (i.e., "ready_") and the given signal

Specified by:

readyForSignal in interface SignalApi

Parameters:

signalName - name of the signal to be added

Returns:

true if the signal is successfully added to the set of job signals

Throws:

SignalApiException - if an error occurred while reading in the signals channel, or when adding the ready signal to job signals

isReceived

public boolean isReceived(String signalName)
                   throws SignalApiException

Description copied from interface: SignalApi

Check if the given signal exists among the set of job signals

Specified by:

isReceived in interface SignalApi

Parameters:

signalName - name of the signal to be checked

Returns:

true if the signal exists among the set of job signals

Throws:

SignalApiException - if an error occurred while reading in the signals channel

checkForSignals

public String checkForSignals(Set<String> signalsSubSet)
                       throws SignalApiException

Description copied from interface: SignalApi

Check if any of the signals given as input exist among the set of job signals

Specified by:

checkForSignals in interface SignalApi

Parameters:

signalsSubSet - set of the signals to be checked

Returns:

the first signal found in the set of job signals, null if no signals are found

Throws:

SignalApiException - if an error occurred while reading in the signals channel

sendSignal

public boolean sendSignal(String signalName)
                   throws SignalApiException

Description copied from interface: SignalApi

Add the given signal to the set of job signals

Specified by:

sendSignal in interface SignalApi

Parameters:

signalName - name of the signal to be added to job signals

Returns:

true if the signal is successfully added to job signals

Throws:

SignalApiException - if the corresponding ready signal does not exist, or when an error occurs while sending the signal

sendManySignals

public boolean sendManySignals(Set<String> signalsSubSet)
                        throws SignalApiException

Description copied from interface: SignalApi

Add the given set of signals to job signals

Specified by:

sendManySignals in interface SignalApi

Parameters:

signalsSubSet - set of the signals to be added to job signals

Returns:

true if all the given signals are successfully added to job signal

Throws:

SignalApiException - if an error occurred while reading in the signals channel, or when adding the signals to job signals

removeSignal

public boolean removeSignal(String signalName)
                     throws SignalApiException

Description copied from interface: SignalApi

Remove the given signal from the set of job signals

Specified by:

removeSignal in interface SignalApi

Parameters:

signalName - name of the signal to be removed from job signals

Returns:

true if the signal is successfully removed from the set of job signals

Throws:

SignalApiException - if an error occurred while reading in the signals channel, or when removing the signal from job signals

removeManySignals

public boolean removeManySignals(Set<String> signalsSubSet)
                          throws SignalApiException

Description copied from interface: SignalApi

Remove the given set of signals from job signals

Specified by:

removeManySignals in interface SignalApi

Parameters:

signalsSubSet - set of the signals to be removed from job signals

Returns:

true if all the given signals are successfully removed from job signals

Throws:

SignalApiException - if an error occurred while reading in the signals channel, or when removing the signals from job signals

getJobSignals

public Set<String> getJobSignals()
                          throws SignalApiException

Description copied from interface: SignalApi

Return the set of job signals

Specified by:

getJobSignals in interface SignalApi

Returns:

the set of job signals

Throws:

SignalApiException - if an error occurred while reading in the signals channel

clearJobSignals

public void clearJobSignals()
                     throws SignalApiException

Description copied from interface: SignalApi

Remove the entry corresponding to job signals from the signals channel

Specified by:

clearJobSignals in interface SignalApi

Throws:

SignalApiException - if an error occurred while reading in the signals channel, or when removing an entry from this channel

waitFor

public void waitFor(String signalName)
             throws SignalApiException

Description copied from interface: SignalApi

Wait until the given signal is added to the set of job signals

Specified by:

waitFor in interface SignalApi

Parameters:

signalName - name of the signal to wait for

Throws:

SignalApiException - if an error occurred while reading in the signals channel

waitForAny

public String waitForAny(Set<String> signalsSubSet)
                  throws SignalApiException

Description copied from interface: SignalApi

Wait until one signal (among those of the given signalsSubSet) is added to the set of job signals

Specified by:

waitForAny in interface SignalApi

Parameters:

signalsSubSet - set of the signals to wait for any of them

Returns:

the first signal received among those given as input

Throws:

SignalApiException - if an error occurred while reading in the signals channel

waitForAll

public void waitForAll(Set<String> signalsSubSet)
                throws SignalApiException

Description copied from interface: SignalApi

Wait until all the input signals are added to the set of job signals

Specified by:

waitForAll in interface SignalApi

Parameters:

signalsSubSet - set of the signals to wait for

Throws:

SignalApiException - if an error occurred while reading in the signals channel