MQAdminExt (rocketmq-tools 3.0.4-open 3.0.4-open API)

所有超级接口:

MQAdmin

所有已知实现类:

DefaultMQAdminExt, DefaultMQAdminExtImpl
```
public interface MQAdminExt
extends MQAdmin
```
MQ管理类接口，涉及所有与MQ管理相关的对外接口
包括Topic创建、订阅组创建、配置修改等

从以下版本开始:

2013-7-14

方法概要

方法
限定符和类型	方法和说明
`void`	`createAndUpdateKvConfig(String namespace, String key, String value)` 在 namespace 上添加或者更新 KV 配置
`void`	`createAndUpdateSubscriptionGroupConfig(String addr, com.alibaba.rocketmq.common.subscription.SubscriptionGroupConfig config)` 向指定Broker创建或者更新订阅组配置
`void`	`createAndUpdateTopicConfig(String addr, com.alibaba.rocketmq.common.TopicConfig config)` 向指定Broker创建或者更新Topic配置
`void`	`deleteIpsByProjectGroup(String key)` 删除 project group 对应的所有 server ip
`void`	`deleteKvConfig(String namespace, String key)` 删除 namespace 上的 KV 配置
`void`	`deleteSubscriptionGroup(String addr, String groupName)` 删除 broker 上的 subscription group 信息
`void`	`deleteTopicInBroker(Set<String> addrs, String topic)` 删除 broker 上的 topic 信息
`void`	`deleteTopicInNameServer(Set<String> addrs, String topic)` 删除 broker 上的 topic 信息
`com.alibaba.rocketmq.common.protocol.body.ClusterInfo`	`examineBrokerClusterInfo()` 查看集群信息
`com.alibaba.rocketmq.common.protocol.body.ConsumerConnection`	`examineConsumerConnectionInfo(String consumerGroup)` 查看Consumer网络连接、订阅关系
`com.alibaba.rocketmq.common.admin.ConsumeStats`	`examineConsumeStats(String consumerGroup)` 查询消费进度
`com.alibaba.rocketmq.common.protocol.body.ProducerConnection`	`examineProducerConnectionInfo(String producerGroup, String topic)` 查看Producer网络连接
`com.alibaba.rocketmq.common.subscription.SubscriptionGroupConfig`	`examineSubscriptionGroupConfig(String addr, String group)` 查询指定Broker的订阅组配置
`com.alibaba.rocketmq.common.TopicConfig`	`examineTopicConfig(String addr, String topic)` 查询指定Broker的Topic配置
`com.alibaba.rocketmq.common.protocol.route.TopicRouteData`	`examineTopicRouteInfo(String topic)` 查看Topic路由信息
`com.alibaba.rocketmq.common.admin.TopicStatsTable`	`examineTopicStats(String topic)` 查询Topic Offset信息
`com.alibaba.rocketmq.common.protocol.body.TopicList`	`fetchAllTopicList()` 从Name Server获取所有Topic列表
`com.alibaba.rocketmq.common.protocol.body.KVTable`	`fetchBrokerRuntimeStats(String brokerAddr)` 获取Broker运行时数据
`String`	`getIpsByProjectGroup(String projectGroup)` 通过 project 获取所有的 server ip 信息
`String`	`getKVConfig(String namespace, String key)` 从Name Server获取一个配置项
`com.alibaba.rocketmq.common.protocol.body.KVTable`	`getKVListByNamespace(String namespace)` 获取指定Namespace下的所有kv
`List<String>`	`getNameServerAddressList()` 获取Name Server地址列表
`String`	`getProjectGroupByIp(String ip)` 通过 server ip 获取 project 信息
`void`	`putKVConfig(String namespace, String key, String value)` 向Name Server增加一个配置项
`List<com.alibaba.rocketmq.common.admin.RollbackStats>`	`resetOffsetByTimestamp(String consumerGroup, String topic, long timestamp, boolean force)` 按照时间回溯消费进度
`void`	`shutdown()`
`void`	`start()`
`void`	`updateBrokerConfig(String brokerAddr, Properties properties)` 更新Broker配置
`com.alibaba.rocketmq.common.protocol.body.ConsumeByWho`	`whoConsumeTheMessage(String msgId)` 查看某个订阅组被谁消费了
`int`	`wipeWritePermOfBroker(String namesrvAddr, String brokerName)` 清除某个Broker的写权限，针对所有Name Server

从接口继承的方法 com.alibaba.rocketmq.client.MQAdmin
createTopic, earliestMsgStoreTime, maxOffset, minOffset, queryMessage, searchOffset, viewMessage

方法详细资料

start

void start()
           throws MQClientException

抛出:: MQClientException

shutdown
```
void shutdown()
```

updateBrokerConfig

void updateBrokerConfig(String brokerAddr,
                      Properties properties)
                        throws com.alibaba.rocketmq.remoting.exception.RemotingConnectException,
                               com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException,
                               com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException,
                               UnsupportedEncodingException,
                               InterruptedException,
                               MQBrokerException

