org.springframework.data.mongodb.gridfs

Class ReactiveGridFsResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.data.mongodb.gridfs.ReactiveGridFsResource

All Implemented Interfaces:

InputStreamSource, Resource

public class ReactiveGridFsResource
extends AbstractResource

Reactive GridFSFile based Resource implementation.

Since:

2.2

Author:

Mark Paluch, Christoph Strobl

Constructor Summary

Constructors

Constructor and Description
ReactiveGridFsResource(com.mongodb.client.gridfs.model.GridFSFile file, org.reactivestreams.Publisher<DataBuffer> content) Creates a new ReactiveGridFsResource from the given GridFSFile.

Method Summary

Modifier and Type	Method and Description
static ReactiveGridFsResource	absent(String filename) Obtain an absent ReactiveGridFsResource.
long	contentLength()
boolean	exists()
String	getDescription()
reactor.core.publisher.Flux<DataBuffer>	getDownloadStream() Retrieve the download stream using the default chunk size of 256 kB.
reactor.core.publisher.Flux<DataBuffer>	getDownloadStream(int chunkSize) Retrieve the download stream.
String	getFilename()
com.mongodb.client.gridfs.model.GridFSFile	getGridFSFile()
Object	getId() Returns the Resource's id.
InputStream	getInputStream()
long	lastModified()

Methods inherited from class org.springframework.core.io.AbstractResource

createRelative, equals, getFile, getFileForLastModifiedCheck, getURI, getURL, hashCode, isFile, isOpen, isReadable, readableChannel, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveGridFsResource

public ReactiveGridFsResource(com.mongodb.client.gridfs.model.GridFSFile file,
                              org.reactivestreams.Publisher<DataBuffer> content)

Creates a new ReactiveGridFsResource from the given GridFSFile.

Parameters:

file - must not be null.

content -

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

getInputStream

public InputStream getInputStream()
                           throws IllegalStateException

Throws:

IllegalStateException

contentLength

public long contentLength()
                   throws IOException

Specified by:

contentLength in interface Resource

Overrides:

contentLength in class AbstractResource

Throws:

IOException

getFilename

public String getFilename()
                   throws IllegalStateException

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

Throws:

IllegalStateException

exists

public boolean exists()

Specified by:

exists in interface Resource

Overrides:

exists in class AbstractResource

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Overrides:

lastModified in class AbstractResource

Throws:

IOException

getDescription

public String getDescription()

getId

public Object getId()

Returns the Resource's id.

Returns:

never null.

Throws:

IllegalStateException - if the file does not exists().

getGridFSFile

@Nullable
public com.mongodb.client.gridfs.model.GridFSFile getGridFSFile()

Returns:

the underlying GridFSFile. Can be null if absent.

Since:

2.2

getDownloadStream

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

Retrieve the download stream using the default chunk size of 256 kB.

Returns:

a Flux emitting data chunks one by one. Please make sure to release all buffers when done.

getDownloadStream

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

Retrieve the download stream.

Parameters:

chunkSize - chunk size in bytes to use.

Returns:

a Flux emitting data chunks one by one. Please make sure to release all buffers when done.

Since:

2.2.1