SignalApiImpl (scheduling 14.1.0-SNAPSHOT API)

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

Fields
Modifier and Type	Field and Description
`static String`	`READY_PREFIX`

Constructor Summary

Constructors
Constructor and Description

SignalApiImpl(String originator, TaskId taskId, SynchronizationInternal synchronizationInternal)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Map<String,String>>`	`checkForSignals(Set<String> signalsSubSet)` Check if all 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
`Map<String,Signal>`	`getJobSignals()` Return the set of job signals
`boolean`	`isReceived(String signalName)` Check if the given signal was received
`void`	`readyForSignal(String signalName)` Add a new signal to the set of job signals
`void`	`readyForSignal(String signalName, List<JobVariable> variables)` Add a new signal to the set of job signals
`void`	`removeManySignals(Set<String> signalsSubSet)` Remove the given set of signals from job signals In order to remove signals that were not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal names
`void`	`removeSignal(String signalName)` Remove the given `signal` from the set of job signals In order to remove a signal that was not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal name
`void`	`sendManySignals(Map<String,Map<String,String>> signalParameters)` Add the given set of signals to job signals
`void`	`sendManySignals(Set<String> signalsSubSet)` Add the given set of signals to job signals
`void`	`sendSignal(String signalName)` Add the given `signal` to the set of job signals
`void`	`sendSignal(String signalName, Map<String,String> parameters)` Add the given `signal` to the set of job signals
`Map<String,String>`	`waitFor(String signalName)` Wait until the given signal is added to the set of job signals
`Map<String,Map<String,String>>`	`waitForAll(Set<String> signalsSubSet)` Wait until all the input signals are added to the set of job signals
`Signal`	`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 void readyForSignal(String signalName,
                           List<JobVariable> variables)
                    throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Add a new signal to the set of job signals
    
    Specified by:
    
    readyForSignal in interface SignalApi
    
    Parameters:
    
    signalName - name of the signal to be added
    
    variables - the input variables of the signal to be added
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the ready signal to job signals
  - readyForSignal
```
public void readyForSignal(String signalName)
                    throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Add a new signal to the set of job signals
    
    Specified by:
    
    readyForSignal in interface SignalApi
    
    Parameters:
    
    signalName - name of the signal to be added
    
    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 was received
    
    Specified by:
    
    isReceived in interface SignalApi
    
    Parameters:
    
    signalName - name of the signal to be checked
    
    Returns:
    
    true if the signal was received
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - checkForSignals
```
public Map<String,Map<String,String>> checkForSignals(Set<String> signalsSubSet)
                                               throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Check if all 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 the map of signals names and updatedVariables found in the set of job signals, empty map if no signals are found
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - sendSignal
```
public void sendSignal(String signalName,
                       Map<String,String> parameters)
                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
    
    parameters - the updated values of the signal to be added
    
    Throws:
    
    SignalApiException - if the corresponding ready signal does not exist, or when an error occurs while sending the signal
  - sendSignal
```
public void 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
    
    Throws:
    
    SignalApiException - if the corresponding ready signal does not exist, or when an error occurs while sending the signal
  - sendManySignals
```
public void sendManySignals(Map<String,Map<String,String>> signalParameters)
                     throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Add the given set of signals to job signals
    
    Specified by:
    
    sendManySignals in interface SignalApi
    
    Parameters:
    
    signalParameters - a map containing the signal name and the updated values of the signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the signals to job signals
  - sendManySignals
```
public void 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
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when adding the signals to job signals
  - removeSignal
```
public void removeSignal(String signalName)
                  throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Remove the given signal from the set of job signals In order to remove a signal that was not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal name
    
    Specified by:
    
    removeSignal in interface SignalApi
    
    Parameters:
    
    signalName - name of the signal to be removed from job signals
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel, or when removing the signal from job signals
  - removeManySignals
```
public void removeManySignals(Set<String> signalsSubSet)
                       throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Remove the given set of signals from job signals In order to remove signals that were not yet received, the signalsSubSet parameter should contain the "ready_" prefix and the signal names
    
    Specified by:
    
    removeManySignals in interface SignalApi
    
    Parameters:
    
    signalsSubSet - set of the signals to be 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 Map<String,Signal> getJobSignals()
                                 throws SignalApiException
```
    Description copied from interface: SignalApi
    
    Return the set of job signals
    
    Specified by:
    
    getJobSignals in interface SignalApi
    
    Returns:
    
    a map containing the signal name and the Signal object
    
    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 Map<String,String> 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
    
    Returns:
    
    a map containing the signal name and the updated values of the signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel
  - waitForAny
```
public Signal 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 Map<String,Map<String,String>> 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
    
    Returns:
    
    a map containing the signal name and the updated values of the signal
    
    Throws:
    
    SignalApiException - if an error occurred while reading in the signals channel

Class SignalApiImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

READY_PREFIX

Constructor Detail

SignalApiImpl

Method Detail

readyForSignal

readyForSignal

isReceived

checkForSignals

sendSignal

sendSignal

sendManySignals

sendManySignals

removeSignal

removeManySignals

getJobSignals

clearJobSignals

waitFor

waitForAny

waitForAll