Package org.springframework.data.mongodb.gridfs

Class ReactiveGridFsTemplate

java.lang.Object

org.springframework.data.mongodb.gridfs.ReactiveGridFsTemplate

All Implemented Interfaces:

ReactiveGridFsOperations

public class ReactiveGridFsTemplate
extends Object
implements ReactiveGridFsOperations

ReactiveGridFsOperations implementation to store content into MongoDB GridFS. Uses by default DefaultDataBufferFactory to create buffers.

Since:

2.2

Author:

Mark Paluch, Nick Stolwijk, Denis Zavedeev, Christoph Strobl, Mathieu Ouellet

Constructor Summary

Constructors

Constructor	Description
ReactiveGridFsTemplate(DataBufferFactory dataBufferFactory, ReactiveMongoDatabaseFactory dbFactory, MongoConverter converter, String bucket)	Creates a new ReactiveGridFsTemplate using the given DataBufferFactory, ReactiveMongoDatabaseFactory and MongoConverter.
ReactiveGridFsTemplate(MongoConverter converter, Mono<com.mongodb.reactivestreams.client.gridfs.GridFSBucket> gridFSBucket, DataBufferFactory dataBufferFactory)	Creates a new ReactiveGridFsTemplate using the given MongoConverter, Mono emitting a ReactiveMongoDatabaseFactory and DataBufferFactory.
ReactiveGridFsTemplate(ReactiveMongoDatabaseFactory dbFactory, MongoConverter converter)	Creates a new ReactiveGridFsTemplate using the given ReactiveMongoDatabaseFactory and MongoConverter.
ReactiveGridFsTemplate(ReactiveMongoDatabaseFactory dbFactory, MongoConverter converter, String bucket)	Creates a new ReactiveGridFsTemplate using the given ReactiveMongoDatabaseFactory and MongoConverter.

Method Summary

Modifier and Type	Method	Description
protected com.mongodb.client.gridfs.model.GridFSUploadOptions	computeUploadOptionsFor(String contentType, org.bson.Document metadata)	Compute the GridFSUploadOptions to be used from the given contentType and metadata Document.
<T> Flux<T>	createFlux(org.springframework.data.mongodb.gridfs.ReactiveGridFsTemplate.ReactiveBucketCallback<T> callback)	Create a reusable Flux for a ReactiveGridFsTemplate.ReactiveBucketCallback.
<T> Mono<T>	createMono(org.springframework.data.mongodb.gridfs.ReactiveGridFsTemplate.ReactiveBucketCallback<T> callback)	Create a reusable Mono for a ReactiveGridFsTemplate.ReactiveBucketCallback.
Mono<Void>	delete(Query query)	Deletes all files matching the given Query.
protected Mono<com.mongodb.reactivestreams.client.gridfs.GridFSBucket>	doGetBucket()
Flux<com.mongodb.client.gridfs.model.GridFSFile>	find(Query query)	Returns a Flux emitting all files matching the given query.
Mono<com.mongodb.client.gridfs.model.GridFSFile>	findFirst(Query query)	Returns a Mono emitting the frist GridFSFile matching the given query or Mono.empty() in case no file matches.
Mono<com.mongodb.client.gridfs.model.GridFSFile>	findOne(Query query)	Returns a Mono emitting a single GridFSFile matching the given query or Mono.empty() in case no file matches.
protected org.bson.Document	getMappedQuery(org.bson.Document query)
Mono<ReactiveGridFsResource>	getResource(com.mongodb.client.gridfs.model.GridFSFile file)	Returns a Mono emitting the ReactiveGridFsResource for a GridFSFile.
Mono<ReactiveGridFsResource>	getResource(String location)	Returns a Mono emitting the ReactiveGridFsResource with the given file name.
Flux<ReactiveGridFsResource>	getResources(String locationPattern)	Returns a Flux emitting all ReactiveGridFsResources matching the given file name pattern.
Mono<org.bson.types.ObjectId>	store(Publisher<DataBuffer> content, String filename, String contentType, Object metadata)	Stores the given content into a file with the given name and content type using the given metadata.
<T> Mono<T>	store(GridFsObject<T,Publisher<DataBuffer>> upload)	Stores the given GridFsObject, likely a GridFsUpload, into into a file with given name.
protected org.bson.Document	toDocument(Object value)	Convert a given value into a Document.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.gridfs.ReactiveGridFsOperations