更新Broker配置

参数:: brokerAddr -; properties -
抛出:: MQBrokerException; InterruptedException; UnsupportedEncodingException; com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException; com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException; com.alibaba.rocketmq.remoting.exception.RemotingConnectException

createAndUpdateTopicConfig

void createAndUpdateTopicConfig(String addr,
                              com.alibaba.rocketmq.common.TopicConfig config)
                                throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                       MQBrokerException,
                                       InterruptedException,
                                       MQClientException

向指定Broker创建或者更新Topic配置

参数:: addr -; config -
抛出:: MQClientException; InterruptedException; MQBrokerException; com.alibaba.rocketmq.remoting.exception.RemotingException

createAndUpdateSubscriptionGroupConfig

void createAndUpdateSubscriptionGroupConfig(String addr,
                                          com.alibaba.rocketmq.common.subscription.SubscriptionGroupConfig config)
                                            throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                   MQBrokerException,
                                                   InterruptedException,
                                                   MQClientException

向指定Broker创建或者更新订阅组配置

参数:: addr -; config -
抛出:: MQClientException; InterruptedException; MQBrokerException; com.alibaba.rocketmq.remoting.exception.RemotingException

examineSubscriptionGroupConfig

com.alibaba.rocketmq.common.subscription.SubscriptionGroupConfig examineSubscriptionGroupConfig(String addr,
                                                                                              String group)

查询指定Broker的订阅组配置

参数:: addr -; group -
返回:

examineTopicConfig

com.alibaba.rocketmq.common.TopicConfig examineTopicConfig(String addr,
                                                         String topic)

查询指定Broker的Topic配置

参数:: addr -; topic -
返回:

examineTopicStats

com.alibaba.rocketmq.common.admin.TopicStatsTable examineTopicStats(String topic)
                                                                    throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                           MQClientException,
                                                                           InterruptedException,
                                                                           MQBrokerException

查询Topic Offset信息

参数:: topic -
返回:
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQClientException; InterruptedException; MQBrokerException

fetchAllTopicList

com.alibaba.rocketmq.common.protocol.body.TopicList fetchAllTopicList()
                                                                      throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                             MQClientException,
                                                                             InterruptedException

从Name Server获取所有Topic列表

返回:
抛出:: InterruptedException; MQClientException; com.alibaba.rocketmq.remoting.exception.RemotingException

fetchBrokerRuntimeStats

com.alibaba.rocketmq.common.protocol.body.KVTable fetchBrokerRuntimeStats(String brokerAddr)
                                                                          throws com.alibaba.rocketmq.remoting.exception.RemotingConnectException,
                                                                                 com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException,
                                                                                 com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException,
                                                                                 InterruptedException,
                                                                                 MQBrokerException

获取Broker运行时数据

返回:
抛出:: MQBrokerException; InterruptedException; com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException; com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException; com.alibaba.rocketmq.remoting.exception.RemotingConnectException

examineConsumeStats

com.alibaba.rocketmq.common.admin.ConsumeStats examineConsumeStats(String consumerGroup)
                                                                   throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                          MQClientException,
                                                                          InterruptedException,
                                                                          MQBrokerException

查询消费进度

参数:: consumerGroup -
返回:
抛出:: InterruptedException; MQClientException; com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException

examineBrokerClusterInfo

com.alibaba.rocketmq.common.protocol.body.ClusterInfo examineBrokerClusterInfo()
                                                                               throws InterruptedException,
                                                                                      MQBrokerException,
                                                                                      com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException,
                                                                                      com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException,
                                                                                      com.alibaba.rocketmq.remoting.exception.RemotingConnectException

查看集群信息

返回:
抛出:: InterruptedException; MQBrokerException; com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException; com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException; com.alibaba.rocketmq.remoting.exception.RemotingConnectException

examineTopicRouteInfo

com.alibaba.rocketmq.common.protocol.route.TopicRouteData examineTopicRouteInfo(String topic)
                                                                                throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                                       MQClientException,
                                                                                       InterruptedException

查看Topic路由信息

参数:: topic -
返回:
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQClientException; InterruptedException

examineConsumerConnectionInfo

com.alibaba.rocketmq.common.protocol.body.ConsumerConnection examineConsumerConnectionInfo(String consumerGroup)
                                                                                           throws com.alibaba.rocketmq.remoting.exception.RemotingConnectException,
                                                                                                  com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException,
                                                                                                  com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException,
                                                                                                  InterruptedException,
                                                                                                  MQBrokerException,
                                                                                                  com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                                                  MQClientException

查看Consumer网络连接、订阅关系

参数:: consumerGroup -
返回:
抛出:: MQBrokerException; InterruptedException; com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException; com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException; com.alibaba.rocketmq.remoting.exception.RemotingConnectException; MQClientException; com.alibaba.rocketmq.remoting.exception.RemotingException

