OperationContext (Microsoft Azure Storage Client SDK 8.0.0 API)

java.lang.Object
- com.microsoft.azure.storage.OperationContext

```
public final class OperationContext
extends Object
```
Represents the current logical operation. A logical operation may have a one-to-many relationship with multiple individual physical requests.

Field Summary

Fields
Modifier and Type Field and Description

static String defaultLoggerName
Name of the Logger that will be created by default if logging is enabled and a Logger has not been specified.

Fields
Modifier and Type	Field and Description
`static String`	`defaultLoggerName` Name of the `Logger` that will be created by default if logging is enabled and a `Logger` has not been specified.

Constructor Summary

Constructors
Constructor and Description

OperationContext()
Creates an instance of the OperationContext class.

Constructors
Constructor and Description
`OperationContext()` Creates an instance of the `OperationContext` class.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`appendRequestResult(RequestResult requestResult)` Reserved for internal use.
`String`	`getClientRequestID()` Gets the client side trace ID.
`long`	`getClientTimeInMs()` Gets the operation latency, in milliseconds, from the client's perspective.
`static Proxy`	`getDefaultProxy()` Gets the default proxy used by the client library if enabled.
`StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>>`	`getErrorReceivingResponseEventHandler()` Gets an event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received.
`static StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>>`	`getGlobalErrorReceivingResponseEventHandler()` Gets a global event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received.
`static StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>>`	`getGlobalRequestCompletedEventHandler()` Gets a global event multi-caster that is triggered when a request is completed.
`static StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>>`	`getGlobalResponseReceivedEventHandler()` Gets a global event multi-caster that is triggered when a response is received.
`static StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>>`	`getGlobalRetryingEventHandler()` Gets a global event multi-caster that is triggered when a request is retried.
`static StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>>`	`getGlobalSendingRequestEventHandler()` Gets a global event multi-caster that is triggered before sending a request.
`RequestResult`	`getLastResult()` Gets the last request result encountered for the operation.
`org.slf4j.Logger`	`getLogger()` Gets the `Logger` associated with this operation.
`Proxy`	`getProxy()` Gets a proxy which will be used when making a request.
`StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>>`	`getRequestCompletedEventHandler()` Gets an event multi-caster that is triggered when a request is completed.
`ArrayList<RequestResult>`	`getRequestResults()` Returns the set of request results that the current operation has created.
`StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>>`	`getResponseReceivedEventHandler()` Gets an event multi-caster that is triggered when a response is received.
`StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>>`	`getRetryingEventHandler()` Gets an event multi-caster that is triggered when a request is retried.
`StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>>`	`getSendingRequestEventHandler()` Gets an event multi-caster that is triggered before sending a request.
`HashMap<String,String>`	`getUserHeaders()` Gets any additional headers for the request, for example, for proxy or logging information.
`void`	`initialize()` Reserved for internal use.
`boolean`	`isLoggingEnabled()` Indicates whether log entries will be produced for this request.
`static boolean`	`isLoggingEnabledByDefault()` Indicates whether the client library should produce log entries by default.
`void`	`setClientRequestID(String clientRequestID)` Sets the client side request ID.
`void`	`setClientTimeInMs(long clientTimeInMs)` Reserved for internal use.
`static void`	`setDefaultProxy(Proxy defaultProxy)` Specifies the proxy the client library should use by default.
`void`	`setErrorReceivingResponseEventHandler(StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>> errorReceivingResponseEventHandler)` Sets an event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received.
`static void`	`setGlobalErrorReceivingResponseEventHandler(StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>> globalErrorReceivingResponseEventHandler)` Sets a global event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received.
`static void`	`setGlobalRequestCompletedEventHandler(StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>> globalRequestCompletedEventHandler)` Sets a global event multi-caster that is triggered when a request is completed.
`static void`	`setGlobalResponseReceivedEventHandler(StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>> globalResponseReceivedEventHandler)` Sets a global event multi-caster that is triggered when a response is received.
`static void`	`setGlobalRetryingEventHandler(StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>> globalRetryingEventHandler)` Sets a global event multi-caster that is triggered when a request is retried.
`static void`	`setGlobalSendingRequestEventHandler(StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>> globalSendingRequestEventHandler)` Sets a global event multi-caster that is triggered before sending a request.
`void`	`setLogger(org.slf4j.Logger logger)` Sets the `Logger` for this operation.
`void`	`setLoggingEnabled(boolean loggingEnabled)` Specifies whether log entries will be produced for this request.
`static void`	`setLoggingEnabledByDefault(boolean enableLoggingByDefault)` Specifies whether the client library should produce log entries by default.
`void`	`setProxy(Proxy proxy)` Sets a proxy which will be used when making a request.
`void`	`setRequestCompletedEventHandler(StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>> requestCompletedEventHandler)` Sets an event multi-caster that is triggered when a request is completed.
`void`	`setResponseReceivedEventHandler(StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>> responseReceivedEventHandler)` Sets an event multi-caster that is triggered when a response is received.
`void`	`setRetryingEventHandler(StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>> retryingEventHandler)` Sets an event multi-caster that is triggered when a request is retried.
`void`	`setSendingRequestEventHandler(StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>> sendingRequestEventHandler)` Sets an event multi-caster that is triggered before sending a request.
`void`	`setUserHeaders(HashMap<String,String> userHeaders)` Sets any additional headers for the request, for example, for proxy or logging information.

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

