com.alibaba.rocketmq.tools.admin

类 DefaultMQAdminExt

java.lang.Object

com.alibaba.rocketmq.client.ClientConfig

com.alibaba.rocketmq.tools.admin.DefaultMQAdminExt

所有已实现的接口:

MQAdmin, MQAdminExt

public class DefaultMQAdminExt
extends ClientConfig
implements MQAdminExt

所有运维接口都在这里实现

从以下版本开始:

2013-7-14

作者:

shijia.wxr

构造器概要

构造器

构造器和说明
DefaultMQAdminExt()
DefaultMQAdminExt(String adminExtGroup)

方法概要

方法

限定符和类型	方法和说明
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	createTopic(String key, String newTopic, int queueNum)
void	deleteIpsByProjectGroup(String projectGroup) 删除 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 信息
long	earliestMsgStoreTime(com.alibaba.rocketmq.common.message.MessageQueue mq)
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	getAdminExtGroup()
String	getCreateTopicKey()
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 信息
long	maxOffset(com.alibaba.rocketmq.common.message.MessageQueue mq)
long	minOffset(com.alibaba.rocketmq.common.message.MessageQueue mq)
void	putKVConfig(String namespace, String key, String value) 向Name Server增加一个配置项
QueryResult	queryMessage(String topic, String key, int maxNum, long begin, long end)
List<com.alibaba.rocketmq.common.admin.RollbackStats>	resetOffsetByTimestamp(String consumerGroup, String topic, long timestamp, boolean force) 按照时间回溯消费进度
long	searchOffset(com.alibaba.rocketmq.common.message.MessageQueue mq, long timestamp)
void	setAdminExtGroup(String adminExtGroup)
void	setCreateTopicKey(String createTopicKey)
void	shutdown()
void	start()
void	updateBrokerConfig(String brokerAddr, Properties properties) 更新Broker配置
com.alibaba.rocketmq.common.message.MessageExt	viewMessage(String msgId)
com.alibaba.rocketmq.common.protocol.body.ConsumeByWho	whoConsumeTheMessage(String msgId) 查看某个订阅组被谁消费了
int	wipeWritePermOfBroker(String namesrvAddr, String brokerName) 清除某个Broker的写权限，针对所有Name Server

从类继承的方法 com.alibaba.rocketmq.client.ClientConfig

buildMQClientId, cloneClientConfig, getClientCallbackExecutorThreads, getClientIP, getHeartbeatBrokerInterval, getInstanceName, getNamesrvAddr, getPersistConsumerOffsetInterval, getPollNameServerInteval, resetClientConfig, setClientCallbackExecutorThreads, setClientIP, setHeartbeatBrokerInterval, setInstanceName, setNamesrvAddr, setPersistConsumerOffsetInterval, setPollNameServerInteval, toString

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

DefaultMQAdminExt

public DefaultMQAdminExt()

DefaultMQAdminExt

public DefaultMQAdminExt(String adminExtGroup)

方法详细资料

createTopic

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

指定者:

createTopic 在接口中 MQAdmin

抛出:

MQClientException

searchOffset

public long searchOffset(com.alibaba.rocketmq.common.message.MessageQueue mq,
                long timestamp)
                  throws MQClientException

指定者:

searchOffset 在接口中 MQAdmin

抛出:

MQClientException

maxOffset

public long maxOffset(com.alibaba.rocketmq.common.message.MessageQueue mq)
               throws MQClientException

指定者:

maxOffset 在接口中 MQAdmin

抛出:

MQClientException

minOffset

public long minOffset(com.alibaba.rocketmq.common.message.MessageQueue mq)
               throws MQClientException

指定者:

minOffset 在接口中 MQAdmin

抛出:

MQClientException

earliestMsgStoreTime

public long earliestMsgStoreTime(com.alibaba.rocketmq.common.message.MessageQueue mq)
                          throws MQClientException

指定者:

earliestMsgStoreTime 在接口中 MQAdmin

抛出:

MQClientException

viewMessage

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

指定者:

viewMessage 在接口中 MQAdmin

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

queryMessage

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

指定者:

queryMessage 在接口中 MQAdmin

抛出:

MQClientException

InterruptedException

start

public void start()
           throws MQClientException

指定者:

start 在接口中 MQAdminExt

抛出:

MQClientException

shutdown

public void shutdown()

指定者:

shutdown 在接口中 MQAdminExt

createAndUpdateTopicConfig

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

从接口复制的说明: MQAdminExt

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

指定者:

createAndUpdateTopicConfig 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

createAndUpdateSubscriptionGroupConfig

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

从接口复制的说明: MQAdminExt

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

指定者:

createAndUpdateSubscriptionGroupConfig 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

examineSubscriptionGroupConfig

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

从接口复制的说明: MQAdminExt

查询指定Broker的订阅组配置

指定者:

examineSubscriptionGroupConfig 在接口中 MQAdminExt

返回:

examineTopicConfig

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

从接口复制的说明: MQAdminExt

查询指定Broker的Topic配置

指定者:

examineTopicConfig 在接口中 MQAdminExt

返回:

examineTopicStats

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

从接口复制的说明: MQAdminExt

