Interface AmazonSQSConfig
-
- All Known Implementing Classes:
ManagedSQSConfig
,MapBasedSQSConfig
public interface AmazonSQSConfig
Encapsulates all the SQS related bits that can be configured.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAccessKey()
AWS access key.java.lang.String
getQueuePrefix()
Prefix to be added to all queues.com.amazonaws.regions.Regions
getRegion()
AWS region to use.AmazonSQSQueueConfig
getRpcQueueConfig()
Retrieves the queue configuration for queues used by the RPC API.java.lang.String
getSecretKey()
AWS secret key.AmazonSQSQueueConfig
getSinkQueueConfig()
Retrieves the queue configuration for queues used by the Sink API.boolean
hasStaticCredentials()
Convenience method that returnstrue
if both an access key and secret key have been set.boolean
isUseHttp()
Used to force the SQS client to use HTTP instead of HTTPS.
-
-
-
Method Detail
-
getQueuePrefix
java.lang.String getQueuePrefix()
Prefix to be added to all queues. This can be used to differentiate between OpenNMS deployments in a single region.- Returns:
- the prefix, or null if no prefix should be used.
-
getRegion
com.amazonaws.regions.Regions getRegion()
AWS region to use.- Returns:
- the region, or null if the default region should be used.
-
getAccessKey
java.lang.String getAccessKey()
AWS access key.- Returns:
- the key, or null if the client should be initialized without static credentials.
-
getSecretKey
java.lang.String getSecretKey()
AWS secret key.- Returns:
- the key, or null if the client should be initialized without static credentials.
-
hasStaticCredentials
boolean hasStaticCredentials()
Convenience method that returnstrue
if both an access key and secret key have been set.- Returns:
true
if both an access key and secret key have been set,false
otherwise.
-
isUseHttp
boolean isUseHttp()
Used to force the SQS client to use HTTP instead of HTTPS. This can be used for testing, making it easier to intercept the messages sent over the wire.- Returns:
true
if HTTP should be used insetad of HTTPS,false
otherwise.
-
getSinkQueueConfig
AmazonSQSQueueConfig getSinkQueueConfig()
Retrieves the queue configuration for queues used by the Sink API.- Returns:
- the queue configuration
-
getRpcQueueConfig
AmazonSQSQueueConfig getRpcQueueConfig()
Retrieves the queue configuration for queues used by the RPC API.- Returns:
- the queue configuration
-
-