BaseRequest (Microsoft Azure Storage Client SDK 2.2.0 API)

java.lang.Object
- com.microsoft.azure.storage.core.BaseRequest

```
public final class BaseRequest
extends Object
```
RESERVED FOR INTERNAL USE. The Base Request class for the protocol layer.

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addMetadata(HttpURLConnection request, HashMap<String,String> metadata, OperationContext opContext)` Adds the metadata.
`static void`	`addOptionalHeader(HttpURLConnection request, String name, String value)` Adds the optional header.
`static HttpURLConnection`	`create(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Creates the specified resource.
`static HttpURLConnection`	`createURLConnection(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Creates the web request.
`static HttpURLConnection`	`delete(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Deletes the specified resource.
`static UriQueryBuilder`	`getListUriQueryBuilder(ListingContext listingContext)` Gets a `UriQueryBuilder` for listing.
`static HttpURLConnection`	`getProperties(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Gets the properties.
`static HttpURLConnection`	`getServiceProperties(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Creates a HttpURLConnection used to retrieve the Analytics service properties from the storage service.
`static HttpURLConnection`	`getServiceStats(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Creates a web request to get the stats of the service.
`static String`	`getUserAgent()` Gets the user agent to send over the wire to identify the client.
`static HttpURLConnection`	`setMetadata(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Sets the metadata.
`static HttpURLConnection`	`setServiceProperties(URI uri, RequestOptions options, UriQueryBuilder builder, OperationContext opContext)` Creates a HttpURLConnection used to set the Analytics service properties on the storage service.
`static void`	`signRequestForBlobAndQueue(HttpURLConnection request, Credentials credentials, Long contentLength, OperationContext opContext)` Signs the request appropriately to make it an authenticated request for Blob and Queue.
`static void`	`signRequestForBlobAndQueueSharedKeyLite(HttpURLConnection request, Credentials credentials, Long contentLength, OperationContext opContext)` Deprecated. as of 2.0.0. Use `signRequestForBlobAndQueue(java.net.HttpURLConnection, com.microsoft.azure.storage.Credentials, java.lang.Long, com.microsoft.azure.storage.OperationContext)` instead.
`static void`	`signRequestForTableSharedKey(HttpURLConnection request, Credentials credentials, Long contentLength, OperationContext opContext)` Signs the request appropriately to make it an authenticated request for Table.
`static void`	`signRequestForTableSharedKeyLite(HttpURLConnection request, Credentials credentials, Long contentLength, OperationContext opContext)` Deprecated. as of 2.0.0. Use `signRequestForTableSharedKey(java.net.HttpURLConnection, com.microsoft.azure.storage.Credentials, java.lang.Long, com.microsoft.azure.storage.OperationContext)` instead.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addMetadata

public static void addMetadata(HttpURLConnection request,
               HashMap<String,String> metadata,
               OperationContext opContext)

Adds the metadata.

Parameters:: request - The request.; metadata - The metadata.

addOptionalHeader

public static void addOptionalHeader(HttpURLConnection request,
                     String name,
                     String value)

Adds the optional header.

Parameters:: request - a HttpURLConnection for the operation.; name - the metadata name.; value - the metadata value.

create
```
public static HttpURLConnection create(URI uri,
                       RequestOptions options,
                       UriQueryBuilder builder,
                       OperationContext opContext)
                                throws IOException,
                                       URISyntaxException,
                                       StorageException
```
Creates the specified resource. Note request is set to setFixedLengthStreamingMode(0); Sign with 0 length.

Parameters:
uri - the request Uri.
options - A RequestOptions object that specifies execution options such as retry policy and timeout settings for the operation.
builder - the UriQueryBuilder for the request
opContext - an object used to track the execution of the operation

Returns:
a HttpURLConnection to perform the operation.

Throws:

IOException - if there is an error opening the connection

URISyntaxException - if there is an improperly formated URI

StorageException

IllegalArgumentException

createURLConnection

public static HttpURLConnection createURLConnection(URI uri,
                                    RequestOptions options,
                                    UriQueryBuilder builder,
                                    OperationContext opContext)
                                             throws IOException,
                                                    URISyntaxException,
                                                    StorageException

Creates the web request.

Parameters:: uri - the request Uri.; options - A RequestOptions object that specifies execution options such as retry policy and timeout settings for the operation. This parameter is unused.; builder - the UriQueryBuilder for the request; opContext - an object used to track the execution of the operation
Returns:: a HttpURLConnection to perform the operation.
Throws:: IOException - if there is an error opening the connection; URISyntaxException - if there is an improperly formated URI; StorageException

delete

public static HttpURLConnection delete(URI uri,
                       RequestOptions options,
                       UriQueryBuilder builder,
                       OperationContext opContext)
                                throws IOException,
                                       URISyntaxException,
                                       StorageException

Deletes the specified resource. Sign with no length specified.

Parameters:: uri - the request Uri.; timeout - the timeout for the request; builder - the UriQueryBuilder for the request; opContext - an object used to track the execution of the operation
Returns:: a HttpURLConnection to perform the operation.
Throws:: IOException - if there is an error opening the connection; URISyntaxException - if there is an improperly formated URI; StorageException

getListUriQueryBuilder
```
public static UriQueryBuilder getListUriQueryBuilder(ListingContext listingContext)
                                              throws StorageException
```
Gets a UriQueryBuilder for listing.

Parameters:
listingContext - A ListingContext object that specifies parameters for the listing operation, if any. May be null.

Throws:

StorageException - If a storage service error occurred during the operation.

getProperties

public static HttpURLConnection getProperties(URI uri,
                              RequestOptions options,
                              UriQueryBuilder builder,
                              OperationContext opContext)
                                       throws IOException,
                                              URISyntaxException,
                                              StorageException

Gets the properties. Sign with no length specified.

Parameters:: uri - The Uri to query.; timeout - The timeout.; builder - The builder.; opContext - an object used to track the execution of the operation
Returns:: a web request for performing the operation.
Throws:: StorageException; URISyntaxException; IOException

getServiceProperties

public static HttpURLConnection getServiceProperties(URI uri,
                                     RequestOptions options,
                                     UriQueryBuilder builder,
                                     OperationContext opContext)
                                              throws IOException,
                                                     URISyntaxException,
                                                     StorageException

Creates a HttpURLConnection used to retrieve the Analytics service properties from the storage service.

Parameters:: uri - The service endpoint.; timeout - The timeout.; builder - The builder.; opContext - an object used to track the execution of the operation
Returns:: a web request for performing the operation.
Throws:: IOException; URISyntaxException; StorageException

getServiceStats

public static HttpURLConnection getServiceStats(URI uri,
                                RequestOptions options,
                                UriQueryBuilder builder,
                                OperationContext opContext)
                                         throws IOException,
                                                URISyntaxException,
                                                StorageException

Creates a web request to get the stats of the service.

Parameters:: uri - The service endpoint.; timeout - The timeout.; builder - The builder.; opContext - an object used to track the execution of the operation
Returns:: a web request for performing the operation.
Throws:: IOException; URISyntaxException; StorageException

getUserAgent
```
public static String getUserAgent()
```
Gets the user agent to send over the wire to identify the client.

Returns:
the user agent to send over the wire to identify the client.

setMetadata

public static HttpURLConnection setMetadata(URI uri,
                            RequestOptions options,
                            UriQueryBuilder builder,
                            OperationContext opContext)
                                     throws IOException,
                                            URISyntaxException,
                                            StorageException

Sets the metadata. Sign with 0 length.

Parameters:: uri - The blob Uri.; timeout - The timeout.; builder - The builder.; opContext - an object used to track the execution of the operation
Returns:: a web request for performing the operation.
Throws:: StorageException; URISyntaxException; IOException

setServiceProperties

public static HttpURLConnection setServiceProperties(URI uri,
                                     RequestOptions options,
                                     UriQueryBuilder builder,
                                     OperationContext opContext)
                                              throws IOException,
                                                     URISyntaxException,
                                                     StorageException

Creates a HttpURLConnection used to set the Analytics service properties on the storage service.

Parameters:: uri - The service endpoint.; timeout - The timeout.; builder - The builder.; opContext - an object used to track the execution of the operation
Returns:: a web request for performing the operation.
Throws:: IOException; URISyntaxException; StorageException

signRequestForBlobAndQueue

public static void signRequestForBlobAndQueue(HttpURLConnection request,
                              Credentials credentials,
                              Long contentLength,
                              OperationContext opContext)
                                       throws InvalidKeyException,
                                              StorageException

Signs the request appropriately to make it an authenticated request for Blob and Queue.

Parameters:: request - a HttpURLConnection for the operation.; credentials - the credentials to use for signing.; contentLength - the length of the content written to the output stream, -1 if unknown.; opContext - an object used to track the execution of the operation
Throws:: InvalidKeyException - if the credentials key is invalid.; StorageException

signRequestForBlobAndQueueSharedKeyLite

@Deprecated
public static void signRequestForBlobAndQueueSharedKeyLite(HttpURLConnection request,
                                                      Credentials credentials,
                                                      Long contentLength,
                                                      OperationContext opContext)
                                                    throws InvalidKeyException,
                                                           StorageException

Deprecated. as of 2.0.0. Use signRequestForBlobAndQueue(java.net.HttpURLConnection, com.microsoft.azure.storage.Credentials, java.lang.Long, com.microsoft.azure.storage.OperationContext) instead.

Signs the request appropriately to make it an authenticated request for Blob and Queue.

Parameters:: request - a HttpURLConnection for the operation.; credentials - the credentials to use for signing.; contentLength - the length of the content written to the output stream, -1 if unknown.; opContext - an object used to track the execution of the operation
Throws:: InvalidKeyException - if the credentials key is invalid.; StorageException

signRequestForTableSharedKey

public static void signRequestForTableSharedKey(HttpURLConnection request,
                                Credentials credentials,
                                Long contentLength,
                                OperationContext opContext)
                                         throws InvalidKeyException,
                                                StorageException

Signs the request appropriately to make it an authenticated request for Table.

Parameters:: request - a HttpURLConnection for the operation.; credentials - the credentials to use for signing.; contentLength - the length of the content written to the output stream, -1 if unknown.; opContext - an object used to track the execution of the operation
Throws:: InvalidKeyException - if the credentials key is invalid.; StorageException

signRequestForTableSharedKeyLite

@Deprecated
public static void signRequestForTableSharedKeyLite(HttpURLConnection request,
                                               Credentials credentials,
                                               Long contentLength,
                                               OperationContext opContext)
                                             throws InvalidKeyException,
                                                    StorageException

Deprecated. as of 2.0.0. Use signRequestForTableSharedKey(java.net.HttpURLConnection, com.microsoft.azure.storage.Credentials, java.lang.Long, com.microsoft.azure.storage.OperationContext) instead.