- Field Detail
  - defaultLoggerName
```
public static final String defaultLoggerName
```
    Name of the Logger that will be created by default if logging is enabled and a Logger has not been specified.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - OperationContext
```
public OperationContext()
```
    Creates an instance of the OperationContext class.
- Method Detail
  - getClientRequestID
```
public String getClientRequestID()
```
    Gets the client side trace ID.
    
    Returns:
    A String which represents the client request ID.
  - getClientTimeInMs
```
public long getClientTimeInMs()
```
    Gets the operation latency, in milliseconds, from the client's perspective. This may include any potential retries.
    
    Returns:
    A long which contains the client latency time in milliseconds.
  - getLastResult
```
public RequestResult getLastResult()
```
    Gets the last request result encountered for the operation.
    
    Returns:
    A RequestResult object which represents the last request result.
  - getLogger
```
public org.slf4j.Logger getLogger()
```
    Gets the Logger associated with this operation. If the Logger object associated with this operation is null, this will return the class's default Logger object.
    
    Returns:
    The Logger object associated with this operation, or the class's default Logger if null.
  - getProxy
```
public Proxy getProxy()
```
    Gets a proxy which will be used when making a request. Default is null. To set a proxy to use by default, use setDefaultProxy(java.net.Proxy)
    
    Returns:
    A Proxy to use when making a request.
  - getUserHeaders
```
public HashMap<String,String> getUserHeaders()
```
    Gets any additional headers for the request, for example, for proxy or logging information.
    
    Returns:
    A java.util.HashMap which contains the the user headers for the request.
  - getRequestResults
```
public ArrayList<RequestResult> getRequestResults()
```
    Returns the set of request results that the current operation has created.
    
    Returns:
    An ArrayList object that contains RequestResult objects that represent the request results created by the current operation.
  - appendRequestResult
```
public void appendRequestResult(RequestResult requestResult)
```
    Reserved for internal use. Appends a RequestResult object to the internal collection in a synchronized manner.
    
    Parameters:
    requestResult - A RequestResult to append.
  - getGlobalSendingRequestEventHandler
```
public static StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>> getGlobalSendingRequestEventHandler()
```
    Gets a global event multi-caster that is triggered before sending a request. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the globalSendingRequestEventHandler.
  - getGlobalResponseReceivedEventHandler
```
public static StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>> getGlobalResponseReceivedEventHandler()
```
    Gets a global event multi-caster that is triggered when a response is received. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the globalResponseReceivedEventHandler.
  - getGlobalErrorReceivingResponseEventHandler
```
public static StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>> getGlobalErrorReceivingResponseEventHandler()
```
    Gets a global event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the globabErrorReceivingResponseEventHandler.
  - getGlobalRequestCompletedEventHandler
```
public static StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>> getGlobalRequestCompletedEventHandler()
```
    Gets a global event multi-caster that is triggered when a request is completed. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the globalRequestCompletedEventHandler.
  - getGlobalRetryingEventHandler
```
public static StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>> getGlobalRetryingEventHandler()
```
    Gets a global event multi-caster that is triggered when a request is retried. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the globalRetryingEventHandler.
  - getSendingRequestEventHandler
```
public StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>> getSendingRequestEventHandler()
```
    Gets an event multi-caster that is triggered before sending a request. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the sendingRequestEventHandler.
  - getResponseReceivedEventHandler
```
public StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>> getResponseReceivedEventHandler()
```
    Gets an event multi-caster that is triggered when a response is received. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the responseReceivedEventHandler.
  - getErrorReceivingResponseEventHandler
