Package org.zalando.fahrschein

Class SubscriptionBuilder

java.lang.Object

org.zalando.fahrschein.SubscriptionBuilder

public class SubscriptionBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SubscriptionBuilder	readFromBegin()
SubscriptionBuilder	readFromCursors(List<Cursor> initialCursors)
SubscriptionBuilder	readFromEnd()
Subscription	subscribe()
Subscription	subscribe(String subscriptionId)	This method allows clients to stream events on the given subscription ID.
SubscriptionBuilder	withAuthorization(Authorization authorization)
SubscriptionBuilder	withConsumerGroup(String consumerGroup)

Methods inherited from class java.lang.Object

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

Method Details

readFromBegin

public SubscriptionBuilder readFromBegin()

readFromEnd

public SubscriptionBuilder readFromEnd()

readFromCursors

public SubscriptionBuilder readFromCursors(List<Cursor> initialCursors)

withConsumerGroup

public SubscriptionBuilder withConsumerGroup(String consumerGroup)

withAuthorization

public SubscriptionBuilder withAuthorization(Authorization authorization)

subscribe

public Subscription subscribe(String subscriptionId)

This method allows clients to stream events on the given subscription ID.

Note: Since the subscription ID is already provided, fahrschein will not attempt to create a new subscription for the events and will therefore will only consider applicationName and eventNames and will ignore other SubscriptionBuilder parameters.

Parameters:

subscriptionId - event(s) subscription ID.

Returns:

subscribe

public Subscription subscribe()
                       throws IOException

Throws:

IOException