org.springframework.data.mongodb.gridfs

Class ReactiveGridFsResource

java.lang.Object

org.springframework.data.mongodb.gridfs.ReactiveGridFsResource

All Implemented Interfaces:

GridFsObject<Object,org.reactivestreams.Publisher<DataBuffer>>

public class ReactiveGridFsResource
extends Object
implements GridFsObject<Object,org.reactivestreams.Publisher<DataBuffer>>

Reactive GridFSFile based Resource implementation. Note that the content can be consumed only once.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.mongodb.gridfs.GridFsObject

GridFsObject.Options

Constructor Summary

Constructors

Constructor and Description
ReactiveGridFsResource(Object id, String filename, GridFsObject.Options options, com.mongodb.reactivestreams.client.gridfs.GridFSDownloadPublisher downloadPublisher) Creates a new, absent ReactiveGridFsResource.
ReactiveGridFsResource(String filename, com.mongodb.reactivestreams.client.gridfs.GridFSDownloadPublisher downloadPublisher) Creates a new, absent ReactiveGridFsResource.

Method Summary

Modifier and Type	Method and Description
static ReactiveGridFsResource	absent(String filename) Obtain an absent ReactiveGridFsResource.
boolean	exists()
reactor.core.publisher.Flux<DataBuffer>	getContent() The actual file content.
reactor.core.publisher.Flux<DataBuffer>	getDownloadStream() Obtain the download stream emitting chunks of data as they come in.
reactor.core.publisher.Flux<DataBuffer>	getDownloadStream(int chunkSize) Obtain the download stream emitting chunks of data with given chunkSize as they come in.
Object	getFileId() The GridFSFile.getId() value converted into its simple java type.
String	getFilename() The filename.
reactor.core.publisher.Mono<com.mongodb.client.gridfs.model.GridFSFile>	getGridFSFile()
reactor.core.publisher.Mono<InputStream>	getInputStream() Obtain the data as InputStream.
GridFsObject.Options	getOptions() Additional information like file metadata (eg. contentType).

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveGridFsResource

public ReactiveGridFsResource(String filename,
                              @Nullable
                              com.mongodb.reactivestreams.client.gridfs.GridFSDownloadPublisher downloadPublisher)

Creates a new, absent ReactiveGridFsResource.

Parameters:

filename - filename of the absent resource.

downloadPublisher -

ReactiveGridFsResource

public ReactiveGridFsResource(@Nullable
                              Object id,
                              String filename,
                              GridFsObject.Options options,
                              @Nullable
                              com.mongodb.reactivestreams.client.gridfs.GridFSDownloadPublisher downloadPublisher)

Creates a new, absent ReactiveGridFsResource.

Parameters:

id -

filename - filename of the absent resource.

options -

downloadPublisher -

Since:

3.0

Method Detail

absent

public static ReactiveGridFsResource absent(String filename)

Obtain an absent ReactiveGridFsResource.

Parameters:

filename - filename of the absent resource, must not be null.

Returns:

never null.

Since:

2.1

getFileId

public Object getFileId()

Description copied from interface: GridFsObject

The GridFSFile.getId() value converted into its simple java type.
A BsonString will be converted to plain String.

Specified by:

getFileId in interface GridFsObject<Object,org.reactivestreams.Publisher<DataBuffer>>

Returns:

can be null depending on the implementation.

getFilename

public String getFilename()
                   throws IllegalStateException

Description copied from interface: GridFsObject

The filename.

Specified by:

getFilename in interface GridFsObject<Object,org.reactivestreams.Publisher<DataBuffer>>

Returns:

Throws:

IllegalStateException

See Also:

AbstractResource.getFilename()

getGridFSFile

public reactor.core.publisher.Mono<com.mongodb.client.gridfs.model.GridFSFile> getGridFSFile()

Returns:

the underlying GridFSFile. Can be null if absent.

Since:

2.2

getInputStream

public reactor.core.publisher.Mono<InputStream> getInputStream()
                                                        throws IllegalStateException

Obtain the data as InputStream.
NOTE Buffers data in memory. Use getDownloadStream() for large files.

Throws:

IllegalStateException - if the underlying Publisher has already been consumed.

Since:

3.0

See Also:

InputStreamResource.getInputStream(), getDownloadStream(), DataBufferUtils.join(Publisher)

getDownloadStream

public reactor.core.publisher.Flux<DataBuffer> getDownloadStream()

Obtain the download stream emitting chunks of data as they come in.

Returns:

Flux.empty() if the file does not exist.

Throws:

IllegalStateException - if the underlying Publisher has already been consumed.

Since:

3.0

See Also:

InputStreamResource.getInputStream(), getDownloadStream(), DataBufferUtils.join(Publisher)

getContent

public reactor.core.publisher.Flux<DataBuffer> getContent()

Description copied from interface: GridFsObject

The actual file content.

Specified by:

getContent in interface GridFsObject<Object,org.reactivestreams.Publisher<DataBuffer>>

Returns:

getOptions

public GridFsObject.Options getOptions()

Description copied from interface: GridFsObject

Additional information like file metadata (eg. contentType).

Specified by:

getOptions in interface GridFsObject<Object,org.reactivestreams.Publisher<DataBuffer>>

Returns:

never null.

getDownloadStream

public reactor.core.publisher.Flux<DataBuffer> getDownloadStream(int chunkSize)

Obtain the download stream emitting chunks of data with given chunkSize as they come in.

Parameters:

chunkSize - the preferred number of bytes per emitted DataBuffer.

Returns:

Flux.empty() if the file does not exist.

Throws:

IllegalStateException - if the underlying Publisher has already been consumed.

Since:

3.0

See Also:

InputStreamResource.getInputStream(), getDownloadStream(), DataBufferUtils.join(Publisher)

exists

public boolean exists()