com.atlassian.messagequeue

Interface MessageInformationService

All Known Implementing Classes:

DefaultMessageInformationService, SQSMessageInformationService

@PublicApi
public interface MessageInformationService

A service that provides sufficient information to enable clients to perform their own delivery of Messages to a queue. Once delivered, atlassian-messagequeue will retrieve from the queue and then dispatch to the appropriate MessageRunner.

Normally MessageRunnerService.addMessage(Message)} would do all this for you, but sometimes you want an external system (say a scheduling service) to take over the delivery aspect to a queue.

It is assumed that clients that compose messages from the information provided by this service have sufficient privileges to deliver to the queue locatable via getQueueUrl(MessageRunnerKey))} (since this service does not provide any credentials).

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Message	fromPayload(String payload) Deserializes a Message from the specified atlassian-messagequeue formatted payload.
String	getQueueUrl(MessageRunnerKey messageRunnerKey) Returns the queue URL that atlassian-messagequeue is consuming from and producing to for the specified message runner key.
String	toPayload(Message message) Serializes the specified message into an atlassian-messagequeue formatted payload.

Method Detail

getQueueUrl

String getQueueUrl(MessageRunnerKey messageRunnerKey)

Returns the queue URL that atlassian-messagequeue is consuming from and producing to for the specified message runner key.

Parameters:

messageRunnerKey - the message runner key

Returns:

the queue URL that atlassian-messagequeue is consuming from and producing to.

toPayload

String toPayload(Message message)

Serializes the specified message into an atlassian-messagequeue formatted payload.

Parameters:

message - the message

Returns:

the atlassian-messagequeue formatted payload

Throws:

MessageSerializationException - if there is an error serializing the specified message

fromPayload

Message fromPayload(String payload)

Deserializes a Message from the specified atlassian-messagequeue formatted payload.

Parameters:

payload - the atlassian-messagequeue formatted payload (cannot be null or empty)

Returns:

the message

Throws:

MessageSerializationException - if there is an error deserializing the specified payload