org.yamcs.api.rest

Class HttpClient

java.lang.Object

org.yamcs.api.rest.HttpClient

public class HttpClient
extends Object

Constructor Summary

Constructors

Constructor and Description
HttpClient()

Method Summary

Modifier and Type	Method and Description
void	close()
CompletableFuture<byte[]>	doAsyncRequest(String url, io.netty.handler.codec.http.HttpMethod httpMethod, byte[] body, AuthenticationToken authToken)
CompletableFuture<Void>	doBulkRequest(String url, io.netty.handler.codec.http.HttpMethod httpMethod, byte[] body, AuthenticationToken authToken, BulkRestDataReceiver receiver) Perform a request that potentially retrieves large amount of data.
CompletableFuture<Void>	doBulkRequest(String url, io.netty.handler.codec.http.HttpMethod httpMethod, String body, AuthenticationToken authToken, BulkRestDataReceiver receiver)
MediaType	getAcceptMediaType()
MediaType	getSendMediaType()
void	setAcceptMediaType(MediaType acceptMediaType)
void	setMaxResponseLength(long length) Sets the maximum size of the responses - this is not applicable to bulk requests whose response is practically unlimited and delivered piece by piece
void	setSendMediaType(MediaType sendMediaType)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient

public HttpClient()

Method Detail

doAsyncRequest

public CompletableFuture<byte[]> doAsyncRequest(String url,
                                                io.netty.handler.codec.http.HttpMethod httpMethod,
                                                byte[] body,
                                                AuthenticationToken authToken)
                                         throws URISyntaxException

Throws:

URISyntaxException

setMaxResponseLength

public void setMaxResponseLength(long length)

Sets the maximum size of the responses - this is not applicable to bulk requests whose response is practically unlimited and delivered piece by piece

Parameters:

length -

doBulkRequest

public CompletableFuture<Void> doBulkRequest(String url,
                                             io.netty.handler.codec.http.HttpMethod httpMethod,
                                             byte[] body,
                                             AuthenticationToken authToken,
                                             BulkRestDataReceiver receiver)
                                      throws URISyntaxException

Perform a request that potentially retrieves large amount of data. The data is forwarded to the client.

Parameters:

url -

httpMethod -

body -

authToken -

receiver - - send all the data to this receiver. To find out when the request has been finished, the Future has to be used

Returns:

a future indicating when the operation is completed.

Throws:

URISyntaxException

doBulkRequest

public CompletableFuture<Void> doBulkRequest(String url,
                                             io.netty.handler.codec.http.HttpMethod httpMethod,
                                             String body,
                                             AuthenticationToken authToken,
                                             BulkRestDataReceiver receiver)
                                      throws URISyntaxException

Throws:

URISyntaxException

getSendMediaType

public MediaType getSendMediaType()

setSendMediaType

public void setSendMediaType(MediaType sendMediaType)

getAcceptMediaType

public MediaType getAcceptMediaType()

setAcceptMediaType

public void setAcceptMediaType(MediaType acceptMediaType)

close

public void close()