程序包 org.opoo.ootp.client

接口 MessageClient

所有已知实现类:

AbstractMessageClient, SmartMessageClient, V1MessageClientImpl, V2MessageClientImpl

public interface MessageClient

字段概要

字段

修饰符和类型	字段	说明
static final int	DEFAULT_BUFFER_SIZE
static final int	DEFAULT_LIMIT	默认上限。

方法概要

修饰符和类型	方法	说明
default int	ack(String... ids)	确认消息。
int	ack(List<String> ids)	确认消息。
ExsMessage	getMessage(String id)	获取消息。
default String	getMessageBody(String id)	获取消息体。
ExsMessageInfo	getMessageInfo(String id)	获取已经发送的消息的信息，如消息的状态，是否被对方消费等。
default PollResult	poll()	使用默认参数轮询消息。
default PollResult	poll(int limit, boolean autoAck, boolean full)	轮询消息。
PollResult	poll(PollRequest request)	轮询消息。
default int	ret(String... ids)	退回消息，使消息可以重新消费。
default int	ret(List<String> ids)	退回消息，使消息可以重新消费。
int	ret(List<String> ids, Consumer<Object> requestConfigurer)	退回消息，使消息可以重新消费。
default String	send(String type, String to, String contentType, byte[] body)	已过时。 由于机构外联仅接收文本消息，因此建议直接使用 send(String, String, String, String) 方法
default String	send(String type, String to, String contentType, String body)	发送消息。
default String	send(String body, ExsMetadata metadata)	发送消息。
default String	send(ExsBody body, ExsMetadata metadata)	发送消息。
String	send(ExsMessage message)	发送消息。

字段详细资料

DEFAULT_LIMIT

static final int DEFAULT_LIMIT

默认上限。

另请参阅:

• 常量字段值

DEFAULT_BUFFER_SIZE

static final int DEFAULT_BUFFER_SIZE

另请参阅:

• 常量字段值

方法详细资料

send

String send(ExsMessage message)
     throws OotpException

发送消息。

参数:

message - 消息

返回:

机构外联返回的消息ID

抛出:

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

send

default String send(ExsBody body,
 ExsMetadata metadata)
             throws OotpException

发送消息。

参数:

body - 消息体

metadata - 消息元数据

返回:

机构外联返回的消息ID

抛出:

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

send

default String send(String body,
 ExsMetadata metadata)
             throws OotpException

发送消息。

参数:

body - 消息体

metadata - 消息元数据

返回:

机构外联返回的消息ID

抛出:

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

send

default String send(String type,
 String to,
 String contentType,
 String body)
             throws OotpException

发送消息。

参数:

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

to - 接收方

contentType - 消息内容类型

body - 消息体正文

返回:

服务端返回的消息ID

抛出:

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

send

@Deprecated
default String send(String type,
 String to,
 String contentType,
 byte[] body)
             throws OotpException

已过时。

由于机构外联仅接收文本消息，因此建议直接使用 send(String, String, String, String) 方法

发送消息。

参数:

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

to - 接收方

contentType - 消息内容类型

body - 消息体正文

返回:

服务端返回的消息ID

抛出:

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

另请参阅:

• send(String, ExsMetadata)
• send(String, String, String, String)

poll

PollResult poll(PollRequest request)
         throws OotpException

轮询消息。

参数:

request - 轮询请求。

返回:

轮询结果

抛出:

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

poll

default PollResult poll(int limit,
 boolean autoAck,
 boolean full)
                 throws OotpException

轮询消息。

参数:

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

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

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

返回:

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

抛出:

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

poll

default PollResult poll()
                 throws OotpException

使用默认参数轮询消息。

返回:

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

抛出:

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

getMessageBody

default String getMessageBody(String id)
                       throws OotpException

获取消息体。默认使用 UTF-8 编码。

参数:

id - 消息ID

返回:

消息体，仅含消息正文

抛出:

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

getMessage

ExsMessage getMessage(String id)
               throws OotpException

获取消息。

参数:

id - 消息ID

返回:

整体消息对象

抛出:

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

从以下版本开始:

1.1.0

getMessageInfo

ExsMessageInfo getMessageInfo(String id)
                       throws OotpException

获取已经发送的消息的信息，如消息的状态，是否被对方消费等。

参数:

id - 消息ID

返回:

消息的信息

抛出:

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

从以下版本开始:

1.1.0

ack

default int ack(String... ids)
         throws OotpException

确认消息。

参数:

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

返回:

实际确认的消息数量

抛出:

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

ack

int ack(List<String> ids)
 throws OotpException

确认消息。

参数:

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

返回:

实际确认的消息数量

抛出:

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

ret

default int ret(String... ids)
         throws OotpException

退回消息，使消息可以重新消费。已确认超过3天的消息不能退回。

参数:

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

返回:

实际退回的消息数量

抛出:

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

从以下版本开始:

1.1.0

ret

default int ret(List<String> ids)
         throws OotpException

退回消息，使消息可以重新消费。已确认超过3天的消息不能退回。

参数:

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

返回:

实际退回的消息数量

抛出:

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

从以下版本开始:

1.1.0

ret

int ret(List<String> ids,
 Consumer<Object> requestConfigurer)
 throws OotpException

退回消息，使消息可以重新消费。已确认超过3天的消息不能退回。

参数:

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

requestConfigurer - 对请求的对象（报文）进行高级配置

返回:

实际退回的消息数量

抛出:

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

从以下版本开始:

1.3.0