com.alibaba.dashscope.protocol

Class ServiceFacility

java.lang.Object

com.alibaba.dashscope.protocol.ServiceFacility

public class ServiceFacility
extends Object

The rpc factory to use both http rpc and ws rpc.

Constructor Summary

Constructors

Constructor and Description
ServiceFacility()

Method Summary

Modifier and Type	Method and Description
static Result	call(Protocol protocol, Map<String,String> extraHeaders, Param param, HttpMethod method, long receiveTimeout) Call the network to do a single-in, single-out request.
static Result	callAndWait(Map<String,String> extraHeaders, Param param, HttpMethod method, long receiveTimeout) Call the network to do async task submitting and queries.
static boolean	isFailedEvent(String msg)
static boolean	isFinishEvent(String msg)
static boolean	isStartEvent(String msg)
static Map<String,String>	prepareHeaders(Protocol protocol, Param param) Prepare common headers.
static Request	prepareRequest(Protocol protocol, Param param, WebSocketEventType eventType) Build the message body by the protocol.
static Result	prepareResult(Protocol protocol, Param param, Response res) Prepare the Result by the response and the input param.
static String	prepareUrl(Protocol protocol, Param param) Prepare the connecting url.
static com.alibaba.dashscope.protocol.ServiceFacility.WsParam	prepareWsParams(io.reactivex.Flowable<Param> params) Add start-task and finish-task to the input stream.
static io.reactivex.Flowable<Result>	streamCall(Map<String,String> extraHeaders, io.reactivex.Flowable<Param> params, long receiveTimeout) Call the network to do a stream-in, stream-out request.
static void	streamCall(Map<String,String> extraHeaders, io.reactivex.Flowable<Param> params, ResultCallback<Result> resultCallback) Call the network to do a single-in, stream-out request via a callback.
static io.reactivex.Flowable<Result>	streamCall(Protocol protocol, Map<String,String> extraHeaders, Param param, long receiveTimeout) Call the network to do a single-in, stream-out request.
static io.reactivex.Flowable<Response>	streamingInAndDuplex(String url, Map<String,String> headers, io.reactivex.Flowable<Request> requests, long receiveTimeout) Call rpc on stream-in mode, only support websocket.
static void	streamingInAndDuplexWithCallback(String url, Map<String,String> headers, io.reactivex.Flowable<Request> requests, ResultCallback<Response> callback) Call rpc with a callback on stream-in mode, only support websocket.
static Response	streamingNone(Protocol protocol, String url, Map<String,String> headers, Request request, HttpMethod httpMethod, long receiveTimeout) Call rpc on single-in, single-out mode
static io.reactivex.Flowable<Response>	streamingOut(Protocol protocol, String url, Map<String,String> headers, Request request, HttpMethod httpMethod, StreamingMode mode, long receiveTimeout) Call rpc on single-in, stream-out mode
static void	streamingOutWithCallback(Protocol protocol, String url, Map<String,String> headers, Request request, HttpMethod httpMethod, StreamingMode mode, ResultCallback<Response> callback) Call rpc on single-in mode with a callback.
static Result	wait(SubmitParam submitParam, Class<? extends Result> clazz, long receiveTimeout) Wait for an async task to finish, check every 5 seconds.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceFacility

public ServiceFacility()

Method Detail

callAndWait

public static Result callAndWait(Map<String,String> extraHeaders,
                                 Param param,
                                 HttpMethod method,
                                 long receiveTimeout)

Call the network to do async task submitting and queries. Only support http.

Parameters:

extraHeaders - Extra headers to pass, basic headers will be built inside this function.

param - The input param to submit the task.

method - The http method.

receiveTimeout - The reception timeout of a single message.

Returns:

The final result after waiting.

wait

public static Result wait(SubmitParam submitParam,
                          Class<? extends Result> clazz,
                          long receiveTimeout)

Wait for an async task to finish, check every 5 seconds. Only support http.

Parameters:

submitParam - The `SubmitParam` used to query the task.

clazz - The result class.

receiveTimeout - The reception timeout.

Returns:

The task result.

streamCall

public static io.reactivex.Flowable<Result> streamCall(Map<String,String> extraHeaders,
                                                       io.reactivex.Flowable<Param> params,
                                                       long receiveTimeout)

Call the network to do a stream-in, stream-out request. Only support websocket. This function will automatically construct the Request and the Result, and build url, headers, body, etc. The websocket command start-task/continue-task/finish-task will also be built here, so user need only to pass the payload and some necessary information into the params. If the payload is binaries, the first message may be binary+parameters, or parameters only.

You can use this function to send binary(binaries).

Parameters:

extraHeaders - Extra headers to pass, basic headers will be built inside this function.

params - The input param containing the necessary payload information.

receiveTimeout - The reception timeout of a single message.

Returns:

The results in a Flowable

streamCall

public static void streamCall(Map<String,String> extraHeaders,
                              io.reactivex.Flowable<Param> params,
                              ResultCallback<Result> resultCallback)

Call the network to do a single-in, stream-out request via a callback. Only support websocket. This function will automatically construct the Request and the Result, and build url, headers, body, etc. The websocket command start-task/continue-task/finish-task will also be built here, so user need only to pass the payload and some necessary information into the params. The callback is supposed to receive the Result and the error messages.

You can use this function to send binary(binaries).

Parameters:

extraHeaders - Extra headers to pass, basic headers will be built inside this function.

params - The input param containing the necessary payload information.

resultCallback - The callback to receive messages.

streamCall

