Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file 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.amazonaws.services.sqs;
 
 
 import java.util.List;
 
 
Client for accessing AmazonSQS. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Simple Queue Service (Amazon SQS) offers a reliable, highly scalable, hosted queue for storing messages as they travel between computers. By using Amazon SQS, developers can simply move data between distributed components of their applications that perform different tasks, without losing messages or requiring each component to be always available. Amazon SQS makes it easy to build an automated workflow, working in close conjunction with the Amazon Elastic Compute Cloud (Amazon EC2) and the other AWS infrastructure web services.

Amazon SQS works by exposing Amazon's web-scale messaging infrastructure as a web service. Any computer on the Internet can add or read messages without any installed software or special firewall configurations. Components of applications using Amazon SQS can run independently, and do not need to be on the same network, developed with the same technologies, or running at the same time.

Visit http://aws.amazon.com/sqs/ for more information.

 
 public class AmazonSQSClient extends AmazonWebServiceClient implements AmazonSQS {

    
The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
 
     private AWSCredentials awsCredentials;

    
List of exception unmarshallers for all AmazonSQS exceptions.
 
     protected final List<Unmarshaller<AmazonServiceExceptionNode>> exceptionUnmarshallers;

    
Low level client for sending requests to AWS services.
 
     protected final HttpClient client;

    
Optional request handlers for additional request processing.
 
     private List<RequestHandlerrequestHandlers = new ArrayList<RequestHandler>();
    
    
AWS signer for authenticating requests.
 
     private QueryStringSigner signer;


    
Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    public AmazonSQSClient(AWSCredentials awsCredentials) {
        this(awsCredentialsnew ClientConfiguration());
    }

    
Constructs a new client to invoke service methods on AmazonSQS using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:
awsCredentials The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration The client configuration options controlling how this client connects to AmazonSQS (ex: proxy settings, retry counts, etc.).
    public AmazonSQSClient(AWSCredentials awsCredentialsClientConfiguration clientConfiguration) {
        super(clientConfiguration);
        this. = awsCredentials;
        
        setEndpoint("queue.amazonaws.com");
         = new QueryStringSigner(awsCredentials);
                "/com/amazonaws/services/sqs/request.handlers");
         = new HttpClient(clientConfiguration);
    }

    
    

The ListQueues action returns a list of your queues.

Parameters:
listQueuesRequest Container for the necessary parameters to execute the ListQueues service method on AmazonSQS.
Returns:
The response from the ListQueues service method, as returned by AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<ListQueuesRequestrequest = new ListQueuesRequestMarshaller().marshall(listQueuesRequest);
        return invoke(requestnew ListQueuesResultStaxUnmarshaller());
    }
    
    

Sets an attribute of a queue. Currently, you can set only the VisibilityTimeout attribute for a queue.

Parameters:
setQueueAttributesRequest Container for the necessary parameters to execute the SetQueueAttributes service method on AmazonSQS.
Throws:
com.amazonaws.services.sqs.model.InvalidAttributeNameException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public void setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<SetQueueAttributesRequestrequest = new SetQueueAttributesRequestMarshaller().marshall(setQueueAttributesRequest);
        invoke(requestnull);
    }
    
    

The ChangeMessageVisibility action changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.)

For example, let's say you have a message and its default message visibility timeout is 30 minutes. You could call ChangeMessageVisiblity with a value of two hours and the effective timeout would be two hours and 30 minutes. When that time comes near you could again extend the time out by calling ChangeMessageVisiblity, but this time the maximum allowed timeout would be 9 hours and 30 minutes.

IMPORTANT: If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.

IMPORTANT: Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

Parameters:
changeMessageVisibilityRequest Container for the necessary parameters to execute the ChangeMessageVisibility service method on AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public void changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<ChangeMessageVisibilityRequestrequest = new ChangeMessageVisibilityRequestMarshaller().marshall(changeMessageVisibilityRequest);
        invoke(requestnull);
    }
    
    

The CreateQueue action creates a new queue, or returns the URL of an existing one. When you request CreateQueue, you provide a name for the queue. To successfully create a new queue, you must provide a name that is unique within the scope of your own queues. If you provide the name of an existing queue, a new queue isn't created and an error isn't returned. Instead, the request succeeds and the queue URL for the existing queue is returned.

IMPORTANT: If you provide a value for DefaultVisibilityTimeout that is different from the value for the existing queue, you receive an error.

Parameters:
createQueueRequest Container for the necessary parameters to execute the CreateQueue service method on AmazonSQS.
Returns:
The response from the CreateQueue service method, as returned by AmazonSQS.
Throws:
com.amazonaws.services.sqs.model.QueueNameExistsException
com.amazonaws.services.sqs.model.QueueDeletedRecentlyException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public CreateQueueResult createQueue(CreateQueueRequest createQueueRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<CreateQueueRequestrequest = new CreateQueueRequestMarshaller().marshall(createQueueRequest);
        return invoke(requestnew CreateQueueResultStaxUnmarshaller());
    }
    
    

The RemovePermission action revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

