com.aliyun.mns.client

Class CloudQueue

java.lang.Object

com.aliyun.mns.client.CloudQueue

public final class CloudQueue
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CloudQueue(String queueURL, ServiceClient client, ServiceCredentials credentials, URI endpoint)

Method Summary

Modifier and Type	Method and Description
AsyncResult<Void>	asyncBatchDeleteMessage(List<String> receiptHandles, AsyncCallback<Void> callback)
AsyncResult<List<Message>>	asyncBatchPeekMessage(int batchSize, AsyncCallback<List<Message>> callback) 异步批量查看消息
AsyncResult<List<Message>>	asyncBatchPopMessage(int batchSize, AsyncCallback<List<Message>> callback) 异步批量获取队列中的消息
AsyncResult<List<Message>>	asyncBatchPopMessage(int batchSize, int waitSeconds, AsyncCallback<List<Message>> callback) 异步批量获取队列中的消息
AsyncResult<List<Message>>	asyncBatchPutMessage(List<Message> messages, AsyncCallback<List<Message>> callback) 异步批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
AsyncResult<Message>	asyncChangeMessageVisibility(String receiptHandle, int visibilityTimeout, AsyncCallback<Message> callback) 异步改变消息的不可见时间
AsyncResult<String>	asyncChangeMessageVisibilityTimeout(String receiptHandle, int visibilityTimeout, AsyncCallback<String> callback) 异步改变消息的不可见时间
AsyncResult<String>	asyncCreate(QueueMeta queueMeta, AsyncCallback<String> callback) 异步创建队列，队列属性由参数queueMeta设置
AsyncResult<Void>	asyncDelete(AsyncCallback<Void> callback) 异步删除队列
AsyncResult<Void>	asyncDeleteMessage(String receiptHandle, AsyncCallback<Void> callback) 异步删除消息
AsyncResult<QueueMeta>	asyncGetAttributes(AsyncCallback<QueueMeta> callback) 异步获取队列的属性
AsyncResult<Message>	asyncPeekMessage(AsyncCallback<Message> callback) 异步查看队列消息
AsyncResult<Message>	asyncPopMessage(AsyncCallback<Message> callback) 异步获取队列中的消息
AsyncResult<Message>	asyncPopMessage(int waitSeconds, AsyncCallback<Message> callback) 异步获取队列中的消息
AsyncResult<Message>	asyncPutMessage(Message message, AsyncCallback<Message> callback) 异步发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
AsyncResult<Void>	asyncSetAttributes(QueueMeta queueMeta, AsyncCallback<Void> callback) 异步设置队列属性
void	batchDeleteMessage(List<String> receiptHandles) 批量删除消息
List<Message>	batchPeekMessage(int batchSize) 批量查看队列消息，消息不存在时返回null
List<Message>	batchPopMessage(int batchSize) 批量获取队列中的消息, 队列中没有消息的时候返回null
List<Message>	batchPopMessage(int batchSize, int waitSeconds) 批量获取队列中的消息, 队列中没有消息的时候返回null
List<Message>	batchPutMessage(List<Message> messages) 批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
Message	changeMessageVisibility(String receiptHandle, int visibilityTimeout) 改变消息的不可见时间
String	changeMessageVisibilityTimeout(String receiptHandle, int visibilityTimeout) 改变消息的不可见时间
String	create() 创建队列，使用默认属性
String	create(QueueMeta queueMeta) 创建队列，队列属性由参数queueMeta设置
void	delete() 删除队列
void	deleteMessage(String receiptHandle) 删除消息
QueueMeta	getAttributes() 获取队列的属性
String	getQueueURL()
boolean	isMessageNotExist(ServiceException e)
boolean	isQueueExist() Check if queue is exist already.
Message	peekMessage() 查看队列消息, 消息不存在时返回null
Message	popMessage() 获取队列中的消息, 在队列中没有消息的时候返回null
Message	popMessage(int waitSeconds) 获取队列中的消息, 队列中没有消息的时候返回null
Message	putMessage(Message message) 发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。
void	setAttributes(QueueMeta queueMeta) 设置队列属性

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudQueue

protected CloudQueue(String queueURL,
                     ServiceClient client,
                     ServiceCredentials credentials,
                     URI endpoint)

Method Detail

create

public String create()
              throws ServiceException,
                     ClientException

创建队列，使用默认属性

Returns:

队列的URL

Throws:

ServiceException - exception

ClientException - exception

create

public String create(QueueMeta queueMeta)
              throws ServiceException,
                     ClientException

创建队列，队列属性由参数queueMeta设置

Parameters:

queueMeta, - queue meta data

Returns:

队列的URL

Throws:

ServiceException - exception

ClientException - exception

asyncCreate