查询Topic Offset信息

指定者:

examineTopicStats 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

InterruptedException

MQBrokerException

examineConsumeStats

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

从接口复制的说明: MQAdminExt

查询消费进度

指定者:

examineConsumeStats 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

InterruptedException

MQBrokerException

examineBrokerClusterInfo

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

从接口复制的说明: MQAdminExt

查看集群信息

指定者:

examineBrokerClusterInfo 在接口中 MQAdminExt

返回:

抛出:

InterruptedException

com.alibaba.rocketmq.remoting.exception.RemotingConnectException

com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException

com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException

MQBrokerException

examineTopicRouteInfo

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

从接口复制的说明: MQAdminExt

查看Topic路由信息

指定者:

examineTopicRouteInfo 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

InterruptedException

putKVConfig

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

从接口复制的说明: MQAdminExt

向Name Server增加一个配置项

指定者:

putKVConfig 在接口中 MQAdminExt

getKVConfig

public String getKVConfig(String namespace,
                 String key)

从接口复制的说明: MQAdminExt

从Name Server获取一个配置项

指定者:

getKVConfig 在接口中 MQAdminExt

返回:

examineConsumerConnectionInfo

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

从接口复制的说明: MQAdminExt

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

指定者:

examineConsumerConnectionInfo 在接口中 MQAdminExt

返回:

抛出:

InterruptedException

MQBrokerException

com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException

com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException

com.alibaba.rocketmq.remoting.exception.RemotingConnectException

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

examineProducerConnectionInfo

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

从接口复制的说明: MQAdminExt

查看Producer网络连接

指定者:

examineProducerConnectionInfo 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

InterruptedException

MQBrokerException

wipeWritePermOfBroker

public 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

从接口复制的说明: MQAdminExt

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

指定者:

wipeWritePermOfBroker 在接口中 MQAdminExt

返回:

返回清除了多少个topic

抛出:

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

getAdminExtGroup

public String getAdminExtGroup()

setAdminExtGroup

public void setAdminExtGroup(String adminExtGroup)

getCreateTopicKey

public String getCreateTopicKey()

setCreateTopicKey

public void setCreateTopicKey(String createTopicKey)

getNameServerAddressList

public List<String> getNameServerAddressList()

从接口复制的说明: MQAdminExt

获取Name Server地址列表

指定者:

getNameServerAddressList 在接口中 MQAdminExt

返回:

whoConsumeTheMessage

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

从接口复制的说明: MQAdminExt

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

指定者:

whoConsumeTheMessage 在接口中 MQAdminExt

返回:

fetchAllTopicList

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

从接口复制的说明: MQAdminExt

从Name Server获取所有Topic列表

指定者:

fetchAllTopicList 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

InterruptedException

fetchBrokerRuntimeStats

public 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

从接口复制的说明: MQAdminExt

获取Broker运行时数据

指定者:

fetchBrokerRuntimeStats 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingConnectException

com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException

com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException

InterruptedException

MQBrokerException

deleteTopicInBroker

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

从接口复制的说明: MQAdminExt

删除 broker 上的 topic 信息

指定者:

deleteTopicInBroker 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

deleteTopicInNameServer

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

从接口复制的说明: MQAdminExt

删除 broker 上的 topic 信息

指定者:

deleteTopicInNameServer 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

deleteSubscriptionGroup

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

从接口复制的说明: MQAdminExt

删除 broker 上的 subscription group 信息

指定者:

deleteSubscriptionGroup 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

createAndUpdateKvConfig

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

从接口复制的说明: MQAdminExt

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

指定者:

createAndUpdateKvConfig 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

deleteKvConfig

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

从接口复制的说明: MQAdminExt

删除 namespace 上的 KV 配置

指定者:

deleteKvConfig 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

getProjectGroupByIp

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

从接口复制的说明: MQAdminExt

通过 server ip 获取 project 信息

指定者:

getProjectGroupByIp 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

getIpsByProjectGroup

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

从接口复制的说明: MQAdminExt

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

指定者:

getIpsByProjectGroup 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

deleteIpsByProjectGroup

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

从接口复制的说明: MQAdminExt

删除 project group 对应的所有 server ip

指定者:

deleteIpsByProjectGroup 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

resetOffsetByTimestamp

public 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

从接口复制的说明: MQAdminExt

按照时间回溯消费进度

指定者:

resetOffsetByTimestamp 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQBrokerException

InterruptedException

MQClientException

getKVListByNamespace

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

从接口复制的说明: MQAdminExt

获取指定Namespace下的所有kv

指定者:

getKVListByNamespace 在接口中 MQAdminExt

返回:

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingException

MQClientException

InterruptedException

updateBrokerConfig

public 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

从接口复制的说明: MQAdminExt

更新Broker配置

指定者:

updateBrokerConfig 在接口中 MQAdminExt

抛出:

com.alibaba.rocketmq.remoting.exception.RemotingConnectException

com.alibaba.rocketmq.remoting.exception.RemotingSendRequestException

com.alibaba.rocketmq.remoting.exception.RemotingTimeoutException

UnsupportedEncodingException

InterruptedException

MQBrokerException