Package io.hanko.sdk.http

Class HankoHttpClient

java.lang.Object

io.hanko.sdk.http.HankoHttpClientBase

io.hanko.sdk.http.HankoHttpClient

public class HankoHttpClient
extends HankoHttpClientBase

Main HankoHttpClientBase extension providing methods aligned with HTTP verbs/operations used with the Hanko API. Handles API error responses.

Constructor Summary

Constructors

Constructor	Description
HankoHttpClient(HankoClientConfig config)	Construct a HankoHttpClient.
HankoHttpClient(HankoClientConfig config, org.apache.http.impl.client.CloseableHttpClient httpClient)	Construct a HankoHttpClient using a custom underlying CloseableHttpClient.

Method Summary

Modifier and Type	Method	Description
HankoHttpResponse	delete(String path)	Make a delete request to the Hanko API.
HankoHttpResponse	get(String path)	Make a GET request to the Hanko API.
protected org.slf4j.Logger	getLogger()	Get a logger
HankoHttpResponse	post(String path, String body)	Make a POST request to the Hanko API.
HankoHttpResponse	put(String path, String body)	Make a PUT request to the Hanko API.

Methods inherited from class io.hanko.sdk.http.HankoHttpClientBase

makeRequest, makeRequest

Methods inherited from class java.lang.Object

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

Constructor Details

HankoHttpClient

public HankoHttpClient(HankoClientConfig config)

Construct a HankoHttpClient. Uses a default underlying CloseableHttpClient.

Parameters:

config - non-null, the HankoClientConfig

HankoHttpClient

public HankoHttpClient(HankoClientConfig config,
 org.apache.http.impl.client.CloseableHttpClient httpClient)

Construct a HankoHttpClient using a custom underlying CloseableHttpClient.

Parameters:

config - the HankoClientConfig

httpClient - non-null, the CloseableHttpClient

Method Details

post

public HankoHttpResponse post(String path,
 String body)

Make a POST request to the Hanko API.

Parameters:

path - the API endpoint path as a String

body - the request body as a String

Returns:

a HankoHttpResponse

Throws:

HankoApiException - if the HankoHttpResponse does not contain a 2xx response code

get

public HankoHttpResponse get(String path)

Make a GET request to the Hanko API.

Parameters:

path - the API endpoint path as a String

Returns:

a HankoHttpResponse

Throws:

HankoApiException - if the HankoHttpResponse does not contain a 2xx response code

put

public HankoHttpResponse put(String path,
 String body)

Make a PUT request to the Hanko API.

Parameters:

path - the API endpoint path as a String

body - the request body as a String

Returns:

a HankoHttpResponse

Throws:

HankoApiException - if the HankoHttpResponse does not contain a 2xx response code

delete

public HankoHttpResponse delete(String path)

Make a delete request to the Hanko API.

Parameters:

path - the API endpoint path as a String

Returns:

a HankoHttpResponse

Throws:

HankoApiException - if the HankoHttpResponse does not contain a 2xx response code

getLogger

protected org.slf4j.Logger getLogger()

Description copied from class: HankoHttpClientBase

Get a logger

Specified by:

getLogger in class HankoHttpClientBase

Returns:

the Logger