com.microsoft.windowsazure.services.queue.client.CloudQueueClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsoft-windowsazure-api Show documentation
Show all versions of microsoft-windowsazure-api Show documentation
API for Microsoft Windows Azure 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.windowsazure.services.queue.client;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.URISyntaxException;
import java.security.InvalidKeyException;
import javax.xml.stream.XMLStreamException;
import com.microsoft.windowsazure.services.blob.client.CloudBlobClient;
import com.microsoft.windowsazure.services.core.storage.DoesServiceRequest;
import com.microsoft.windowsazure.services.core.storage.OperationContext;
import com.microsoft.windowsazure.services.core.storage.RequestOptions;
import com.microsoft.windowsazure.services.core.storage.ResultContinuation;
import com.microsoft.windowsazure.services.core.storage.ResultContinuationType;
import com.microsoft.windowsazure.services.core.storage.ResultSegment;
import com.microsoft.windowsazure.services.core.storage.ServiceClient;
import com.microsoft.windowsazure.services.core.storage.ServiceProperties;
import com.microsoft.windowsazure.services.core.storage.StorageCredentials;
import com.microsoft.windowsazure.services.core.storage.StorageException;
import com.microsoft.windowsazure.services.core.storage.utils.Utility;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.ExecutionEngine;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.LazySegmentedIterable;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.ListingContext;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.SegmentedStorageOperation;
import com.microsoft.windowsazure.services.core.storage.utils.implementation.StorageOperation;
/**
* Provides a service client for accessing the Windows Azure Queue service.
*/
public final class CloudQueueClient extends ServiceClient {
/**
* Initializes a new instance of the CloudQueueClient class
* using the specified Queue service endpoint and account credentials.
*
* @param baseUri
* The Queue service endpoint to use to create the client
* @param credentials
* The account credentials.
*/
public CloudQueueClient(final URI baseUri, final StorageCredentials credentials) {
super(baseUri, credentials);
this.setTimeoutInMs(QueueConstants.DEFAULT_QUEUE_CLIENT_TIMEOUT_IN_MS);
if (credentials == null) {
throw new IllegalArgumentException("StorageCredentials can't be null for the queue service.");
}
}
/**
* Gets a {@link CloudQueue} object that represents the storage service
* queue for the specified address.
*
* @param queueAddress
* A String that represents the name of the queue,
* or the absolute URI to the queue.
*
* @return A {@link CloudQueue} object that represents a reference to the
* queue.
*
* @throws URISyntaxException
* If the resource URI is invalid.
* @throws StorageException
* If a storage service error occurred during the operation.
*/
public CloudQueue getQueueReference(final String queueAddress) throws URISyntaxException, StorageException {
Utility.assertNotNullOrEmpty("queueAddress", queueAddress);
return new CloudQueue(queueAddress, this);
}
/**
* Gets an iterable collection of queues for this queue service client.
*
* @return An iterable collection of {@link CloudQueue} objects that
* represent the queues in this client.
*/
@DoesServiceRequest
public Iterable listQueues() {
return this.listQueues(null, QueueListingDetails.NONE, null, null);
}
/**
* Returns an iterable collection of queues whose names begin with the
* specified prefix in this Queue service client.
*
* @param prefix
* A String that represents the queue name prefix.
*
* @return An iterable collection of {@link CloudQueue} objects that
* represent the queues in this client whose names begin with the
* specified prefix.
*/
@DoesServiceRequest
public Iterable listQueues(final String prefix) {
return this.listQueues(prefix, QueueListingDetails.NONE, null, null);
}
/**
* Returns an iterable collection of queues whose names begin with the
* specified prefix for this Queue service client, using the specified
* details setting, request options, and operation context.
*
* @param prefix
* A String that represents the queue name prefix.
* @param detailsIncluded
* A {@link QueueListingDetails} value that indicates whether
* queue metadata will be returned.
* @param options
* A {@link QueueRequestOptions} object that specifies any
* additional options for the request. Specifying null will use the default request options
* from
* the associated service client ( {@link CloudQueue}).
* @param opContext
* An {@link 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.
*
* @return An iterable collection of {@link CloudQueue} objects that
* represents the specified queues for this client.
*/
@DoesServiceRequest
public Iterable listQueues(final String prefix, final QueueListingDetails detailsIncluded,
QueueRequestOptions options, OperationContext opContext) {
if (opContext == null) {
opContext = new OperationContext();
}
if (options == null) {
options = new QueueRequestOptions();
}
opContext.initialize();
options.applyDefaults(this);
final SegmentedStorageOperation> impl = new SegmentedStorageOperation>(
options, null) {
@Override
public ResultSegment execute(final CloudQueueClient client, final Void dontCare,
final OperationContext opContext) throws Exception {
final ResultSegment result = CloudQueueClient.this.listQueuesCore(prefix, detailsIncluded,
-1, this.getToken(), this.getRequestOptions(), this, opContext);
this.setToken(result.getContinuationToken());
return result;
}
};
return new LazySegmentedIterable(impl, this, null,
options.getRetryPolicyFactory(), opContext);
}
/**
* Gets a result segment containing a collection of queues from the storage
* service with the specified parameters.
*
* @param prefix
* A String containing the queue name prefix to
* filter the results with.
* @param detailsIncluded
* A {@link QueueListingDetails} value that indicates whether
* queue metadata will be returned.
* @param maxResults
* The maximum number of queue results to retrieve.
* @param continuationToken
* A {@link ResultContinuation} object that represents a
* continuation token returned by a previous listing operation.
* @param options
* A {@link QueueRequestOptions} object that specifies any
* additional options for the request. Specifying null will use the default request options
* from
* the associated service client ( {@link CloudQueue}).
* @param taskReference
* A {@link StorageOperation} reference to the encapsulating
* task.
* @param opContext
* An {@link 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.
*
* @return A {@link ResultSegment} of {@link CloudQueue} objects that
* contains a segment of the iterable collection of {@link CloudQueue} objects that represent the requested
* queues in
* the storage service.
*
* @throws IOException
* @throws URISyntaxException
* If the URI is not valid.
* @throws XMLStreamException
* @throws InvalidKeyException
* @throws StorageException
* If a storage service error occurred during the operation.
*/
@DoesServiceRequest
ResultSegment listQueuesCore(final String prefix, final QueueListingDetails detailsIncluded,
final int maxResults, final ResultContinuation continuationToken, final RequestOptions options,
final StorageOperation> taskReference,
final OperationContext opContext) throws IOException, URISyntaxException, XMLStreamException,
InvalidKeyException, StorageException {
Utility.assertContinuationType(continuationToken, ResultContinuationType.QUEUE);
final ListingContext listingContext = new ListingContext(prefix, maxResults);
listingContext.setMarker(continuationToken != null ? continuationToken.getNextMarker() : null);
final HttpURLConnection listQueueRequest = QueueRequest.list(this.getEndpoint(),
options.getTimeoutIntervalInMs(), listingContext, detailsIncluded, opContext);
taskReference.setConnection(listQueueRequest);
taskReference.signRequest(this, listQueueRequest, -1L, null);
ExecutionEngine.processRequest(listQueueRequest, opContext, taskReference.getResult());
if (taskReference.getResult().getStatusCode() != HttpURLConnection.HTTP_OK) {
taskReference.setNonExceptionedRetryableFailure(true);
return null;
}
final ListQueuesResponse response = new ListQueuesResponse(listQueueRequest.getInputStream());
response.parseResponse(this);
ResultContinuation newToken = null;
if (response.getNextMarker() != null) {
newToken = new ResultContinuation();
newToken.setNextMarker(response.getNextMarker());
newToken.setContinuationType(ResultContinuationType.QUEUE);
}
final ResultSegment resSegment = new ResultSegment(response.getQueues(this),
maxResults, newToken);
return resSegment;
}
/**
* Gets a result segment of an iterable collection of queues for this Queue
* service client.
*
* @return A {@link ResultSegment} of {@link CloudQueue} objects that
* contains a segment of the iterable collection of {@link CloudQueue} objects that represent the requested
* queues in
* the storage service.
*
* @throws StorageException
* If a storage service error occurred during the operation.
*/
@DoesServiceRequest
public ResultSegment listQueuesSegmented() throws StorageException {
return this.listQueuesSegmented(null, QueueListingDetails.NONE, 0, null, null, null);
}
/**
* Gets a result segment of an iterable collection of queues whose names
* begin with the specified prefix for this Queue service client.
*
* @return A {@link ResultSegment} of {@link CloudQueue} objects that
* contains a segment of the iterable collection of {@link CloudQueue} objects that represent the requested
* queues in
* the storage service.
*
* @throws StorageException
* If a storage service error occurred during the operation.
*/
@DoesServiceRequest
public ResultSegment listQueuesSegmented(final String prefix) throws StorageException {
return this.listQueuesSegmented(prefix, QueueListingDetails.NONE, 0, null, null, null);
}
/**
* Gets a result segment of an iterable collection of queues whose names
* begin with the specified prefix for this queue, using the specified
* listing details options, request options, and operation context.
*
* @param prefix
* A String that represents the prefix of the queue
* name to match.
* @param detailsIncluded
* A {@link QueueListingDetails} value that indicates whether
* queue metadata will be returned.
* @param maxResults
* The maximum number of queue results to retrieve.
* @param continuationToken
* A {@link ResultContinuation} object that represents a
* continuation token returned by a previous listing operation.
* @param options
* A {@link QueueRequestOptions} object that specifies any
* additional options for the request. Specifying null will use the default request options
* from
* the associated service client ( {@link CloudQueue}).
* @param opContext
* An {@link 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.
*
* @return A {@link ResultSegment} of {@link CloudQueue} objects that
* contains a segment of the iterable collection of {@link CloudQueue} objects that represent the requested
* queues in
* the storage service.
*
* @throws StorageException
* If a storage service error occurred during the operation.
*/
@DoesServiceRequest
public ResultSegment listQueuesSegmented(final String prefix,
final QueueListingDetails detailsIncluded, final int maxResults,
final ResultContinuation continuationToken, QueueRequestOptions options, OperationContext opContext)
throws StorageException {
if (opContext == null) {
opContext = new OperationContext();
}
if (options == null) {
options = new QueueRequestOptions();
}
opContext.initialize();
options.applyDefaults(this);
Utility.assertContinuationType(continuationToken, ResultContinuationType.QUEUE);
final StorageOperation> impl = new StorageOperation>(
options) {
@Override
public ResultSegment execute(final CloudQueueClient client, final Void dontCare,
final OperationContext opContext) throws Exception {
return CloudQueueClient.this.listQueuesCore(prefix, detailsIncluded, maxResults, continuationToken,
this.getRequestOptions(), this, opContext);
}
};
return ExecutionEngine.executeWithRetry(this, null, impl, options.getRetryPolicyFactory(), opContext);
}
/**
* Uploads a new configuration of service properties to the storage service,
* using the default request options. This includes Metrics and Logging
* Configuration.
*
* @param properties
* The {@link ServiceProperties} to upload.
*
* @throws StorageException
* If a storage service error occurred during the operation.
*/
@DoesServiceRequest
@Override
public void uploadServiceProperties(final ServiceProperties properties) throws StorageException {
this.uploadServiceProperties(properties, null, null);
}
/**
* Uploads a new configuration of service properties to the storage service,
* using the specified request options and operation context. This includes
* Metrics and Logging Configuration.
*
* @param properties
* The {@link ServiceProperties} to upload.
* @param options
* A {@link RequestOptions} object that specifies any additional
* options for the request. Specifying null will use
* the default request options from the associated service client
* ( {@link CloudBlobClient}{@link CloudQueueClient}).
* @param opContext
* An {@link 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 during the operation.
*/
@DoesServiceRequest
@Override
public void uploadServiceProperties(final ServiceProperties properties, final RequestOptions options,
final OperationContext opContext) throws StorageException {
if (!Utility.isNullOrEmpty(properties.getDefaultServiceVersion())) {
throw new IllegalArgumentException(
"DefaultServiceVersion can only be set for the Blob service and the request must be made using the 2011-08-18 version");
}
super.uploadServiceProperties(properties, options, opContext);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy