org.noear.water.dso

类 MessageApi

java.lang.Object

org.noear.water.dso.MessageApi

public class MessageApi
extends Object

消息服务接口

从以下版本开始:

2.0

作者:

noear

字段概要

字段

限定符和类型	字段和说明
protected org.noear.water.dso.ApiCaller	apiCaller

构造器概要

构造器

构造器和说明
MessageApi()

方法概要

限定符和类型	方法和说明
boolean	cancelMessage(String msg_key) 取消消息
boolean	cancelMessage(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 topic, String message) 发送消息
boolean	sendMessage(String msg_key, String topic, String message) 发送消息
boolean	sendMessage(String msg_key, String topic, String message, Date planTime) 发送消息
boolean	sendMessageAndTags(String topic, String message, String tags)
boolean	sendMessageAndTags(String msg_key, String topic, String message, Date planTime, String tags) 发送消息
boolean	sendMessageAndTags(String msg_key, String topic, String message, String tags)
boolean	sendMessageAndTagsCallback(String msg_key, String message, Date planTime, String receiver_url, String receiver_cehck, String tags) 发送消息回调
boolean	sendMessageAndTagsCallback(String message, String receiver_url, String receiver_cehck, String tags)
boolean	sendMessageCallback(String msg_key, String message, Date planTime, String receiver_url, String receiver_cehck)
boolean	sendMessageCallback(String message, String receiver_url, String receiver_cehck) 发送消息回调
boolean	subscribeTopic(String subscriber_key, String receive_url, String receive_key, String alarm_mobile, int receive_way, boolean is_unstable, String... topics) 订阅
boolean	subscribeTopic(String subscriber_key, String subscriber_note, String receive_url, String receive_key, String alarm_mobile, int receive_way, boolean is_unstable, String... topics) 订阅
boolean	succeedMessage(String msg_key) 完成消息（设为成功）
boolean	succeedMessage(String msg_key, String subscriber_key) 完成XXX订阅者的消息
boolean	unSubscribeTopic(String subscriber_key, String... topics) 取消麻阅

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

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

字段详细资料

apiCaller

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

构造器详细资料

MessageApi

public MessageApi()

方法详细资料

subscribeTopic

public boolean subscribeTopic(String subscriber_key,
                              String receive_url,
                              String receive_key,
                              String alarm_mobile,
                              int receive_way,
                              boolean is_unstable,
                              String... topics)
                       throws Exception

订阅

参数:

subscriber_key - 订阅者key

receive_url - 接收地址

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

receive_key - 接收密钥，签名用

抛出:

Exception

subscribeTopic

public boolean subscribeTopic(String subscriber_key,
                              String subscriber_note,
                              String receive_url,
                              String receive_key,
                              String alarm_mobile,
                              int receive_way,
                              boolean is_unstable,
                              String... topics)
                       throws Exception

订阅

参数:

subscriber_key - 订阅者key

subscriber_note - 订阅者简介

receive_url - 接收地址

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

receive_key - 接收密钥

alarm_mobile - 报警手机号

topics - 主题..

抛出:

Exception

unSubscribeTopic

public boolean unSubscribeTopic(String subscriber_key,
                                String... topics)
                         throws Exception

取消麻阅

参数:

subscriber_key - 订阅者标识

topics - 主题..

抛出:

Exception

sendMessage

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

发送消息

参数:

topic - 消息主题

message - 消息内容

抛出:

Exception

sendMessage

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

发送消息

参数:

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

topic - 消息主题

message - 消息内容

抛出:

Exception

sendMessage

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

发送消息

参数:

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

topic - 主题

message - 消息内容

planTime - 计划通知时间

抛出:

Exception

sendMessageAndTags

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

抛出:

Exception

sendMessageAndTags

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

抛出:

Exception

sendMessageAndTags

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

发送消息

参数:

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

tags - 标签

topic - 主题

message - 消息内容

planTime - 计划通知时间

抛出:

Exception

sendMessageCallback

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

发送消息回调

抛出:

Exception

sendMessageCallback

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

抛出:

Exception

sendMessageAndTagsCallback

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

抛出:

Exception

sendMessageAndTagsCallback

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

发送消息回调

参数:

msg_key - 消息标识

tags - 标签

message - 消息

receiver_url - 接收地址

receiver_cehck - 接收检测

planTime - 计划发送时间

抛出:

Exception

cancelMessage

public boolean cancelMessage(String msg_key)
                      throws Exception

取消消息

抛出:

Exception

cancelMessage

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

取消XXX订阅者的消息

抛出:

Exception

succeedMessage

public boolean succeedMessage(String msg_key)
                       throws Exception

完成消息（设为成功）

抛出:

Exception

succeedMessage

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

完成XXX订阅者的消息

抛出:

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

抛出:

Throwable