public AsyncResult<String> asyncCreate(QueueMeta queueMeta,
                                       AsyncCallback<String> callback)
                                throws ClientException

异步创建队列，队列属性由参数queueMeta设置

Parameters:

queueMeta - queue meta data

callback - callback

Returns:

队列的URL

Throws:

ClientException - exception

delete

public void delete()
            throws ServiceException,
                   ClientException

删除队列

Throws:

ServiceException - exception

ClientException - exception

asyncDelete

public AsyncResult<Void> asyncDelete(AsyncCallback<Void> callback)
                              throws ServiceException,
                                     ClientException

异步删除队列

Parameters:

callback - callback

Returns:

result

Throws:

ServiceException - exception

ClientException - exception

getAttributes

public QueueMeta getAttributes()
                        throws ServiceException,
                               ClientException

获取队列的属性

Returns:

队列属性

Throws:

ServiceException - exception

ClientException - exception

asyncGetAttributes

public AsyncResult<QueueMeta> asyncGetAttributes(AsyncCallback<QueueMeta> callback)
                                          throws ClientException

异步获取队列的属性

Parameters:

callback - callback

Returns:

队列属性

Throws:

ClientException - exception

setAttributes

public void setAttributes(QueueMeta queueMeta)
                   throws ClientException,
                          ServiceException

设置队列属性

Parameters:

queueMeta, - queue meta data

Throws:

ClientException - exception

ServiceException - exception

asyncSetAttributes

public AsyncResult<Void> asyncSetAttributes(QueueMeta queueMeta,
                                            AsyncCallback<Void> callback)
                                     throws ClientException

异步设置队列属性

Parameters:

queueMeta - queue meta data

callback - callback

Returns:

result

Throws:

ClientException - exception

peekMessage

public Message peekMessage()
                    throws ServiceException,
                           ClientException

查看队列消息, 消息不存在时返回null

Returns:

查找到的消息

Throws:

ServiceException - exception

ClientException - exception

asyncPeekMessage

public AsyncResult<Message> asyncPeekMessage(AsyncCallback<Message> callback)
                                      throws ClientException

异步查看队列消息

Parameters:

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

batchPeekMessage

public List<Message> batchPeekMessage(int batchSize)
                               throws ServiceException,
                                      ClientException

批量查看队列消息，消息不存在时返回null

Parameters:

batchSize - 本次最多查看消息的条数

Returns:

查找到的消息

Throws:

ServiceException - exception

ClientException - exception

asyncBatchPeekMessage

public AsyncResult<List<Message>> asyncBatchPeekMessage(int batchSize,
                                                        AsyncCallback<List<Message>> callback)
                                                 throws ClientException

异步批量查看消息

Parameters:

batchSize - 本次最多查看消息的条数

callback - callback

Returns:

异步结果调用句柄

Throws:

ClientException - exception

changeMessageVisibilityTimeout

public String changeMessageVisibilityTimeout(String receiptHandle,
                                             int visibilityTimeout)
                                      throws ServiceException,
                                             ClientException

改变消息的不可见时间

Parameters:

receiptHandle - 消息句柄

visibilityTimeout - 消息不可见时间，单位是秒

Returns:

新的消息句柄

Throws:

ServiceException - exception

ClientException - exception

asyncChangeMessageVisibilityTimeout

public AsyncResult<String> asyncChangeMessageVisibilityTimeout(String receiptHandle,
                                                               int visibilityTimeout,
                                                               AsyncCallback<String> callback)
                                                        throws ClientException

异步改变消息的不可见时间

Parameters:

receiptHandle - 待改变消息的句柄

visibilityTimeout - 新的消息不可见时间，单位是秒

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

changeMessageVisibility

public Message changeMessageVisibility(String receiptHandle,
                                       int visibilityTimeout)
                                throws ServiceException,
                                       ClientException

改变消息的不可见时间

Parameters:

receiptHandle - 消息句柄

visibilityTimeout - 消息不可见时间，单位是秒

Returns:

新的消息，保含消息句柄和下次可见时间

Throws:

ServiceException - exception

ClientException - exception

asyncChangeMessageVisibility

public AsyncResult<Message> asyncChangeMessageVisibility(String receiptHandle,
                                                         int visibilityTimeout,
                                                         AsyncCallback<Message> callback)
                                                  throws ClientException

异步改变消息的不可见时间

Parameters:

receiptHandle - 待改变消息的句柄

visibilityTimeout - 新的消息不可见时间，单位是秒

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

popMessage

public Message popMessage()
                   throws ServiceException,
                          ClientException

获取队列中的消息, 在队列中没有消息的时候返回null

Returns:

返回队列中的一个消息

Throws:

ServiceException - exception

ClientException - exception

popMessage

public Message popMessage(int waitSeconds)
                   throws ServiceException,
                          ClientException

