org.apache.rocketmq.client.java.message.GeneralMessage Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* http://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.apache.rocketmq.client.java.message;
import java.nio.ByteBuffer;
import java.util.Collection;
import java.util.Map;
import java.util.Optional;
import org.apache.rocketmq.client.apis.message.Message;
import org.apache.rocketmq.client.apis.message.MessageId;
import org.apache.rocketmq.client.apis.message.MessageView;
/**
* General message for RocketMQ, which combines {@link Message} and {@link MessageView}.
*/
public interface GeneralMessage {
/**
* Get the unique id of the message.
*
* @return unique id.
*/
Optional getMessageId();
/**
* Get the topic of the message, which is the first classifier for the message.
*
* @return topic of the message.
*/
String getTopic();
/**
* Get the deep copy of the message body, which means any modification of the return value does not
* affect the built-in message body.
*
* @return the deep copy of message body.
*/
ByteBuffer getBody();
/**
* Get the deep copy of message properties, which makes the modifies of return value does
* not affect the message itself.
*
* @return the deep copy of message properties.
*/
Map getProperties();
/**
* Get the tag of the message, which is the second classifier besides the topic.
*
* @return the tag of message, which is optional, {@link Optional#empty()} means tag does not exist.
*/
Optional getTag();
/**
* Get the key collection of the message, which means any modification of the return value does not affect the
* built-in message key collection.
*
* @return copy of the key collection of the message, empty collection means message key is not specified.
*/
Collection getKeys();
/**
* Get the message group, which makes sense only when the topic type is FIFO(First In, First Out).
*
* @return message group, which is optional, {@link Optional#empty()} means message group is not specified.
*/
Optional getMessageGroup();
/**
* Get the expected delivery timestamp, which makes sense only when topic type is delay.
*
* @return message expected delivery timestamp, which is optional, {@link Optional#empty()} means delivery
* timestamp is not specified.
*/
Optional getDeliveryTimestamp();
/**
* Get the born host of the message.
*
* @return born host of the message, which is optional, {@link Optional#empty()} means born host is not specified.
*/
Optional getBornHost();
/**
* Get the born timestamp of the message.
*
* Born time means the timestamp that the message is prepared to send rather than the timestamp the
* {@link Message} was built.
*
* @return born timestamp of the message, which is optional, {@link Optional#empty()} means born timestamp is not
* specified.
*/
Optional getBornTimestamp();
/**
* Get the delivery attempt for the message.
*
* @return delivery attempt.
*/
Optional getDeliveryAttempt();
/**
* Get decode timestamp, which makes sense only if the message is delivered from remote.
*
* @return message decode timestamp, which is optional, {@link Optional#empty()} means decode timestamp is not
* specified.
*/
Optional getDecodeTimestamp();
/**
* Get transport delivery timestamp, which makes sense only if the message is delivered from remote.
*
* @return message transport delivery timestamp, which is optional, {@link Optional#empty()} means transport
* delivery timestamp is not specified.
*/
Optional getTransportDeliveryTimestamp();
}