com.mongodb.client.gridfs

Class GridFSBucketImpl

java.lang.Object

com.mongodb.client.gridfs.GridFSBucketImpl

All Implemented Interfaces:

GridFSBucket

final class GridFSBucketImpl
extends java.lang.Object
implements GridFSBucket

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	bucketName
private boolean	checkedIndexes
private MongoCollection<Document>	chunksCollection
private int	chunkSizeBytes
private static int	DEFAULT_CHUNKSIZE_BYTES
private MongoCollection<GridFSFile>	filesCollection

Constructor Summary

Constructors

Constructor and Description
GridFSBucketImpl(MongoDatabase database)
GridFSBucketImpl(MongoDatabase database, java.lang.String bucketName)
GridFSBucketImpl(java.lang.String bucketName, int chunkSizeBytes, MongoCollection<GridFSFile> filesCollection, MongoCollection<Document> chunksCollection)

Method Summary

Modifier and Type	Method and Description
private void	checkCreateIndex()
void	delete(BsonValue id) Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
void	delete(ObjectId id) Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.
void	downloadToStream(BsonValue id, java.io.OutputStream destination) Downloads the contents of the stored file specified by id and writes the contents to the destination Stream.
private void	downloadToStream(GridFSDownloadStream downloadStream, java.io.OutputStream destination)
void	downloadToStream(ObjectId id, java.io.OutputStream destination) Downloads the contents of the stored file specified by id and writes the contents to the destination Stream.
void	downloadToStream(java.lang.String filename, java.io.OutputStream destination) Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.
void	downloadToStream(java.lang.String filename, java.io.OutputStream destination, GridFSDownloadOptions options) Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination Stream.
void	downloadToStreamByName(java.lang.String filename, java.io.OutputStream destination) Deprecated.
void	downloadToStreamByName(java.lang.String filename, java.io.OutputStream destination, GridFSDownloadByNameOptions options) Deprecated.
void	drop() Drops the data associated with this bucket from the database.
GridFSFindIterable	find() Finds all documents in the files collection.
GridFSFindIterable	find(Bson filter) Finds all documents in the collection that match the filter.
private GridFSDownloadStream	findTheFileInfoAndOpenDownloadStream(BsonValue id)
java.lang.String	getBucketName() The bucket name.
private static MongoCollection<Document>	getChunksCollection(MongoDatabase database, java.lang.String bucketName)
int	getChunkSizeBytes() Sets the chunk size in bytes.
private GridFSFile	getFileByName(java.lang.String filename, GridFSDownloadOptions options)
private static MongoCollection<GridFSFile>	getFilesCollection(MongoDatabase database, java.lang.String bucketName)
ReadConcern	getReadConcern() Get the read concern for the GridFSBucket.
ReadPreference	getReadPreference() Get the read preference for the GridFSBucket.
WriteConcern	getWriteConcern() Get the write concern for the GridFSBucket.
private <T> boolean	hasIndex(MongoCollection<T> collection, Document index)
GridFSDownloadStream	openDownloadStream(BsonValue id) Opens a Stream from which the application can read the contents of the stored file specified by id.
GridFSDownloadStream	openDownloadStream(ObjectId id) Opens a Stream from which the application can read the contents of the stored file specified by id.
GridFSDownloadStream	openDownloadStream(java.lang.String filename) Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the filename.
GridFSDownloadStream	openDownloadStream(java.lang.String filename, GridFSDownloadOptions options) Opens a Stream from which the application can read the contents of the stored file specified by filename and the revision in options.
GridFSDownloadStream	openDownloadStreamByName(java.lang.String filename) Deprecated.
GridFSDownloadStream	openDownloadStreamByName(java.lang.String filename, GridFSDownloadByNameOptions options) Deprecated.
GridFSUploadStream	openUploadStream(BsonValue id, java.lang.String filename) Opens a Stream that the application can write the contents of the file to.
GridFSUploadStream	openUploadStream(BsonValue id, java.lang.String filename, GridFSUploadOptions options) Opens a Stream that the application can write the contents of the file to.
GridFSUploadStream	openUploadStream(java.lang.String filename) Opens a Stream that the application can write the contents of the file to.
GridFSUploadStream	openUploadStream(java.lang.String filename, GridFSUploadOptions options) Opens a Stream that the application can write the contents of the file to.
void	rename(BsonValue id, java.lang.String newFilename) Renames the stored file with the specified id.
void	rename(ObjectId id, java.lang.String newFilename) Renames the stored file with the specified id.
void	uploadFromStream(BsonValue id, java.lang.String filename, java.io.InputStream source) Uploads the contents of the given InputStream to a GridFS bucket.
void	uploadFromStream(BsonValue id, java.lang.String filename, java.io.InputStream source, GridFSUploadOptions options) Uploads the contents of the given InputStream to a GridFS bucket.
ObjectId	uploadFromStream(java.lang.String filename, java.io.InputStream source) Uploads the contents of the given InputStream to a GridFS bucket.
ObjectId	uploadFromStream(java.lang.String filename, java.io.InputStream source, GridFSUploadOptions options) Uploads the contents of the given InputStream to a GridFS bucket.
GridFSBucket	withChunkSizeBytes(int chunkSizeBytes) Create a new GridFSBucket instance with a new chunk size in bytes.
GridFSBucket	withReadConcern(ReadConcern readConcern) Create a new GridFSBucket instance with a different read concern.
GridFSBucket	withReadPreference(ReadPreference readPreference) Create a new GridFSBucket instance with a different read preference.
GridFSBucket	withWriteConcern(WriteConcern writeConcern) Create a new GridFSBucket instance with a different write concern.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHUNKSIZE_BYTES