获取队列中的消息, 队列中没有消息的时候返回null

Parameters:

waitSeconds - 长轮询等待时间，单位是秒

Returns:

队列中的一个消息

Throws:

ServiceException - exception

ClientException - exception

asyncPopMessage

public AsyncResult<Message> asyncPopMessage(AsyncCallback<Message> callback)
                                     throws ClientException

异步获取队列中的消息

Parameters:

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

asyncPopMessage

public AsyncResult<Message> asyncPopMessage(int waitSeconds,
                                            AsyncCallback<Message> callback)
                                     throws ClientException

异步获取队列中的消息

Parameters:

waitSeconds - 长轮询等待时间，单位是秒

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

batchPopMessage

public List<Message> batchPopMessage(int batchSize)
                              throws ServiceException,
                                     ClientException

批量获取队列中的消息, 队列中没有消息的时候返回null

Parameters:

batchSize - 本次最多获取消息的条数

Returns:

消息列表

Throws:

ServiceException - exception

ClientException - exception

batchPopMessage

public List<Message> batchPopMessage(int batchSize,
                                     int waitSeconds)
                              throws ServiceException,
                                     ClientException

批量获取队列中的消息, 队列中没有消息的时候返回null

Parameters:

batchSize - 本次最多获取消息的条数

waitSeconds - 长轮询等待时间，单位是秒

Returns:

消息列表

Throws:

ServiceException - exception

ClientException - exception

asyncBatchPopMessage

public AsyncResult<List<Message>> asyncBatchPopMessage(int batchSize,
                                                       AsyncCallback<List<Message>> callback)
                                                throws ClientException

异步批量获取队列中的消息

Parameters:

batchSize - batch size

callback - callback

Returns:

异步结果调用句柄

Throws:

ClientException - exception

asyncBatchPopMessage

public AsyncResult<List<Message>> asyncBatchPopMessage(int batchSize,
                                                       int waitSeconds,
                                                       AsyncCallback<List<Message>> callback)
                                                throws ClientException

异步批量获取队列中的消息

Parameters:

batchSize - size

waitSeconds - 长轮询等待时间，单位是秒

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

deleteMessage

public void deleteMessage(String receiptHandle)
                   throws ServiceException,
                          ClientException

删除消息

Parameters:

receiptHandle - 消息句柄

Throws:

ServiceException - exception

ClientException - exception

asyncDeleteMessage

public AsyncResult<Void> asyncDeleteMessage(String receiptHandle,
                                            AsyncCallback<Void> callback)
                                     throws ClientException

异步删除消息

Parameters:

receiptHandle - 消息句柄

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

batchDeleteMessage

public void batchDeleteMessage(List<String> receiptHandles)
                        throws ServiceException,
                               ClientException

批量删除消息

Parameters:

receiptHandles - 消息句柄列表

Throws:

ServiceException - exception

ClientException - exception

asyncBatchDeleteMessage

public AsyncResult<Void> asyncBatchDeleteMessage(List<String> receiptHandles,
                                                 AsyncCallback<Void> callback)
                                          throws ClientException

Parameters:

receiptHandles - 消息句柄列表

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

putMessage

public Message putMessage(Message message)
                   throws ServiceException,
                          ClientException

发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

Parameters:

message - 待发送的消息

Returns:

发送成功的消息

Throws:

ServiceException - exception

ClientException - exception

asyncPutMessage

public AsyncResult<Message> asyncPutMessage(Message message,
                                            AsyncCallback<Message> callback)
                                     throws ClientException

异步发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

Parameters:

message - 待发送的消息

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

batchPutMessage

public List<Message> batchPutMessage(List<Message> messages)
                              throws ServiceException,
                                     ClientException

批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

Parameters:

messages - 待发送的消息

Returns:

发送成功的消息

Throws:

ServiceException - exception

ClientException - exception

asyncBatchPutMessage

public AsyncResult<List<Message>> asyncBatchPutMessage(List<Message> messages,
                                                       AsyncCallback<List<Message>> callback)
                                                throws ClientException

异步批量发送消息, 消息体在发送到服务端前，我们会对消息体进行一次base64编码，如果你使用本SDK发送， 但用其他方式接收时，需要确认，接收方有无对消息体进行base64解码。

Parameters:

messages - 待发送的消息

callback - 异步回调对象

Returns:

异步结果调用句柄

Throws:

ClientException - exception

getQueueURL

public String getQueueURL()

isMessageNotExist

public boolean isMessageNotExist(ServiceException e)

isQueueExist

public boolean isQueueExist()
                     throws ServiceException,
                            ClientException

Check if queue is exist already.

Returns:

true means queue exists, false means queue does not exist.

Throws:

ServiceException - ClientException

ClientException