StorageRequest (Microsoft Azure Storage Client SDK 2.2.0 API)

java.lang.Object
- com.microsoft.azure.storage.core.StorageRequest<C,P,R>

Type Parameters:
C - The service client type
P - The type of the parent object, i.e. CloudBlobContainer for downloadAttributes etc.
R - The type of the expected result
```
public abstract class StorageRequest<C,P,R>
extends Object
```
RESERVED FOR INTERNAL USE. A class which encapsulate the execution of a given storage operation.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`StorageRequest()` Default Ctor.
	`StorageRequest(RequestOptions options, StorageUri storageUri)` Initializes a new instance of the StorageRequest class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyLocationModeToRequest()`
`abstract HttpURLConnection`	`buildRequest(C client, P parentObject, OperationContext context)` Function to construct the request.
`boolean`	`getArePropertiesPopulated()`
`HttpURLConnection`	`getConnection()`
`String`	`getContentMD5()`
`StorageLocation`	`getCurrentLocation()`
`long`	`getCurrentRequestByteCount()`
`AccessCondition`	`getETagLockCondition()`
`StorageException`	`getException()`
`Long`	`getLength()`
`LocationMode`	`getLocationMode()`
`String`	`getLockedETag()`
`Long`	`getOffset()`
`RequestLocationMode`	`getRequestLocationMode()`
`RequestOptions`	`getRequestOptions()`
`RequestResult`	`getResult()`
`InputStream`	`getSendStream()`
`StorageUri`	`getStorageUri()`
`protected void`	`initialize(OperationContext opContext)` Resets the operation status flags between operations.
`void`	`initializeLocation()`
`boolean`	`isNonExceptionedRetryableFailure()`
`protected boolean`	`isSent()`
`protected StorageException`	`materializeException(OperationContext opContext)` Returns either the held exception from the operation if it is set, otherwise the translated exception.
`StorageExtendedErrorInformation`	`parseErrorDetails()` Returns extended error information for this request.
`R`	`postProcessResponse(HttpURLConnection connection, P parentObject, C client, OperationContext context, R storageObject)` Post-Stream Retrieval function.
`abstract R`	`preProcessResponse(P parentObject, C client, OperationContext context)` Pre-Stream Retrieval function.
`void`	`recoveryAction(OperationContext context)` Recovery action for retries.
`void`	`setArePropertiesPopulated(boolean arePropertiesPopulated)`
`void`	`setConnection(HttpURLConnection connection)`
`void`	`setContentMD5(String contentMD5)`
`void`	`setCurrentLocation(StorageLocation currentLocation)`
`void`	`setCurrentRequestByteCount(long currentRequestByteCount)`
`void`	`setETagLockCondition(AccessCondition etagLockCondition)`
`protected void`	`setException(StorageException exceptionReference)`
`void`	`setHeaders(HttpURLConnection connection, P parentObject, OperationContext context)` Function to set custom headers.
`protected void`	`setIsSent(boolean isSent)`
`void`	`setLength(Long length)`
`void`	`setLocationMode(LocationMode locationMode)`
`void`	`setLockedETag(String lockedETag)`
`void`	`setNonExceptionedRetryableFailure(boolean nonExceptionedRetryableFailure)`
`void`	`setOffset(Long offset)`
`void`	`setRequestLocationMode()` Function to apply the location mode to the request.
`void`	`setRequestLocationMode(RequestLocationMode requestLocationMode)`
`protected void`	`setRequestOptions(RequestOptions requestOptions)`
`void`	`setResult(RequestResult result)`
`void`	`setSendStream(InputStream sendStream)`
`void`	`setStorageUri(StorageUri storageUri)`
`static void`	`signBlobQueueAndFileRequest(HttpURLConnection request, ServiceClient client, long contentLength, OperationContext context)`
`abstract void`	`signRequest(HttpURLConnection connection, C client, OperationContext context)` Function to Sign headers.
`static void`	`signTableRequest(HttpURLConnection request, ServiceClient client, long contentLength, OperationContext context)`
`void`	`validateLocation()`
`void`	`validateStreamWrite(StreamMd5AndLength descriptor)` Validate the written stream length when length is provided.

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

- Constructor Detail
  - StorageRequest
```
protected StorageRequest()
```
    Default Ctor.
  - StorageRequest
```
public StorageRequest(RequestOptions options,
              StorageUri storageUri)