public static io.reactivex.Flowable<Result> streamCall(Protocol protocol,
                                                       Map<String,String> extraHeaders,
                                                       Param param,
                                                       long receiveTimeout)

Call the network to do a single-in, stream-out request. This function will automatically construct the Request and the Result, and build url, headers, body, etc. The websocket command start-task will also be built here, so user need only to pass the payload and some necessary information into the Param.

This function does not support binary.

Parameters:

protocol - The protocol.

extraHeaders - Extra headers to pass, basic headers will be built inside this function.

param - The input param containing the necessary payload information.

receiveTimeout - The reception timeout.

Returns:

The iterable result.

Throws:

ApiException - when error occurs.

call

public static Result call(Protocol protocol,
                          Map<String,String> extraHeaders,
                          Param param,
                          HttpMethod method,
                          long receiveTimeout)
                   throws ApiException

Call the network to do a single-in, single-out request. This function will automatically construct the Request and the Result, and build url, headers, body, etc. The websocket command start-task will also be built here, so user need only to pass the payload and some necessary information into the Param.

This function does not support binary.

Parameters:

protocol - The protocol.

extraHeaders - Extra headers to pass, basic headers will be built inside this function.

param - The input param containing the necessary payload information.

method - The http method.

receiveTimeout - The reception timeout.

Returns:

The result.

Throws:

ApiException - when error occurs.

prepareUrl

public static String prepareUrl(Protocol protocol,
                                Param param)
                         throws ApiException

Prepare the connecting url.

Parameters:

protocol - The protocol.

param - The input param.

Returns:

The constructed url.

Throws:

ApiException - when the protocol is not supported.

prepareHeaders

public static Map<String,String> prepareHeaders(Protocol protocol,
                                                Param param)

Prepare common headers.

Parameters:

protocol - The protocol.

param - The input param.

Returns:

Headers.

prepareRequest

public static Request prepareRequest(Protocol protocol,
                                     Param param,
                                     WebSocketEventType eventType)

Build the message body by the protocol.

Parameters:

protocol - The protocol, can be 'http' or 'websocket'.

param - The input param

eventType - The WebSocketEventType to built into the Request

Returns:

The message body

Throws:

ApiException - if the input is invalid.

prepareWsParams

public static com.alibaba.dashscope.protocol.ServiceFacility.WsParam prepareWsParams(io.reactivex.Flowable<Param> params)

Add start-task and finish-task to the input stream.

Parameters:

params - The params needed to send.

Returns:

A class contains the constructed requests and the first param.

prepareResult

public static Result prepareResult(Protocol protocol,
                                   Param param,
                                   Response res)

Prepare the Result by the response and the input param.

Parameters:

protocol - The protocol.

param - The input param to call `returnType`

res - The response.

Returns:

The constructed Result instance.

streamingOut

public static io.reactivex.Flowable<Response> streamingOut(Protocol protocol,
                                                           String url,
                                                           Map<String,String> headers,
                                                           Request request,
                                                           HttpMethod httpMethod,
                                                           StreamingMode mode,
                                                           long receiveTimeout)
                                                    throws ApiException

Call rpc on single-in, stream-out mode

Parameters:

protocol - The protocol.

url - The url.

headers - The headers.

request - The input request.

receiveTimeout - The timeout of receiving single message.

httpMethod - The `HttpMethod` to use if the protocol is http.

mode - The streaming mode.

Returns:

The Flowable of `Response`

Throws:

ApiException

streamingNone

public static Response streamingNone(Protocol protocol,
                                     String url,
                                     Map<String,String> headers,
                                     Request request,
                                     HttpMethod httpMethod,
                                     long receiveTimeout)
                              throws ApiException

Call rpc on single-in, single-out mode

Parameters:

protocol - The protocol.

url - The url.

headers - The headers.

request - The input request.

receiveTimeout - The timeout of receiving single message.

httpMethod - The `HttpMethod` to use if the protocol is http.

Returns:

The Flowable of `Response`

Throws:

ApiException

streamingOutWithCallback

public static void streamingOutWithCallback(Protocol protocol,
                                            String url,
                                            Map<String,String> headers,
                                            Request request,
                                            HttpMethod httpMethod,
                                            StreamingMode mode,
                                            ResultCallback<Response> callback)

Call rpc on single-in mode with a callback.

Parameters:

protocol - The protocol.

url - The url.

headers - The headers.

request - The input request.

mode - The streaming mode.

httpMethod - The `HttpMethod` to use if the protocol is http.

callback - The custom callback to use.

streamingInAndDuplexWithCallback

public static void streamingInAndDuplexWithCallback(String url,
                                                    Map<String,String> headers,
                                                    io.reactivex.Flowable<Request> requests,
                                                    ResultCallback<Response> callback)

Call rpc with a callback on stream-in mode, only support websocket.

Parameters:

url - The url.

headers - The headers.

requests - The iterable input request.

callback - The custom callback to use.

streamingInAndDuplex

public static io.reactivex.Flowable<Response> streamingInAndDuplex(String url,
                                                                   Map<String,String> headers,
                                                                   io.reactivex.Flowable<Request> requests,
                                                                   long receiveTimeout)

Call rpc on stream-in mode, only support websocket.

Parameters:

url - The url.

headers - The headers.

requests - The iterable input request.

receiveTimeout - The message timeout.

Returns:

A Flowable of `Response`

isFinishEvent

public static boolean isFinishEvent(String msg)

isStartEvent

public static boolean isStartEvent(String msg)

isFailedEvent

public static boolean isFailedEvent(String msg)