ml.comet.experiment.impl.http

Class Connection

java.lang.Object

ml.comet.experiment.impl.http.Connection

All Implemented Interfaces:

Closeable, AutoCloseable

public class Connection
extends Object
implements Closeable

Represents connection with the CometML server. Provides utility methods to send various data records to the server.

Make sure to close this connection to avoid resources leak.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMET_SDK_API_HEADER
static int	CONNECTION_SHUTDOWN_TIMEOUT_MS
static int	READ_TIMEOUT_MS
static int	REQUEST_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
Connection(@NonNull String cometBaseUrl, @NonNull String apiKey, int maxAuthRetries, @NonNull org.slf4j.Logger logger) Creates new instance with specified parameters.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this connection immediately by releasing underlying resources.
org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response>	downloadAsync(@NonNull File file, @NonNull String endpoint, @NonNull Map<QueryParamName,String> params) Allows downloading remote assets to the provided file asynchronously.
org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response>	downloadAsync(@NonNull OutputStream outputStream, @NonNull String endpoint, @NonNull Map<QueryParamName,String> params) Allows downloading data from remote endpoint and write it into provided OutputStream asynchronously.
Optional<String>	sendGetWithRetries(@NonNull String endpoint, @NonNull Map<QueryParamName,String> params) Allows sending synchronous GET request to the specified endpoint with given request parameters.
Optional<String>	sendGetWithRetries(@NonNull String endpoint, @NonNull Map<QueryParamName,String> params, boolean throwOnFailure) Allows sending synchronous GET request to the specified endpoint with given request parameters.
org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response>	sendPostAsync(byte[] bytes, @NonNull String endpoint, @NonNull Map<QueryParamName,String> params, Map<FormParamName,Object> formParams) Allows asynchronous sending of provided byte array as POST request to the specified endpoint.
org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response>	sendPostAsync(@NonNull File file, @NonNull String endpoint, @NonNull Map<QueryParamName,String> queryParams, Map<FormParamName,Object> formParams) Allows asynchronous posting the content of the file as multipart form data to the specified endpoint.
org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response>	sendPostAsync(@NonNull String endpoint, @NonNull Map<QueryParamName,String> params, @NonNull Map<FormParamName,Object> formParams) Allows asynchronous FORM submission to the specified endpoint.
org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response>	sendPostAsync(@NonNull String json, @NonNull String endpoint) Allows asynchronous sending of text as JSON encoded body of the POST request.
Optional<String>	sendPostWithRetries(@NonNull String json, @NonNull String endpoint, boolean throwOnFailure) Allows sending POST to the specified endpoint with body as JSON string.
void	waitAndClose(@NonNull Duration timeout) Allows to properly close this connection after all scheduled posts request are executed or if timeout expired.

Methods inherited from class java.lang.Object

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

Field Detail

READ_TIMEOUT_MS

public static final int READ_TIMEOUT_MS

See Also:

Constant Field Values

REQUEST_TIMEOUT_MS

public static final int REQUEST_TIMEOUT_MS

See Also:

Constant Field Values

CONNECTION_SHUTDOWN_TIMEOUT_MS

public static final int CONNECTION_SHUTDOWN_TIMEOUT_MS

See Also:

Constant Field Values

COMET_SDK_API_HEADER

public static final String COMET_SDK_API_HEADER

See Also:

Constant Field Values

Constructor Detail

Connection

public Connection(@NonNull
                  @NonNull String cometBaseUrl,
                  @NonNull
                  @NonNull String apiKey,
                  int maxAuthRetries,
                  @NonNull
                  @NonNull org.slf4j.Logger logger)

Creates new instance with specified parameters.

Parameters:

cometBaseUrl - the base URL of the Comet server's endpoints.

apiKey - the API key to authorize Comet API access

maxAuthRetries - the maximum number of retries per failed request.

logger - the Logger to collect log records.

Method Detail

sendGetWithRetries

public Optional<String> sendGetWithRetries(@NonNull
                                           @NonNull String endpoint,
                                           @NonNull
                                           @NonNull Map<QueryParamName,String> params)

Allows sending synchronous GET request to the specified endpoint with given request parameters. It will attempt to retry request if failed for the maxAuthRetries attempts.

Parameters:

endpoint - the request path of the endpoint

params - the map with request parameters.

Returns:

the Optional of response body.

sendGetWithRetries

public Optional<String> sendGetWithRetries(@NonNull
                                           @NonNull String endpoint,
                                           @NonNull
                                           @NonNull Map<QueryParamName,String> params,
                                           boolean throwOnFailure)
                                    throws CometApiException

Allows sending synchronous GET request to the specified endpoint with given request parameters. It will attempt to retry request if failed for the maxAuthRetries attempts.

If request failed the CometApiException will be thrown with related details if throwOnFailure parameter set.

Parameters:

endpoint - the request path of the endpoint

params - the map with request parameters.

