org.springframework.data.mongodb.gridfs.GridFsTemplate.java Source code

Java tutorial

Introduction

Here is the source code for org.springframework.data.mongodb.gridfs.GridFsTemplate.java

Source

/*
 * Copyright 2011-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.mongodb.gridfs;

import static org.springframework.data.mongodb.core.query.Query.*;
import static org.springframework.data.mongodb.gridfs.GridFsCriteria.*;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

import org.bson.BsonObjectId;
import org.bson.Document;
import org.bson.types.ObjectId;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.convert.MongoConverter;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

import com.mongodb.client.MongoDatabase;
import com.mongodb.client.gridfs.GridFSBucket;
import com.mongodb.client.gridfs.GridFSBuckets;
import com.mongodb.client.gridfs.GridFSFindIterable;
import com.mongodb.client.gridfs.model.GridFSFile;

/**
 * {@link GridFsOperations} implementation to store content into MongoDB GridFS.
 *
 * @author Oliver Gierke
 * @author Philipp Schneider
 * @author Thomas Darimont
 * @author Martin Baumgartner
 * @author Christoph Strobl
 * @author Mark Paluch
 * @author Hartmut Lang
 * @author Niklas Helge Hanft
 */
public class GridFsTemplate extends GridFsOperationsSupport implements GridFsOperations, ResourcePatternResolver {

    private final MongoDbFactory dbFactory;

    private final @Nullable String bucket;

    /**
     * Creates a new {@link GridFsTemplate} using the given {@link MongoDbFactory} and {@link MongoConverter}.
     *
     * @param dbFactory must not be {@literal null}.
     * @param converter must not be {@literal null}.
     */
    public GridFsTemplate(MongoDbFactory dbFactory, MongoConverter converter) {
        this(dbFactory, converter, null);
    }

    /**
     * Creates a new {@link GridFsTemplate} using the given {@link MongoDbFactory} and {@link MongoConverter}.
     *
     * @param dbFactory must not be {@literal null}.
     * @param converter must not be {@literal null}.
     * @param bucket
     */
    public GridFsTemplate(MongoDbFactory dbFactory, MongoConverter converter, @Nullable String bucket) {

        super(converter);

        Assert.notNull(dbFactory, "MongoDbFactory must not be null!");

        this.dbFactory = dbFactory;
        this.bucket = bucket;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String)
     */
    public ObjectId store(InputStream content, String filename) {
        return store(content, filename, (Object) null);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.Object)
     */
    @Override
    public ObjectId store(InputStream content, @Nullable Object metadata) {
        return store(content, null, metadata);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, com.mongodb.Document)
     */
    @Override
    public ObjectId store(InputStream content, @Nullable Document metadata) {
        return store(content, null, metadata);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, java.lang.String)
     */
    public ObjectId store(InputStream content, @Nullable String filename, @Nullable String contentType) {
        return store(content, filename, contentType, (Object) null);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, java.lang.Object)
     */
    public ObjectId store(InputStream content, @Nullable String filename, @Nullable Object metadata) {
        return store(content, filename, null, metadata);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, java.lang.String, java.lang.Object)
     */
    public ObjectId store(InputStream content, @Nullable String filename, @Nullable String contentType,
            @Nullable Object metadata) {
        return store(content, filename, contentType, toDocument(metadata));
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, com.mongodb.Document)
     */
    public ObjectId store(InputStream content, @Nullable String filename, @Nullable Document metadata) {
        return this.store(content, filename, null, metadata);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, com.mongodb.Document)
     */
    public ObjectId store(InputStream content, @Nullable String filename, @Nullable String contentType,
            @Nullable Document metadata) {

        Assert.notNull(content, "InputStream must not be null!");
        return getGridFs().uploadFromStream(filename, content, computeUploadOptionsFor(contentType, metadata));
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#find(com.mongodb.Document)
     */
    public GridFSFindIterable find(Query query) {

        Assert.notNull(query, "Query must not be null!");

        Document queryObject = getMappedQuery(query.getQueryObject());
        Document sortObject = getMappedQuery(query.getSortObject());

        return getGridFs().find(queryObject).sort(sortObject);
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#findOne(com.mongodb.Document)
     */
    public GridFSFile findOne(Query query) {
        return find(query).first();
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#delete(org.springframework.data.mongodb.core.query.Query)
     */
    public void delete(Query query) {

        for (GridFSFile gridFSFile : find(query)) {
            getGridFs().delete(((BsonObjectId) gridFSFile.getId()).getValue());
        }
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.core.io.ResourceLoader#getClassLoader()
     */
    public ClassLoader getClassLoader() {
        return dbFactory.getClass().getClassLoader();
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.core.io.ResourceLoader#getResource(java.lang.String)
     */
    public GridFsResource getResource(String location) {

        return Optional.ofNullable(findOne(query(whereFilename().is(location)))) //
                .map(this::getResource) //
                .orElseGet(() -> GridFsResource.absent(location));
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.gridfs.GridFsOperations#getResource(com.mongodb.client.gridfs.model.GridFSFile)
     */
    public GridFsResource getResource(GridFSFile file) {

        Assert.notNull(file, "GridFSFile must not be null!");

        return new GridFsResource(file, getGridFs().openDownloadStream(file.getObjectId()));
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.core.io.support.ResourcePatternResolver#getResources(java.lang.String)
     */
    public GridFsResource[] getResources(String locationPattern) {

        if (!StringUtils.hasText(locationPattern)) {
            return new GridFsResource[0];
        }

        AntPath path = new AntPath(locationPattern);

        if (path.isPattern()) {

            GridFSFindIterable files = find(query(whereFilename().regex(path.toRegex())));
            List<GridFsResource> resources = new ArrayList<>();

            for (GridFSFile file : files) {
                resources.add(getResource(file));
            }

            return resources.toArray(new GridFsResource[0]);
        }

        return new GridFsResource[] { getResource(locationPattern) };
    }

    private GridFSBucket getGridFs() {

        MongoDatabase db = dbFactory.getDb();
        return bucket == null ? GridFSBuckets.create(db) : GridFSBuckets.create(db, bucket);
    }
}