examineProducerConnectionInfo

com.alibaba.rocketmq.common.protocol.body.ProducerConnection examineProducerConnectionInfo(String producerGroup,
                                                                                         String topic)
                                                                                           throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                                                  MQClientException,
                                                                                                  InterruptedException,
                                                                                                  MQBrokerException

查看Producer网络连接

参数:: producerGroup -; topic -
返回:
抛出:: InterruptedException; MQClientException; com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException

getNameServerAddressList
```
List<String> getNameServerAddressList()
```
获取Name Server地址列表

返回:

wipeWritePermOfBroker

int wipeWritePermOfBroker(String namesrvAddr,
                        String brokerName)
                          throws com.alibaba.rocketmq.remoting.exception.RemotingCommandException,
                                 com.alibaba.rocketmq.remoting.exception.RemotingConnectException,
                                 com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException,
                                 com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException,
                                 InterruptedException,
                                 MQClientException

清除某个Broker的写权限，针对所有Name Server

参数:: brokerName -
返回:: 返回清除了多少个topic
抛出:: MQClientException; InterruptedException; com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException; com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException; com.alibaba.rocketmq.remoting.exception.RemotingConnectException; com.alibaba.rocketmq.remoting.exception.RemotingCommandException

whoConsumeTheMessage

com.alibaba.rocketmq.common.protocol.body.ConsumeByWho whoConsumeTheMessage(String msgId)

查看某个订阅组被谁消费了

参数:: msgId -
返回:

putKVConfig

void putKVConfig(String namespace,
               String key,
               String value)

向Name Server增加一个配置项

参数:: namespace -; key -; value -

getKVConfig

String getKVConfig(String namespace,
                 String key)

从Name Server获取一个配置项

参数:: namespace -; key -
返回:

getKVListByNamespace

com.alibaba.rocketmq.common.protocol.body.KVTable getKVListByNamespace(String namespace)
                                                                       throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                              MQClientException,
                                                                              InterruptedException

获取指定Namespace下的所有kv

参数:: namespace -
返回:
抛出:: InterruptedException; MQClientException; com.alibaba.rocketmq.remoting.exception.RemotingException

deleteTopicInBroker

void deleteTopicInBroker(Set<String> addrs,
                       String topic)
                         throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                MQBrokerException,
                                InterruptedException,
                                MQClientException

删除 broker 上的 topic 信息

参数:: addrs -; topic -
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

deleteTopicInNameServer

void deleteTopicInNameServer(Set<String> addrs,
                           String topic)
                             throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                    MQBrokerException,
                                    InterruptedException,
                                    MQClientException

删除 broker 上的 topic 信息

参数:: addrs -; topic -
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

deleteSubscriptionGroup

void deleteSubscriptionGroup(String addr,
                           String groupName)
                             throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                    MQBrokerException,
                                    InterruptedException,
                                    MQClientException

删除 broker 上的 subscription group 信息

参数:: addr -; groupName -
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

createAndUpdateKvConfig

void createAndUpdateKvConfig(String namespace,
                           String key,
                           String value)
                             throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                    MQBrokerException,
                                    InterruptedException,
                                    MQClientException

在 namespace 上添加或者更新 KV 配置

参数:: namespace -; key -; value -
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

deleteKvConfig

void deleteKvConfig(String namespace,
                  String key)
                    throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                           MQBrokerException,
                           InterruptedException,
                           MQClientException

删除 namespace 上的 KV 配置

参数:: namespace -; key -
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

getProjectGroupByIp

String getProjectGroupByIp(String ip)
                           throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                  MQBrokerException,
                                  InterruptedException,
                                  MQClientException

通过 server ip 获取 project 信息

参数:: ip -
返回:
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

getIpsByProjectGroup

String getIpsByProjectGroup(String projectGroup)
                            throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                   MQBrokerException,
                                   InterruptedException,
                                   MQClientException

通过 project 获取所有的 server ip 信息

参数:: projectGroup -
返回:
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

deleteIpsByProjectGroup

void deleteIpsByProjectGroup(String key)
                             throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                    MQBrokerException,
                                    InterruptedException,
                                    MQClientException

删除 project group 对应的所有 server ip

参数:: key -
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

resetOffsetByTimestamp

List<com.alibaba.rocketmq.common.admin.RollbackStats> resetOffsetByTimestamp(String consumerGroup,
                                                                           String topic,
                                                                           long timestamp,
                                                                           boolean force)
                                                                             throws com.alibaba.rocketmq.remoting.exception.RemotingException,
                                                                                    MQBrokerException,
                                                                                    InterruptedException,
                                                                                    MQClientException

按照时间回溯消费进度

参数:: consumerGroup -; topic -; timestamp -; force -
返回:
抛出:: com.alibaba.rocketmq.remoting.exception.RemotingException; MQBrokerException; InterruptedException; MQClientException

接口 MQAdminExt