Package org.texttechnologylab.DockerUnifiedUIMAInterface.driver

Class DUUIHttpRequestHandler

java.lang.Object

org.texttechnologylab.DockerUnifiedUIMAInterface.driver.DUUIHttpRequestHandler

public class DUUIHttpRequestHandler
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DUUIHttpRequestHandler.Response	A record class of the response status code and body in a byte array.

Constructor Summary

Constructors

Constructor	Description
DUUIHttpRequestHandler(HttpClient client, String componentUrl, long timeout)

Method Summary

Modifier and Type	Method	Description
DUUIHttpRequestHandler.Response	get()	Send a GET query to the component.
DUUIHttpRequestHandler.Response	get(String path)	Send a GET query to the given endpoint on the component.
DUUIHttpRequestHandler.Response	get(String path, String... parameters)	Send a GET query with parameters to the given endpoint on the component.
DUUIHttpRequestHandler.Response	getDocumentation()	Get the DUUI V1 documentation of the component.
void	header(String name, String value)	Adds the given name-value pair to the set of headers for this request
void	headers(String... headers)	Adds the given name-value pairs to the set of headers for this request.
DUUIHttpRequestHandler.Response	post(String path, byte[] data)	Send a POST request with the given data to the given endpoint on the component.
DUUIHttpRequestHandler.Response	process(byte[] data)	Send a DUUI V1 process request to the component.
void	setHeader(String name, String value)	Set the given header to the given value.
DUUIHttpRequestHandler	withHeaders(String... headers)	Create a copy of this request handler with the given headers set.

Methods inherited from class java.lang.Object

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

Constructor Details

DUUIHttpRequestHandler

public DUUIHttpRequestHandler(HttpClient client,
 String componentUrl,
 long timeout)

Method Details

getDocumentation

public DUUIHttpRequestHandler.Response getDocumentation()

Get the DUUI V1 documentation of the component.

Equivalent to get("/v1/documentation").

Returns:

the response

process

public DUUIHttpRequestHandler.Response process(byte[] data)

Send a DUUI V1 process request to the component.

Parameters:

data - an array of encoded data to send to the component

Returns:

the response

get

public DUUIHttpRequestHandler.Response get()

Send a GET query to the component.

Returns:

the response

get

public DUUIHttpRequestHandler.Response get(String path)

Send a GET query to the given endpoint on the component.

Parameters:

path - the path of the endpoint

Returns:

the response

get

public DUUIHttpRequestHandler.Response get(String path,
 String... parameters)

Send a GET query with parameters to the given endpoint on the component.

Parameters:

path - the path of the endpoint

parameters - a list of name-value pairs to be formatted as a GET query string

Returns:

the response

post

public DUUIHttpRequestHandler.Response post(String path,
 byte[] data)

Send a POST request with the given data to the given endpoint on the component.

Parameters:

path - the path of the endpoint

data - the data as a byte array

Returns:

the response

header

public void header(String name,
 String value)

Adds the given name-value pair to the set of headers for this request

Parameters:

name - the header name

value - the header value

See Also:

• HttpRequest.Builder.header(java.lang.String, java.lang.String)

headers

public void headers(String... headers)

Adds the given name-value pairs to the set of headers for this request.

Parameters:

headers - the list of name-value pairs

See Also:

• HttpRequest.Builder.headers(java.lang.String...)

setHeader

public void setHeader(String name,
 String value)

Set the given header to the given value. Overwrites previously set values.

Parameters:

name - the name of the header to set

value - the value of the header

See Also:

• HttpRequest.Builder.setHeader(java.lang.String, java.lang.String)

withHeaders

public DUUIHttpRequestHandler withHeaders(String... headers)

Create a copy of this request handler with the given headers set.

Parameters:

headers - a list of name-value header pairs

Returns:

the new request handler

See Also:

• headers(java.lang.String...)