org.jclouds.aws.s3.domain.S3Object 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.domain;

import org.jclouds.io.PayloadEnclosing;

import com.google.common.collect.Multimap;
import com.google.inject.internal.Nullable;

/**
 * Amazon S3 is designed to store objects. Objects are stored in buckets and consist of a
 * {@link ObjectMetadataS3Object#getInput() value}, a {@link ObjectMetadata#getKey key},
 * {@link ObjectMetadata#getUserMetadata() metadata}, and an access control policy.
 * 
 * @author Adrian Cole
 * @see 
 */
public interface S3Object extends PayloadEnclosing, Comparable {
   public interface Factory {
      S3Object create(@Nullable MutableObjectMetadata metadata);
   }

   /**
    * @return System and User metadata relevant to this object.
    */
   MutableObjectMetadata getMetadata();

   Multimap getAllHeaders();

   void setAccessControlList(AccessControlList acl);

   AccessControlList getAccessControlList();

   void setAllHeaders(Multimap allHeaders);
}