com.atlassian.messagequeue

Class Message

java.lang.Object

com.atlassian.messagequeue.Message

@PublicApi
public final class Message
extends Object

Encapsulates information that is passed to MessageRunnerService.addMessage(Message).

A Message contains a MessageRunnerKey which specifies a MessageRunner with which the Message should be handled by.

A Message also contains an optional String payload that is passed to the execution of the corresponding MessageRunner.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder Message Builder

Method Summary

Modifier and Type	Method and Description
static Message.Builder	builder(MessageRunnerKey runnerKey) Builder factory method
static Message	create(MessageRunnerKey runnerKey, String payload) Message factory method
boolean	equals(Object o)
Optional<String>	getPayload()
MessageRunnerKey	getRunnerKey() Returns the MessageRunnerKey which specifies a MessageRunner with which this Message should be handled by.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRunnerKey

public MessageRunnerKey getRunnerKey()

Returns the MessageRunnerKey which specifies a MessageRunner with which this Message should be handled by.

Returns:

message runner key

getPayload

public Optional<String> getPayload()

Returns:

Returns the message payload or Optional.empty() when no payload was specified in the construction of a Message (or null was specified for construction).

create

public static Message create(MessageRunnerKey runnerKey,
                             @Nullable
                             String payload)

Message factory method

Parameters:

runnerKey - message runner key

payload - message payload

Returns:

Message instance

Throws:

MessagePayloadSizeExceededException - if payload exceeds MessageRunnerConstants.payloadMaxSize().

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static Message.Builder builder(MessageRunnerKey runnerKey)

Builder factory method

Parameters:

runnerKey - message runner key

Returns:

Message Builder