com.aliyun.mns.client

类 DefaultMNSClient

java.lang.Object

com.aliyun.mns.client.DefaultMNSClient

所有已实现的接口:

MNSClient

public class DefaultMNSClient
extends Object
implements MNSClient

构造器概要

构造器

限定符	构造器和说明
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对象。

方法概要

方法

限定符和类型	方法和说明
void	addHeader(String key, String value)
void	close() 关闭 client, close之后这个client的资源可能随时被释放
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList) Creates topic for pull.
CloudPullTopic	createPullTopic(TopicMeta topicMeta, Vector<String> queueNameList, boolean needCreateQueue, QueueMeta queueMetaTemplate) Creates topic for pull.
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) 根据Topic的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) 设置当前用户的账号级别属性

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

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

构造器详细资料

DefaultMNSClient

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

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

参数:

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对象。

参数:

endpoint - MNS服务的Endpoint。

accessId - 访问MNS的Access ID。

accessKey - 访问MNS的Access Key。

config - 客户端配置 ClientConfiguration。

DefaultMNSClient

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

方法详细资料

getServiceClientHashCode

public int getServiceClientHashCode()

close

public void close()

从接口复制的说明: MNSClient

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

指定者:

close 在接口中 MNSClient

isOpen

public boolean isOpen()

从接口复制的说明: MNSClient

检查client是否为打开状态

指定者:

isOpen 在接口中 MNSClient

SetAccountAttributes

public void SetAccountAttributes(AccountAttributes accountAttributes)
                          throws ServiceException,
                                 ClientException

从接口复制的说明: MNSClient

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

指定者:

SetAccountAttributes 在接口中 MNSClient

参数:

accountAttributes - object

抛出:

ServiceException

ClientException

GetAccountAttributes

public AccountAttributes GetAccountAttributes()
                                       throws ServiceException,
                                              ClientException

从接口复制的说明: MNSClient

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

指定者:

GetAccountAttributes 在接口中 MNSClient

返回:

AccountAttributes object

抛出:

ServiceException

ClientException

getQueueRef

public CloudQueue getQueueRef(String queueName)

从接口复制的说明: MNSClient

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

指定者:

getQueueRef 在接口中 MNSClient

返回:

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

创建队列

指定者:

createQueue 在接口中 MNSClient

参数:

queueMeta - 队列属性

返回:

CloudQueue object

抛出:

ClientException

ServiceException

getTransQueueRef

public 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.

指定者:

getTransQueueRef 在接口中 MNSClient

参数:

queueName -

checker - TransactionChecker to check the transaction message status.

返回:

TransactionQueue object

createTransQueue

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

Creates transaction queue.

指定者:

createTransQueue 在接口中 MNSClient

参数:

queueMeta - queue properties.

checker - TransactionChecker to check the transaction message status.

lifeTime - message life time

delayTime - message delay time

抛出:

ClientException

ServiceException

createTransQueue

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

Creates transaction queue with default message life time and delayTime

指定者:

createTransQueue 在接口中 MNSClient

参数:

queueMeta - queue properties.

checker - TransactionChecker to check the transaction message status.

抛出:

ClientException

ServiceException

createTransQueue

public TransactionQueue createTransQueue(QueueMeta queueMeta)
                                  throws ClientException,
                                         ServiceException

Creates transaction queue with default message life time and delayTime

指定者:

createTransQueue 在接口中 MNSClient

参数:

queueMeta - queue properties.

抛出:

ClientException

ServiceException

createPullTopic

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

Creates topic for pull.

指定者:

createPullTopic 在接口中 MNSClient

参数:

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,IllegalArgumentException

ClientException

ServiceException

createPullTopic

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

Creates topic for pull.

指定者:

createPullTopic 在接口中 MNSClient

参数:

topicMeta - topic properties.

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

抛出:

ClientException,ServiceException,IllegalArgumentException

ClientException

ServiceException

listQueueURL

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

列举队列

指定者:

listQueueURL 在接口中 MNSClient

参数:

prefix - 队列名前缀

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

retNumber - 最多返回的个数

返回:

返回队列URL列表及marker

抛出:

ClientException

ServiceException

listQueue

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

列举队列

指定者:

listQueue 在接口中 MNSClient

参数:

prefix - 队列名前缀

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

retNumber - 最多返回的个数

返回:

返回队列属性列表及marker

抛出:

ClientException

ServiceException

getTopicRef

public CloudTopic getTopicRef(String topicName)

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

指定者:

getTopicRef 在接口中 MNSClient

参数:

topicName - topic name

返回:

CloudTpoic对象

createTopic

public CloudTopic createTopic(TopicMeta meta)

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

指定者:

createTopic 在接口中 MNSClient

参数:

meta - CloudTpoic的meta数据

返回:

CloudTpoic对象

listTopic

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

指定者:

listTopic 在接口中 MNSClient

参数:

prefix - topic name前缀

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

retNumber - 最多返回的个数

返回:

topic meta列表及marker数据

抛出:

ClientException

ServiceException

listTopicURL

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

指定者:

listTopicURL 在接口中 MNSClient

参数:

prefix - topic name前缀

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

retNumber - 最多返回的个数

返回:

topic url列表及marker数据

抛出:

ClientException

ServiceException