org.jclouds.aws.ec2.options.BundleInstanceS3StorageOptions 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.ec2.options;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static org.jclouds.Constants.PROPERTY_IDENTITY;

import javax.inject.Named;

import org.jclouds.aws.ec2.options.internal.BaseEC2RequestOptions;

import com.google.common.collect.Multimap;
import com.google.inject.Inject;

/**
 * Contains options supported in the Form API for the RegisterImage operation.
 * 
 * Usage The recommended way to instantiate a
 * BundleInstanceS3StorageOptions object is to statically import
 * BundleInstanceS3StorageOptions.Builder.* and invoke a static creation method
 * followed by an instance mutator (if needed):
 * 
 * 
 * import static org.jclouds.aws.ec2.options.BundleInstanceS3StorageOptions.Builder.*
 * 

 * EC2Client connection = // get connection
 * String imageId = connection.getWindowsServices().bundleInstanceInRegion(...bucketOwnedBy(anotherAccessKey));
 * 
 * 
 * @author Adrian Cole
 * @see 
 */
public class BundleInstanceS3StorageOptions extends BaseEC2RequestOptions {

   @Inject(optional = true)
   @Named(PROPERTY_IDENTITY)
   String currentAwsAccessKeyId;

   @Override
   public Multimap buildFormParameters() {
      if (getAwsAccessKeyId() == null) {
         checkState(currentAwsAccessKeyId != null, "currentAwsAccessKeyId should have been injected");
         bucketOwnedBy(currentAwsAccessKeyId);
      }
      return super.buildFormParameters();
   }

   /**
    * 
    * @param awsAccessKeyId
    *           The Access Key ID of the owner of the Amazon S3 bucket.
    */
   public BundleInstanceS3StorageOptions bucketOwnedBy(String awsAccessKeyId) {
      formParameters.put("Storage.S3.AWSAccessKeyId", checkNotNull(awsAccessKeyId, "awsAccessKeyId"));
      return this;
   }

   /**
    * 
    * @return The Access Key ID of the owner of the Amazon S3 bucket.
    */
   public String getAwsAccessKeyId() {
      return getFirstFormOrNull("Storage.S3.AWSAccessKeyId");
   }

   public static class Builder {
      /**
       * @see BundleInstanceS3StorageOptions#bucketOwnedBy(awsAccessKeyId)
       */
      public static BundleInstanceS3StorageOptions bucketOwnedBy(String awsAccessKeyId) {
         BundleInstanceS3StorageOptions options = new BundleInstanceS3StorageOptions();
         return options.bucketOwnedBy(awsAccessKeyId);
      }

   }
}