com.oneops.proxy.keywhiz.http

Class HttpClient

java.lang.Object

com.oneops.proxy.keywhiz.http.HttpClient

Direct Known Subclasses:

KeywhizAutomationClient, KeywhizClient

public abstract class HttpClient
extends Object

An abstract http client for both Keywhiz automation and admin clients.

Author:

Suresh

Field Summary

Fields

Modifier and Type	Field and Description
protected okhttp3.HttpUrl	baseUrl
protected okhttp3.OkHttpClient	client
protected static okhttp3.MediaType	JSON
protected KeywhizKeyStore	keywhizKeyStore
protected static com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpClient(String baseUrl, KeywhizKeyStore keywhizKeyStore) Creates an http client.

Method Summary

Modifier and Type	Method and Description
void	clearCookies() Clear all cookies from cookie manager.
protected okhttp3.OkHttpClient	createHttpsClient() Creates a OkHttpClient to start a TLS connection.
static com.fasterxml.jackson.databind.ObjectMapper	createObjectMapper() Creates and customizes new ObjectMapper for common settings.
protected String	httpDelete(okhttp3.HttpUrl url)
protected String	httpGet(okhttp3.HttpUrl url)
protected String	httpPost(okhttp3.HttpUrl url, Object content)
protected String	httpPut(okhttp3.HttpUrl url, Object content)
abstract boolean	isClientAuthEnabled() Check if client auth is enabled (mTLS) instead of session cookie.
protected String	makeCall(okhttp3.Request request)
protected void	throwOnCommonError(int status, String message) Maps some of the common HTTP errors to the corresponding exceptions.

Methods inherited from class java.lang.Object

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

Field Detail

JSON

protected static final okhttp3.MediaType JSON

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

client

protected final okhttp3.OkHttpClient client

baseUrl

protected final okhttp3.HttpUrl baseUrl

keywhizKeyStore

protected final KeywhizKeyStore keywhizKeyStore

Constructor Detail

HttpClient

protected HttpClient(String baseUrl,
                     KeywhizKeyStore keywhizKeyStore)
              throws GeneralSecurityException

Creates an http client.

Parameters:

baseUrl - keywhiz base url

keywhizKeyStore - keywhiz keystore.

Throws:

GeneralSecurityException

Method Detail

createObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper createObjectMapper()

Creates and customizes new ObjectMapper for common settings.

Returns:

customized input factory

createHttpsClient

protected okhttp3.OkHttpClient createHttpsClient()
                                          throws GeneralSecurityException

Creates a OkHttpClient to start a TLS connection. The OKHttp logging is enabled if the debug log is enabled for HttpClient.

Throws:

GeneralSecurityException

clearCookies

public void clearCookies()

Clear all cookies from cookie manager.

isClientAuthEnabled

public abstract boolean isClientAuthEnabled()

Check if client auth is enabled (mTLS) instead of session cookie.

Returns:

true if client auth is enabled

throwOnCommonError

protected void throwOnCommonError(int status,
                                  String message)
                           throws IOException

Maps some of the common HTTP errors to the corresponding exceptions.

Throws:

IOException

makeCall

protected String makeCall(okhttp3.Request request)
                   throws IOException

Throws:

IOException

httpGet

protected String httpGet(okhttp3.HttpUrl url)
                  throws IOException

Throws:

IOException

httpPost

protected String httpPost(okhttp3.HttpUrl url,
                          Object content)
                   throws IOException

Throws:

IOException

httpPut

protected String httpPut(okhttp3.HttpUrl url,
                         Object content)
                  throws IOException

Throws:

IOException

httpDelete

protected String httpDelete(okhttp3.HttpUrl url)
                     throws IOException

Throws:

IOException