org.eclipse.ditto.services.gateway.streaming

Class StartStreaming

java.lang.Object

org.eclipse.ditto.services.gateway.streaming.StartStreaming

public final class StartStreaming
extends Object

Message indicating a demand to receive entities of a specified StreamingType via a "streaming" connection.

Constructor Summary

Constructors

Constructor and Description
StartStreaming(StreamingType streamingType, String connectionCorrelationId, org.eclipse.ditto.model.base.auth.AuthorizationContext authorizationContext, List<String> namespaces, String filter) Constructs a new StartStreaming instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
org.eclipse.ditto.model.base.auth.AuthorizationContext	getAuthorizationContext()
String	getConnectionCorrelationId()
Optional<String>	getFilter()
List<String>	getNamespaces()
StreamingType	getStreamingType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartStreaming

public StartStreaming(StreamingType streamingType,
                      String connectionCorrelationId,
                      org.eclipse.ditto.model.base.auth.AuthorizationContext authorizationContext,
                      List<String> namespaces,
                      @Nullable
                      String filter)

Constructs a new StartStreaming instance.

Parameters:

streamingType - the type of entity to start the streaming for.

connectionCorrelationId - the correlationId of the connection/session.

authorizationContext - the AuthorizationContext of the connection/session.

namespaces - the namespaces for which the filter should be applied - if empty, all namespaces are considered.

filter - the filter string (RQL) to apply for event filtering or null if none should be applied.

Method Detail

getStreamingType

public StreamingType getStreamingType()

Returns:

the Streaming type of what streaming to start.

getConnectionCorrelationId

public String getConnectionCorrelationId()

getAuthorizationContext

public org.eclipse.ditto.model.base.auth.AuthorizationContext getAuthorizationContext()

getNamespaces

public List<String> getNamespaces()

Returns:

the List of namespaces for which Signals should be emitted to the stream

getFilter

public Optional<String> getFilter()

Returns:

the optional RQL filter to apply for events before publishing to the stream

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object