org.yamcs.client.base

Class RestClient

java.lang.Object

org.yamcs.client.base.RestClient

public class RestClient
extends Object

A simple Yamcs Rest client to help with basic requests.

Constructor Summary

Constructors

Constructor and Description
RestClient(String host, int port, boolean tls, String context) 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)
void	close()
CompletableFuture<byte[]>	doBaseRequest(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<Void>	doBulkRequest(io.netty.handler.codec.http.HttpMethod method, String resource, BulkRestDataReceiver receiver)
CompletableFuture<Void>	doBulkRequest(io.netty.handler.codec.http.HttpMethod method, String resource, byte[] body, BulkRestDataReceiver receiver) Performs a bulk request and provides the result piece by piece to the 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<byte[]>	doRequest(String resource, io.netty.handler.codec.http.HttpMethod method, com.google.protobuf.Message message) 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()
Credentials	getCredentials()
boolean	isAutoclose()
boolean	isInsecureTls()
void	login(String username, char[] password)
void	loginWithAuthorizationCode(String authorizationCode)
static int	readVarInt32(ByteBuffer bb)
void	setAcceptMediaType(String 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	setCaCertFile(String caCertFile) In case of https connections, this file contains the CA certificates that are used to verify server certificate.
void	setInsecureTls(boolean insecureTls) if true and https connections are used, do not verify server certificate
void	setMaxResponseLength(int size)
void	setSendMediaType(String sendMediaType)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

public RestClient(String host,
                  int port,
                  boolean tls,
                  String context)

Creates a rest client that communications using protobuf

Method Detail

login

public void login(String username,
                  char[] password)
           throws ClientException

Throws:

ClientException

loginWithAuthorizationCode

public void loginWithAuthorizationCode(String authorizationCode)
                                throws ClientException

Throws:

ClientException

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 - when the resource specification is invalid

doRequest

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

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 -

message -

Returns:

future containing protobuf encoded data

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

doBaseRequest

public CompletableFuture<byte[]> doBaseRequest(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

doBulkRequest

public CompletableFuture<Void> doBulkRequest(io.netty.handler.codec.http.HttpMethod method,
                                             String resource,
                                             BulkRestDataReceiver receiver)

doBulkRequest

public CompletableFuture<Void> doBulkRequest(io.netty.handler.codec.http.HttpMethod method,
                                             String resource,
                                             byte[] body,
                                             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:

method -

resource -

receiver -

Returns:

future that is completed when the request is finished

Throws:

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

readVarInt32

public static int readVarInt32(ByteBuffer bb)
                        throws ClientException

Throws:

ClientException

setSendMediaType

public void setSendMediaType(String sendMediaType)

setAcceptMediaType

public void setAcceptMediaType(String acceptMediaType)

setMaxResponseLength

public void setMaxResponseLength(int size)

close

public void close()

isAutoclose

public boolean isAutoclose()

getCredentials

public Credentials getCredentials()

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)

isInsecureTls

public boolean isInsecureTls()

setInsecureTls

public void setInsecureTls(boolean insecureTls)

if true and https connections are used, do not verify server certificate

Parameters:

insecureTls -

setCaCertFile

public void setCaCertFile(String caCertFile)
                   throws IOException,
                          GeneralSecurityException

In case of https connections, this file contains the CA certificates that are used to verify server certificate. If this is not set, java will use the default mechanism with the trustStore that can be configured via the javax.net.ssl.trustStore system property.

Parameters:

caCertFile -

Throws:

IOException

GeneralSecurityException