org.yamcs.api.rest

Class RestClient

java.lang.Object

org.yamcs.api.rest.RestClient

public class RestClient
extends Object

A simple Yamcs Rest client to help with basic requests.

Author:

nm

Constructor Summary

Constructors

Constructor and Description
RestClient(YamcsConnectionProperties connectionProperties) Creates a rest client that communications using protobuf

Method Summary

Modifier and Type	Method and Description
void	addCookie(io.netty.handler.codec.http.cookie.Cookie c)
List<YamcsManagement.YamcsInstance>	blockingGetYamcsInstances() Retrieve the list of yamcs instances from the server.
void	close()
CompletableFuture<Void>	doBulkGetRequest(String resource, BulkRestDataReceiver receiver) Performs a bulk request and provides the result piece by piece to the receiver.
CompletableFuture<Void>	doBulkGetRequest(String resource, byte[] body, BulkRestDataReceiver receiver)
CompletableFuture<BulkRestDataSender>	doBulkSendRequest(String resource, io.netty.handler.codec.http.HttpMethod method)
CompletableFuture<byte[]>	doRequest(String resource, io.netty.handler.codec.http.HttpMethod method) Performs a request with an empty body.
CompletableFuture<byte[]>	doRequest(String resource, io.netty.handler.codec.http.HttpMethod method, byte[] body) Perform asynchronously the request indicated by the HTTP method and return the result as a future providing byte array.
CompletableFuture<String>	doRequest(String resource, io.netty.handler.codec.http.HttpMethod method, String body) Perform asynchronously the request indicated by the HTTP method and return the result as a future providing byte array.
List<io.netty.handler.codec.http.cookie.Cookie>	getCookies()
CompletableFuture<List<YamcsManagement.YamcsInstance>>	getYamcsInstances()
boolean	isAutoclose()
static int	readVarInt32(ByteBuffer bb)
void	setAcceptMediaType(MediaType acceptMediaType)
void	setAutoclose(boolean autoclose) if autoclose is set, the httpClient will be automatically closed at the end of the request, so the netty eventgroup is shutdown.
void	setMaxResponseLength(int size)
void	setSendMediaType(MediaType sendMediaType)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

public RestClient(YamcsConnectionProperties connectionProperties)

Creates a rest client that communications using protobuf

Parameters:

connectionProperties -

Method Detail

blockingGetYamcsInstances

public List<YamcsManagement.YamcsInstance> blockingGetYamcsInstances()
                                                              throws Exception

Retrieve the list of yamcs instances from the server. The operation will block until the list is received.

Returns:

the list of yamcs instances configured on the server

Throws:

Exception

getYamcsInstances

public CompletableFuture<List<YamcsManagement.YamcsInstance>> getYamcsInstances()

doRequest

public CompletableFuture<byte[]> doRequest(String resource,
                                           io.netty.handler.codec.http.HttpMethod method)

Performs a request with an empty body. Works using protobuf

Parameters:

resource -

method -

Returns:

a the response body

doRequest

public CompletableFuture<String> doRequest(String resource,
                                           io.netty.handler.codec.http.HttpMethod method,
                                           String body)

Perform asynchronously the request indicated by the HTTP method and return the result as a future providing byte array. Note that the response body will be limited to - in case the server sends more than that, the CompletableFuture will completed with an error (the get() method will throw an Exception); the partial response will not be available.

Parameters:

resource - - the url and query parameters after the "/api" part.

method - - http method to use

body - - the body of the request. Can be used even for the GET requests although strictly not allowed by the HTTP standard.

Returns:

- the response body

Throws:

IllegalArgumentException - thrown in case the resource specification is invalid

doRequest

public CompletableFuture<byte[]> doRequest(String resource,
                                           io.netty.handler.codec.http.HttpMethod method,
                                           byte[] body)

Perform asynchronously the request indicated by the HTTP method and return the result as a future providing byte array. To be used when performing protobuf requests.

Parameters:

resource -

method -

body - protobuf encoded data.

Returns:

future containing protobuf encoded data

doBulkGetRequest

public CompletableFuture<Void> doBulkGetRequest(String resource,
                                                BulkRestDataReceiver receiver)

Performs a bulk request and provides the result piece by piece to the receiver. The potentially large result is split into messages based on the VarInt size preceding each message. The maximum size of each individual message is limited to

Parameters:

resource -

receiver -

Returns:

future that is completed when the request is finished

Throws:

RuntimeException - - thrown if the uri + resource does not form a correct URL

doBulkGetRequest

public CompletableFuture<Void> doBulkGetRequest(String resource,
                                                byte[] body,
                                                BulkRestDataReceiver receiver)

readVarInt32

public static int readVarInt32(ByteBuffer bb)
                        throws YamcsApiException

Throws:

YamcsApiException

setSendMediaType

public void setSendMediaType(MediaType sendMediaType)

setAcceptMediaType

public void setAcceptMediaType(MediaType acceptMediaType)

setMaxResponseLength

public void setMaxResponseLength(int size)

close

public void close()

isAutoclose

public boolean isAutoclose()

setAutoclose

public void setAutoclose(boolean autoclose)

if autoclose is set, the httpClient will be automatically closed at the end of the request, so the netty eventgroup is shutdown. Otherwise it has to be done manually - but then the same object can be used to perform multiple requests.

Parameters:

autoclose -

addCookie

public void addCookie(io.netty.handler.codec.http.cookie.Cookie c)

getCookies

public List<io.netty.handler.codec.http.cookie.Cookie> getCookies()

doBulkSendRequest

public CompletableFuture<BulkRestDataSender> doBulkSendRequest(String resource,
                                                               io.netty.handler.codec.http.HttpMethod method)