TemporaryS3Folder.java

/**
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * @author Gabriel Roldan, Boundless Spatial Inc, Copyright 2015
 */
package org.geowebcache.s3;

import static com.google.common.base.Preconditions.checkState;

import java.util.List;
import java.util.Properties;
import java.util.UUID;

import org.junit.rules.ExternalResource;

import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3Client;
import com.amazonaws.services.s3.iterable.S3Objects;
import com.amazonaws.services.s3.model.DeleteObjectsRequest;
import com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion;
import com.amazonaws.services.s3.model.S3ObjectSummary;
import com.google.common.base.Function;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;

/**
 * The TemporaryS3Folder provides a path prefix for S3 storage and deletes all resources under the
 * given prefix at shutdown.
 */
public class TemporaryS3Folder extends ExternalResource {

    private Properties properties;

    private String bucket;

    private String accessKey;

    private String secretKey;

    private String temporaryPrefix;

    private AmazonS3Client s3;

    public TemporaryS3Folder(Properties properties) {
        this.properties = properties;
        this.bucket = properties.getProperty("bucket");
        this.accessKey = properties.getProperty("accessKey");
        this.secretKey = properties.getProperty("secretKey");
    }

    @Override
    protected void before() throws Throwable {
        if (!isConfigured()) {
            return;
        }
        this.temporaryPrefix = "tmp_" + UUID.randomUUID().toString().replace("-", "");
        s3 = getConfig().buildClient();
    }

    @Override
    protected void after() {
        if (!isConfigured()) {
            return;
        }
        try {
            delete();
        } finally {
            temporaryPrefix = null;
            s3.shutdown();
        }
    }

    public AmazonS3 getClient() {
        checkState(isConfigured(), "client not configured.");
        return s3;
    }

    public S3BlobStoreConfig getConfig() {
        checkState(isConfigured(), "client not configured.");
        S3BlobStoreConfig config = new S3BlobStoreConfig();
        config.setBucket(bucket);
        config.setAwsAccessKey(accessKey);
        config.setAwsSecretKey(secretKey);
        config.setPrefix(temporaryPrefix);
        if (properties.getProperty("maxConnections") != null) {
            config.setMaxConnections(Integer.valueOf(properties.getProperty("maxConnections")));
        }
        if (properties.getProperty("useHTTPS") != null) {
            config.setUseHTTPS(Boolean.valueOf(properties.getProperty("useHTTPS")));
        }
        if (properties.getProperty("proxyDomain") != null) {
            config.setProxyDomain(properties.getProperty("proxyDomain"));
        }
        if (properties.getProperty("proxyWorkstation") != null) {
            config.setProxyWorkstation(properties.getProperty("proxyWorkstation"));
        }
        if (properties.getProperty("proxyHost") != null) {
            config.setProxyHost(properties.getProperty("proxyHost"));
        }
        if (properties.getProperty("proxyPort") != null) {
            config.setProxyPort(Integer.valueOf(properties.getProperty("proxyPort")));
        }
        if (properties.getProperty("proxyUsername") != null) {
            config.setProxyUsername(properties.getProperty("proxyUsername"));
        }
        if (properties.getProperty("proxyPassword") != null) {
            config.setProxyPassword(properties.getProperty("proxyPassword"));
        }
        if (properties.getProperty("useGzip") == null) {
            config.setUseGzip(true);
        } else {
            config.setUseGzip(Boolean.valueOf(properties.getProperty("useGzip")));
        }
        return config;
    }

    public void delete() {
        checkState(isConfigured(), "client not configured.");
        if (temporaryPrefix == null) {
            return;
        }

        Iterable<S3ObjectSummary> objects = S3Objects.withPrefix(s3, bucket, temporaryPrefix);
        Iterable<List<S3ObjectSummary>> partition = Iterables.partition(objects, 1000);
        for (List<S3ObjectSummary> os : partition) {
            List<KeyVersion> keys = Lists.transform(os,
                    new Function<S3ObjectSummary, KeyVersion>() {
                        @Override
                        public KeyVersion apply(S3ObjectSummary input) {
                            KeyVersion k = new KeyVersion(input.getKey());
                            return k;
                        }
                    });
            DeleteObjectsRequest deleteRequest = new DeleteObjectsRequest(bucket);
            deleteRequest.setKeys(keys);
            s3.deleteObjects(deleteRequest);
        }
    }

    public boolean isConfigured() {
        return bucket != null && accessKey != null && secretKey != null;
    }
}