org.springframework.amqp.core

Class Message

java.lang.Object

org.springframework.amqp.core.Message

All Implemented Interfaces:

Serializable

public class Message
extends Object
implements Serializable

The 0-8 and 0-9-1 AMQP specifications do not define an Message class or interface. Instead, when performing an operation such as basicPublish the content is passed as a byte-array argument and additional properties are passed in as separate arguments. Spring AMQP defines a Message class as part of a more general AMQP domain model representation. The purpose of the Message class is to simply encapsulate the body and properties within a single instance so that the rest of the AMQP API can in turn be simpler.

Author:

Mark Pollack, Mark Fisher, Oleg Zhurakousky, Dave Syer, Gary Russell, Alex Panchenko, Artem Bilan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Message(byte[] body) Construct an instance with the provided body and default MessageProperties.
Message(byte[] body, MessageProperties messageProperties) Construct an instance with the provided body and properties.

Method Summary

Modifier and Type	Method and Description
static void	addAllowedListPatterns(String... patterns) Add patterns to the allowed list of permissible package/class name patterns for deserialization in toString().
boolean	equals(Object obj)
byte[]	getBody()
MessageProperties	getMessageProperties()
int	hashCode()
static void	setDefaultEncoding(String encoding) Set the encoding to use in toString() when converting the body if there is no contentEncoding message property present.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(byte[] body)

Construct an instance with the provided body and default MessageProperties.

Parameters:

body - the body.

Since:

2.2.17

Message

public Message(byte[] body,
               MessageProperties messageProperties)

Construct an instance with the provided body and properties.

Parameters:

body - the body.

messageProperties - the properties.

Method Detail

addAllowedListPatterns

public static void addAllowedListPatterns(String... patterns)

Add patterns to the allowed list of permissible package/class name patterns for deserialization in toString(). The patterns will be applied in order until a match is found. A class can be fully qualified or a wildcard '*' is allowed at the beginning or end of the class name. Examples: com.foo.*, *.MyClass. By default, only java.util and java.lang classes will be deserialized.

Parameters:

patterns - the patterns.

Since:

1.5.7

setDefaultEncoding

public static void setDefaultEncoding(String encoding)

Set the encoding to use in toString() when converting the body if there is no contentEncoding message property present.

Parameters:

encoding - the encoding to use.

Since:

2.2.4

getBody

public byte[] getBody()

getMessageProperties

public MessageProperties getMessageProperties()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object