private static final int DEFAULT_CHUNKSIZE_BYTES

See Also:

Constant Field Values

bucketName

private final java.lang.String bucketName

chunkSizeBytes

private final int chunkSizeBytes

filesCollection

private final MongoCollection<GridFSFile> filesCollection

chunksCollection

private final MongoCollection<Document> chunksCollection

checkedIndexes

private volatile boolean checkedIndexes

Constructor Detail

GridFSBucketImpl

GridFSBucketImpl(MongoDatabase database)

GridFSBucketImpl

GridFSBucketImpl(MongoDatabase database,
                 java.lang.String bucketName)

GridFSBucketImpl

GridFSBucketImpl(java.lang.String bucketName,
                 int chunkSizeBytes,
                 MongoCollection<GridFSFile> filesCollection,
                 MongoCollection<Document> chunksCollection)

Method Detail

getBucketName

public java.lang.String getBucketName()

Description copied from interface: GridFSBucket

The bucket name.

Specified by:

getBucketName in interface GridFSBucket

Returns:

the bucket name

getChunkSizeBytes

public int getChunkSizeBytes()

Description copied from interface: GridFSBucket

Sets the chunk size in bytes. Defaults to 255.

Specified by:

getChunkSizeBytes in interface GridFSBucket

Returns:

the chunk size in bytes.

getReadPreference

public ReadPreference getReadPreference()

Description copied from interface: GridFSBucket

Get the read preference for the GridFSBucket.

Specified by:

getReadPreference in interface GridFSBucket

Returns:

the ReadPreference

getWriteConcern

public WriteConcern getWriteConcern()

Description copied from interface: GridFSBucket

Get the write concern for the GridFSBucket.

Specified by:

getWriteConcern in interface GridFSBucket

Returns:

the WriteConcern

getReadConcern

public ReadConcern getReadConcern()

Description copied from interface: GridFSBucket

Get the read concern for the GridFSBucket.

Specified by:

getReadConcern in interface GridFSBucket

Returns:

the ReadConcern

withChunkSizeBytes

public GridFSBucket withChunkSizeBytes(int chunkSizeBytes)

Description copied from interface: GridFSBucket

Create a new GridFSBucket instance with a new chunk size in bytes.

Specified by:

withChunkSizeBytes in interface GridFSBucket

Parameters:

chunkSizeBytes - the new chunk size in bytes.

Returns:

a new GridFSBucket instance with the different chunk size in bytes

withReadPreference

public GridFSBucket withReadPreference(ReadPreference readPreference)

