com.microsoft.azure.storage.ServiceClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsoft-windowsazure-storage-sdk Show documentation
Show all versions of microsoft-windowsazure-storage-sdk Show documentation
SDK for Microsoft Azure Storage Clients
/**
* 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.
*/
package com.microsoft.azure.storage;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import javax.xml.stream.XMLStreamException;
import com.microsoft.azure.storage.core.BaseRequest;
import com.microsoft.azure.storage.core.RequestLocationMode;
import com.microsoft.azure.storage.core.SR;
import com.microsoft.azure.storage.core.StorageRequest;
import com.microsoft.azure.storage.core.StreamMd5AndLength;
import com.microsoft.azure.storage.core.Utility;
/**
* Provides a client for accessing the Microsoft Azure Storage service.
*/
public abstract class ServiceClient {
/**
* Holds the list of URIs for all locations.
*/
private StorageUri storageUri;
/**
* Holds the StorageCredentials associated with this Service Client.
*/
protected StorageCredentials credentials;
/**
* Reserved for internal use. An internal flag which indicates if path style uris should be used.
*/
private boolean usePathStyleUris;
/**
* Holds the AuthenticationScheme associated with this Service Client.
*/
protected AuthenticationScheme authenticationScheme = AuthenticationScheme.SHAREDKEYFULL;
/**
* Creates an instance of the ServiceClient class using the specified service endpoint and account
* credentials.
*
* @param storageUri
* A {@link StorageUri} object which represents the service endpoint used to create the client.
* @param credentials
* A {@link StorageCredentials} object which represents the account credentials.
*/
protected ServiceClient(final StorageUri storageUri, final StorageCredentials credentials) {
Utility.assertNotNull("baseUri", storageUri);
if (!storageUri.isAbsolute()) {
throw new IllegalArgumentException(String.format(SR.RELATIVE_ADDRESS_NOT_PERMITTED, storageUri));
}
this.credentials = credentials == null ? StorageCredentialsAnonymous.ANONYMOUS : credentials;
this.usePathStyleUris = Utility.determinePathStyleFromUri(storageUri.getPrimaryUri());
this.storageUri = storageUri;
}
protected StorageRequest downloadServicePropertiesImpl(
final RequestOptions options, final boolean signAsTable) {
final StorageRequest getRequest = new StorageRequest(
options, this.getStorageUri()) {
@Override
public HttpURLConnection buildRequest(ServiceClient client, Void parentObject, OperationContext context)
throws Exception {
return BaseRequest.getServiceProperties(client.getEndpoint(), options, null, context);
}
@Override
public void signRequest(HttpURLConnection connection, ServiceClient client, OperationContext context)
throws Exception {
if (signAsTable) {
StorageRequest.signTableRequest(connection, client, -1, null);
}
else {
StorageRequest.signBlobAndQueueRequest(connection, client, -1, null);
}
}
@Override
public ServiceProperties preProcessResponse(Void parentObject, ServiceClient client,
OperationContext context) throws Exception {
if (this.getResult().getStatusCode() != HttpURLConnection.HTTP_OK) {
this.setNonExceptionedRetryableFailure(true);
}
return null;
}
@Override
public ServiceProperties postProcessResponse(HttpURLConnection connection, Void parentObject,
ServiceClient client, OperationContext context, ServiceProperties storageObject) throws Exception {
return ServicePropertiesHandler.readServicePropertiesFromStream(connection.getInputStream());
}
};
return getRequest;
}
protected StorageRequest getServiceStatsImpl(final RequestOptions options,
final boolean signAsTable) {
final StorageRequest getRequest = new StorageRequest(
options, this.getStorageUri()) {
@Override
public void setRequestLocationMode() {
this.applyLocationModeToRequest();
this.setRequestLocationMode(RequestLocationMode.PRIMARY_OR_SECONDARY);
}
@Override
public HttpURLConnection buildRequest(ServiceClient client, Void parentObject, OperationContext context)
throws Exception {
return BaseRequest.getServiceStats(client.getStorageUri().getUri(this.getCurrentLocation()), options,
null, context);
}
@Override
public void signRequest(HttpURLConnection connection, ServiceClient client, OperationContext context)
throws Exception {
if (signAsTable) {
StorageRequest.signTableRequest(connection, client, -1, null);
}
else {
StorageRequest.signBlobAndQueueRequest(connection, client, -1, null);
}
}
@Override
public ServiceStats preProcessResponse(Void parentObject, ServiceClient client, OperationContext context)
throws Exception {
if (this.getResult().getStatusCode() != HttpURLConnection.HTTP_OK) {
this.setNonExceptionedRetryableFailure(true);
}
return null;
}
@Override
public ServiceStats postProcessResponse(HttpURLConnection connection, Void parentObject,
ServiceClient client, OperationContext context, ServiceStats storageObject) throws Exception {
return ServiceStatsHandler.readServiceStatsFromStream(connection.getInputStream());
}
};
return getRequest;
}
/**
* Returns the storage credentials associated with this service client.
*
* @return A {@link StorageCredentials} object which represents the storage credentials associated with this client.
*/
public final StorageCredentials getCredentials() {
return this.credentials;
}
/**
* Returns the AuthenticationScheme associated with this service client.
*
* @return An {@link AuthenticationScheme} object which represents the authentication scheme associated with this
* client.
*/
public final AuthenticationScheme getAuthenticationScheme() {
return this.authenticationScheme;
}
/**
* Returns the base URI for this service client.
*
* @return A java.net.URI object which represents the base URI for the service client.
*/
public final URI getEndpoint() {
return this.storageUri.getPrimaryUri();
}
/**
* Returns the list of URIs for all locations.
*
* @return A {@link StorageUri} object which represents the list of URIs for all locations.
*/
public final StorageUri getStorageUri() {
return this.storageUri;
}
/**
* @return true if path-style URIs are used; otherwise, false.
*/
protected boolean isUsePathStyleUris() {
return this.usePathStyleUris;
}
/**
* Sets the credentials to use with this service client.
*
* @param credentials
* A {@link StorageCredentials} object which represents the credentials being assigned for the service
* client.
*/
protected final void setCredentials(final StorageCredentials credentials) {
this.credentials = credentials;
}
/**
* Sets the list of URIs for all locations.
*
* @param storageUri
* A {@link StorageUri} object which represents the list of URIs for all locations.
*/
protected final void setStorageUri(final StorageUri storageUri) {
this.usePathStyleUris = Utility.determinePathStyleFromUri(storageUri.getPrimaryUri());
this.storageUri = storageUri;
}
/**
* Sets the Authentication Scheme to use with this service client.
*
* @param scheme
* An {@link AuthenticationScheme} object which represents the authentication scheme being assigned for
* the service client.
*/
public final void setAuthenticationScheme(final AuthenticationScheme scheme) {
this.authenticationScheme = scheme;
}
protected StorageRequest uploadServicePropertiesImpl(final ServiceProperties properties,
final RequestOptions options, final OperationContext opContext, final boolean signAsTable)
throws StorageException {
try {
byte[] propertiesBytes = ServicePropertiesSerializer.serializeToByteArray(properties);
final ByteArrayInputStream sendStream = new ByteArrayInputStream(propertiesBytes);
final StreamMd5AndLength descriptor = Utility.analyzeStream(sendStream, -1L, -1L,
true /* rewindSourceStream */, true /* calculateMD5 */);
final StorageRequest putRequest = new StorageRequest(
options, this.getStorageUri()) {
@Override
public HttpURLConnection buildRequest(ServiceClient client, Void parentObject, OperationContext context)
throws Exception {
this.setSendStream(sendStream);
this.setLength(descriptor.getLength());
return BaseRequest.setServiceProperties(client.getEndpoint(), options, null, context);
}
@Override
public void setHeaders(HttpURLConnection connection, Void parentObject, OperationContext context) {
connection.setRequestProperty(Constants.HeaderConstants.CONTENT_MD5, descriptor.getMd5());
}
@Override
public void signRequest(HttpURLConnection connection, ServiceClient client, OperationContext context)
throws Exception {
if (signAsTable) {
StorageRequest.signTableRequest(connection, client, descriptor.getLength(), null);
}
else {
StorageRequest.signBlobAndQueueRequest(connection, client, descriptor.getLength(), null);
}
}
@Override
public Void preProcessResponse(Void parentObject, ServiceClient client, OperationContext context)
throws Exception {
if (this.getResult().getStatusCode() != HttpURLConnection.HTTP_ACCEPTED) {
this.setNonExceptionedRetryableFailure(true);
}
return null;
}
@Override
public void recoveryAction(OperationContext context) throws IOException {
sendStream.reset();
sendStream.mark(Constants.MAX_MARK_LENGTH);
}
};
return putRequest;
}
catch (IllegalArgumentException e) {
// to do : Move this to multiple catch clause so we can avoid the duplicated code once we move to Java 1.7.
// The request was not even made. There was an error while trying to read the permissions. Just throw.
StorageException translatedException = StorageException.translateException(null, e, null);
throw translatedException;
}
catch (XMLStreamException e) {
// The request was not even made. There was an error while trying to read the serviceProperties and write to stream. Just throw.
StorageException translatedException = StorageException.translateException(null, e, null);
throw translatedException;
}
catch (IOException e) {
// The request was not even made. There was an error while trying to read the serviceProperties and write to stream. Just throw.
StorageException translatedException = StorageException.translateException(null, e, null);
throw translatedException;
}
}
/**
* Gets the default location mode for requests made via the service client.
*
* @return A {@link LocationMode} object which represents the default location mode for the service client.
*
* @deprecated use {@link #getDefaultRequestOptions().getLocationMode()} instead.
*/
@Deprecated
public final LocationMode getLocationMode() {
return this.getDefaultRequestOptions().getLocationMode();
}
/**
* Returns the retry policy currently in effect for this service client.
*
* @return An {@link RetryPolicyFactory} object which represents the current retry policy.
*
* @see RetryPolicy
* @see RetryExponentialRetry
* @see RetryLinearRetry
* @see RetryNoRetry
*
* @deprecated use {@link #getDefaultRequestOptions().getRetryPolicyFactory()} instead.
*/
@Deprecated
public final RetryPolicyFactory getRetryPolicyFactory() {
return this.getDefaultRequestOptions().getRetryPolicyFactory();
}
/**
* Returns the timeout value for requests made to the service. For more information about the timeout, see
* {@link #setTimeoutInMs}.
*
* @return The current timeout value, in milliseconds, for requests made to the storage service.
*
* @deprecated use {@link #getDefaultRequestOptions().getTimeoutIntervalInMs()} instead.
*/
@Deprecated
public final int getTimeoutInMs() {
return this.getDefaultRequestOptions().getTimeoutIntervalInMs();
}
/**
* Returns the maximum execution time, in milliseconds, across all potential retries. For more information about
* maximum execution time, see {@link #setMaximumExecutionTimeInMs(Integer)}.
*
* @return The maximum execution time, in milliseconds, for requests made to the storage service.
*
* @deprecated use {@link #getDefaultRequestOptions().getMaximumExecutionTimeInMs()} instead.
*/
@Deprecated
public Integer getMaximumExecutionTimeInMs() {
return this.getDefaultRequestOptions().getMaximumExecutionTimeInMs();
}
/**
* Sets the default {@link LocationMode} for requests made via the service client.
*
* @param locationMode
* the locationMode to set
*
* @deprecated use {@link #getDefaultRequestOptions().setLocationMode()} instead.
*/
@Deprecated
public void setLocationMode(LocationMode locationMode) {
this.getDefaultRequestOptions().setLocationMode(locationMode);
}
/**
* Sets the RetryPolicyFactory object to use when making service requests.
*
* @param retryPolicyFactory
* the RetryPolicyFactory object to use when making service requests.
*
* @deprecated use {@link #getDefaultRequestOptions().setRetryPolicyFactory()} instead.
*/
@Deprecated
public void setRetryPolicyFactory(final RetryPolicyFactory retryPolicyFactory) {
this.getDefaultRequestOptions().setRetryPolicyFactory(retryPolicyFactory);
}
/**
* 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.
*
* 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 {@link RequestOptions#setTimeoutIntervalInMs(Integer)} property.
*
* @param timeoutInMs
* The timeout, in milliseconds, to use when making requests to the storage service.
*
* @deprecated use {@link #getDefaultRequestOptions().setTimeoutIntervalInMs()} instead.
*/
@Deprecated
public final void setTimeoutInMs(final int timeoutInMs) {
this.getDefaultRequestOptions().setTimeoutIntervalInMs(timeoutInMs);
}
/**
* Sets the maximum execution time to use when making requests to the storage service.
*
* The maximum execution time interval begins at the time that the client begins building the request. The maximum
* execution time is checked intermittently while uploading data, downloading data, and before executing retries.
* The service will continue to upload, download, and retry until the maximum execution time is reached. At that
* time, any partial uploads or downloads will be cancelled and an exception will be thrown.
*
* The default maximum execution time is null, indicating no maximum time. 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
* maximum execution time. You can also change this value for an individual request, by setting the
* {@link RequestOptions#setMaximumExecutionTimeInMs(Integer)} property.
*
* @param maximumExecutionTimeInMs
* The maximum execution time, in milliseconds, to use when making service requests.
*
* @deprecated use {@link #getDefaultRequestOptions().setMaximumExecutionTimeInMs()} instead.
*/
@Deprecated
public void setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs) {
this.getDefaultRequestOptions().setMaximumExecutionTimeInMs(maximumExecutionTimeInMs);
}
/**
* Gets the {@link RequestOptions} that is used for requests associated with this ServiceClient
*
* @return The {@link RequestOptions} object containing the values used by this ServiceClient
*/
public abstract RequestOptions getDefaultRequestOptions();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy