org.opennms.core.ipc.common.aws.sqs

Interface AmazonSQSManager

All Known Implementing Classes:

DefaultAmazonSQSManager

public interface AmazonSQSManager

Method Summary

Modifier and Type	Method and Description
String	getRpcReplyQueueNameAndCreateIfNecessary(String moduleId, String location) Retrieve the queue name to use for RPC replies from a specific RPC Module and location.
String	getRpcRequestQueueNameAndCreateIfNecessary(String moduleId, String location) Retrieve the queue name to use for RPC request targetting a specific RPC Module and location.
String	getSinkQueueUrlAndCreateIfNecessary(String moduleId) Retrieve the queue URL for the given Sink Module and create the queue if it does not already exist.
com.amazonaws.services.sqs.AmazonSQS	getSQSClient() Retrieve the underlying SQS client.
com.amazon.sqs.javamessaging.SQSConnectionFactory	getSQSConnectionFactory() Retrieve a connection factory that wraps the SQS client as a JMS provider.
String	sendMessage(String queueUrl, String body) Send message.

Method Detail

getSQSClient

com.amazonaws.services.sqs.AmazonSQS getSQSClient()

Retrieve the underlying SQS client.

Returns:

the sqs client

getSQSConnectionFactory

com.amazon.sqs.javamessaging.SQSConnectionFactory getSQSConnectionFactory()

Retrieve a connection factory that wraps the SQS client as a JMS provider.

Returns:

the JMS connection factory

getSinkQueueUrlAndCreateIfNecessary

String getSinkQueueUrlAndCreateIfNecessary(String moduleId)
                                    throws InterruptedException

Retrieve the queue URL for the given Sink Module and create the queue if it does not already exist.

This is a blocking operation. If AWS is unreachable, the method will keep retrying indefinitely until the queue is created and the queue URL is determined, or the thread is interrupted.

This function may cache the queue URL, avoiding unecesssary API calls.

Parameters:

moduleId - the ID of the Sink Module

Returns:

the queue URL

Throws:

InterruptedException

getRpcRequestQueueNameAndCreateIfNecessary

String getRpcRequestQueueNameAndCreateIfNecessary(String moduleId,
                                                  String location)
                                           throws AmazonSQSQueueException

Retrieve the queue name to use for RPC request targetting a specific RPC Module and location. Also create the queue if it does not already exist.

This function may cache the queue URL, avoiding unecesssary API calls.

Parameters:

moduleId - the ID of the RPC Module

location - the targetted location of the request

Returns:

the queue name

Throws:

AmazonSQSQueueException - if some error occured creating the queue or determining the URL

getRpcReplyQueueNameAndCreateIfNecessary

String getRpcReplyQueueNameAndCreateIfNecessary(String moduleId,
                                                String location)
                                         throws AmazonSQSQueueException

Retrieve the queue name to use for RPC replies from a specific RPC Module and location. Also create the queue if it does not already exist.

This function may cache the queue URL, avoiding unecesssary API calls.

Parameters:

moduleId - the ID of the RPC Module

location - the source location of the reply

Returns:

the queue name

Throws:

AmazonSQSQueueException - if some error occured creating the queue or determining the URL

sendMessage

String sendMessage(String queueUrl,
                   String body)
            throws InterruptedException

Send message.

This is a blocking operation. If AWS is unreachable, the method will keep retrying indefinitely until the message is delivered or the thread is interrupted.

Parameters:

queueUrl - the queue URL

body - the message body

Returns:

the message ID

Throws:

InterruptedException