org.noear.water.dso

Class MessageApi

java.lang.Object

org.noear.water.dso.MessageApi

public class MessageApi
extends Object

消息服务接口

Since:

2.0

Author:

noear

Field Summary

Fields

Modifier and Type	Field and Description
protected org.noear.water.dso.ApiCaller	apiCaller

Constructor Summary

Constructors

Constructor and Description
MessageApi()

Method Summary

Modifier and Type	Method and Description
boolean	cancelMessage(String broker, String msg_key) 取消消息
boolean	cancelMessage(String broker, String msg_key, String subscriber_key) 取消XXX订阅者的消息
boolean	checkMessage(MessageM msg, String receive_key) 检测消息签名
String	receiveMessage(Fun1<String,String> paramS, String service_secretKey, MessageHandler consumer)
boolean	sendMessage(String broker, String topic, String message) 发送消息
boolean	sendMessage(String broker, String msg_key, String topic, String message) 发送消息
boolean	sendMessage(String broker, String msg_key, String topic, String message, Date planTime) 发送消息
boolean	sendMessageAndTags(String broker, String topic, String message, String tags)
boolean	sendMessageAndTags(String broker, String msg_key, String topic, String message, Date planTime, String tags) 发送消息
boolean	sendMessageAndTags(String broker, String msg_key, String topic, String message, String tags)
boolean	sendMessageAndTagsCallback(String broker, String msg_key, String message, Date planTime, String receiver_url, String receiver_cehck, String tags) 发送消息回调
boolean	sendMessageAndTagsCallback(String broker, String message, String receiver_url, String receiver_cehck, String tags)
boolean	sendMessageCallback(String broker, String msg_key, String message, Date planTime, String receiver_url, String receiver_cehck)
boolean	sendMessageCallback(String broker, String message, String receiver_url, String receiver_cehck) 发送消息回调
boolean	subscribeTopic(String broker, String subscriber_key, String subscriber_name, String subscriber_tag, String receive_url, String receive_key, String alarm_mobile, int receive_way, boolean is_unstable, String[] topics) 订阅
boolean	succeedMessage(String broker, String msg_key) 完成消息（设为成功）
boolean	succeedMessage(String broker, String msg_key, String subscriber_key) 完成XXX订阅者的消息
boolean	unSubscribeTopic(String broker, String subscriber_key, String[] topics) 取消麻阅

Methods inherited from class java.lang.Object

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

Field Detail

apiCaller

protected final org.noear.water.dso.ApiCaller apiCaller

Constructor Detail

MessageApi

public MessageApi()

Method Detail

subscribeTopic

public boolean subscribeTopic(String broker,
                              String subscriber_key,
                              String subscriber_name,
                              String subscriber_tag,
                              String receive_url,
                              String receive_key,
                              String alarm_mobile,
                              int receive_way,
                              boolean is_unstable,
                              String[] topics)
                       throws Exception

订阅

Parameters:

subscriber_key - 订阅者key

subscriber_name - 订阅者name

subscriber_tag - 订阅者tag

receive_url - 接收地址

receive_way - 接收方式 (0:http异步等待, 1:http同步等待, 2:http异步不等待)

receive_key - 接收密钥

alarm_mobile - 报警手机号

topics - 主题（多个）

Throws:

Exception

unSubscribeTopic

public boolean unSubscribeTopic(String broker,
                                String subscriber_key,
                                String[] topics)
                         throws Exception

取消麻阅

Parameters:

subscriber_key - 订阅者标识

topics - 主题（多个）

Throws:

Exception

sendMessage

public boolean sendMessage(String broker,
                           String topic,
                           String message)
                    throws Exception

发送消息

Parameters:

topic - 消息主题

message - 消息内容

Throws:

Exception

sendMessage

public boolean sendMessage(String broker,
                           String msg_key,
                           String topic,
                           String message)
                    throws Exception

发送消息

Parameters:

msg_key - 消息key（用于建立本地关键）

topic - 消息主题

message - 消息内容

Throws:

Exception

sendMessage

public boolean sendMessage(String broker,
                           String msg_key,
                           String topic,
                           String message,
                           Date planTime)
                    throws Exception

发送消息

Parameters:

msg_key - 消息标识（用于建立本地关键）

topic - 主题

message - 消息内容

planTime - 计划通知时间

Throws:

Exception

sendMessageAndTags

public boolean sendMessageAndTags(String broker,
                                  String topic,
                                  String message,
                                  String tags)
                           throws Exception

Throws:

Exception

sendMessageAndTags

public boolean sendMessageAndTags(String broker,
                                  String msg_key,
                                  String topic,
                                  String message,
                                  String tags)
                           throws Exception

Throws:

Exception

sendMessageAndTags

public boolean sendMessageAndTags(String broker,
                                  String msg_key,
                                  String topic,
                                  String message,
                                  Date planTime,
                                  String tags)
                           throws Exception

发送消息

Parameters:

msg_key - 消息标识（用于建立本地关键）

tags - 标签

topic - 主题

message - 消息内容

planTime - 计划通知时间

Throws:

Exception

sendMessageCallback

public boolean sendMessageCallback(String broker,
                                   String message,
                                   String receiver_url,
                                   String receiver_cehck)
                            throws Exception

发送消息回调

Throws:

Exception

sendMessageCallback

public boolean sendMessageCallback(String broker,
                                   String msg_key,
                                   String message,
                                   Date planTime,
                                   String receiver_url,
                                   String receiver_cehck)
                            throws Exception

Throws:

Exception

sendMessageAndTagsCallback

public boolean sendMessageAndTagsCallback(String broker,
                                          String message,
                                          String receiver_url,
                                          String receiver_cehck,
                                          String tags)
                                   throws Exception

Throws:

Exception

sendMessageAndTagsCallback

public boolean sendMessageAndTagsCallback(String broker,
                                          String msg_key,
                                          String message,
                                          Date planTime,
                                          String receiver_url,
                                          String receiver_cehck,
                                          String tags)
                                   throws Exception

发送消息回调

Parameters:

msg_key - 消息标识

tags - 标签

message - 消息

receiver_url - 接收地址

receiver_cehck - 接收检测

planTime - 计划发送时间

Throws:

Exception

cancelMessage

public boolean cancelMessage(String broker,
                             String msg_key)
                      throws Exception

取消消息

Throws:

Exception

cancelMessage

public boolean cancelMessage(String broker,
                             String msg_key,
                             String subscriber_key)
                      throws Exception

取消XXX订阅者的消息

Throws:

Exception

succeedMessage

public boolean succeedMessage(String broker,
                              String msg_key)
                       throws Exception

完成消息（设为成功）

Throws:

Exception

succeedMessage

public boolean succeedMessage(String broker,
                              String msg_key,
                              String subscriber_key)
                       throws Exception

完成XXX订阅者的消息

Throws:

Exception

checkMessage

public boolean checkMessage(MessageM msg,
                            String receive_key)

检测消息签名

receiveMessage

public String receiveMessage(Fun1<String,String> paramS,
                             String service_secretKey,
                             MessageHandler consumer)
                      throws Throwable

Throws:

Throwable