Description copied from interface: GridFSBucket

Create a new GridFSBucket instance with a different read preference.

Specified by:

withReadPreference in interface GridFSBucket

Parameters:

readPreference - the new ReadPreference for the GridFSBucket

Returns:

a new GridFSBucket instance with the different readPreference

withWriteConcern

public GridFSBucket withWriteConcern(WriteConcern writeConcern)

Description copied from interface: GridFSBucket

Create a new GridFSBucket instance with a different write concern.

Specified by:

withWriteConcern in interface GridFSBucket

Parameters:

writeConcern - the new WriteConcern for the GridFSBucket

Returns:

a new GridFSBucket instance with the different writeConcern

withReadConcern

public GridFSBucket withReadConcern(ReadConcern readConcern)

Description copied from interface: GridFSBucket

Create a new GridFSBucket instance with a different read concern.

Specified by:

withReadConcern in interface GridFSBucket

Parameters:

readConcern - the new ReadConcern for the GridFSBucket

Returns:

a new GridFSBucket instance with the different ReadConcern

openUploadStream

public GridFSUploadStream openUploadStream(java.lang.String filename)

Description copied from interface: GridFSBucket

Opens a Stream that the application can write the contents of the file to.

As the application writes the contents to the returned Stream, the contents are uploaded as chunks in the chunks collection. When the application signals it is done writing the contents of the file by calling close on the returned Stream, a files collection document is created in the files collection.

Specified by:

openUploadStream in interface GridFSBucket

Parameters:

filename - the filename for the stream

Returns:

the GridFSUploadStream that provides the ObjectId for the file to be uploaded and the Stream to which the application will write the contents.

openUploadStream

public GridFSUploadStream openUploadStream(java.lang.String filename,
                                           GridFSUploadOptions options)

Description copied from interface: GridFSBucket

Opens a Stream that the application can write the contents of the file to.

As the application writes the contents to the returned Stream, the contents are uploaded as chunks in the chunks collection. When the application signals it is done writing the contents of the file by calling close on the returned Stream, a files collection document is created in the files collection.

Specified by:

openUploadStream in interface GridFSBucket

Parameters:

filename - the filename for the stream

options - the GridFSUploadOptions

Returns:

the GridFSUploadStream that provides the ObjectId for the file to be uploaded and the Stream to which the application will write the contents.

openUploadStream

public GridFSUploadStream openUploadStream(BsonValue id,
                                           java.lang.String filename)

Description copied from interface: GridFSBucket

Opens a Stream that the application can write the contents of the file to.

As the application writes the contents to the returned Stream, the contents are uploaded as chunks in the chunks collection. When the application signals it is done writing the contents of the file by calling close on the returned Stream, a files collection document is created in the files collection.

Specified by:

openUploadStream in interface GridFSBucket

Parameters:

id - the custom id value of the file

filename - the filename for the stream

Returns:

the GridFSUploadStream that provides the ObjectId for the file to be uploaded and the Stream to which the application will write the contents.

openUploadStream

public GridFSUploadStream openUploadStream(BsonValue id,
                                           java.lang.String filename,
                                           GridFSUploadOptions options)

Description copied from interface: GridFSBucket

Opens a Stream that the application can write the contents of the file to.

As the application writes the contents to the returned Stream, the contents are uploaded as chunks in the chunks collection. When the application signals it is done writing the contents of the file by calling close on the returned Stream, a files collection document is created in the files collection.

Specified by:

openUploadStream in interface GridFSBucket

Parameters:

id - the custom id value of the file

filename - the filename for the stream

options - the GridFSUploadOptions

Returns:

the GridFSUploadStream that includes the _id for the file to be uploaded and the Stream to which the application will write the contents.

uploadFromStream

public ObjectId uploadFromStream(java.lang.String filename,
                                 java.io.InputStream source)

Description copied from interface: GridFSBucket

Uploads the contents of the given InputStream to a GridFS bucket.

Reads the contents of the user file from the Stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

Specified by:

uploadFromStream in interface GridFSBucket

Parameters:

filename - the filename for the stream

source - the Stream providing the file data

