com.aliyun.iot.aep.sdk.apiclient.hook

Interface IoTAPIHook

All Known Implementing Classes:

IoTAuthProvider, IoTCredentialProviderImpl

public interface IoTAPIHook

用于在请求发送, 或者响应/失败触发前返回插入业务逻辑

Method Summary

Modifier and Type	Method and Description
void	onInterceptFailure(IoTRequest request, IoTRequestPayload payload, java.lang.Exception error, IoTCallback callback) 当失败触发前，触发 可以在失败触发前，实现对失败的预处理 对 error 的预处理完成后，请调用IoTCallback.onFailure(IoTRequest, Exception), API 通道 SDK 会把修改后的 error 返回给 API 调用者 如果对于特定的 error，需要转换为 response，请调用IoTCallback.onResponse(IoTRequest, IoTResponse), API 通道 SDK 会把 response 返回给 API 调用者， 开发者也可以通过这个方式实现失败请求的重试 注意:即使不需要处理当前 error， 也需要调用 IoTCallback.onFailure(IoTRequest, Exception), 否则 API 调用者无法收到失败响应
void	onInterceptResponse(IoTRequest request, IoTRequestPayload payload, IoTResponse response, IoTCallback callback) 当响应触发前，触发 可以在响应触发前，实现对响应的预处理 对 response 的预处理完成后，请调用IoTCallback.onResponse(IoTRequest, IoTResponse), API 通道 SDK 会把修改后的 response 返回给 API 调用者 如果 response 的预处理过程中发生异常，或者其他的特定业务需求， 可以调用IoTCallback.onFailure(IoTRequest, Exception)返回一个 Exception， API 通道 SDK 会把这个 Exception 返回给 API 调用者 注意:即使不需要处理当前 response， 也需要调用 IoTCallback.onResponse(IoTRequest, IoTResponse), 否则 API 调用者无法收到响应
void	onInterceptSend(IoTRequest request, IoTRequestPayload payload, IoTRequestPayloadCallback callback) 当请求发送前，触发 可以在请求发送前，实现对 payload 的预处理 对 payload 的预处理完成后，请调用 IoTRequestPayloadCallback.onIoTRequestPayloadReady()函数， 通知 API 通道 SDK 预处理完成，API 通道 SDK 收到通知后，会开始通过网络层发送 payload 如果预处理失败，那么可以通过以下两者方式处理: 1.

Method Detail

onInterceptSend

void onInterceptSend(IoTRequest request,
                     IoTRequestPayload payload,
                     IoTRequestPayloadCallback callback)

当请求发送前，触发

可以在请求发送前，实现对 payload 的预处理

对 payload 的预处理完成后，请调用 IoTRequestPayloadCallback.onIoTRequestPayloadReady()函数， 通知 API 通道 SDK 预处理完成，API 通道 SDK 收到通知后，会开始通过网络层发送 payload
如果预处理失败，那么可以通过以下两者方式处理:
1. 调用 IoTCallback.onFailure(IoTRequest, Exception) 返回 exception, API 通道 SDK 会把这个 exception 返回给当前 API 调用者
2. 调用 IoTCallback.onResponse(IoTRequest, IoTResponse) 返回一个 response， API 通道会把这个 response 返回给当前 API 调用者

Parameters:

request - 业务请求

payload - 封装好的请求数据

callback - 等待 payload 组装完成的回调

onInterceptResponse

void onInterceptResponse(IoTRequest request,
                         IoTRequestPayload payload,
                         IoTResponse response,
                         IoTCallback callback)

当响应触发前，触发

可以在响应触发前，实现对响应的预处理

对 response 的预处理完成后，请调用IoTCallback.onResponse(IoTRequest, IoTResponse), API 通道 SDK 会把修改后的 response 返回给 API 调用者
如果 response 的预处理过程中发生异常，或者其他的特定业务需求， 可以调用IoTCallback.onFailure(IoTRequest, Exception)返回一个 Exception， API 通道 SDK 会把这个 Exception 返回给 API 调用者

注意:即使不需要处理当前 response， 也需要调用 IoTCallback.onResponse(IoTRequest, IoTResponse), 否则 API 调用者无法收到响应

Parameters:

request - 业务请求

payload - 封装好的请求数据

response - 响应

callback - 等待 response 处理完成的回调

onInterceptFailure

void onInterceptFailure(IoTRequest request,
                        IoTRequestPayload payload,
                        java.lang.Exception error,
                        IoTCallback callback)

当失败触发前，触发

可以在失败触发前，实现对失败的预处理

对 error 的预处理完成后，请调用IoTCallback.onFailure(IoTRequest, Exception), API 通道 SDK 会把修改后的 error 返回给 API 调用者
如果对于特定的 error，需要转换为 response，请调用IoTCallback.onResponse(IoTRequest, IoTResponse), API 通道 SDK 会把 response 返回给 API 调用者， 开发者也可以通过这个方式实现失败请求的重试

注意:即使不需要处理当前 error， 也需要调用 IoTCallback.onFailure(IoTRequest, Exception), 否则 API 调用者无法收到失败响应

Parameters:

request - 业务请求

payload - 封装好的请求数据

error - 失败信息

callback - 等待 error 处理完成的回调