ServiceClient (Microsoft Windows Azure Client API 0.4.2 API)

java.lang.Object
- com.microsoft.windowsazure.services.core.storage.ServiceClient

Direct Known Subclasses:

CloudBlobClient, CloudQueueClient, CloudTableClient
```
public abstract class ServiceClient
extends Object
```
Reserved for internal use. Provides a client for accessing the Windows Azure Storage service.

Field Summary

Fields
Modifier and Type	Field and Description
`protected StorageCredentials`	`credentials` Holds the StorageCredentials associated with this Service Client.
`protected URI`	`endpoint` Holds the base URI for the Service Client.
`protected RetryPolicyFactory`	`retryPolicyFactory` Holds the default retry policy for requests made via the service client to set.
`protected int`	`timeoutInMs` Holds the default server and client timeout for requests made by the service client.

Constructor Summary

Constructors
Constructor and Description
`ServiceClient(URI baseUri)` Creates an instance of the `ServiceClient` class using the specified service endpoint.
`ServiceClient(URI baseUri, StorageCredentials credentials)` Creates an instance of the `ServiceClient` class using the specified service endpoint and account credentials.

Method Summary

Methods
Modifier and Type	Method and Description
`ServiceProperties`	`downloadServiceProperties()` Retrieves the current ServiceProperties for the given storage service.
`ServiceProperties`	`downloadServiceProperties(RequestOptions options, OperationContext opContext)` Retrieves the current ServiceProperties for the given storage service.
`StorageCredentials`	`getCredentials()` Returns the storage credentials associated with this service client.
`URI`	`getEndpoint()` Returns the base URI for this service client.
`RetryPolicyFactory`	`getRetryPolicyFactory()` Returns the retry policy currently in effect for this Blob service client.
`int`	`getTimeoutInMs()` Returns the timeout value for requests made to the service.
`boolean`	`isUsePathStyleUris()`
`protected void`	`setBaseURI(URI baseUri)` Sets the base URI for the service client.
`protected void`	`setCredentials(StorageCredentials credentials)` Sets the credentials to use with this service client.
`void`	`setRetryPolicyFactory(RetryPolicyFactory retryPolicyFactory)` Sets the RetryPolicyFactory object to use when making service requests.
`void`	`setTimeoutInMs(int timeoutInMs)` Sets the timeout to use when making requests to the storage service.
`void`	`uploadServiceProperties(ServiceProperties properties)` Uploads a new configuration to the storage service.
`void`	`uploadServiceProperties(ServiceProperties properties, RequestOptions options, OperationContext opContext)` Uploads a new configuration to the storage service.

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

- Field Detail
  - endpoint
```
protected URI endpoint
```
    Holds the base URI for the Service Client.
  - credentials
```
protected StorageCredentials credentials
```
    Holds the StorageCredentials associated with this Service Client.
  - retryPolicyFactory
```
protected RetryPolicyFactory retryPolicyFactory
```
    Holds the default retry policy for requests made via the service client to set.
  - timeoutInMs
```
protected int timeoutInMs
```
    Holds the default server and client timeout for requests made by the service client.
- Constructor Detail
  - ServiceClient
```
public ServiceClient(URI baseUri)
```
    Creates an instance of the ServiceClient class using the specified service endpoint.
    
    Parameters:
    baseUri - A java.net.URI object that represents the service endpoint used to create the client.
  - ServiceClient
```
public ServiceClient(URI baseUri,
             StorageCredentials credentials)
```
    Creates an instance of the ServiceClient class using the specified service endpoint and account credentials.
    
    Parameters:
    baseUri - A java.net.URI object that represents the service endpoint used to create the client.
    credentials - A StorageCredentials object that represents the account credentials.
- Method Detail
  - downloadServiceProperties
```
public final ServiceProperties downloadServiceProperties()
                                                  throws StorageException
```
    Retrieves the current ServiceProperties for the given storage service. This includes Metrics and Logging Configurations.
    
    Returns:
    the ServiceProperties object representing the current configuration of the service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadServiceProperties
