org.opoo.ootp.client

接口 ExsClient

public interface ExsClient

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_LIMIT 默认上限。

方法概要

限定符和类型	方法和说明
void	ack(java.util.List<java.lang.String> ids) 确认消息。
default void	ack(java.lang.String... ids) 确认消息。
default java.lang.String	getMessageBody(java.lang.String id) 获取消息体。
ExsMessageContent	getMessageContent(java.lang.String id) 获取消息体。
default java.util.List<ExsMessage>	poll() 使用默认参数轮询消息。
java.util.List<ExsMessage>	poll(int limit, boolean autoAck, boolean full) 轮询消息。
void	send(java.lang.String type, java.lang.String to, java.lang.String contentType, byte[] body) 发送消息。
void	send(java.lang.String type, java.lang.String to, java.lang.String contentType, java.lang.String body) 发送消息。

字段详细资料

DEFAULT_LIMIT

static final int DEFAULT_LIMIT

默认上限。

另请参阅:

常量字段值

方法详细资料

send

void send(java.lang.String type,
          java.lang.String to,
          java.lang.String contentType,
          java.lang.String body)
   throws OotpException

发送消息。

参数:

type - 消息业务类型，用于消息处理方进行标识

to - 接收方

contentType - 消息内容类型

body - 消息体正文

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

send

void send(java.lang.String type,
          java.lang.String to,
          java.lang.String contentType,
          byte[] body)
   throws OotpException

发送消息。

参数:

type - 消息业务类型，用于消息处理方进行标识

to - 接收方

contentType - 消息内容类型

body - 消息体正文

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

poll

java.util.List<ExsMessage> poll(int limit,
                                boolean autoAck,
                                boolean full)
                         throws OotpException

轮询消息。

参数:

limit - 每次轮询最大记录数，默认 100

autoAck - 是否自动进行消息确认，即轮询时就发送消息回执，默认 false

full - 是否返回完整的消息记录，默认 false

返回:

消息集合，可能为空，不为 null

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

poll

default java.util.List<ExsMessage> poll()
                                 throws OotpException

使用默认参数轮询消息。

返回:

消息集合，可能为空，不为 null

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

getMessageBody

default java.lang.String getMessageBody(java.lang.String id)
                                 throws OotpException

获取消息体。

参数:

id - 消息ID

返回:

消息体，仅含消息正文

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

getMessageContent

ExsMessageContent getMessageContent(java.lang.String id)
                             throws OotpException

获取消息体。

参数:

id - 消息ID

返回:

消息体，含消息的 ContentType 信息

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

ack

default void ack(java.lang.String... ids)
          throws OotpException

确认消息。

参数:

ids - 要确认的消息数组，不能为空

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息

ack

void ack(java.util.List<java.lang.String> ids)
  throws OotpException

确认消息。

参数:

ids - 要确认的消息集合，不能为空

抛出:

OotpException - 通常是 Http 请求异常，或者服务器返回错误消息