Package org.springframework.data.mongodb.gridfs

Class GridFsResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.core.io.InputStreamResource

org.springframework.data.mongodb.gridfs.GridFsResource

All Implemented Interfaces:

InputStreamSource, Resource, GridFsObject<Object,InputStream>

public class GridFsResource
extends InputStreamResource
implements GridFsObject<Object,InputStream>

GridFSFile based Resource implementation.

Author:

Oliver Gierke, Christoph Strobl, Hartmut Lang, Mark Paluch

Nested Class Summary

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

GridFsObject.Options

Constructor Summary

Constructors

Constructor	Description
GridFsResource(com.mongodb.client.gridfs.model.GridFSFile file)	Creates a new GridFsResource from the given GridFSFile.
GridFsResource(com.mongodb.client.gridfs.model.GridFSFile file, InputStream inputStream)	Creates a new GridFsResource from the given GridFSFile and InputStream.

Method Summary

Modifier and Type	Method	Description
static GridFsResource	absent(String filename)	Obtain an absent GridFsResource.
long	contentLength()
boolean	exists()
InputStream	getContent()	The actual file content.
String	getContentType()	Returns the Resource's content type.
String	getDescription()
Object	getFileId()	The GridFSFile.getId() value converted into its simple java type.
String	getFilename()	The filename.
com.mongodb.client.gridfs.model.GridFSFile	getGridFSFile()
Object	getId()	Returns the Resource's id.
InputStream	getInputStream()
GridFsObject.Options	getOptions()	Additional information like file metadata (eg. contentType).
long	lastModified()

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

equals, hashCode, isOpen

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

createRelative, getFile, getFileForLastModifiedCheck, getURI, getURL, isFile, isReadable, readableChannel, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.io.Resource

getContentAsByteArray, getContentAsString

Constructor Details

GridFsResource

public GridFsResource(com.mongodb.client.gridfs.model.GridFSFile file)

Creates a new GridFsResource from the given GridFSFile.

Parameters:

file - must not be null.

GridFsResource

public GridFsResource(com.mongodb.client.gridfs.model.GridFSFile file,
 InputStream inputStream)

Creates a new GridFsResource from the given GridFSFile and InputStream.

Parameters:

file - must not be null.

inputStream - must not be null.

Method Details

absent

public static GridFsResource absent(String filename)

Obtain an absent GridFsResource.

Parameters:

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

Returns:

never null.

Since:

2.1

getInputStream

public InputStream getInputStream()
                           throws IOException,
IllegalStateException

Specified by:

getInputStream in interface InputStreamSource

Overrides:

getInputStream in class InputStreamResource

Throws:

IOException

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

Description copied from interface: GridFsObject

The filename.

Specified by:

getFilename in interface GridFsObject<Object,InputStream>

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 InputStreamResource

lastModified

public long lastModified()
                  throws IOException

Specified by:

lastModified in interface Resource

Overrides:

lastModified in class AbstractResource

Throws:

IOException

getDescription

public String getDescription()

Specified by:

getDescription in interface Resource

Overrides:

getDescription in class InputStreamResource

getId

public Object getId()

Returns the Resource's id.

Returns:

never null.

Throws:

IllegalStateException - if the file does not exists().

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,InputStream>

Returns:

can be null depending on the implementation.

getGridFSFile

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

Returns:

the underlying GridFSFile. Can be null if absent.

Since:

2.2

getContentType

public String getContentType()

Returns the Resource's content type.

Returns:

never null.

Throws:

com.mongodb.MongoGridFSException - in case no content type declared on GridFSFile.getMetadata() nor provided via GridFSFile.

IllegalStateException - if the file does not exists().

getContent

public InputStream getContent()

Description copied from interface: GridFsObject

The actual file content.

Specified by:

getContent in interface GridFsObject<Object,InputStream>

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,InputStream>

Returns:

never null.