com.aliyun.mns.client

类 CloudTopic

java.lang.Object

com.aliyun.mns.client.CloudTopic

public class CloudTopic
extends Object

字段概要

字段

限定符和类型	字段和说明
static org.apache.log4j.Logger	logger log4j object

构造器概要

构造器

限定符	构造器和说明
protected	CloudTopic(String topicName, ServiceClient client, ServiceCredentials credentials, URI endpoint)

方法概要

方法

限定符和类型	方法和说明
AsyncResult<Void>	asyncDelete(AsyncCallback<Void> callback) async delete topic
AsyncResult<TopicMeta>	asyncGetAttribute(AsyncCallback<TopicMeta> callback) async get topic attribute
AsyncResult<SubscriptionMeta>	asyncGetSubscriptionAttr(String subscriptionName, AsyncCallback<SubscriptionMeta> callback) async get subscription attribute
AsyncResult<TopicMessage>	asyncPublishMessage(TopicMessage msg, AsyncCallback<TopicMessage> callback) async publish message, we will do base64 encode for message body before publish it to MNS server.
AsyncResult<Void>	asyncSetAttribute(TopicMeta meta, AsyncCallback<Void> callback) async set topic attribute with given meta and callback object
AsyncResult<Void>	asyncSetSubscriptionAttr(SubscriptionMeta meta, AsyncCallback<Void> callback) async set subscription attribute
AsyncResult<String>	asyncSubscribe(SubscriptionMeta meta, AsyncCallback<String> callback) async subscribe this topic
AsyncResult<Void>	asyncUnsubscribe(String subscriptionName, AsyncCallback<Void> callback) async unsubscribe
String	create() create topic with default topic meta
String	create(TopicMeta meta) create topic with special topic meta
void	delete() delete topic
String	generateBatchSmsEndpoint() generate batch sms endpoint for subscription
String	generateDayuEndpoint(String phone) generate mail endpoint for subscription
String	generateMailEndpoint(String mailAddress) generate mail endpoint for subscription
String	generateQueueEndpoint(String queueName) generate queue endpoint for subscription
String	generateQueueEndpoint(String queueName, String region)
String	generateSmsEndpoint()
String	generateSmsEndpoint(String phone) generate sms endpoint for subscription
TopicMeta	getAttribute() get topic attribute
SubscriptionMeta	getSubscriptionAttr(String subscriptionName) get subscription attribute
String	getTopicURL() get topic url
PagingListResult<SubscriptionMeta>	listSubscriptions(String prefix, String marker, Integer retNumber) list topic subscription
PagingListResult<String>	listSubscriptionUrls(String prefix, String marker, Integer retNumber) list topic subscription
TopicMessage	publishMessage(RawTopicMessage msg, MessageAttributes messageAttributes) publish raw message to topic
TopicMessage	publishMessage(TopicMessage msg) publish message to topic
void	setAttribute(TopicMeta meta) set tpoic attribute with given meta
void	setSubscriptionAttr(SubscriptionMeta meta) set subscription attribute
String	subscribe(SubscriptionMeta meta) subscribe this topic
void	unsubscribe(String subscriptionName) unsubscribe this topic

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

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

字段详细资料

logger

public static org.apache.log4j.Logger logger

log4j object

构造器详细资料

CloudTopic

protected CloudTopic(String topicName,
          ServiceClient client,
          ServiceCredentials credentials,
          URI endpoint)

参数:

topicName, - topic name

client, - ServiceClient object

credentials, - ServiceCredentials object

endpoint, - user mns endpoint, ie: http://uid.mns.region.aliyuncs.com/

方法详细资料

getTopicURL

public String getTopicURL()

get topic url

返回:

topic url

create

public String create()

create topic with default topic meta

返回:

topic url

create

public String create(TopicMeta meta)

create topic with special topic meta

参数:

meta, - topic meta data

返回:

topic url

asyncSetAttribute

public AsyncResult<Void> asyncSetAttribute(TopicMeta meta,
                                  AsyncCallback<Void> callback)

async set topic attribute with given meta and callback object

参数:

meta, - tpoic meta data

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

getAttribute

public TopicMeta getAttribute()

get topic attribute

返回:

topic meta data

setAttribute

public void setAttribute(TopicMeta meta)

set tpoic attribute with given meta

参数:

meta, - topic meta data

asyncGetAttribute

public AsyncResult<TopicMeta> asyncGetAttribute(AsyncCallback<TopicMeta> callback)

async get topic attribute

参数:

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

delete

public void delete()

delete topic

asyncDelete

public AsyncResult<Void> asyncDelete(AsyncCallback<Void> callback)

async delete topic

参数:

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

subscribe

public String subscribe(SubscriptionMeta meta)

