Skip to content
Merged

Dev #71

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -690,11 +690,10 @@ void createBlobBlock(String container, String blob, String blockId, InputStream
* You can call this method to update a blob by uploading only those blocks that have changed, then committing the
* new and existing blocks together. You can do this with the <em>blockList</em> parameter by specifying whether to
* commit a block from the committed block list or from the uncommitted block list, or to commit the most recently
* uploaded version of the block, whichever list it may belong to. Use the
* {@link BlobContract#CommitBlobBlocksOptions options} parameter to optionally specify the server timeout for the
* operation, the MIME content type and content encoding for the blob, the content language, the MD5 hash, a cache
* control value, blob metadata, the lease ID if the blob has an active lease, and any access conditions for the
* operation.
* uploaded version of the block, whichever list it may belong to. Use the {@link CommitBlobBlocksOptions options}
* parameter to optionally specify the server timeout for the operation, the MIME content type and content encoding
* for the blob, the content language, the MD5 hash, a cache control value, blob metadata, the lease ID if the blob
* has an active lease, and any access conditions for the operation.
* <p>
* In order to be written as part of a blob, each block in the list must have been successfully written to the
* server with a call to {@link BlobContract#createBlobBlock(String, String, String, InputStream)} or
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<html>
<head />
<body>This package contains the integrated blob service client classes and implementation.
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<html>
<head />
<body>This package contains the implementation of the blob service classes and utilities.
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
* Copyright 2011 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
* 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.
* 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;

Expand All @@ -24,22 +24,22 @@ public enum AccessConditionHeaderType {
NONE,

/**
* Specifies the <i>If-Unmodified-Since</i> conditional header is set.
* Specifies the <code>If-Unmodified-Since</code> conditional header is set.
*/
IF_UNMODIFIED_SINCE,

/**
* Specifies the <i>If-Match</i> conditional header is set.
* Specifies the <code>If-Match</code> conditional header is set.
*/
IF_MATCH,

/**
* Specifies the <i>If-Modified-Since</i> conditional header is set.
* Specifies the <code>If-Modified-Since</code> conditional header is set.
*/
IF_MODIFIED_SINCE,

/**
* Specifies the <i>If-None-Match</i> conditional header is set.
* Specifies the <code>If-None-Match</code> conditional header is set.
*/
IF_NONE_MATCH;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public String getSnapshot() {
}

/**
* Reserved for internal use. Sets the snapshot timestamp value from the <strong>x-ms-snapshot</strong> header
* Reserved for internal use. Sets the snapshot timestamp value from the <code>x-ms-snapshot</code> header
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand Down Expand Up @@ -75,7 +75,7 @@ public String getEtag() {
}

/**
* Reserved for internal use. Sets the ETag of the snapshot from the <strong>ETag</strong> header returned in the
* Reserved for internal use. Sets the ETag of the snapshot from the <code>ETag</code> header returned in the
* response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand Down Expand Up @@ -104,8 +104,8 @@ public Date getLastModified() {
}

/**
* Reserved for internal use. Sets the last modified time of the snapshot from the <strong>Last-Modified</strong>
* header returned in the response.
* Reserved for internal use. Sets the last modified time of the snapshot from the <code>Last-Modified</code> header
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public String getEtag() {
}

/**
* Reserved for internal use. Sets the ETag of the blob from the <strong>ETag</strong> header returned in the
* Reserved for internal use. Sets the ETag of the blob from the <code>ETag</code> header returned in the
* response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand Down Expand Up @@ -75,8 +75,8 @@ public Date getLastModified() {
}

/**
* Reserved for internal use. Sets the last modified time of the blob from the <strong>Last-Modified</strong>
* header returned in the response.
* Reserved for internal use. Sets the last modified time of the blob from the <code>Last-Modified</code> header
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand All @@ -101,8 +101,8 @@ public HashMap<String, String> getMetadata() {
}

/**
* Reserved for internal use. Sets the blob metadata from the <em>x-ms-meta-name:value</em> headers returned in the
* response.
* Reserved for internal use. Sets the blob metadata from the <code>x-ms-meta-<em>name:value</em></code> headers
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ public HashMap<String, String> getMetadata() {
}

/**
* Reserved for internal use. Sets the blob metadata from the <em>x-ms-meta-name:value</em> headers returned in the
* response.
* Reserved for internal use. Sets the blob metadata from the <code>x-ms-meta-<em>name:value</em></code> headers
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ public HashMap<String, String> getMetadata() {
}

/**
* Reserved for internal use. Sets the blob metadata from the <em>x-ms-meta-name:value</em> headers returned in the
* response.
* Reserved for internal use. Sets the blob metadata from the <code>x-ms-meta-<em>name:value</em></code> headers
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public String getEtag() {
}

/**
* Reserved for internal use. Sets the Etag of the container from the <strong>ETag</strong> header returned in
* Reserved for internal use. Sets the Etag of the container from the <code>ETag</code> header returned in
* the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand All @@ -74,8 +74,8 @@ public Date getLastModified() {
}

/**
* Reserved for internal use. Sets the last modified time of the container from the
* <strong>Last-Modified</strong> header returned in the response.
* Reserved for internal use. Sets the last modified time of the container from the <code>Last-Modified</code>
* header returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand All @@ -100,7 +100,7 @@ public HashMap<String, String> getMetadata() {
}

/**
* Reserved for internal use. Sets the container metadata from the <strong>x-ms-meta-<em>name</em></strong> headers
* Reserved for internal use. Sets the container metadata from the <code>x-ms-meta-<em>name</em></code> headers
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public String getEtag() {
}

/**
* Reserved for internal use. Sets the ETag of the blob from the <strong>ETag</strong> header returned in the
* Reserved for internal use. Sets the ETag of the blob from the <code>ETag</code> header returned in the
* response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand All @@ -109,8 +109,8 @@ public String getContentType() {
}

/**
* Reserved for internal use. Sets the MIME content type of the blob from the <strong>Content-Type</strong>
* header returned in the response.
* Reserved for internal use. Sets the MIME content type of the blob from the <code>Content-Type</code> header
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand All @@ -133,7 +133,7 @@ public long getContentLength() {
}

/**
* Reserved for internal use. Sets the content length of the blob from the <strong>x-ms-blob-content-length</strong>
* Reserved for internal use. Sets the content length of the blob from the <code>x-ms-blob-content-length</code>
* header returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ public Date getLastModified() {
}

/**
* Reserved for internal use. Sets the last modified time of the blob from the <strong>Last-Modified</strong>
* header returned in the response.
* Reserved for internal use. Sets the last modified time of the blob from the <code>Last-Modified</code> header
* returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
* the server.
Expand All @@ -78,7 +78,7 @@ public String getEtag() {
}

/**
* Reserved for internal use. Sets the ETag of the blob from the <strong>ETag</strong> header returned in the
* Reserved for internal use. Sets the ETag of the blob from the <code>ETag</code> header returned in the
* response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand All @@ -102,7 +102,7 @@ public long getContentLength() {
}

/**
* Reserved for internal use. Sets the content length of the blob from the <strong>x-ms-blob-content-length</strong>
* Reserved for internal use. Sets the content length of the blob from the <code>x-ms-blob-content-length</code>
* header returned in the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ public String getDelimiter() {
* each blob does.
* <p>
* Note that if a delimiter is set, you cannot include snapshots. A request that includes both returns an
* InvalidQueryParameter error (HTTP status code 400 Bad Request), which causes a {@link ServiceException} to be
* InvalidQueryParameter error (HTTP status code 400 - Bad Request), which causes a {@link ServiceException} to be
* thrown.
* <p>
* The <em>delimiter</em> value only affects calls made on methods where this {@link ListBlobsOptions} instance is
Expand Down Expand Up @@ -246,7 +246,7 @@ public boolean isIncludeSnapshots() {
* Sets the value of an optional flag indicating whether to include blob snapshots with a response.
* <p>
* Note that if this flag is set, you cannot set a delimiter. A request that includes both returns an
* InvalidQueryParameter error (HTTP status code 400 Bad Request), which causes a {@link ServiceException} to be
* InvalidQueryParameter error (HTTP status code 400 - Bad Request), which causes a {@link ServiceException} to be
* thrown.
*
* @param includeSnapshots
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@
import com.microsoft.windowsazure.services.blob.implementation.MetadataAdapter;

/**
* A wrapper class for the response returned from a Blob Service REST API Get Blobs operation. This is returned by
* A wrapper class for the response returned from a Blob Service REST API List Blobs operation. This is returned by
* calls to implementations of {@link BlobContract#listBlobs(String)} and
* {@link BlobContract#listBlobs(String, ListBlobsOptions)}.
* <p>
* See the <a href="http://msdn.microsoft.com/en-us/library/windowsazure/dd135734.aspx">Get Blobs</a> documentation on
* See the <a href="http://msdn.microsoft.com/en-us/library/windowsazure/dd135734.aspx">List Blobs</a> documentation on
* MSDN for details of the underlying Blob Service REST API operation.
*/
@XmlRootElement(name = "EnumerationResults")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public String getMarker() {
* Use the {@link ListContainersResult#getNextMarker() getNextMarker} method on a {@link ListContainersResult}
* instance to get the marker value to set on a {@link ListContainersOptions} instance using a call to this method.
* Pass the {@link ListContainersOptions} instance as a parameter to a
* {@link BlobContract#listContainers(listContainersOptions)} call to get the next portion of the container list.
* {@link BlobContract#listContainers(ListContainersOptions)} call to get the next portion of the container list.
* <p>
* The <em>marker</em> value only affects calls made on methods where this {@link ListContainersOptions} instance is
* passed as a parameter.
Expand Down Expand Up @@ -130,7 +130,7 @@ public int getMaxResults() {
* Use the {@link ListContainersResult#getNextMarker() getNextMarker} method on a {@link ListContainersResult}
* instance to get the marker value to set on a {@link ListContainersOptions} instance using a call to
* {@link ListContainersOptions#setMarker(String)}. Pass the {@link ListContainersOptions} instance as a parameter
* to a {@link BlobContract#listContainers(listContainersOptions)} call to get the next portion of the container
* to a {@link BlobContract#listContainers(ListContainersOptions)} call to get the next portion of the container
* list.
* <p>
* The <em>maxResults</em> value only affects calls made on methods where this {@link ListContainersOptions}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
/**
* A wrapper class for the response returned from a Blob Service REST API List Containers operation. This is returned by
* calls to implementations of {@link BlobContract#listContainers} and
* {@link BlobContract#listContainers(listContainersOptions)}.
* {@link BlobContract#listContainers(ListContainersOptions)}.
* <p>
* See the <a href="http://msdn.microsoft.com/en-us/library/windowsazure/dd179352.aspx">List Containers</a>
* documentation on MSDN for details of the underlying Blob Service REST API operation.
Expand Down Expand Up @@ -135,7 +135,7 @@ public void setPrefix(String prefix) {
* Use the {@link ListContainersResult#getNextMarker() getNextMarker} method to get the marker value to set on a
* {@link ListContainersOptions} instance using a call to {@link ListContainersOptions#setMarker(String)}. Pass the
* {@link ListContainersOptions} instance as a parameter to a
* {@link BlobContract#listContainers(listContainersOptions)} call to get the next portion of the container list.
* {@link BlobContract#listContainers(ListContainersOptions)} call to get the next portion of the container list.
*
* @return
* A {@link String} containing the marker used to specify the beginning of the container list returned, if
Expand Down Expand Up @@ -207,7 +207,7 @@ public void setNextMarker(String nextMarker) {
* Use the {@link ListContainersResult#getNextMarker() getNextMarker} method to get the marker value to set on a
* {@link ListContainersOptions} instance using a call to {@link ListContainersOptions#setMarker(String)}. Pass the
* {@link ListContainersOptions} instance as a parameter to a
* {@link BlobContract#listContainers(listContainersOptions)} call to get the next portion of the container list.
* {@link BlobContract#listContainers(ListContainersOptions)} call to get the next portion of the container list.
*
* @return
* The maximum number of container list items to return that was specified in the request, if any.
Expand Down Expand Up @@ -292,7 +292,7 @@ public void setUrl(String url) {
}

/**
* Gets the container properties. The container properties include the last modified time and an Etag value.
* Gets the container properties. The container properties include the last modified time and an ETag value.
*
* @return
* A {@link ContainerProperties} instance containing the properties associated with the container.
Expand Down Expand Up @@ -384,27 +384,27 @@ public void setLastModified(Date lastModified) {
}

/**
* Gets the Etag of the container. This value can be used when updating or deleting a container using an
* Gets the ETag of the container. This value can be used when updating or deleting a container using an
* optimistic concurrency model to prevent the client from modifying data that has been changed by another
* client.
*
* @return
* A {@link String} containing the server-assigned Etag value for the container.
* A {@link String} containing the server-assigned ETag value for the container.
*/
@XmlElement(name = "Etag")
public String getEtag() {
return etag;
}

/**
* Reserved for internal use. Sets the Etag of the container from the <strong>Etag</strong> element returned in
* Reserved for internal use. Sets the ETag of the container from the <strong>ETag</strong> element returned in
* the response.
* <p>
* This method is invoked by the API to set the value from the Blob Service REST API operation response returned
* by the server.
*
* @param etag
* A {@link String} containing the server-assigned Etag value for the container.
* A {@link String} containing the server-assigned ETag value for the container.
*/
public void setEtag(String etag) {
this.etag = etag;
Expand Down
Loading