Returns:

the ObjectId of the uploaded file.

uploadFromStream

public ObjectId uploadFromStream(java.lang.String filename,
                                 java.io.InputStream source,
                                 GridFSUploadOptions options)

Description copied from interface: GridFSBucket

Uploads the contents of the given InputStream to a GridFS bucket.

Reads the contents of the user file from the Stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

Specified by:

uploadFromStream in interface GridFSBucket

Parameters:

filename - the filename for the stream

source - the Stream providing the file data

options - the GridFSUploadOptions

Returns:

the ObjectId of the uploaded file.

uploadFromStream

public void uploadFromStream(BsonValue id,
                             java.lang.String filename,
                             java.io.InputStream source)

Description copied from interface: GridFSBucket

Uploads the contents of the given InputStream to a GridFS bucket.

Reads the contents of the user file from the Stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

Specified by:

uploadFromStream in interface GridFSBucket

Parameters:

id - the custom id value of the file

filename - the filename for the stream

source - the Stream providing the file data

uploadFromStream

public void uploadFromStream(BsonValue id,
                             java.lang.String filename,
                             java.io.InputStream source,
                             GridFSUploadOptions options)

Description copied from interface: GridFSBucket

Uploads the contents of the given InputStream to a GridFS bucket.

Reads the contents of the user file from the Stream and uploads it as chunks in the chunks collection. After all the chunks have been uploaded, it creates a files collection document for filename in the files collection.

Specified by:

uploadFromStream in interface GridFSBucket

Parameters:

id - the custom id value of the file

filename - the filename for the stream

source - the Stream providing the file data

options - the GridFSUploadOptions

openDownloadStream

public GridFSDownloadStream openDownloadStream(ObjectId id)

Description copied from interface: GridFSBucket

Opens a Stream from which the application can read the contents of the stored file specified by id.

Specified by:

openDownloadStream in interface GridFSBucket

Parameters:

id - the ObjectId of the file to be put into a stream.

Returns:

the stream

downloadToStream

public void downloadToStream(ObjectId id,
                             java.io.OutputStream destination)

Description copied from interface: GridFSBucket

Downloads the contents of the stored file specified by id and writes the contents to the destination Stream.

Specified by:

downloadToStream in interface GridFSBucket

Parameters:

id - the ObjectId of the file to be written to the destination stream

destination - the destination stream

downloadToStream

public void downloadToStream(BsonValue id,
                             java.io.OutputStream destination)

Description copied from interface: GridFSBucket

Downloads the contents of the stored file specified by id and writes the contents to the destination Stream.

Specified by:

downloadToStream in interface GridFSBucket

Parameters:

id - the custom id of the file, to be written to the destination stream

destination - the destination stream

downloadToStream

public void downloadToStream(java.lang.String filename,
                             java.io.OutputStream destination)

Description copied from interface: GridFSBucket

Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.

Specified by:

downloadToStream in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

destination - the destination stream

downloadToStream

public void downloadToStream(java.lang.String filename,
                             java.io.OutputStream destination,
                             GridFSDownloadOptions options)

Description copied from interface: GridFSBucket

Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination Stream.

Specified by:

downloadToStream in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

destination - the destination stream

options - the download options

openDownloadStream

public GridFSDownloadStream openDownloadStream(BsonValue id)

Description copied from interface: GridFSBucket

Opens a Stream from which the application can read the contents of the stored file specified by id.

Specified by:

openDownloadStream in interface GridFSBucket

Parameters:

id - the custom id value of the file, to be put into a stream.

Returns:

the stream

openDownloadStream

public GridFSDownloadStream openDownloadStream(java.lang.String filename)

Description copied from interface: GridFSBucket

Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the filename.

Specified by:

openDownloadStream in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

Returns:

the stream

openDownloadStream

public GridFSDownloadStream openDownloadStream(java.lang.String filename,
                                               GridFSDownloadOptions options)

Description copied from interface: GridFSBucket

Opens a Stream from which the application can read the contents of the stored file specified by filename and the revision in options.

Specified by:

openDownloadStream in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

options - the download options

Returns:

the stream

find

public GridFSFindIterable find()

