com.aliyun.mns.client

Interface MNSClient

All Known Implementing Classes:

DefaultMNSClient

public interface MNSClient

Method Summary

Modifier and Type	Method and Description
void	close() 关闭 client, close之后这个client的资源可能随时被释放
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList) Creates cloud pull topic.
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList, boolean needCreateQueue, QueueMeta queueMetaTemplate) Creates cloud pull topic.
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList, boolean needCreateQueue, QueueMeta queueMetaTemplate, Vector<String> tagList) Creates cloud pull topic.
CloudQueue	createQueue(QueueMeta queue) 创建队列
CloudTopic	createTopic(TopicMeta meta) 根据Topic的meta数据，创建CloudTopic对象，用于后续的消息发送等
TransactionQueue	createTransQueue(QueueMeta queueMeta) Deprecated.
TransactionQueue	createTransQueue(QueueMeta queueMeta, TransactionChecker checker) Deprecated.
TransactionQueue	createTransQueue(QueueMeta queueMeta, TransactionChecker checker, long lifeTime, long delayTime) Deprecated.
AccountAttributes	GetAccountAttributes() 获取当前用户的账号级别属性
CloudQueue	getQueueRef(String queueName) 根据队列的URL创建CloudQueue对象，后于后续对改对象的创建、查询等
CloudTopic	getTopicRef(String topicName) 根据Tpoic的URL创建CloudTopic对象，后于后续对改对象的创建、查询等
TransactionQueue	getTransQueueRef(String queueName, TransactionChecker checker) Deprecated.
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)
OpenServiceResponse	openService() 开通 mns
void	SetAccountAttributes(AccountAttributes accountAttributes) 设置当前用户的账号级别属性

Method Detail

close

void close()

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

isOpen

boolean isOpen()

检查client是否为打开状态

Returns:

is open or not

SetAccountAttributes

void SetAccountAttributes(AccountAttributes accountAttributes)
                   throws ServiceException,
                          ClientException

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

Parameters:

accountAttributes - object

Throws:

ServiceException - exception

ClientException - exception

GetAccountAttributes

AccountAttributes GetAccountAttributes()
                                throws ServiceException,
                                       ClientException

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

Returns:

AccountAttributes object

Throws:

ServiceException - exception

ClientException - exception

getQueueRef

CloudQueue getQueueRef(String queueName)

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

Parameters:

queueName - exception

Returns:

CloudQueue object

createQueue

CloudQueue createQueue(QueueMeta queue)
                throws ClientException,
                       ServiceException

创建队列

Parameters:

queue - 队列属性

Returns:

CloudQueue object

Throws:

ClientException - exception

ServiceException - exception

getTransQueueRef

@Deprecated
TransactionQueue getTransQueueRef(String queueName,
                                              TransactionChecker checker)

Deprecated.

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.

Parameters:

queueName - queueName

checker - TransactionChecker to check the transaction message status.

Returns:

TransactionQueue object The product no longer supports this function

createTransQueue

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

Deprecated.

Creates transaction queue.

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

Parameters:

queueMeta - queue properties.

checker - TransactionChecker to check the transaction message status.

lifeTime - message life time in seconds

delayTime - message delay time in seconds

Returns:

transaction queue

Throws:

ClientException - exception

ServiceException - exception The product no longer supports this function

createTransQueue

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

Deprecated.

Creates transaction queue with default message life time and delayTime

Parameters:

queueMeta - queue properties.

checker - TransactionChecker to check the transaction message status.

Returns:

transaction queue

Throws:

ClientException - exception

ServiceException - exception The product no longer supports this function

createPullTopic

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

Creates cloud pull topic.

Parameters:

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.

Returns:

cloud pull topic

Throws:

ClientException - exception

ServiceException - exception

createPullTopic

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

Creates cloud pull topic.

Parameters:

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.

tagList - the filter tag list for each consumer queue.

Returns:

cloud pull topic

Throws:

ClientException - exception

ServiceException - exception

createPullTopic

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

Creates cloud pull topic.

Parameters:

topicMeta - topic properties.

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

Returns:

cloud pull topic

Throws:

ClientException - exception

ServiceException - exception

createTransQueue

@Deprecated
TransactionQueue createTransQueue(QueueMeta queueMeta)
                                       throws ClientException,
                                              ServiceException

Deprecated.

Creates transaction queue with default message life time and delayTime

Parameters:

queueMeta - queue properties.

Returns:

transaction queue

Throws:

ClientException - exception

ServiceException - exception The product no longer supports this function

listQueue

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

列举队列

Parameters:

prefix - 队列名前缀

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

retNumber - 最多返回的个数

Returns:

返回队列属性列表及marker

Throws:

ClientException - exception

ServiceException - exception

listQueueURL

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

列举队列

Parameters:

prefix - 队列名前缀

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

retNumber - 最多返回的个数

Returns:

返回队列URL列表及marker

Throws:

ClientException - exception

ServiceException - exception

getTopicRef

CloudTopic getTopicRef(String topicName)

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

Parameters:

topicName - topic name

Returns:

CloudTopic

createTopic

CloudTopic createTopic(TopicMeta meta)

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

Parameters:

meta - CloudTpoic的meta数据

Returns:

CloudTpoic对象

listTopic

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

Parameters:

prefix - topic name前缀

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

retNumber - 最多返回的个数

Returns:

topic meta列表及marker数据

Throws:

ClientException - exception

ServiceException - exception

listTopicURL

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

Parameters:

prefix - topic name前缀

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

retNumber - 最多返回的个数

Returns:

topic url列表及marker数据

Throws:

ClientException - exception

ServiceException - exception

openService

OpenServiceResponse openService()

开通 mns

Returns:

response