com.logicalclocks.hsfs.metadata

Class HopsworksExternalClient

java.lang.Object

com.logicalclocks.hsfs.metadata.HopsworksExternalClient

All Implemented Interfaces:

HopsworksHttpClient

public class HopsworksExternalClient
extends Object
implements HopsworksHttpClient

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiKey
protected String	certKey
protected org.apache.http.impl.conn.PoolingHttpClientConnectionManager	connectionPool
protected org.apache.http.impl.client.CloseableHttpClient	httpClient
protected org.apache.http.HttpHost	httpHost
protected static String	K_CERTIFICATE
protected String	keyStorePath
protected static org.slf4j.Logger	LOGGER
protected static String	MATERIAL_PASSWD
protected static String	PARAM_NAME_PARAMETER_STORE
protected static String	PARAM_NAME_SECRET_STORE
protected static String	T_CERTIFICATE
protected String	trustStorePath

Constructor Summary

Constructors

Constructor and Description
HopsworksExternalClient(org.apache.http.impl.client.CloseableHttpClient httpClient, org.apache.http.HttpHost httpHost)
HopsworksExternalClient(String host, int port, boolean hostnameVerification, String trustStorePath, software.amazon.awssdk.regions.Region region, SecretStore secretStore)
HopsworksExternalClient(String host, int port, boolean hostnameVerification, String trustStorePath, String apiKeyValue)
HopsworksExternalClient(String host, int port, String apiKeyFilepath, boolean hostnameVerification, String trustStorePath)

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory>	createConnectionFactory(org.apache.http.HttpHost httpHost, boolean hostnameVerification, String trustStorePath)
protected String	getAssumedRole()
<T> T	handleRequest(org.apache.http.HttpRequest request, org.apache.http.client.ResponseHandler<T> responseHandler)
String	readApiKey(SecretStore secretStore, software.amazon.awssdk.regions.Region region, String apiKeyFilepath) Read API key.
protected String	readApiKeyParamStore(software.amazon.awssdk.regions.Region region, String secretKey)
protected String	readApiKeySecretManager(software.amazon.awssdk.regions.Region region, String secretKey)
protected static String	readCertKey(String materialPwd)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.logicalclocks.hsfs.metadata.HopsworksHttpClient

getCertKey, getKeyStorePath, getTrustStorePath, setCertKey, setKeyStorePath, setTrustStorePath

Field Detail

LOGGER

protected static final org.slf4j.Logger LOGGER

PARAM_NAME_SECRET_STORE

protected static final String PARAM_NAME_SECRET_STORE

See Also:

Constant Field Values

PARAM_NAME_PARAMETER_STORE

protected static final String PARAM_NAME_PARAMETER_STORE

See Also:

Constant Field Values

MATERIAL_PASSWD

protected static final String MATERIAL_PASSWD

See Also:

Constant Field Values

T_CERTIFICATE

protected static final String T_CERTIFICATE

See Also:

Constant Field Values

K_CERTIFICATE

protected static final String K_CERTIFICATE

See Also:

Constant Field Values

connectionPool

protected org.apache.http.impl.conn.PoolingHttpClientConnectionManager connectionPool

httpHost

protected org.apache.http.HttpHost httpHost

httpClient

protected org.apache.http.impl.client.CloseableHttpClient httpClient

apiKey

protected String apiKey

trustStorePath

protected String trustStorePath

keyStorePath

protected String keyStorePath

certKey

protected String certKey

Constructor Detail

HopsworksExternalClient

public HopsworksExternalClient(String host,
                               int port,
                               String apiKeyFilepath,
                               boolean hostnameVerification,
                               String trustStorePath)
                        throws IOException,
                               FeatureStoreException,
                               KeyStoreException,
                               CertificateException,
                               NoSuchAlgorithmException,
                               KeyManagementException

Throws:

IOException

FeatureStoreException

KeyStoreException

CertificateException

NoSuchAlgorithmException

KeyManagementException

HopsworksExternalClient

public HopsworksExternalClient(String host,
                               int port,
                               boolean hostnameVerification,
                               String trustStorePath,
                               software.amazon.awssdk.regions.Region region,
                               SecretStore secretStore)
                        throws IOException,
                               FeatureStoreException,
                               KeyStoreException,
                               CertificateException,
                               NoSuchAlgorithmException,
                               KeyManagementException

Throws:

IOException

FeatureStoreException

KeyStoreException

CertificateException

NoSuchAlgorithmException

KeyManagementException

HopsworksExternalClient

public HopsworksExternalClient(String host,
                               int port,
                               boolean hostnameVerification,
                               String trustStorePath,
                               String apiKeyValue)
                        throws IOException,
                               FeatureStoreException,
                               KeyStoreException,
                               CertificateException,
                               NoSuchAlgorithmException,
                               KeyManagementException

Throws:

IOException

FeatureStoreException

KeyStoreException

CertificateException

NoSuchAlgorithmException

KeyManagementException

HopsworksExternalClient

public HopsworksExternalClient(org.apache.http.impl.client.CloseableHttpClient httpClient,
                               org.apache.http.HttpHost httpHost)

Method Detail

createConnectionFactory

protected org.apache.http.config.Registry<org.apache.http.conn.socket.ConnectionSocketFactory> createConnectionFactory(org.apache.http.HttpHost httpHost,
                                                                                                                       boolean hostnameVerification,
                                                                                                                       String trustStorePath)
                                                                                                                throws IOException,
                                                                                                                       KeyStoreException,
                                                                                                                       CertificateException,
                                                                                                                       NoSuchAlgorithmException,
                                                                                                                       KeyManagementException

Throws:

IOException

KeyStoreException

CertificateException

NoSuchAlgorithmException

KeyManagementException

readCertKey

protected static String readCertKey(String materialPwd)

Specified by:

readCertKey in interface HopsworksHttpClient

readApiKey

public String readApiKey(SecretStore secretStore,
                         software.amazon.awssdk.regions.Region region,
                         String apiKeyFilepath)
                  throws IOException,
                         FeatureStoreException

Read API key. We currently support 3 options: - AWS Parameter store - AWS Secrets manager - FIle on the local file system

Parameters:

secretStore - SecretStore PARAMETER_STORE or SECRET_MANAGER

region - AWS regions

apiKeyFilepath - path to API key file

Returns:

String

Throws:

IOException - IOException

FeatureStoreException - FeatureStoreException

readApiKeyParamStore

protected String readApiKeyParamStore(software.amazon.awssdk.regions.Region region,
                                      String secretKey)
                               throws FeatureStoreException

Throws:

FeatureStoreException

readApiKeySecretManager

protected String readApiKeySecretManager(software.amazon.awssdk.regions.Region region,
                                         String secretKey)
                                  throws FeatureStoreException,
                                         IOException

Throws:

FeatureStoreException

IOException

getAssumedRole

protected String getAssumedRole()
                         throws FeatureStoreException

Throws:

FeatureStoreException

handleRequest

public <T> T handleRequest(org.apache.http.HttpRequest request,
                           org.apache.http.client.ResponseHandler<T> responseHandler)
                    throws IOException

Specified by:

handleRequest in interface HopsworksHttpClient

Throws:

IOException