```
public final ServiceProperties downloadServiceProperties(RequestOptions options,
                                          OperationContext opContext)
                                                  throws StorageException
```
    Retrieves the current ServiceProperties for the given storage service. This includes Metrics and Logging Configurations.
    
    Parameters:
    options - A RequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClientCloudQueueClient).
    opContext - 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:
    the ServiceProperties object representing the current configuration of the service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - getCredentials
```
public final StorageCredentials getCredentials()
```
    Returns the storage credentials associated with this service client.
    
    Returns:
    A StorageCredentials object that represents the storage credentials associated with this client.
  - getEndpoint
```
public final URI getEndpoint()
```
    Returns the base URI for this service client.
    
    Returns:
    A java.net.URI object that represents the base URI for the service client.
  - getRetryPolicyFactory
```
public final RetryPolicyFactory getRetryPolicyFactory()
```
    Returns the retry policy currently in effect for this Blob service client.
    
    Returns:
    An RetryPolicyFactory object that represents the current retry policy.
    See Also:
    RetryPolicy, RetryExponentialRetry, RetryLinearRetry, RetryNoRetry
  - getTimeoutInMs
```
public final int getTimeoutInMs()
```
    Returns the timeout value for requests made to the service. For more information about the timeout, see setTimeoutInMs(int).
    
    Returns:
    The current timeout value, in milliseconds, for requests made to the storage service.
  - isUsePathStyleUris
```
public final boolean isUsePathStyleUris()
```
    Returns:
    the usePathStyleUris
  - setBaseURI
```
protected final void setBaseURI(URI baseUri)
```
    Sets the base URI for the service client.
    
    Parameters:
    baseUri - A java.net.URI object that represents the base URI being assigned to the service client.
  - setCredentials
```
protected final void setCredentials(StorageCredentials credentials)
```
    Sets the credentials to use with this service client.
    
    Parameters:
    credentials - A Credentials object that represents the credentials being assigned for the service client.
  - setRetryPolicyFactory
```
public void setRetryPolicyFactory(RetryPolicyFactory retryPolicyFactory)
```
    Sets the RetryPolicyFactory object to use when making service requests.
    
    Parameters:
    retryPolicyFactory - the RetryPolicyFactory object to use when making service requests.
  - setTimeoutInMs
```
public final void setTimeoutInMs(int timeoutInMs)
```
    Sets the timeout to use when making requests to the storage service.
    The server timeout interval begins at the time that the complete request has been received by the service, and the server begins processing the response. If the timeout interval elapses before the response is returned to the client, the operation times out. The timeout interval resets with each retry, if the request is retried. The default timeout interval for a request made via the service client is 90 seconds. You can change this value on the service client by setting this property, so that all subsequent requests made via the service client will use the new timeout interval. You can also change this value for an individual request, by setting the RequestOptions.timeoutIntervalInMs property. If you are downloading a large blob, you should increase the value of the timeout beyond the default value.
    
    Parameters:
    timeoutInMs - The timeout, in milliseconds, to use when making requests to the storage service.
  - uploadServiceProperties
```
@DoesServiceRequest
public void uploadServiceProperties(ServiceProperties properties)
                             throws StorageException
```
    Uploads a new configuration to the storage service. This includes Metrics and Logging Configuration.
    
    Parameters:
    properties - The ServiceProperties to upload.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadServiceProperties
```
@DoesServiceRequest
public void uploadServiceProperties(ServiceProperties properties,
                                              RequestOptions options,
                                              OperationContext opContext)
                             throws StorageException
```
    Uploads a new configuration to the storage service. This includes Metrics and Logging Configuration.
    
    Parameters:
    properties - The ServiceProperties to upload.
    options - A RequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClientCloudQueueClient).
    opContext - 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:
    
    StorageException - If a storage service error occurred.

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

endpoint

credentials

retryPolicyFactory

timeoutInMs

Constructor Detail

ServiceClient

ServiceClient

Method Detail

downloadServiceProperties

downloadServiceProperties

getCredentials

getEndpoint

getRetryPolicyFactory

getTimeoutInMs

isUsePathStyleUris

setBaseURI

setCredentials

setRetryPolicyFactory

setTimeoutInMs

uploadServiceProperties

uploadServiceProperties