com.alibaba.rocketmq.client

接口 MQAdmin

所有已知子接口:

MQConsumer, MQProducer, MQPullConsumer, MQPushConsumer

所有已知实现类:

DefaultMQProducer, DefaultMQPullConsumer, DefaultMQPushConsumer, TransactionMQProducer

public interface MQAdmin

Base interface for MQ management

从以下版本开始:

2013-7-24

作者:

shijia.wxr

方法概要

方法

限定符和类型	方法和说明
void	createTopic(String key, String newTopic, int queueNum) Creates an topic
void	createTopic(String key, String newTopic, int queueNum, int topicSysFlag) Creates an topic
long	earliestMsgStoreTime(MessageQueue mq) Gets the earliest stored message time
long	maxOffset(MessageQueue mq) Gets the max offset
long	minOffset(MessageQueue mq) Gets the minimum offset
QueryResult	queryMessage(String topic, String key, int maxNum, long begin, long end) Query messages
long	searchOffset(MessageQueue mq, long timestamp) Gets the message queue offset according to some time in milliseconds be cautious to call because of more IO overhead
MessageExt	viewMessage(String msgId) Query message according tto message id

方法详细资料

createTopic

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

Creates an topic

参数:

key - accesskey

newTopic - topic name

queueNum - topic's queue number

抛出:

MQClientException

createTopic

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

Creates an topic

参数:

key - accesskey

newTopic - topic name

queueNum - topic's queue number

topicSysFlag - topic system flag

抛出:

MQClientException

searchOffset

long searchOffset(MessageQueue mq,
                long timestamp)
                  throws MQClientException

Gets the message queue offset according to some time in milliseconds
be cautious to call because of more IO overhead

参数:

mq - Instance of MessageQueue

timestamp - from when in milliseconds.

返回:

offset

抛出:

MQClientException

maxOffset

long maxOffset(MessageQueue mq)
               throws MQClientException

Gets the max offset

参数:

mq - Instance of MessageQueue

返回:

the max offset

抛出:

MQClientException

minOffset

long minOffset(MessageQueue mq)
               throws MQClientException

Gets the minimum offset

参数:

mq - Instance of MessageQueue

返回:

the minimum offset

抛出:

MQClientException

earliestMsgStoreTime

long earliestMsgStoreTime(MessageQueue mq)
                          throws MQClientException

Gets the earliest stored message time

参数:

mq - Instance of MessageQueue

返回:

the time in microseconds

抛出:

MQClientException

viewMessage

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

Query message according tto message id

参数:

msgId - message id

返回:

message

抛出:

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

Query messages

参数:

topic - message topic

key - message key index word

maxNum - max message number

begin - from when

end - to when

返回:

Instance of QueryResult

抛出:

MQClientException

InterruptedException