subscribe this topic

参数:

meta, - SubscriptionMeta data

asyncSubscribe

public AsyncResult<String> asyncSubscribe(SubscriptionMeta meta,
                                 AsyncCallback<String> callback)

async subscribe this topic

参数:

meta, - SubscriptionMeta data

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

setSubscriptionAttr

public void setSubscriptionAttr(SubscriptionMeta meta)

set subscription attribute

参数:

meta, - SubscriptionMeta data

asyncSetSubscriptionAttr

public AsyncResult<Void> asyncSetSubscriptionAttr(SubscriptionMeta meta,
                                         AsyncCallback<Void> callback)

async set subscription attribute

参数:

meta, - SubscriptionMeta data

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

getSubscriptionAttr

public SubscriptionMeta getSubscriptionAttr(String subscriptionName)

get subscription attribute

参数:

subscriptionName, - subscription name

返回:

SubscriptionMeta data

asyncGetSubscriptionAttr

public AsyncResult<SubscriptionMeta> asyncGetSubscriptionAttr(String subscriptionName,
                                                     AsyncCallback<SubscriptionMeta> callback)

async get subscription attribute

参数:

subscriptionName, - subscription name

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

unsubscribe

public void unsubscribe(String subscriptionName)

unsubscribe this topic

参数:

subscriptionName, - subscription name

asyncUnsubscribe

public AsyncResult<Void> asyncUnsubscribe(String subscriptionName,
                                 AsyncCallback<Void> callback)

async unsubscribe

参数:

subscriptionName, - subscription name

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this

listSubscriptions

public PagingListResult<SubscriptionMeta> listSubscriptions(String prefix,
                                                   String marker,
                                                   Integer retNumber)

list topic subscription

参数:

prefix, - subscription name prefis

marker, - subscription start marker

retNumber, - return number

返回:

SubscriptionMeta list

listSubscriptionUrls

public PagingListResult<String> listSubscriptionUrls(String prefix,
                                            String marker,
                                            Integer retNumber)

list topic subscription

参数:

prefix, - subscription name prefis

marker, - subscription start marker

retNumber, - return number

返回:

subscription url list

generateQueueEndpoint

public String generateQueueEndpoint(String queueName)

generate queue endpoint for subscription

generateQueueEndpoint

public String generateQueueEndpoint(String queueName,
                           String region)

generateMailEndpoint

public String generateMailEndpoint(String mailAddress)

generate mail endpoint for subscription

generateDayuEndpoint

public String generateDayuEndpoint(String phone)

generate mail endpoint for subscription

generateSmsEndpoint

public String generateSmsEndpoint(String phone)

generate sms endpoint for subscription

generateSmsEndpoint

public String generateSmsEndpoint()

generateBatchSmsEndpoint

public String generateBatchSmsEndpoint()

generate batch sms endpoint for subscription

publishMessage

public TopicMessage publishMessage(TopicMessage msg)

publish message to topic

参数:

msg, - message，这里可以使用RawTopicMessage跟Base64TopicMessage作为向服务发消息的结构。 Base64TopicMessage会将消息体进行base64编码。 RawTopicMessage发送的数据是明文可读的串，我们不做任何改动。 如果你是用Base64TopicMessage发送消息的，那么在endpoint端收到消息时， 需要额外做一次base64解码，才能跟你发送的消息相匹配。 如果接收端包含了邮箱,请使用publishMessage(RawTopicMessage, MessageAttributes)

返回:

message

publishMessage

public TopicMessage publishMessage(RawTopicMessage msg,
                          MessageAttributes messageAttributes)

publish raw message to topic

参数:

msg, - RawTopicMessage发送的数据是明文可读的串，我们不做任何改动。 如果接收端是邮箱,那么这里的msg就是邮件正文.

messageAttributes - 如果希望被推送到邮箱,那么attributes需要包含发送邮件所必须的几个属性

返回:

message

asyncPublishMessage

public AsyncResult<TopicMessage> asyncPublishMessage(TopicMessage msg,
                                            AsyncCallback<TopicMessage> callback)

async publish message, we will do base64 encode for message body before publish it to MNS server. so, when you receive this message, you should do base64 decode before use it.

参数:

msg, - message，这里可以使用RawTopicMessage跟Base64TopicMessage作为向服务发消息的结构。 但我们推荐使用Base64TopicMessage，它会将消息体进行base64编码后再发送数据。 RawTopicMessage发送的数据是明文可读的串，我们不做任何改动。 如果你是用Base64TopicMessage发送消息的，那么在endpoint端收到的消息， 需要额外做一次base64解码，才能跟你发送的消息相匹配。

callback, - user callback object

返回:

AsyncResult, you can wait result by AsyncResult if you want to do this