1 /**
2 *
3 * Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com>
4 *
5 * ====================================================================
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 * ====================================================================
18 */
19 package org.jclouds.blobstore.domain;
20
21 import javax.annotation.Nullable;
22
23 import org.jclouds.io.Payload;
24 import org.jclouds.io.PayloadEnclosing;
25
26 import com.google.common.collect.Multimap;
27
28 /**
29 * Value type for an HTTP Blob service. Blobs are stored in containers and consist of a
30 * {@link MutableBlobMetadata#getName name}, {@link Payload payload}, and
31 * {@link MutableBlobMetadata metadata}.
32 *
33 * @author Adrian Cole
34 */
35 public interface Blob extends PayloadEnclosing, Comparable<Blob> {
36 /**
37 * Allows you to construct blobs without knowing the implementation type
38 */
39 public interface Factory {
40 /**
41 * Creates a blob, optionally setting its metadata to a known value. This is useful in making
42 * copies of blobs.
43 */
44 Blob create(@Nullable MutableBlobMetadata metadata);
45 }
46
47 /**
48 * @return System and User metadata relevant to this object.
49 */
50 MutableBlobMetadata getMetadata();
51
52 /**
53 * @return headers returned from the services
54 */
55 Multimap<String, String> getAllHeaders();
56
57 /**
58 *
59 * @see #getAllHeaders
60 */
61 void setAllHeaders(Multimap<String, String> allHeaders);
62
63 }