org.jclouds.aws.s3.options.PutObjectOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jclouds-aws Show documentation
jclouds Core components to access Amazon AWS
The newest version!
/**
 *
 * Copyright (C) 2010 Cloud Conscious, LLC. 
 *
 * ====================================================================
 * 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 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;

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

/**
 * Contains options supported in the REST API for the PUT object operation.
 * 
 * 

 * Usage The recommended way to instantiate a PutObjectOptions object is to
 * statically import PutObjectOptions.Builder.* and invoke a static creation
 * method followed by an instance mutator (if needed):
 * 
 * 
 * import static org.jclouds.aws.s3.commands.options.PutObjectOptions.Builder.*
 * import org.jclouds.aws.s3.S3Client;
 * 
 * S3Client connection = // get connection
 * Future publicly readable = connection.putObject("bucketName",new S3Object("key","value"), withAcl(CannedAccessPolicy.PUBLIC_READ));
 * 
 * 
 * @see 
 * 
 * @author Adrian Cole
 * 
 */
public class PutObjectOptions extends BaseHttpRequestOptions {
    public static final PutObjectOptions NONE = new PutObjectOptions();

    private CannedAccessPolicy acl = CannedAccessPolicy.PRIVATE;
    
    private String headerTag;

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

    @Override
    public Multimap buildRequestHeaders() {
       checkState(headerTag != null, "headerTag should have been injected!");
       Multimap returnVal = LinkedHashMultimap.create();
       for (Entry 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 PutObjectOptions withAcl(CannedAccessPolicy acl) {
	this.acl = checkNotNull(acl, "acl");
	if (!acl.equals(CannedAccessPolicy.PRIVATE))
	    this.replaceHeader(S3Headers.CANNED_ACL, acl.toString());
	return this;
    }

    /**
     * @see PutObjectOptions#withAcl(CannedAccessPolicy)
     */
    public CannedAccessPolicy getAcl() {
	return acl;
    }

    public static class Builder {

	/**
	 * @see PutObjectOptions#withAcl(CannedAccessPolicy)
	 */
	public static PutObjectOptions withAcl(CannedAccessPolicy acl) {
	    PutObjectOptions options = new PutObjectOptions();
	    return options.withAcl(acl);
	}
    }
}