com.aliyun.openservices.ons.api.bean

Class OrderConsumerBean

java.lang.Object

com.aliyun.openservices.ons.api.bean.OrderConsumerBean

All Implemented Interfaces:

Admin, OrderConsumer

public class OrderConsumerBean
extends Object
implements OrderConsumer

OrderConsumerBean用于将OrderConsumer集成至Spring Bean中

Constructor Summary

Constructors

Constructor and Description
OrderConsumerBean()

Method Summary

Methods

Modifier and Type	Method and Description
Properties	getProperties()
Map<Subscription,MessageOrderListener>	getSubscriptionTable()
boolean	isClosed() 检查服务是否已经关闭
boolean	isStarted() 检查服务是否已经启动.
void	setProperties(Properties properties)
void	setSubscriptionTable(Map<Subscription,MessageOrderListener> subscriptionTable)
void	shutdown() 关闭该OrderConsumer实例，建议配置为Bean的destroy-method
void	start() 启动该OrderConsumer实例，建议配置为Bean的init-method
void	subscribe(String topic, MessageSelector selector, MessageOrderListener listener) 订阅消息，可以使用SQL表达式对消息进行过滤，请注意，SQL表达式过滤只针对MQ铂金版用户，公网服务暂时不支持。
void	subscribe(String topic, String subExpression, MessageOrderListener listener) 订阅消息
void	updateCredential(Properties credentialProperties) 更新凭据 (AccessKey/SecretKey/SecurityToken/ONSChannel) 动态更新访问凭据

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderConsumerBean

public OrderConsumerBean()

Method Detail

isStarted

public boolean isStarted()

Description copied from interface: Admin

检查服务是否已经启动.

Specified by:

isStarted in interface Admin

Returns:

true如果服务已启动; 其它情况返回false

See Also:

Admin.isClosed()

isClosed

public boolean isClosed()

Description copied from interface: Admin

检查服务是否已经关闭

Specified by:

isClosed in interface Admin

Returns:

true如果服务已关闭; 其它情况返回false

See Also:

Admin.isStarted()

start

public void start()

启动该OrderConsumer实例，建议配置为Bean的init-method

Specified by:

start in interface Admin

Specified by:

start in interface OrderConsumer

updateCredential

public void updateCredential(Properties credentialProperties)

Description copied from interface: Admin

更新凭据 (AccessKey/SecretKey/SecurityToken/ONSChannel) 动态更新访问凭据

Specified by:

updateCredential in interface Admin

Parameters:

credentialProperties - STSToken相关的信息

shutdown

public void shutdown()

关闭该OrderConsumer实例，建议配置为Bean的destroy-method

Specified by:

shutdown in interface Admin

Specified by:

shutdown in interface OrderConsumer

subscribe

public void subscribe(String topic,
             String subExpression,
             MessageOrderListener listener)

Description copied from interface: OrderConsumer

订阅消息

Specified by:

subscribe in interface OrderConsumer

Parameters:

topic - 消息主题

subExpression - 订阅过滤表达式字符串，broker依据此表达式进行过滤。目前只支持或运算
eg: "tag1 || tag2 || tag3"
如果subExpression等于null或者*，则表示全部订阅

listener - 消息回调监听器，客户端接收到消息后传给消息回调监听器进行消费

subscribe

public void subscribe(String topic,
             MessageSelector selector,
             MessageOrderListener listener)

Description copied from interface: OrderConsumer

订阅消息，可以使用SQL表达式对消息进行过滤，请注意，SQL表达式过滤只针对MQ铂金版用户，公网服务暂时不支持。

Specified by:

subscribe in interface OrderConsumer

Parameters:

topic - 消息主题

selector - 订阅消息选择器（可空，表示不做过滤），ONS服务器依据此选择器中的表达式进行过滤。 目前支持两种表达式语法：ExpressionType.TAG, ExpressionType.SQL92 其中，TAG过滤的效果和上面的接口一致

listener - 消息回调监听器

getProperties

public Properties getProperties()

setProperties

public void setProperties(Properties properties)

getSubscriptionTable

public Map<Subscription,MessageOrderListener> getSubscriptionTable()

setSubscriptionTable

public void setSubscriptionTable(Map<Subscription,MessageOrderListener> subscriptionTable)