Description copied from interface: GridFSBucket

Finds all documents in the files collection.

Specified by:

find in interface GridFSBucket

Returns:

the GridFS find iterable interface

find

public GridFSFindIterable find(Bson filter)

Description copied from interface: GridFSBucket

Finds all documents in the collection that match the filter.

Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data:

  
      Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
  
  

Specified by:

find in interface GridFSBucket

Parameters:

filter - the query filter

Returns:

the GridFS find iterable interface

See Also:

Filters

delete

public void delete(ObjectId id)

Description copied from interface: GridFSBucket

Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.

Specified by:

delete in interface GridFSBucket

Parameters:

id - the ObjectId of the file to be deleted

delete

public void delete(BsonValue id)

Description copied from interface: GridFSBucket

Given a id, delete this stored file's files collection document and associated chunks from a GridFS bucket.

Specified by:

delete in interface GridFSBucket

Parameters:

id - the id of the file to be deleted

rename

public void rename(ObjectId id,
                   java.lang.String newFilename)

Description copied from interface: GridFSBucket

Renames the stored file with the specified id.

Specified by:

rename in interface GridFSBucket

Parameters:

id - the id of the file in the files collection to rename

newFilename - the new filename for the file

rename

public void rename(BsonValue id,
                   java.lang.String newFilename)

Description copied from interface: GridFSBucket

Renames the stored file with the specified id.

Specified by:

rename in interface GridFSBucket

Parameters:

id - the id of the file in the files collection to rename

newFilename - the new filename for the file

drop

public void drop()

Description copied from interface: GridFSBucket

Drops the data associated with this bucket from the database.

Specified by:

drop in interface GridFSBucket

openDownloadStreamByName

@Deprecated
public GridFSDownloadStream openDownloadStreamByName(java.lang.String filename)

Deprecated.

Description copied from interface: GridFSBucket

Opens a Stream from which the application can read the contents of the latest version of the stored file specified by the filename.

Specified by:

openDownloadStreamByName in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

Returns:

the stream

openDownloadStreamByName

@Deprecated
public GridFSDownloadStream openDownloadStreamByName(java.lang.String filename,
                                                                 GridFSDownloadByNameOptions options)

Deprecated.

Description copied from interface: GridFSBucket

Opens a Stream from which the application can read the contents of the stored file specified by filename and the revision in options.

Specified by:

openDownloadStreamByName in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

options - the download options

Returns:

the stream

downloadToStreamByName

@Deprecated
public void downloadToStreamByName(java.lang.String filename,
                                               java.io.OutputStream destination)

Deprecated.

Description copied from interface: GridFSBucket

Downloads the contents of the latest version of the stored file specified by filename and writes the contents to the destination Stream.

Specified by:

downloadToStreamByName in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

destination - the destination stream

downloadToStreamByName

@Deprecated
public void downloadToStreamByName(java.lang.String filename,
                                               java.io.OutputStream destination,
                                               GridFSDownloadByNameOptions options)

Deprecated.

Description copied from interface: GridFSBucket

Downloads the contents of the stored file specified by filename and by the revision in options and writes the contents to the destination Stream.

Specified by:

downloadToStreamByName in interface GridFSBucket

Parameters:

filename - the name of the file to be downloaded

destination - the destination stream

options - the download options

getFilesCollection

private static MongoCollection<GridFSFile> getFilesCollection(MongoDatabase database,
                                                              java.lang.String bucketName)

getChunksCollection

private static MongoCollection<Document> getChunksCollection(MongoDatabase database,
                                                             java.lang.String bucketName)

checkCreateIndex

private void checkCreateIndex()

hasIndex

private <T> boolean hasIndex(MongoCollection<T> collection,
                             Document index)

getFileByName

private GridFSFile getFileByName(java.lang.String filename,
                                 GridFSDownloadOptions options)

findTheFileInfoAndOpenDownloadStream

private GridFSDownloadStream findTheFileInfoAndOpenDownloadStream(BsonValue id)

downloadToStream

private void downloadToStream(GridFSDownloadStream downloadStream,
                              java.io.OutputStream destination)