Parameters:
removePermissionRequest Container for the necessary parameters to execute the RemovePermission service method on AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public void removePermission(RemovePermissionRequest removePermissionRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<RemovePermissionRequestrequest = new RemovePermissionRequestMarshaller().marshall(removePermissionRequest);
        invoke(requestnull);
    }
    
    

Gets one or all attributes of a queue. Queues currently have two attributes you can get: ApproximateNumberOfMessages and VisibilityTimeout.

Parameters:
getQueueAttributesRequest Container for the necessary parameters to execute the GetQueueAttributes service method on AmazonSQS.
Returns:
The response from the GetQueueAttributes service method, as returned by AmazonSQS.
Throws:
com.amazonaws.services.sqs.model.InvalidAttributeNameException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<GetQueueAttributesRequestrequest = new GetQueueAttributesRequestMarshaller().marshall(getQueueAttributesRequest);
        return invoke(requestnew GetQueueAttributesResultStaxUnmarshaller());
    }
    
    

The AddPermission action adds a permission to a queue for a specific principal. This allows for sharing access to the queue.

When you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.

Parameters:
addPermissionRequest Container for the necessary parameters to execute the AddPermission service method on AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public void addPermission(AddPermissionRequest addPermissionRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<AddPermissionRequestrequest = new AddPermissionRequestMarshaller().marshall(addPermissionRequest);
        invoke(requestnull);
    }
    
    

This action unconditionally deletes the queue specified by the queue URL. Use this operation WITH CARE! The queue is deleted even if it is NOT empty.

Parameters:
deleteQueueRequest Container for the necessary parameters to execute the DeleteQueue service method on AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public void deleteQueue(DeleteQueueRequest deleteQueueRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<DeleteQueueRequestrequest = new DeleteQueueRequestMarshaller().marshall(deleteQueueRequest);
        invoke(requestnull);
    }
    
    

The DeleteMessage action unconditionally removes the specified message from the specified queue. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue.

Parameters:
deleteMessageRequest Container for the necessary parameters to execute the DeleteMessage service method on AmazonSQS.
Throws:
com.amazonaws.services.sqs.model.ReceiptHandleIsInvalidException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public void deleteMessage(DeleteMessageRequest deleteMessageRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<DeleteMessageRequestrequest = new DeleteMessageRequestMarshaller().marshall(deleteMessageRequest);
        invoke(requestnull);
    }
    
    

The SendMessage action delivers a message to the specified queue.

Parameters:
sendMessageRequest Container for the necessary parameters to execute the SendMessage service method on AmazonSQS.
Returns:
The response from the SendMessage service method, as returned by AmazonSQS.
Throws:
com.amazonaws.services.sqs.model.InvalidMessageContentsException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public SendMessageResult sendMessage(SendMessageRequest sendMessageRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<SendMessageRequestrequest = new SendMessageRequestMarshaller().marshall(sendMessageRequest);
        return invoke(requestnew SendMessageResultStaxUnmarshaller());
    }
    
    

Retrieves one or more messages from the specified queue, including the message body and message ID of each message. Messages returned by this action stay in the queue until you delete them. However, once a message is returned to a ReceiveMessage request, it is not returned on subsequent ReceiveMessage requests for the duration of the VisibilityTimeout. If you do not specify a VisibilityTimeout in the request, the overall visibility timeout for the queue is used for the returned messages.

Parameters:
receiveMessageRequest Container for the necessary parameters to execute the ReceiveMessage service method on AmazonSQS.
Returns:
The response from the ReceiveMessage service method, as returned by AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
    public ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest
            throws AmazonServiceExceptionAmazonClientException {
        Request<ReceiveMessageRequestrequest = new ReceiveMessageRequestMarshaller().marshall(receiveMessageRequest);
        return invoke(requestnew ReceiveMessageResultStaxUnmarshaller());
    }
    
    

The ListQueues action returns a list of your queues.

Returns:
The response from the ListQueues service method, as returned by AmazonSQS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonSQS indicating either a problem with the data in the request, or a server side issue.
        return listQueues(new ListQueuesRequest());
    }
    


    
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Parameters:
request The originally executed request
Returns:
The response metadata for the specified request, or null if none is available.
        return .getResponseMetadataForRequest(request);
    }
    private <X, Y extends AmazonWebServiceRequest> X invoke(Request<Y> requestUnmarshaller<X, StaxUnmarshallerContextunmarshaller) {
        request.setEndpoint();
        for (Entry<StringStringentry : request.getOriginalRequest().copyPrivateRequestParameters().entrySet()) {
            request.addParameter(entry.getKey(), entry.getValue());
        }
        // Apply any additional service specific request handlers that need to be run
        if ( != null) {
            for (RequestHandler requestHandler : ) {
                request = requestHandler.handleRequest(request);
            }
        }
        try {
            .sign(request);
        } catch (SignatureException e) {
            throw new AmazonServiceException("Unable to sign request"e);
        }
        HttpRequest httpRequest = convertToHttpRequest(request.);
        
        StaxResponseHandler<X> responseHandler = new StaxResponseHandler<X>(unmarshaller);
        return (X).execute(httpRequestresponseHandlererrorResponseHandler);
    }
}
        
New to GrepCode? Check out our FAQ X