org.opoo.ootp.client

类 SmartMessageClient

java.lang.Object

org.opoo.ootp.client.SmartMessageClient

所有已实现的接口:

MessageClient

public class SmartMessageClient
extends java.lang.Object
implements MessageClient

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	META_FILE_REF

从接口继承的字段 org.opoo.ootp.client.MessageClient

DEFAULT_BUFFER_SIZE, DEFAULT_LIMIT

构造器概要

构造器

构造器和说明
SmartMessageClient(MessageClient messageClient, FileClient fileClient)
SmartMessageClient(OotpClient ootpClient)

方法概要

限定符和类型	方法和说明
int	ack(java.util.List<java.lang.String> ids) 确认消息。
ExsMessage	getMessage(java.lang.String id) 获取消息。
ExsMessageInfo	getMessageInfo(java.lang.String id) 获取已经发送的消息的信息，如消息的状态，是否被对方消费等。
PollResult	poll(PollRequest request) 轮询消息。
int	ret(java.util.List<java.lang.String> ids) 退回消息，使消息可以重新消费。
int	ret(java.util.List<java.lang.String> ids, java.util.function.Consumer<java.lang.Object> requestConfigurer) 退回消息，使消息可以重新消费。
java.lang.String	send(ExsMessage message) 支持文件及大报文的发送，接收时必须单独接收，使用 getMessage(String) 读取消息内容。

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

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

从接口继承的方法 org.opoo.ootp.client.MessageClient

ack, getMessageBody, poll, poll, ret, send, send, send, send

字段详细资料

META_FILE_REF

public static final java.lang.String META_FILE_REF

另请参阅:

常量字段值

构造器详细资料

SmartMessageClient

public SmartMessageClient(MessageClient messageClient,
                          FileClient fileClient)

SmartMessageClient

public SmartMessageClient(OotpClient ootpClient)

方法详细资料

send

public java.lang.String send(ExsMessage message)
                      throws OotpException

支持文件及大报文的发送，接收时必须单独接收，使用 getMessage(String) 读取消息内容。

指定者:

send 在接口中 MessageClient

参数:

message - 消息

返回:

抛出:

OotpException

poll

public PollResult poll(PollRequest request)
                throws OotpException

从接口复制的说明: MessageClient

轮询消息。

指定者:

poll 在接口中 MessageClient

参数:

request - 轮询请求。

返回:

轮询结果

抛出:

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

getMessage

public ExsMessage getMessage(java.lang.String id)
                      throws OotpException

从接口复制的说明: MessageClient

获取消息。

指定者:

getMessage 在接口中 MessageClient

参数:

id - 消息ID

返回:

整体消息对象

抛出:

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

getMessageInfo

public ExsMessageInfo getMessageInfo(java.lang.String id)
                              throws OotpException

从接口复制的说明: MessageClient

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

指定者:

getMessageInfo 在接口中 MessageClient

参数:

id - 消息ID

返回:

消息的信息

抛出:

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

ack

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

从接口复制的说明: MessageClient

确认消息。

指定者:

ack 在接口中 MessageClient

参数:

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

返回:

实际确认的消息数量

抛出:

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

ret

public int ret(java.util.List<java.lang.String> ids)
        throws OotpException

从接口复制的说明: MessageClient

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

指定者:

ret 在接口中 MessageClient

参数:

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

返回:

实际退回的消息数量

抛出:

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

ret

public int ret(java.util.List<java.lang.String> ids,
               java.util.function.Consumer<java.lang.Object> requestConfigurer)
        throws OotpException

从接口复制的说明: MessageClient

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

指定者:

ret 在接口中 MessageClient

参数:

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

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

返回:

实际退回的消息数量

抛出:

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