org.springframework.amqp.core.Message Maven / Gradle / Ivy
/*
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.amqp.core;
import java.io.Serializable;
import java.nio.charset.Charset;
import java.util.Arrays;
import org.springframework.util.Assert;
/**
* 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
* @author Mark Fisher
* @author Oleg Zhurakousky
* @author Dave Syer
* @author Gary Russell
* @author Alex Panchenko
* @author Artem Bilan
*/
public class Message implements Serializable {
private static final long serialVersionUID = -7177590352110605597L;
private static final String DEFAULT_ENCODING = Charset.defaultCharset().name();
private static final int DEFAULT_MAX_BODY_LENGTH = 50;
private static String bodyEncoding = DEFAULT_ENCODING;
private static int maxBodyLength = DEFAULT_MAX_BODY_LENGTH;
private final MessageProperties messageProperties;
private final byte[] body;
/**
* Construct an instance with the provided body and default {@link MessageProperties}.
* @param body the body.
* @since 2.2.17
*/
public Message(byte[] body) {
this(body, new MessageProperties());
}
/**
* Construct an instance with the provided body and properties.
* @param body the body.
* @param messageProperties the properties.
*/
public Message(byte[] body, MessageProperties messageProperties) { //NOSONAR
Assert.notNull(body, "'body' cannot be null");
Assert.notNull(messageProperties, "'messageProperties' cannot be null");
this.body = body; //NOSONAR
this.messageProperties = messageProperties;
}
/**
* No longer used.
* @param patterns the patterns.
* @since 1.5.7
* @deprecated toString() no longer deserializes the body.
*/
@Deprecated
public static void addAllowedListPatterns(String... patterns) {
}
/**
* Set the encoding to use in {@link #toString()} when converting the body if
* there is no {@link MessageProperties#getContentEncoding() contentEncoding} message property present.
* @param encoding the encoding to use.
* @since 2.2.4
*/
public static void setDefaultEncoding(String encoding) {
Assert.notNull(encoding, "'encoding' cannot be null");
bodyEncoding = encoding;
}
/**
* Set the maximum length of a test message body to render as a String in
* {@link #toString()}. Default 50.
* @param length the length to render.
* @since 2.2.20
*/
public static void setMaxBodyLength(int length) {
maxBodyLength = length;
}
public byte[] getBody() {
return this.body; //NOSONAR
}
public MessageProperties getMessageProperties() {
return this.messageProperties;
}
@Override
public String toString() {
StringBuilder buffer = new StringBuilder();
buffer.append("(");
buffer.append("Body:'").append(this.getBodyContentAsString()).append("'");
buffer.append(" ").append(this.messageProperties.toString());
buffer.append(")");
return buffer.toString();
}
private String getBodyContentAsString() {
try {
String contentType = this.messageProperties.getContentType();
if (MessageProperties.CONTENT_TYPE_SERIALIZED_OBJECT.equals(contentType)) {
return "[serialized object]";
}
String encoding = encoding();
if (this.body.length <= maxBodyLength // NOSONAR
&& (MessageProperties.CONTENT_TYPE_TEXT_PLAIN.equals(contentType)
|| MessageProperties.CONTENT_TYPE_JSON.equals(contentType)
|| MessageProperties.CONTENT_TYPE_JSON_ALT.equals(contentType)
|| MessageProperties.CONTENT_TYPE_XML.equals(contentType))) {
return new String(this.body, encoding);
}
}
catch (Exception e) {
// ignore
}
// Comes out as '[[email protected]' (so harmless)
return this.body.toString() + "(byte[" + this.body.length + "])"; //NOSONAR
}
private String encoding() {
String encoding = this.messageProperties.getContentEncoding();
if (encoding == null) {
encoding = bodyEncoding;
}
return encoding;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + Arrays.hashCode(this.body);
result = prime * result + ((this.messageProperties == null) ? 0 : this.messageProperties.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
Message other = (Message) obj;
if (!Arrays.equals(this.body, other.body)) {
return false;
}
if (this.messageProperties == null) {
if (other.messageProperties != null) {
return false;
}
}
else if (!this.messageProperties.equals(other.messageProperties)) {
return false;
}
return true;
}
}