org.alanwilliamson.amazon.s3.List.java Source code

Introduction

Here is the source code for org.alanwilliamson.amazon.s3.List.java

Source

/* 
 *  Copyright (C) 2000 - 2015 TagServlet Ltd
 *
 *  This file is part of Open BlueDragon (OpenBD) CFML Server Engine.
 *  
 *  OpenBD is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  Free Software Foundation,version 3.
 *  
 *  OpenBD 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 General Public License
 *  along with OpenBD.  If not, see http://www.gnu.org/licenses/
 *  
 *  Additional permission under GNU GPL version 3 section 7
 *  
 *  If you modify this Program, or any covered work, by linking or combining 
 *  it with any of the JARS listed in the README.txt (or a modified version of 
 *  (that library), containing parts covered by the terms of that JAR, the 
 *  licensors of this Program grant you additional permission to convey the 
 *  resulting work. 
 *  README.txt @ http://www.openbluedragon.org/license/README.txt
 *  
 *  http://openbd.org/
 *  $Id: List.java 2466 2015-01-11 15:53:09Z alan $
 */

package org.alanwilliamson.amazon.s3;

import org.alanwilliamson.amazon.AmazonBase;
import org.alanwilliamson.amazon.AmazonKey;

import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.model.ListObjectsRequest;
import com.amazonaws.services.s3.model.ObjectListing;
import com.amazonaws.services.s3.model.S3ObjectSummary;
import com.naryx.tagfusion.cfm.engine.cfArgStructData;
import com.naryx.tagfusion.cfm.engine.cfBooleanData;
import com.naryx.tagfusion.cfm.engine.cfData;
import com.naryx.tagfusion.cfm.engine.cfDateData;
import com.naryx.tagfusion.cfm.engine.cfNullData;
import com.naryx.tagfusion.cfm.engine.cfNumberData;
import com.naryx.tagfusion.cfm.engine.cfQueryResultData;
import com.naryx.tagfusion.cfm.engine.cfSession;
import com.naryx.tagfusion.cfm.engine.cfStringData;
import com.naryx.tagfusion.cfm.engine.cfmRunTimeException;

public class List extends AmazonBase {

    private static final long serialVersionUID = 1L;

    public List() {
        min = 2;
        max = 3;
        setNamedParams(new String[] { "datasource", "bucket", "prefix" });
    }

    public String[] getParamInfo() {
        return new String[] { "Amazon datasource", "Amazon Bucket", "Optional prefix to list" };
    }

    public java.util.Map<String, String> getInfo() {
        return makeInfo("amazon",
                "Amazon S3: Returns all the keys for this bucket as a query with the fields 'key', 'size', 'modified' and 'etag'.  Any key returning a slash (/) at the end is considered a subprefix (or directory) of the current prefix.",
                ReturnType.QUERY);
    }

    public cfData execute(cfSession _session, cfArgStructData argStruct) throws cfmRunTimeException {

        AmazonKey amazonKey = getAmazonKey(_session, argStruct);
        AmazonS3 s3Client = getAmazonS3(amazonKey);

        String bucket = getNamedStringParam(argStruct, "bucket", null);
        String prefix = getNamedStringParam(argStruct, "prefix", "");

        if (bucket == null)
            throwException(_session, "Please specify a bucket");

        try {
            // Create the results
            cfQueryResultData qD = new cfQueryResultData(new String[] { "key", "size", "modified", "etag" }, null);
            qD.setQuerySource("AmazonS3." + amazonKey.getDataSource());

            ListObjectsRequest listObjectsRequest = new ListObjectsRequest().withBucketName(bucket)
                    .withDelimiter("/").withPrefix(prefix);
            ObjectListing objectListing;

            do {
                objectListing = s3Client.listObjects(listObjectsRequest);

                java.util.List<String> prefixes = objectListing.getCommonPrefixes();

                // first add the prefixes
                for (String nextPrefix : prefixes) {
                    qD.addRow(1);
                    qD.setCurrentRow(qD.getSize());

                    qD.setCell(1, new cfStringData(nextPrefix));
                    qD.setCell(2, new cfNumberData(0));
                    qD.setCell(3, cfNullData.NULL);
                    qD.setCell(4, cfNullData.NULL);

                }

                for (S3ObjectSummary objectSummary : objectListing.getObjectSummaries()) {

                    // don't include the prefix being listed
                    if (objectSummary.getKey().equals(prefix)) {
                        continue;
                    }
                    qD.addRow(1);
                    qD.setCurrentRow(qD.getSize());

                    qD.setCell(1, new cfStringData(objectSummary.getKey()));
                    qD.setCell(2, new cfNumberData(objectSummary.getSize()));
                    qD.setCell(3, new cfDateData(objectSummary.getLastModified()));
                    qD.setCell(4, new cfStringData(objectSummary.getETag()));
                }

                listObjectsRequest.setMarker(objectListing.getNextMarker());
            } while (objectListing.isTruncated());

            return qD;
        } catch (Exception e) {
            throwException(_session, "AmazonS3: " + e.getMessage());
            return cfBooleanData.FALSE;
        }
    }

}