```
    Initializes a new instance of the StorageRequest class.
    
    Parameters:
    options - the RequestOptions to use
- Method Detail
  - getException
```
public final StorageException getException()
```
    Returns:
    the exception
  - getRequestOptions
```
public final RequestOptions getRequestOptions()
```
    Returns:
    the requestOptions
  - getResult
```
public final RequestResult getResult()
```
    Returns:
    the result
  - getConnection
```
public final HttpURLConnection getConnection()
```
    Returns:
    the URL connection
  - getSendStream
```
public final InputStream getSendStream()
```
    Returns:
    the stream to send to server
  - getOffset
```
public Long getOffset()
```
    Returns:
    the offset to start reading from
  - getLength
```
public Long getLength()
```
    Returns:
    the length, in bytes, of the stream
  - getLockedETag
```
public final String getLockedETag()
```
    Returns:
    the locked ETag
  - getContentMD5
```
public final String getContentMD5()
```
    Returns:
    the ContentMD5
  - getLocationMode
```
public LocationMode getLocationMode()
```
    Returns:
    the location mode used to decide which location the request should be sent to.
  - getRequestLocationMode
```
public RequestLocationMode getRequestLocationMode()
```
    Returns:
    the location mode used to decide which location the request should be sent to.
  - getCurrentLocation
```
public StorageLocation getCurrentLocation()
```
    Returns:
    the current location to which the request will be sent.
  - getETagLockCondition
```
public AccessCondition getETagLockCondition()
```
    Returns:
    the locked ETag condition
  - getArePropertiesPopulated
```
public boolean getArePropertiesPopulated()
```
    Returns:
    the arePropertiesPopulated value
  - getStorageUri
```
public StorageUri getStorageUri()
```
    Returns:
    the URI to which the request will be sent.
  - getCurrentRequestByteCount
```
public long getCurrentRequestByteCount()
```
    Returns:
    the currentRequestByteCount
  - isSent
```
protected boolean isSent()
```
    Returns:
    the isSent value
  - initialize
```
protected final void initialize(OperationContext opContext)
```
    Resets the operation status flags between operations.
  - isNonExceptionedRetryableFailure
```
public final boolean isNonExceptionedRetryableFailure()
```
    Returns:
    the nonExceptionedRetryableFailure
  - materializeException
```
protected final StorageException materializeException(OperationContext opContext)
```
    Returns either the held exception from the operation if it is set, otherwise the translated exception.
    
    Parameters:
    request - the reference to the HttpURLConnection for the operation.
    opContext - an object used to track the execution of the operation
    
    Returns:
    the exception to throw.
  - signBlobQueueAndFileRequest
```
public static final void signBlobQueueAndFileRequest(HttpURLConnection request,
                               ServiceClient client,
                               long contentLength,
                               OperationContext context)
                                              throws InvalidKeyException,
                                                     StorageException
```
    Throws:
    
    InvalidKeyException
    
    StorageException
  - signTableRequest
```
public static final void signTableRequest(HttpURLConnection request,
                    ServiceClient client,
                    long contentLength,
                    OperationContext context)
                                   throws InvalidKeyException,
                                          StorageException
```
    Throws:
    
    InvalidKeyException
    
    StorageException
  - applyLocationModeToRequest
```
public void applyLocationModeToRequest()
```
  - initializeLocation
```
public void initializeLocation()
```
  - validateLocation
```
public void validateLocation()
```
  - setException
```
protected final void setException(StorageException exceptionReference)
```
    Parameters:
    exceptionReference - the exception to set
  - setNonExceptionedRetryableFailure
```
public final void setNonExceptionedRetryableFailure(boolean nonExceptionedRetryableFailure)
```
    Parameters:
    nonExceptionedRetryableFailure - the nonExceptionedRetryableFailure to set
  - setRequestOptions
```
protected final void setRequestOptions(RequestOptions requestOptions)
```
    Parameters:
    requestOptions - the requestOptions to set
  - setResult
```
public final void setResult(RequestResult result)
```
    Parameters:
    result - the result to set
  - setConnection
```
public final void setConnection(HttpURLConnection connection)
```
    Parameters:
    connection - the connection to set
  - setSendStream
```
public void setSendStream(InputStream sendStream)
```
    Parameters:
    sendStream - the stream to send to the server
  - setOffset
```
public void setOffset(Long offset)
```
    Parameters:
    offset - the stream offset to start copying from
  - setLength
```
public void setLength(Long length)
```
    Parameters:
    length - the length, in bytes, of the stream
  - setLockedETag
```
public void setLockedETag(String lockedETag)
```
    Parameters:
    lockedETag - the locked ETag
  - setContentMD5
```
public void setContentMD5(String contentMD5)
```
    Parameters:
    contentMD5 - the contentMD5
  - setETagLockCondition
```
public void setETagLockCondition(AccessCondition etagLockCondition)
```
    Parameters:
    etagLockCondition - the locked ETag condition
  - setArePropertiesPopulated
```
public void setArePropertiesPopulated(boolean arePropertiesPopulated)
```
    Parameters:
    arePropertiesPopulated - the arePropertiesPopulated value
  - setLocationMode
```
public void setLocationMode(LocationMode locationMode)
```
    Parameters:
    locationMode - the locationMode value
  - setRequestLocationMode
```
public void setRequestLocationMode(RequestLocationMode requestLocationMode)
```
    Parameters:
    requestLocationMode - the requestLocationMode value
  - setCurrentLocation
```
public void setCurrentLocation(StorageLocation currentLocation)
```
    Parameters:
    storageLocation - the storageLocation value
  - setStorageUri
```
public void setStorageUri(StorageUri storageUri)
```
    Parameters:
    storageUri - the storageUri value
  - setCurrentRequestByteCount
```
public void setCurrentRequestByteCount(long currentRequestByteCount)
```
    Parameters:
    currentRequestByteCount - the currentRequestByteCount to set
  - setRequestLocationMode
```
public void setRequestLocationMode()
```
    Function to apply the location mode to the request.
  - setIsSent
```
protected void setIsSent(boolean isSent)
```
    Parameters:
    isSent - the isSent value
  - buildRequest
```
public abstract HttpURLConnection buildRequest(C client,
                             P parentObject,
                             OperationContext context)
                                        throws Exception
