org.jclouds.aws.s3.options.PutBucketOptions.java Source code

Introduction

Here is the source code for org.jclouds.aws.s3.options.PutBucketOptions.java

Source

/**
 *
 * Copyright (C) 2010 Cloud Conscious, LLC. <info@cloudconscious.com>
 *
 * ====================================================================
 * 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
 *
 * http://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.jclouds.aws.s3.options;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static org.jclouds.aws.reference.AWSConstants.PROPERTY_HEADER_TAG;

import java.util.Map.Entry;

import javax.inject.Inject;
import javax.inject.Named;

import org.jclouds.aws.s3.domain.CannedAccessPolicy;
import org.jclouds.aws.s3.reference.S3Headers;
import org.jclouds.http.options.BaseHttpRequestOptions;

import com.google.common.collect.LinkedHashMultimap;
import com.google.common.collect.Multimap;

/**
 * Contains options supported in the REST API for the PUT bucket operation. <h2>
 * Usage</h2> The recommended way to instantiate a PutBucketOptions object is to statically import
 * PutBucketOptions.Builder.* and invoke a static creation method followed by an instance mutator
 * (if needed):
 * <p/>
 * <code>
 * import static org.jclouds.aws.s3.commands.options.PutBucketOptions.Builder.*
 * import static org.jclouds.aws.s3.domain.S3Bucket.Metadata.LocationConstraint.*;
 * import org.jclouds.aws.s3.S3Client;
 * <p/>
 * S3Client connection = // get connection
 * Future<Boolean> createdInEu = connection.putBucketIfNotExists("bucketName",createIn(EU));
 * <code>
 * 
 * @author Adrian Cole
 * @see <a
 *      href="http://docs.amazonwebservices.com/AmazonS3/2006-03-01/index.html?RESTBucketPUT.html?"
 *      />
 */
public class PutBucketOptions extends BaseHttpRequestOptions {
    private CannedAccessPolicy acl = CannedAccessPolicy.PRIVATE;

    private String headerTag;

    @Inject
    public void setHeaderTag(@Named(PROPERTY_HEADER_TAG) String headerTag) {
        this.headerTag = headerTag;
    }

    @Override
    public Multimap<String, String> buildRequestHeaders() {
        checkState(headerTag != null, "headerTag should have been injected!");
        Multimap<String, String> returnVal = LinkedHashMultimap.create();
        for (Entry<String, String> entry : headers.entries()) {
            returnVal.put(entry.getKey().replace("aws", headerTag), entry.getValue());
        }
        return returnVal;
    }

    /**
     * Override the default ACL (private) with the specified one.
     * 
     * @see CannedAccessPolicy
     */
    public PutBucketOptions withBucketAcl(CannedAccessPolicy acl) {
        this.acl = checkNotNull(acl, "acl");
        if (!acl.equals(CannedAccessPolicy.PRIVATE))
            this.replaceHeader(S3Headers.CANNED_ACL, acl.toString());
        return this;
    }

    /**
     * @see PutBucketOptions#withBucketAcl
     */
    public CannedAccessPolicy getAcl() {
        return acl;
    }

    public static class Builder {
        /**
         * @see PutBucketOptions#withBucketAcl
         */
        public static PutBucketOptions withBucketAcl(CannedAccessPolicy acl) {
            PutBucketOptions options = new PutBucketOptions();
            return options.withBucketAcl(acl);
        }
    }
}