store, store, store, store, store, store, store

Constructor Details

ReactiveGridFsTemplate

public ReactiveGridFsTemplate(ReactiveMongoDatabaseFactory dbFactory,
 MongoConverter converter)

Creates a new ReactiveGridFsTemplate using the given ReactiveMongoDatabaseFactory and MongoConverter.

Note that the GridFSBucket is obtained only once from MongoDatabase. Use ReactiveGridFsTemplate(MongoConverter, Mono, DataBufferFactory) if you want to use different buckets from the same Template instance.

Parameters:

dbFactory - must not be null.

converter - must not be null.

ReactiveGridFsTemplate

public ReactiveGridFsTemplate(ReactiveMongoDatabaseFactory dbFactory,
 MongoConverter converter,
 @Nullable
 String bucket)

Creates a new ReactiveGridFsTemplate using the given ReactiveMongoDatabaseFactory and MongoConverter.

Note that the GridFSBucket is obtained only once from MongoDatabase. Use ReactiveGridFsTemplate(MongoConverter, Mono, DataBufferFactory) if you want to use different buckets from the same Template instance.

Parameters:

dbFactory - must not be null.

converter - must not be null.

bucket - can be null.

ReactiveGridFsTemplate

public ReactiveGridFsTemplate(DataBufferFactory dataBufferFactory,
 ReactiveMongoDatabaseFactory dbFactory,
 MongoConverter converter,
 @Nullable
 String bucket)

Creates a new ReactiveGridFsTemplate using the given DataBufferFactory, ReactiveMongoDatabaseFactory and MongoConverter.

Note that the GridFSBucket is obtained only once from MongoDatabase. Use ReactiveGridFsTemplate(MongoConverter, Mono, DataBufferFactory) if you want to use different buckets from the same Template instance.

Parameters:

dataBufferFactory - must not be null.

dbFactory - must not be null.

converter - must not be null.

bucket - can be null.

ReactiveGridFsTemplate

public ReactiveGridFsTemplate(MongoConverter converter,
 Mono<com.mongodb.reactivestreams.client.gridfs.GridFSBucket> gridFSBucket,
 DataBufferFactory dataBufferFactory)

Creates a new ReactiveGridFsTemplate using the given MongoConverter, Mono emitting a ReactiveMongoDatabaseFactory and DataBufferFactory.

Parameters:

converter - must not be null.

gridFSBucket - must not be null.

dataBufferFactory - must not be null.

Since:

4.2

Method Details

store

public Mono<org.bson.types.ObjectId> store(Publisher<DataBuffer> content,
 @Nullable
 String filename,
 @Nullable
 String contentType,
 @Nullable
 Object metadata)

Description copied from interface: ReactiveGridFsOperations

Stores the given content into a file with the given name and content type using the given metadata. The metadata object will be marshalled before writing.

Specified by:

store in interface ReactiveGridFsOperations

Parameters:

content - must not be null.

filename - must not be null or empty.

contentType - can be null.

metadata - can be null

Returns:

a Mono emitting the ObjectId of the GridFSFile just created.

store

public <T> Mono<T> store(GridFsObject<T,Publisher<DataBuffer>> upload)

Description copied from interface: ReactiveGridFsOperations

Stores the given GridFsObject, likely a GridFsUpload, into into a file with given name. If the GridFsObject.getFileId() is set, the file will be stored with that id, otherwise the server auto creates a new id.

Specified by:

store in interface ReactiveGridFsOperations

Type Parameters:

T - id type of the underlying GridFSFile

Parameters:

upload - the GridFsObject (most likely a GridFsUpload) to be stored.

Returns:

Mono emitting the id of the stored file which is either an auto created value or GridFsObject.getFileId().

find

public Flux<com.mongodb.client.gridfs.model.GridFSFile> find(Query query)

Description copied from interface: ReactiveGridFsOperations

Returns a Flux emitting all files matching the given query.
NOTE: Currently Sort criteria defined at the Query will not be regarded as MongoDB does not support ordering for GridFS file access.

Specified by:

find in interface ReactiveGridFsOperations

Parameters:

query - must not be null.

Returns:

