com.aliyun.mns.client

Class DefaultMNSClient

java.lang.Object

com.aliyun.mns.client.DefaultMNSClient

All Implemented Interfaces:

MNSClient

public class DefaultMNSClient
extends Object
implements MNSClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultMNSClient(ServiceCredentials credentials, ServiceClient serviceClient, String endpoint)
	DefaultMNSClient(String endpoint, String accessId, String accessKey) 使用指定的MNS Endpoint构造一个新的MNSClient对象。
	DefaultMNSClient(String endpoint, String accessId, String accessKey, ClientConfiguration config) 使用指定的MNS Endpoint和配置构造一个新的MNSClient对象。

Method Summary

Modifier and Type	Method and Description
void	addHeader(String key, String value)
AsyncResult<PagingListResult<QueueMeta>>	asyncListQueue(String prefix, String marker, Integer retNumber, boolean withMeta, AsyncCallback<PagingListResult<QueueMeta>> callback)
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 queueMeta) 创建队列
AsyncResult<String>	createQueueAsync(QueueMeta queueMeta, AsyncCallback<String> callback)
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对象，后于后续对改对象的创建、查询等
int	getServiceClientHashCode()
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)
OpenServiceResponse	openService() 开通 mns
void	SetAccountAttributes(AccountAttributes accountAttributes) 设置当前用户的账号级别属性

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMNSClient

public DefaultMNSClient(String endpoint,
                        String accessId,
                        String accessKey)

使用指定的MNS Endpoint构造一个新的MNSClient对象。

Parameters:

endpoint - MNS服务的Endpoint。

accessId - 访问MNS的Access ID。

accessKey - 访问MNS的Access Key。

DefaultMNSClient

public DefaultMNSClient(String endpoint,
                        String accessId,
                        String accessKey,
                        ClientConfiguration config)

使用指定的MNS Endpoint和配置构造一个新的MNSClient对象。

Parameters:

endpoint - MNS服务的Endpoint。

accessId - 访问MNS的Access ID。

accessKey - 访问MNS的Access Key。

config - 客户端配置 ClientConfiguration。

DefaultMNSClient

protected DefaultMNSClient(ServiceCredentials credentials,
                           ServiceClient serviceClient,
                           String endpoint)

Method Detail

getServiceClientHashCode

public int getServiceClientHashCode()

close

public void close()

Description copied from interface: MNSClient

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

Specified by:

close in interface MNSClient

isOpen

public boolean isOpen()

Description copied from interface: MNSClient

检查client是否为打开状态

Specified by:

isOpen in interface MNSClient

Returns:

is open or not

SetAccountAttributes

public void SetAccountAttributes(AccountAttributes accountAttributes)
                          throws ServiceException,
                                 ClientException

Description copied from interface: MNSClient

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

Specified by:

SetAccountAttributes in interface MNSClient

Parameters:

accountAttributes - object

Throws:

ServiceException - exception

ClientException - exception

GetAccountAttributes

public AccountAttributes GetAccountAttributes()
                                       throws ServiceException,
                                              ClientException

Description copied from interface: MNSClient

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

Specified by:

GetAccountAttributes in interface MNSClient

Returns:

AccountAttributes object

Throws:

ServiceException - exception

ClientException - exception

getQueueRef

public CloudQueue getQueueRef(String queueName)

Description copied from interface: MNSClient

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

Specified by:

getQueueRef in interface MNSClient

Parameters:

queueName - exception

Returns:

CloudQueue object

addHeader

public void addHeader(String key,
                      String value)

createQueueAsync

public AsyncResult<String> createQueueAsync(QueueMeta queueMeta,
                                            AsyncCallback<String> callback)

createQueue

public CloudQueue createQueue(QueueMeta queueMeta)
                       throws ClientException,
                              ServiceException

创建队列

Specified by:

createQueue in interface MNSClient

Parameters:

queueMeta - 队列属性

Returns:

CloudQueue object

Throws:

ClientException - exception

ServiceException - exception

getTransQueueRef

public TransactionQueue getTransQueueRef(String queueName,
                                         TransactionChecker checker)

Description copied from interface: MNSClient

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.

Specified by:

getTransQueueRef in interface MNSClient

Parameters:

queueName - queueName

checker - TransactionChecker to check the transaction message status.

Returns:

TransactionQueue object The product no longer supports this function

createTransQueue

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

Description copied from interface: MNSClient

Creates transaction queue.

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

Specified by:

createTransQueue in interface MNSClient

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

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

Description copied from interface: MNSClient

Creates transaction queue with default message life time and delayTime

Specified by:

createTransQueue in interface MNSClient

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

createTransQueue

public TransactionQueue createTransQueue(QueueMeta queueMeta)
                                  throws ClientException,
                                         ServiceException

Description copied from interface: MNSClient

Creates transaction queue with default message life time and delayTime

Specified by:

createTransQueue in interface MNSClient

Parameters:

queueMeta - queue properties.

Returns:

transaction queue

Throws:

ClientException - exception

ServiceException - exception The product no longer supports this function

createPullTopic

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

Description copied from interface: MNSClient

Creates cloud pull topic.

Specified by:

createPullTopic in interface MNSClient

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

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

Description copied from interface: MNSClient

Creates cloud pull topic.

Specified by:

createPullTopic in interface MNSClient

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

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

Description copied from interface: MNSClient

Creates cloud pull topic.

Specified by:

createPullTopic in interface MNSClient

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

listQueueURL

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

Description copied from interface: MNSClient

列举队列

Specified by:

listQueueURL in interface MNSClient

Parameters:

prefix - 队列名前缀

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

retNumber - 最多返回的个数

Returns:

返回队列URL列表及marker

Throws:

ClientException - exception

ServiceException - exception

listQueue

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

Description copied from interface: MNSClient

列举队列

Specified by:

listQueue in interface MNSClient

Parameters:

prefix - 队列名前缀

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

retNumber - 最多返回的个数

Returns:

返回队列属性列表及marker

Throws:

ClientException - exception

ServiceException - exception

asyncListQueue

public AsyncResult<PagingListResult<QueueMeta>> asyncListQueue(String prefix,
                                                               String marker,
                                                               Integer retNumber,
                                                               boolean withMeta,
                                                               AsyncCallback<PagingListResult<QueueMeta>> callback)
                                                        throws ClientException,
                                                               ServiceException

Throws:

ClientException

ServiceException

getTopicRef

public CloudTopic getTopicRef(String topicName)

Description copied from interface: MNSClient

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

Specified by:

getTopicRef in interface MNSClient

Parameters:

topicName - topic name

Returns:

CloudTopic

createTopic

public CloudTopic createTopic(TopicMeta meta)

Description copied from interface: MNSClient

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

Specified by:

createTopic in interface MNSClient

Parameters:

meta - CloudTpoic的meta数据

Returns:

CloudTpoic对象

listTopic

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

Specified by:

listTopic in interface MNSClient

Parameters:

prefix - topic name前缀

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

retNumber - 最多返回的个数

Returns:

topic meta列表及marker数据

Throws:

ClientException - exception

ServiceException - exception

listTopicURL

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

Specified by:

listTopicURL in interface MNSClient

Parameters:

prefix - topic name前缀

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

retNumber - 最多返回的个数

Returns:

topic url列表及marker数据

Throws:

ClientException - exception

ServiceException - exception

openService

public OpenServiceResponse openService()

Description copied from interface: MNSClient

开通 mns

Specified by:

openService in interface MNSClient

Returns:

response