Module java4ever.framework

Package tech.deplant.java4ever.framework.subscription

Class Subscriptions.Builder

java.lang.Object

tech.deplant.java4ever.framework.subscription.Subscriptions.Builder

Enclosing interface:

Subscriptions

public static class Subscriptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Subscriptions.Builder	addCallbackConsumer(Consumer<com.fasterxml.jackson.databind.JsonNode> callbackConsumer)	If set, receives events that pass filters will be immediately consumed with provided Consumer interface
Subscriptions.Builder	addFilterOnConsume(Predicate<com.fasterxml.jackson.databind.JsonNode> javaFilter)	If Java filter is set, event will be received, but will not be consumed until predicate is true.
Subscriptions.Builder	addFilterOnSubscription(String gqlFilter)	If Gql filter is set, event will be received by graphql client only if does meet provided filter requirements.
Subscriptions.Builder	setCallbackToQueue(boolean doCallbackToQueue)	If set, received events that pass filters will be consumed by internal queue object.
SubscriptionHandle	subscribeUntilCancel(int contextId)
SubscriptionHandle	subscribeUntilCondition(int contextId, Predicate<com.fasterxml.jackson.databind.JsonNode> unsubscribeCondition)
SubscriptionHandle	subscribeUntilFirst(int contextId)

Methods inherited from class java.lang.Object

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

Method Details

addCallbackConsumer

public Subscriptions.Builder addCallbackConsumer(Consumer<com.fasterxml.jackson.databind.JsonNode> callbackConsumer)

If set, receives events that pass filters will be immediately consumed with provided Consumer interface

Parameters:

callbackConsumer - consumer lambda function that handles new JsonNode callback

setCallbackToQueue

public Subscriptions.Builder setCallbackToQueue(boolean doCallbackToQueue)

If set, received events that pass filters will be consumed by internal queue object. You can later retrieve them by calling SubscribeHandle::queue().

addFilterOnSubscription

public Subscriptions.Builder addFilterOnSubscription(String gqlFilter)

If Gql filter is set, event will be received by graphql client only if does meet provided filter requirements. Gql filter is limited to GraphQL api filters of your endpoint.

Parameters:

gqlFilter - String representation of GraphQL filter query

addFilterOnConsume

public Subscriptions.Builder addFilterOnConsume(Predicate<com.fasterxml.jackson.databind.JsonNode> javaFilter)

If Java filter is set, event will be received, but will not be consumed until predicate is true. This filter is not limited by GraphQL endpoint possible filters, but it can take more network bandwidth as it receives all events. It's better to use GraphQL Server filter for most tasks and add Java client-side filter for more complex conditions. You can add any number of filters.

subscribeUntilCancel

public SubscriptionHandle subscribeUntilCancel(int contextId)
                                        throws tech.deplant.java4ever.binding.EverSdkException

Throws:

tech.deplant.java4ever.binding.EverSdkException

subscribeUntilFirst

public SubscriptionHandle subscribeUntilFirst(int contextId)
                                       throws tech.deplant.java4ever.binding.EverSdkException

Throws:

tech.deplant.java4ever.binding.EverSdkException

subscribeUntilCondition

public SubscriptionHandle subscribeUntilCondition(int contextId,
 Predicate<com.fasterxml.jackson.databind.JsonNode> unsubscribeCondition)
                                           throws tech.deplant.java4ever.binding.EverSdkException

Throws:

tech.deplant.java4ever.binding.EverSdkException