Flux.empty() if no mach found.

See Also:

• MongoDB Jira: JAVA-431

findOne

public Mono<com.mongodb.client.gridfs.model.GridFSFile> findOne(Query query)

Description copied from interface: ReactiveGridFsOperations

Returns a Mono emitting a single GridFSFile matching the given query or Mono.empty() in case no file matches.
NOTE: If more than one file matches the given query the resulting Mono emits an error. If you want to obtain the first found file use ReactiveGridFsOperations.findFirst(Query).

Specified by:

findOne in interface ReactiveGridFsOperations

Parameters:

query - must not be null.

Returns:

Mono.empty() if not match found.

findFirst

public Mono<com.mongodb.client.gridfs.model.GridFSFile> findFirst(Query query)

Description copied from interface: ReactiveGridFsOperations

Returns a Mono emitting the frist GridFSFile matching the given query or Mono.empty() in case no file matches.

Specified by:

findFirst in interface ReactiveGridFsOperations

Parameters:

query - must not be null.

Returns:

Mono.empty() if not match found.

delete

public Mono<Void> delete(Query query)

Description copied from interface: ReactiveGridFsOperations

Deletes all files matching the given Query.

Specified by:

delete in interface ReactiveGridFsOperations

Parameters:

query - must not be null.

Returns:

a Mono signalling operation completion.

getResource

public Mono<ReactiveGridFsResource> getResource(String location)

Description copied from interface: ReactiveGridFsOperations

Returns a Mono emitting the ReactiveGridFsResource with the given file name.

Specified by:

getResource in interface ReactiveGridFsOperations

Parameters:

location - must not be null.

Returns:

Mono.empty() if no match found.

getResource

public Mono<ReactiveGridFsResource> getResource(com.mongodb.client.gridfs.model.GridFSFile file)

Description copied from interface: ReactiveGridFsOperations

Returns a Mono emitting the ReactiveGridFsResource for a GridFSFile.

Specified by:

getResource in interface ReactiveGridFsOperations

Parameters:

file - must not be null.

Returns:

Mono.empty() if no match found.

getResources

public Flux<ReactiveGridFsResource> getResources(String locationPattern)

Description copied from interface: ReactiveGridFsOperations

Returns a Flux emitting all ReactiveGridFsResources matching the given file name pattern.

Specified by:

getResources in interface ReactiveGridFsOperations

Parameters:

locationPattern - must not be null.

Returns:

Flux.empty() if no match found.

createMono

public <T> Mono<T> createMono(org.springframework.data.mongodb.gridfs.ReactiveGridFsTemplate.ReactiveBucketCallback<T> callback)

Create a reusable Mono for a ReactiveGridFsTemplate.ReactiveBucketCallback. It's up to the developer to choose to obtain a new Flux or to reuse the Flux.

Parameters:

callback - must not be null

Returns:

a Mono wrapping the ReactiveGridFsTemplate.ReactiveBucketCallback.

createFlux

public <T> Flux<T> createFlux(org.springframework.data.mongodb.gridfs.ReactiveGridFsTemplate.ReactiveBucketCallback<T> callback)

Create a reusable Flux for a ReactiveGridFsTemplate.ReactiveBucketCallback. It's up to the developer to choose to obtain a new Flux or to reuse the Flux.

Parameters:

callback - must not be null

Returns:

a Flux wrapping the ReactiveGridFsTemplate.ReactiveBucketCallback.

doGetBucket

protected Mono<com.mongodb.reactivestreams.client.gridfs.GridFSBucket> doGetBucket()

getMappedQuery

protected org.bson.Document getMappedQuery(org.bson.Document query)

Parameters:

query - pass the given query though a QueryMapper to apply type conversion.

Returns:

never null.

computeUploadOptionsFor

protected com.mongodb.client.gridfs.model.GridFSUploadOptions computeUploadOptionsFor(@Nullable
 String contentType,
 @Nullable
 org.bson.Document metadata)

Compute the GridFSUploadOptions to be used from the given contentType and metadata Document.

Parameters:

contentType - can be null.

metadata - can be null

Returns:

never null.

toDocument

protected org.bson.Document toDocument(@Nullable
 Object value)

Convert a given value into a Document.

Parameters:

value - can be null.

Returns:

an empty Document if the source value is null.