Package org.pipservices3.commons.run

Class Notifier

java.lang.Object

org.pipservices3.commons.run.Notifier

public class Notifier
extends Object

Helper class that notifies components.

See Also:

• INotifiable

Constructor Summary

Constructors

Constructor	Description
Notifier()

Method Summary

Modifier and Type	Method	Description
static void	notify(String correlationId, Iterable<Object> components, Parameters args)	Notifies multiple components.
static void	notifyOne(String correlationId, Object component, Parameters args)	Notifies specific component.

Methods inherited from class java.lang.Object

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

Constructor Details

Notifier

public Notifier()

Method Details

notifyOne

public static void notifyOne(String correlationId,
 Object component,
 Parameters args)
                      throws ApplicationException

Notifies specific component.

To be notiied components must implement INotifiable interface. If they don't the call to this method has no effect.

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

component - the component that is to be notified.

args - notifiation arguments.

Throws:

ApplicationException - when errors occured.

See Also:

• INotifiable

notify

public static void notify(String correlationId,
 Iterable<Object> components,
 Parameters args)
                   throws ApplicationException

Notifies multiple components.

To be notified components must implement INotifiable interface. If they don't the call to this method has no effect.

Parameters:

correlationId - (optional) transaction id to trace execution through call chain.

components - a list of components that are to be notified.

args - notification arguments.

Throws:

ApplicationException - when errors occured.

See Also:

• notifyOne(String, Object, Parameters)
• INotifiable