程序包 org.opoo.ootp.client.impl

类 V1MessageClientImpl

java.lang.Object

org.opoo.ootp.client.impl.AbstractMessageClient

org.opoo.ootp.client.impl.V1MessageClientImpl

所有已实现的接口:

MessageClient

public class V1MessageClientImpl
extends AbstractMessageClient
implements MessageClient

嵌套类概要

嵌套类

修饰符和类型	类	说明
static class	V1MessageClientImpl.MessageV1	V1 版接口的消息
static class	V1MessageClientImpl.MessageWrapper1	第一类返回，返回 V1 版消息
static class	V1MessageClientImpl.MessageWrapper2

字段概要

从类继承的字段 org.opoo.ootp.client.impl.AbstractMessageClient

baseUrl, httpClient, objectMapper

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

DEFAULT_BUFFER_SIZE, DEFAULT_LIMIT

构造器概要

构造器

构造器	说明
V1MessageClientImpl(URI endpoint, org.apache.http.impl.client.CloseableHttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
V1MessageClientImpl(URI endpoint, org.apache.http.impl.client.CloseableHttpClient httpClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String basePath, String openApiContextPath)

方法概要

修饰符和类型	方法	说明
int	ack(List<String> ids)	确认消息。
protected <T> T	exec1(org.apache.http.client.methods.HttpUriRequest request, org.opoo.ootp.client.impl.V1MessageClientImpl.Handler1<T> handler)
protected <T> T	exec2(org.apache.http.client.methods.HttpUriRequest request, org.opoo.ootp.client.impl.V1MessageClientImpl.Handler2<T> handler)
ExsMessage	getMessage(String id)	获取消息。
ExsMessageInfo	getMessageInfo(String id)	获取已经发送的消息的信息，如消息的状态，是否被对方消费等。
PollResult	poll(PollRequest request)	轮询消息。
int	ret(List<String> ids, Consumer<Object> requestConfigurer)	退回消息，使消息可以重新消费。
String	send(ExsMessage message)	发送消息。

从类继承的方法 org.opoo.ootp.client.impl.AbstractMessageClient

codecDecode, codecEncode, getCodec, getMessage, hasContent, isDefaultCjkExtensionEnabled, processCjkExtensionHeader, processIds, setCodec, setDefaultCjkExtensionEnabled, toEntity, validateResponse, validateResponse

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

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

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

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

构造器详细资料

V1MessageClientImpl

public V1MessageClientImpl(URI endpoint,
 org.apache.http.impl.client.CloseableHttpClient httpClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

V1MessageClientImpl

public V1MessageClientImpl(URI endpoint,
 org.apache.http.impl.client.CloseableHttpClient httpClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 String basePath,
 String openApiContextPath)

方法详细资料

exec1

protected <T> T exec1(org.apache.http.client.methods.HttpUriRequest request,
 org.opoo.ootp.client.impl.V1MessageClientImpl.Handler1<T> handler)

exec2

protected <T> T exec2(org.apache.http.client.methods.HttpUriRequest request,
 org.opoo.ootp.client.impl.V1MessageClientImpl.Handler2<T> handler)

send

public String send(ExsMessage message)
            throws OotpException

从接口复制的说明: MessageClient

发送消息。

指定者:

send 在接口中 MessageClient

参数:

message - 消息

返回:

机构外联返回的消息ID

抛出:

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

poll

public PollResult poll(PollRequest request)
                throws OotpException

从接口复制的说明: MessageClient

轮询消息。

指定者:

poll 在接口中 MessageClient

参数:

request - 轮询请求。

返回:

轮询结果

抛出:

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

getMessage

public ExsMessage getMessage(String id)
                      throws OotpException

从接口复制的说明: MessageClient

获取消息。

指定者:

getMessage 在接口中 MessageClient

参数:

id - 消息ID

返回:

整体消息对象

抛出:

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

getMessageInfo

public ExsMessageInfo getMessageInfo(String id)
                              throws OotpException

从接口复制的说明: MessageClient

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

指定者:

getMessageInfo 在接口中 MessageClient

参数:

id - 消息ID

返回:

消息的信息

抛出:

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

ack

public int ack(List<String> ids)
        throws OotpException

从接口复制的说明: MessageClient

确认消息。

指定者:

ack 在接口中 MessageClient

参数:

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

返回:

实际确认的消息数量

抛出:

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

ret

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

从接口复制的说明: MessageClient

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

指定者:

ret 在接口中 MessageClient

参数:

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

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

返回:

实际退回的消息数量

抛出:

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