org.springframework.data.mongodb.core.messaging

Class ChangeStreamRequest<T>

java.lang.Object

org.springframework.data.mongodb.core.messaging.ChangeStreamRequest<T>

All Implemented Interfaces:

SubscriptionRequest<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,T,ChangeStreamRequest.ChangeStreamRequestOptions>

public class ChangeStreamRequest<T>
extends Object
implements SubscriptionRequest<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,T,ChangeStreamRequest.ChangeStreamRequestOptions>

SubscriptionRequest implementation to be used for listening to Change Streams via a MessageListenerContainer using the synchronous MongoDB Java driver.

The most trivial use case is subscribing to all events of a specific collection

 
     ChangeStreamRequest request = new ChangeStreamRequest<>(System.out::println, () -> "collection-name");
 
 

or MongoDatabase which receives events from all collections in that database.

 
     ChangeStreamRequest request = new ChangeStreamRequest<>(System.out::println, RequestOptions.justDatabase("test"));
 
 

For more advanced scenarios ChangeStreamOptions offers abstractions for options like filtering, resuming,...

 
     ChangeStreamOptions options = ChangeStreamOptions.builder()
         .filter(newAggregation(match(where("age").is(7))))
         .returnFullDocumentOnUpdate()
         .build();

     ChangeStreamRequest request = new ChangeStreamRequest<>(System.out::println, new ChangeStreamRequestOptions("collection-name", options));
 
 

ChangeStreamRequest.ChangeStreamRequestBuilder offers a fluent API for creating ChangeStreamRequest with ChangeStreamOptions in one go.

 
     ChangeStreamRequest request = ChangeStreamRequest.builder()
         .collection("collection-name")
         .publishTo(System.out::println)
         .filter(newAggregation(match(where("age").is(7))))
         .fullDocumentLookup(UPDATE_LOOKUP)
         .build();
 
 

Messges passed to the MessageListener contain the ChangeStreamDocument within their raw value while the fullDocument is extracted into the messages body. Unless otherwise specified (via ChangeStreamOptions.getFullDocumentLookup() the message body for update events will be empty for a Document target type. Message.getBody() Message bodies} that map to a different target type automatically enforce an FullDocument.UPDATE_LOOKUP.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChangeStreamRequest.ChangeStreamRequestBuilder<T> Builder for creating ChangeStreamRequest.
static class	ChangeStreamRequest.ChangeStreamRequestOptions SubscriptionRequest.RequestOptions implementation specific to a ChangeStreamRequest.

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.messaging.SubscriptionRequest

SubscriptionRequest.RequestOptions

Constructor Summary

Constructors

Constructor and Description
ChangeStreamRequest(MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> messageListener, SubscriptionRequest.RequestOptions options) Create a new ChangeStreamRequest with options, passing messages to the given MessageListener.

Method Summary

Modifier and Type	Method and Description
static ChangeStreamRequest.ChangeStreamRequestBuilder	builder() Obtain a shiny new ChangeStreamRequest.ChangeStreamRequestBuilder and start defining your ChangeStreamRequest in this fancy fluent way.
static <T> ChangeStreamRequest.ChangeStreamRequestBuilder<T>	builder(MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> listener) Obtain a shiny new ChangeStreamRequest.ChangeStreamRequestBuilder and start defining your ChangeStreamRequest in this fancy fluent way.
MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T>	getMessageListener() Obtain the MessageListener to publish messages to.
ChangeStreamRequest.ChangeStreamRequestOptions	getRequestOptions() Get the SubscriptionRequest.RequestOptions specifying the requests behaviour.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeStreamRequest

public ChangeStreamRequest(MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> messageListener,
                           SubscriptionRequest.RequestOptions options)

Create a new ChangeStreamRequest with options, passing messages to the given MessageListener.

Parameters:

messageListener - must not be null.

options - must not be null.

Method Detail

getMessageListener

public MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> getMessageListener()

Description copied from interface: SubscriptionRequest

Obtain the MessageListener to publish messages to.

Specified by:

getMessageListener in interface SubscriptionRequest<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,T,ChangeStreamRequest.ChangeStreamRequestOptions>

Returns:

never null.

getRequestOptions

public ChangeStreamRequest.ChangeStreamRequestOptions getRequestOptions()

Description copied from interface: SubscriptionRequest

Get the SubscriptionRequest.RequestOptions specifying the requests behaviour.

Specified by:

getRequestOptions in interface SubscriptionRequest<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,T,ChangeStreamRequest.ChangeStreamRequestOptions>

Returns:

never null.

builder

public static ChangeStreamRequest.ChangeStreamRequestBuilder builder()

Obtain a shiny new ChangeStreamRequest.ChangeStreamRequestBuilder and start defining your ChangeStreamRequest in this fancy fluent way. Just don't forget to call build() when your're done.

Returns:

new instance of ChangeStreamRequest.

builder

public static <T> ChangeStreamRequest.ChangeStreamRequestBuilder<T> builder(MessageListener<com.mongodb.client.model.changestream.ChangeStreamDocument<org.bson.Document>,? super T> listener)

Obtain a shiny new ChangeStreamRequest.ChangeStreamRequestBuilder and start defining your ChangeStreamRequest in this fancy fluent way. Just don't forget to call build() when your're done.

Returns:

new instance of ChangeStreamRequest.