throwOnFailure - if true then CometApiException will be thrown on failure. Otherwise, the empty Optional returned.

Returns:

the Optional of response body or empty Optional.

Throws:

CometApiException - if failed and throwOnFailure parameter set.

sendPostWithRetries

public Optional<String> sendPostWithRetries(@NonNull
                                            @NonNull String json,
                                            @NonNull
                                            @NonNull String endpoint,
                                            boolean throwOnFailure)
                                     throws CometApiException

Allows sending POST to the specified endpoint with body as JSON string. This method will retry request using maxAuthRetries attempts. If failed empty Optional will be returned or CometApiException will be thrown if maxAuthRetries attempts exceeded.

Parameters:

json - the JSON string to be posted.

endpoint - the relative path to the endpoint

throwOnFailure - the flag to indicate if exception should be thrown on failure of request execution.

Returns:

the Optional of response body.

Throws:

CometApiException - if throwOnFailure set to true and request was failed.

sendPostAsync

public org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response> sendPostAsync(@NonNull
                                                                                        @NonNull String json,
                                                                                        @NonNull
                                                                                        @NonNull String endpoint)

Allows asynchronous sending of text as JSON encoded body of the POST request.

Parameters:

json - the JSON encoded text.

endpoint - the relative path to the endpoint.

Returns:

the ListenableFuture which can be used to monitor status of the request execution.

sendPostAsync

public org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response> sendPostAsync(@NonNull
                                                                                        @NonNull File file,
                                                                                        @NonNull
                                                                                        @NonNull String endpoint,
                                                                                        @NonNull
                                                                                        @NonNull Map<QueryParamName,String> queryParams,
                                                                                        Map<FormParamName,Object> formParams)

Allows asynchronous posting the content of the file as multipart form data to the specified endpoint.

Parameters:

file - the file to be included.

endpoint - the relative path to the endpoint.

queryParams - the request query parameters

formParams - the form parameters

Returns:

the ListenableFuture which can be used to monitor status of the request execution.

sendPostAsync

public org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response> sendPostAsync(byte[] bytes,
                                                                                        @NonNull
                                                                                        @NonNull String endpoint,
                                                                                        @NonNull
                                                                                        @NonNull Map<QueryParamName,String> params,
                                                                                        Map<FormParamName,Object> formParams)

Allows asynchronous sending of provided byte array as POST request to the specified endpoint.

Parameters:

bytes - the data array

endpoint - the relative path to the endpoint.

params - the request parameters map.

formParams - the form parameters

Returns:

the ListenableFuture which can be used to monitor status of the request execution.

sendPostAsync

public org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response> sendPostAsync(@NonNull
                                                                                        @NonNull String endpoint,
                                                                                        @NonNull
                                                                                        @NonNull Map<QueryParamName,String> params,
                                                                                        @NonNull
                                                                                        @NonNull Map<FormParamName,Object> formParams)

Allows asynchronous FORM submission to the specified endpoint.

Parameters:

endpoint - the relative path to the endpoint.

params - the request parameters map.

formParams - the form parameters

Returns:

the ListenableFuture which can be used to monitor status of the request execution.

downloadAsync

public org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response> downloadAsync(@NonNull
                                                                                        @NonNull File file,
                                                                                        @NonNull
                                                                                        @NonNull String endpoint,
                                                                                        @NonNull
                                                                                        @NonNull Map<QueryParamName,String> params)

Allows downloading remote assets to the provided file asynchronously.

Parameters:

file - the File instance to collect received data.

endpoint - the request path of the endpoint.

params - the map with request parameters.

Returns:

the ListenableFuture which can be used to monitor status of the request execution.

downloadAsync

public org.asynchttpclient.ListenableFuture<org.asynchttpclient.Response> downloadAsync(@NonNull
                                                                                        @NonNull OutputStream outputStream,
                                                                                        @NonNull
                                                                                        @NonNull String endpoint,
                                                                                        @NonNull
                                                                                        @NonNull Map<QueryParamName,String> params)

Allows downloading data from remote endpoint and write it into provided OutputStream asynchronously.

The provided OutputStream will be closed when response from server completed either successfully or failed.

Parameters:

outputStream - the OutputStream to write received data into.

endpoint - the request path of the endpoint.

params - the map with request parameters.

Returns:

the ListenableFuture which can be used to monitor status of the request execution.

close

public void close()
           throws IOException

Closes this connection immediately by releasing underlying resources.

Please note that some asynchronous post request can still be not processed, which will result in errors. Use this method with great caution and only if you are not expecting any request still be unprocessed. For all other cases it is recommended to use waitAndClose method.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs.

waitAndClose

public void waitAndClose(@NonNull
                         @NonNull Duration timeout)
                  throws IOException

Allows to properly close this connection after all scheduled posts request are executed or if timeout expired.

Parameters:

timeout - the maximum duration to wait before closing connection.

Throws:

IOException - if an I/O error occurs.