com.microsoft.windowsazure.services.blob.models.GetBlobResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsoft-windowsazure-api Show documentation
API for Microsoft Windows Azure Clients
There is a newer version: 0.4.6
Show newest version
/**
 * Copyright Microsoft Corporation
 * 
 * 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 com.microsoft.windowsazure.services.blob.models;

import java.io.InputStream;
import java.util.HashMap;

import com.microsoft.windowsazure.services.blob.BlobContract;

/**
 * A wrapper class for the response returned from a Blob Service REST API Get Blob operation. This is returned by calls
 * to implementations of {@link BlobContract#getBlob(String, String, GetBlobOptions)}.
 * 
 * See the Get Blob documentation on
 * MSDN for details of the underlying Blob Service REST API operation.
 */
public class GetBlobResult {
    private InputStream contentStream;
    private BlobProperties properties;
    private HashMap metadata;

    /**
     * Gets the content of the blob.
     * 
     * @return
     *         An {@link InputStream} instance containing the content of the blob.
     */
    public InputStream getContentStream() {
        return contentStream;
    }

    /**
     * Reserved for internal use. Sets the blob content from the body returned in the response.
     * 

     * This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
     * the server.
     * 
     * @param contentStream
     *            An {@link InputStream} instance containing the content of the blob.
     */
    public void setContentStream(InputStream contentStream) {
        this.contentStream = contentStream;
    }

    /**
     * Gets the standard HTTP properties and system properties of the blob.
     * 
     * @return
     *         A {@link BlobProperties} instance containing the properties of the blob.
     */
    public BlobProperties getProperties() {
        return properties;
    }

    /**
     * Reserved for internal use. Sets the blob properties from the headers returned in the response.
     * 

     * This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
     * the server.
     * 
     * @param properties
     *            A {@link BlobProperties} instance containing the properties of the blob.
     */
    public void setProperties(BlobProperties properties) {
        this.properties = properties;
    }

    /**
     * Gets the user-defined blob metadata as a map of name and value pairs. The metadata is for client use and is
     * opaque to the server.
     * 
     * @return
     *         A {@link java.util.HashMap} of key-value pairs of {@link String} containing the names and values of
     *         the blob metadata.
     */
    public HashMap getMetadata() {
        return metadata;
    }

    /**
     * Reserved for internal use. Sets the blob metadata from the x-ms-meta-name:value headers
     * returned in the response.
     * 
     * This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
     * the server.
     * 
     * @param metadata
     *            A {@link java.util.HashMap} of key-value pairs of {@link String} containing the names and values
     *            of the blob metadata.
     */
    public void setMetadata(HashMap metadata) {
        this.metadata = metadata;
    }
}