```
public StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>> getErrorReceivingResponseEventHandler()
```
    Gets an event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the errorReceivingResponseEventHandler.
  - getRequestCompletedEventHandler
```
public StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>> getRequestCompletedEventHandler()
```
    Gets an event multi-caster that is triggered when a request is completed. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the requestCompletedEventHandler.
  - getRetryingEventHandler
```
public StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>> getRetryingEventHandler()
```
    Gets an event multi-caster that is triggered when a request is retried. It allows event listeners to be dynamically added and removed.
    
    Returns:
    A StorageEventMultiCaster object for the retryingEventHandler.
  - initialize
```
public void initialize()
```
    Reserved for internal use. Initializes the OperationContext in order to begin processing a new operation. All operation specific information is erased.
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    Indicates whether log entries will be produced for this request.
    
    Returns:
    true if logging is enabled; otherwise false.
  - setClientRequestID
```
public void setClientRequestID(String clientRequestID)
```
    Sets the client side request ID.
    
    Parameters:
    clientRequestID - A String which contains the client request ID to set.
  - setClientTimeInMs
```
public void setClientTimeInMs(long clientTimeInMs)
```
    Reserved for internal use. Represents the operation latency, in milliseconds, from the client's perspective. This may include any potential retries.
    
    Parameters:
    clientTimeInMs - A long which contains the client operation latency in milliseconds.
  - setLogger
```
public void setLogger(org.slf4j.Logger logger)
```
    Sets the Logger for this operation.
    
    Parameters:
    logger - The Logger to use for this operation.
  - setProxy
```
public void setProxy(Proxy proxy)
```
    Sets a proxy which will be used when making a request. Default is null. To set a proxy to use by default, use setDefaultProxy(java.net.Proxy)
    
    Parameters:
    proxy - A Proxy to use when making a request.
  - setUserHeaders
```
public void setUserHeaders(HashMap<String,String> userHeaders)
```
    Sets any additional headers for the request, for example, for proxy or logging information.
    
    Parameters:
    userHeaders - A java.util.HashMap which contains any additional headers to set.
  - setLoggingEnabled
```
public void setLoggingEnabled(boolean loggingEnabled)
```
    Specifies whether log entries will be produced for this request.
    
    Parameters:
    loggingEnabled - true to enable logging; otherwise false to disable logging.
  - setGlobalSendingRequestEventHandler
```
public static void setGlobalSendingRequestEventHandler(StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>> globalSendingRequestEventHandler)
```
    Sets a global event multi-caster that is triggered before sending a request.
    
    Parameters:
    globalSendingRequestEventHandler - The StorageEventMultiCaster object to set for the globalSendingRequestEventHandler.
  - setGlobalResponseReceivedEventHandler
```
public static void setGlobalResponseReceivedEventHandler(StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>> globalResponseReceivedEventHandler)
```
    Sets a global event multi-caster that is triggered when a response is received.
    
    Parameters:
    globalResponseReceivedEventHandler - The StorageEventMultiCaster object to set for the globalResponseReceivedEventHandler.
  - setGlobalErrorReceivingResponseEventHandler
```
public static void setGlobalErrorReceivingResponseEventHandler(StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>> globalErrorReceivingResponseEventHandler)
```
    Sets a global event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received.
    
    Parameters:
    globalErrorReceivingResponseEventHandler - The StorageEventMultiCaster object to set for the globalErrorReceivingResponseEventHandler.
  - setGlobalRequestCompletedEventHandler
```
public static void setGlobalRequestCompletedEventHandler(StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>> globalRequestCompletedEventHandler)
```
    Sets a global event multi-caster that is triggered when a request is completed.
    
    Parameters:
    globalRequestCompletedEventHandler - The StorageEventMultiCaster object to set for the globalRequestCompletedEventHandler.
  - setGlobalRetryingEventHandler
```
public static void setGlobalRetryingEventHandler(StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>> globalRetryingEventHandler)
```
    Sets a global event multi-caster that is triggered when a request is retried.
    
    Parameters:
    globalRetryingEventHandler - The StorageEventMultiCaster object to set for the globalRetryingEventHandler.
  - setSendingRequestEventHandler
```
public void setSendingRequestEventHandler(StorageEventMultiCaster<SendingRequestEvent,StorageEvent<SendingRequestEvent>> sendingRequestEventHandler)
```
    Sets an event multi-caster that is triggered before sending a request.
    
    Parameters:
    sendingRequestEventHandler - The StorageEventMultiCaster object to set for the sendingRequestEventHandler.
  - setResponseReceivedEventHandler
