com.aliyun.mns.client

接口 MNSClient

所有已知实现类:

DefaultMNSClient

public interface MNSClient

方法概要

方法

限定符和类型	方法和说明
void	close() 关闭 client, close之后这个client的资源可能随时被释放
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList) Creates transaction queue with default message life time and delayTime
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList, boolean needCreateQueue, QueueMeta queueMetaTemplate) Creates transaction queue with default message life time and delayTime
CloudQueue	createQueue(QueueMeta queue) 创建队列
CloudTopic	createTopic(TopicMeta meta) 根据Topic的meta数据，创建CloudTopic对象，用于后续的消息发送等
TransactionQueue	createTransQueue(QueueMeta queueMeta) Creates transaction queue with default message life time and delayTime
TransactionQueue	createTransQueue(QueueMeta queueMeta, TransactionChecker checker) Creates transaction queue with default message life time and delayTime
TransactionQueue	createTransQueue(QueueMeta queueMeta, TransactionChecker checker, long lifeTime, long delayTime) Creates transaction queue.
AccountAttributes	GetAccountAttributes() 获取当前用户的账号级别属性
CloudQueue	getQueueRef(String queueName) 根据队列的URL创建CloudQueue对象，后于后续对改对象的创建、查询等
CloudTopic	getTopicRef(String topicName) 根据Tpoic的URL创建CloudTopic对象，后于后续对改对象的创建、查询等
TransactionQueue	getTransQueueRef(String queueName, TransactionChecker checker) Get reference to a transaction queue object by given queue name.
boolean	isOpen() 检查client是否为打开状态
PagingListResult<QueueMeta>	listQueue(String prefix, String marker, Integer retNumber) 列举队列
PagingListResult<String>	listQueueURL(String prefix, String marker, Integer retNumber) 列举队列
PagingListResult<TopicMeta>	listTopic(String prefix, String marker, Integer retNumber)
PagingListResult<String>	listTopicURL(String prefix, String marker, Integer retNumber)
void	SetAccountAttributes(AccountAttributes accountAttributes) 设置当前用户的账号级别属性

方法详细资料

close

void close()

关闭 client, close之后这个client的资源可能随时被释放

isOpen

boolean isOpen()

检查client是否为打开状态

SetAccountAttributes

void SetAccountAttributes(AccountAttributes accountAttributes)
                          throws ServiceException,
                                 ClientException

设置当前用户的账号级别属性

参数:

accountAttributes - object

抛出:

ServiceException

ClientException

GetAccountAttributes

AccountAttributes GetAccountAttributes()
                                       throws ServiceException,
                                              ClientException

获取当前用户的账号级别属性

返回:

AccountAttributes object

抛出:

ServiceException

ClientException

getQueueRef

CloudQueue getQueueRef(String queueName)

根据队列的URL创建CloudQueue对象，后于后续对改对象的创建、查询等

参数:

queueName -

返回:

CloudQueue object

createQueue

CloudQueue createQueue(QueueMeta queue)
                       throws ClientException,
                              ServiceException

创建队列

参数:

queue - 队列属性

返回:

CloudQueue object

抛出:

ClientException

ServiceException

getTransQueueRef

TransactionQueue getTransQueueRef(String queueName,
                                TransactionChecker checker)

Get reference to a transaction queue object by given queue name. note: it will not do create queue operation and assumes the queue has already be create properly.

参数:

queueName -

checker - TransactionChecker to check the transaction message status.

返回:

TransactionQueue object

createTransQueue

TransactionQueue createTransQueue(QueueMeta queueMeta,
                                TransactionChecker checker,
                                long lifeTime,
                                long delayTime)
                                  throws ClientException,
                                         ServiceException

Creates transaction queue.

参数:

queueMeta - queue properties.

checker - TransactionChecker to check the transaction message status.

lifeTime - message life time in seconds

delayTime - message delay time in seconds

抛出:

ClientException - note:delayTime should be bigger than lifetime to make sure that that message will not be visible to consumer by default.

ServiceException

createTransQueue

TransactionQueue createTransQueue(QueueMeta queueMeta,
                                TransactionChecker checker)
                                  throws ClientException,
                                         ServiceException

Creates transaction queue with default message life time and delayTime

参数:

queueMeta - queue properties.

checker - TransactionChecker to check the transaction message status.

抛出:

ClientException

ServiceException

createPullTopic

CloudPullTopic createPullTopic(TopicMeta topicMeta,
                             Vector<String> queueNameList,
                             boolean needCreateQueue,
                             QueueMeta queueMetaTemplate)
                               throws ClientException,
                                      ServiceException

Creates transaction queue with default message life time and delayTime

参数:

topicMeta - topic properties.

queueNameList - the queue name list which are going to be endpoint of new created topic.

needCreateQueue - flag to indicate that if we need to create the queue in the queueNameList.

queueMetaTemplate - the queueMeta template used to create queues in queueNamelist if need.

抛出:

ClientException

ServiceException

createPullTopic

CloudPullTopic createPullTopic(TopicMeta topicMeta,
                             Vector<String> queueNameList)
                               throws ClientException,
                                      ServiceException

Creates transaction queue with default message life time and delayTime

参数:

topicMeta - topic properties.

queueNameList - the queue name list which are going to be endpoint of new created topic.

抛出:

ClientException

ServiceException

createTransQueue

TransactionQueue createTransQueue(QueueMeta queueMeta)
                                  throws ClientException,
                                         ServiceException

Creates transaction queue with default message life time and delayTime

参数:

queueMeta - queue properties.

抛出:

ClientException

ServiceException

listQueue

PagingListResult<QueueMeta> listQueue(String prefix,
                                    String marker,
                                    Integer retNumber)
                                      throws ClientException,
                                             ServiceException

列举队列

参数:

prefix - 队列名前缀

marker - 列举的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker

retNumber - 最多返回的个数

返回:

返回队列属性列表及marker

抛出:

ClientException

ServiceException

listQueueURL

PagingListResult<String> listQueueURL(String prefix,
                                    String marker,
                                    Integer retNumber)
                                      throws ClientException,
                                             ServiceException

列举队列

参数:

prefix - 队列名前缀

marker - 列举的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker

retNumber - 最多返回的个数

返回:

返回队列URL列表及marker

抛出:

ClientException

ServiceException

getTopicRef

CloudTopic getTopicRef(String topicName)

根据Tpoic的URL创建CloudTopic对象，后于后续对改对象的创建、查询等

参数:

topicName - topic name

返回:

CloudTpoic对象

createTopic

CloudTopic createTopic(TopicMeta meta)

根据Topic的meta数据，创建CloudTopic对象，用于后续的消息发送等

参数:

meta - CloudTpoic的meta数据

返回:

CloudTpoic对象

listTopic

PagingListResult<TopicMeta> listTopic(String prefix,
                                    String marker,
                                    Integer retNumber)
                                      throws ClientException,
                                             ServiceException

参数:

prefix - topic name前缀

marker - topic的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker

retNumber - 最多返回的个数

返回:

topic meta列表及marker数据

抛出:

ClientException

ServiceException

listTopicURL

PagingListResult<String> listTopicURL(String prefix,
                                    String marker,
                                    Integer retNumber)
                                      throws ClientException,
                                             ServiceException

参数:

prefix - topic name前缀

marker - topic的起始位置，""表示从第一个开始，也可以是前一次列举返回的marker

retNumber - 最多返回的个数

返回:

topic url列表及marker数据

抛出:

ClientException

ServiceException