Package org.ovirt.vdsm.jsonrpc.client.events

Class EventSubscriber

java.lang.Object

org.ovirt.vdsm.jsonrpc.client.events.EventSubscriber

All Implemented Interfaces:

Subscriber<java.util.Map<java.lang.String,java.lang.Object>>

public abstract class EventSubscriber
extends java.lang.Object
implements Subscriber<java.util.Map<java.lang.String,java.lang.Object>>

Subscription id contains <receiver>.<component>.<operation_id>.<unique_id>.

Constructor Summary

Constructors

Constructor	Description
EventSubscriber(java.lang.String subscriptionId)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getSubscriptionId()
abstract void	onComplete()	Successful terminal state.
abstract void	onError(java.lang.Throwable t)	Failed terminal state.
abstract void	onNext(java.util.Map<java.lang.String,java.lang.Object> t)	Data notification sent by the Publisher in response to requests to Subscription.request(int).
abstract void	onSubscribe(Subscription s)	Invoked after calling Publisher.subscribe(Subscriber).

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSubscriber

public EventSubscriber(java.lang.String subscriptionId)

Parameters:

subscriptionId - subscription id which is used to match an event to subscription.

Method Detail

onSubscribe

public abstract void onSubscribe(Subscription s)

Description copied from interface: Subscriber

Invoked after calling Publisher.subscribe(Subscriber).

No data will start flowing until Subscription.request(int) is invoked.

It is the responsibility of this Subscriber instance to call Subscription.request(int) whenever more data is wanted.

The Publisher will send notifications only in response to Subscription.request(int).

Specified by:

onSubscribe in interface Subscriber<java.util.Map<java.lang.String,java.lang.Object>>

Parameters:

s - Subscription that allows requesting data via Subscription.request(int)

onNext

public abstract void onNext(java.util.Map<java.lang.String,java.lang.Object> t)

Description copied from interface: Subscriber

Data notification sent by the Publisher in response to requests to Subscription.request(int).

Specified by:

onNext in interface Subscriber<java.util.Map<java.lang.String,java.lang.Object>>

Parameters:

t - the element signaled

onError

public abstract void onError(java.lang.Throwable t)

Description copied from interface: Subscriber

Failed terminal state.

It is up to implementer to decide whether to cancel subscription or use Subscription.request(int) and expect further notifications.

Specified by:

onError in interface Subscriber<java.util.Map<java.lang.String,java.lang.Object>>

Parameters:

t - the throwable signaled

onComplete

public abstract void onComplete()

Description copied from interface: Subscriber

Successful terminal state.

No further events will be sent even if Subscription.request(int) is invoked again.

Specified by:

onComplete in interface Subscriber<java.util.Map<java.lang.String,java.lang.Object>>

getSubscriptionId

public java.lang.String getSubscriptionId()

Returns:

subscription id which is used to match incoming events.