com.alibaba.rocketmq.client

接口 MQAdmin

所有已知子接口:

MQConsumer, MQProducer, MQPullConsumer, MQPushConsumer

所有已知实现类:

DefaultMQProducer, DefaultMQPullConsumer, DefaultMQPushConsumer, TransactionMQProducer

public interface MQAdmin

MQ管理类接口

从以下版本开始:

2013-7-24

作者:

shijia.wxr

方法概要

方法

限定符和类型	方法和说明
void	createTopic(String key, String newTopic, int queueNum) 创建topic
long	earliestMsgStoreTime(MessageQueue mq) 向服务器查询队列保存的最早消息对应的存储时间
long	maxOffset(MessageQueue mq) 向服务器查询队列最大Offset PS: 最大Offset无对应消息，减1有消息
long	minOffset(MessageQueue mq) 向服务器查询队列最小Offset PS: 最小Offset有对应消息
QueryResult	queryMessage(String topic, String key, int maxNum, long begin, long end) 根据消息Key查询消息
long	searchOffset(MessageQueue mq, long timestamp) 根据时间查询对应的offset，精确到毫秒 P.S.
MessageExt	viewMessage(String msgId) 根据消息ID，从服务器获取完整的消息

方法详细资料

createTopic

void createTopic(String key,
               String newTopic,
               int queueNum)
                 throws MQClientException

创建topic

参数:

key - 请向运维人员申请

newTopic - 要创建的新topic

queueNum - 新topic队列数

抛出:

MQClientException

searchOffset

long searchOffset(MessageQueue mq,
                long timestamp)
                  throws MQClientException

根据时间查询对应的offset，精确到毫秒
P.S. 当前接口有较多IO开销，请勿频繁调用

参数:

mq - 队列

timestamp - 毫秒形式时间戳

返回:

指定时间对应的offset

抛出:

MQClientException

maxOffset

long maxOffset(MessageQueue mq)
               throws MQClientException

向服务器查询队列最大Offset PS: 最大Offset无对应消息，减1有消息

参数:

mq - 队列

返回:

队列的最大Offset

抛出:

MQClientException

minOffset

long minOffset(MessageQueue mq)
               throws MQClientException

向服务器查询队列最小Offset PS: 最小Offset有对应消息

参数:

mq - 队列

返回:

队列的最小Offset

抛出:

MQClientException

earliestMsgStoreTime

long earliestMsgStoreTime(MessageQueue mq)
                          throws MQClientException

向服务器查询队列保存的最早消息对应的存储时间

参数:

mq - 队列

返回:

最早消息对应的存储时间，精确到毫秒

抛出:

MQClientException

viewMessage

MessageExt viewMessage(String msgId)
                       throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                              MQBrokerException,
                              InterruptedException,
                              MQClientException

根据消息ID，从服务器获取完整的消息

参数:

msgId -

返回:

完整消息

抛出:

InterruptedException

MQBrokerException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

queryMessage

QueryResult queryMessage(String topic,
                       String key,
                       int maxNum,
                       long begin,
                       long end)
                         throws MQClientException,
                                InterruptedException

根据消息Key查询消息

参数:

topic - 消息主题

key - 消息关键词

maxNum - 查询最大条数

begin - 起始时间戳

end - 结束时间戳

返回:

查询结果

抛出:

MQClientException

InterruptedException