```
public void setResponseReceivedEventHandler(StorageEventMultiCaster<ResponseReceivedEvent,StorageEvent<ResponseReceivedEvent>> responseReceivedEventHandler)
```
    Sets an event multi-caster that is triggered when a response is received.
    
    Parameters:
    responseReceivedEventHandler - The StorageEventMultiCaster object to set for the responseReceivedEventHandler.
  - setErrorReceivingResponseEventHandler
```
public void setErrorReceivingResponseEventHandler(StorageEventMultiCaster<ErrorReceivingResponseEvent,StorageEvent<ErrorReceivingResponseEvent>> errorReceivingResponseEventHandler)
```
    Sets an event multi-caster that is triggered when a network error occurs before the HTTP response status and headers are received.
    
    Parameters:
    errorReceivingResponseEventHandler - The StorageEventMultiCaster object to set for the errorReceivingResponseEventHandler.
  - setRequestCompletedEventHandler
```
public void setRequestCompletedEventHandler(StorageEventMultiCaster<RequestCompletedEvent,StorageEvent<RequestCompletedEvent>> requestCompletedEventHandler)
```
    Sets an event multi-caster that is triggered when a request is completed.
    
    Parameters:
    requestCompletedEventHandler - The StorageEventMultiCaster object to set for the requestCompletedEventHandler.
  - setRetryingEventHandler
```
public void setRetryingEventHandler(StorageEventMultiCaster<RetryingEvent,StorageEvent<RetryingEvent>> retryingEventHandler)
```
    Sets an event multi-caster that is triggered when a request is retried.
    
    Parameters:
    retryingEventHandler - The StorageEventMultiCaster object to set for the retryingEventHandler.
  - isLoggingEnabledByDefault
```
public static boolean isLoggingEnabledByDefault()
```
    Indicates whether the client library should produce log entries by default. The default can be overridden to enable logging for an individual operation context instance by using setLoggingEnabled(boolean).
    
    Returns:
    true if logging is enabled by default; otherwise false.
  - setLoggingEnabledByDefault
```
public static void setLoggingEnabledByDefault(boolean enableLoggingByDefault)
```
    Specifies whether the client library should produce log entries by default. The default can be overridden to turn on logging for an individual operation context instance by using setLoggingEnabled(boolean).
    
    Parameters:
    enableLoggingByDefault - true if logging should be enabled by default; otherwise false if logging should be disabled by default.
  - getDefaultProxy
```
public static Proxy getDefaultProxy()
```
    Gets the default proxy used by the client library if enabled. The default can be overridden to enable a proxy for an individual operation context instance by using setProxy(java.net.Proxy).
    
    Returns:
    The default Proxy if set; otherwise null
  - setDefaultProxy
```
public static void setDefaultProxy(Proxy defaultProxy)
```
    Specifies the proxy the client library should use by default. The default can be overridden to turn on a proxy for an individual operation context instance by using setProxy(java.net.Proxy).
    
    Parameters:
    defaultProxy - The Proxy to use by default, or null to not use a proxy.

Class OperationContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultLoggerName

Constructor Detail

OperationContext

Method Detail

getClientRequestID

getClientTimeInMs

getLastResult

getLogger

getProxy

getUserHeaders

getRequestResults

appendRequestResult

getGlobalSendingRequestEventHandler

getGlobalResponseReceivedEventHandler

getGlobalErrorReceivingResponseEventHandler

getGlobalRequestCompletedEventHandler

getGlobalRetryingEventHandler

getSendingRequestEventHandler

getResponseReceivedEventHandler

getErrorReceivingResponseEventHandler

getRequestCompletedEventHandler

getRetryingEventHandler

initialize

isLoggingEnabled

setClientRequestID

setClientTimeInMs

setLogger

setProxy

setUserHeaders

setLoggingEnabled

setGlobalSendingRequestEventHandler

setGlobalResponseReceivedEventHandler

setGlobalErrorReceivingResponseEventHandler

setGlobalRequestCompletedEventHandler

setGlobalRetryingEventHandler

setSendingRequestEventHandler

setResponseReceivedEventHandler

setErrorReceivingResponseEventHandler

setRequestCompletedEventHandler

setRetryingEventHandler

isLoggingEnabledByDefault

setLoggingEnabledByDefault

getDefaultProxy

setDefaultProxy