```
    Function to construct the request.
    
    Parameters:
    parentObject - Parent object, i.e. CloudBlobContainer for downloadAttributes etc.
    context - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Returns:
    a HttpURLConnection configured for the operation.
    
    Throws:
    
    Exception
  - setHeaders
```
public void setHeaders(HttpURLConnection connection,
              P parentObject,
              OperationContext context)
```
    Function to set custom headers.
    
    Parameters:
    connection - HttpURLConnection configured for the operation.
    parentObject - Parent object, i.e. CloudBlobContainer for downloadAttributes etc.
    context - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
  - signRequest
```
public abstract void signRequest(HttpURLConnection connection,
               C client,
               OperationContext context)
                          throws Exception
```
    Function to Sign headers.
    
    Parameters:
    connection - HttpURLConnection configured for the operation.
    client - The service client.
    context - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.
    
    Throws:
    
    Exception
  - preProcessResponse
```
public abstract R preProcessResponse(P parentObject,
                   C client,
                   OperationContext context)
                              throws Exception
```
    Pre-Stream Retrieval function.
    
    Parameters:
    command - StorageCommand for the operation.
    parentObject - Parent object, i.e. CloudBlobContainer for downloadAttributes etc.
    client - The service client.
    
    Returns:
    an Object of the expected result's type.
    
    Throws:
    
    Exception
  - postProcessResponse
```
public R postProcessResponse(HttpURLConnection connection,
                    P parentObject,
                    C client,
                    OperationContext context,
                    R storageObject)
                      throws Exception
```
    Post-Stream Retrieval function.
    
    Parameters:
    connection - HttpURLConnection configured for the operation.
    storageObject - An object of the expected result's type.
    
    Returns:
    the expected result of the operation.
    
    Throws:
    
    Exception
  - validateStreamWrite
```
public void validateStreamWrite(StreamMd5AndLength descriptor)
                         throws StorageException
```
    Validate the written stream length when length is provided.
    
    Throws:
    
    StorageException
  - recoveryAction
```
public void recoveryAction(OperationContext context)
                    throws IOException
```
    Recovery action for retries.
    
    Throws:
    
    IOException
  - parseErrorDetails
```
public StorageExtendedErrorInformation parseErrorDetails()
```
    Returns extended error information for this request.
    
    Returns:
    A StorageExtendedErrorInformation object that represents the error details for the specified request.

/** 
* 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. 
*/

Class StorageRequest<C,P,R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StorageRequest

StorageRequest

Method Detail

getException

getRequestOptions

getResult

getConnection

getSendStream

getOffset

getLength

getLockedETag

getContentMD5

getLocationMode

getRequestLocationMode

getCurrentLocation

getETagLockCondition

getArePropertiesPopulated

getStorageUri

getCurrentRequestByteCount

isSent

initialize

isNonExceptionedRetryableFailure

materializeException

signBlobQueueAndFileRequest

signTableRequest

applyLocationModeToRequest

initializeLocation

validateLocation

setException

setNonExceptionedRetryableFailure

setRequestOptions

setResult

setConnection

setSendStream

setOffset

setLength

setLockedETag

setContentMD5

setETagLockCondition

setArePropertiesPopulated

setLocationMode

setRequestLocationMode

setCurrentLocation

setStorageUri

setCurrentRequestByteCount

setRequestLocationMode

setIsSent

buildRequest

setHeaders

signRequest

preProcessResponse

postProcessResponse

validateStreamWrite

recoveryAction

parseErrorDetails