Package org.odpi.openmetadata.adapters.connectors.restclients.factory

Class RESTClientFactory

java.lang.Object

org.odpi.openmetadata.adapters.connectors.restclients.factory.RESTClientFactory

public class RESTClientFactory
extends Object

RESTClientFactory is used to create an ew REST client

Constructor Summary

Constructors

Constructor	Description
RESTClientFactory(String serverName, String serverPlatformURLRoot, String localServerSecretsStoreProvider, String localServerSecretsStoreLocation, String localServerSecretsStoreCollection, String localServerSecretsStorePurpose, AuditLog auditLog)	Constructor for unsecured client connector
RESTClientFactory(String serverName, String serverPlatformURLRoot, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, AuditLog auditLog)	Constructor for authenticated client connector

Method Summary

Modifier and Type	Method	Description
RESTClientConnector	getClientConnector()	Retrieve the REST client connector.

Methods inherited from class java.lang.Object

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

Constructor Details

RESTClientFactory

public RESTClientFactory(String serverName,
 String serverPlatformURLRoot,
 String localServerSecretsStoreProvider,
 String localServerSecretsStoreLocation,
 String localServerSecretsStoreCollection,
 String localServerSecretsStorePurpose,
 AuditLog auditLog)
                  throws ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

Constructor for unsecured client connector

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

localServerSecretsStoreProvider - secrets store connector for bearer token

localServerSecretsStoreLocation - secrets store location for bearer token

localServerSecretsStoreCollection - secrets store collection for bearer token

localServerSecretsStorePurpose - purpose for the secrets collection

auditLog - audit log

Throws:

NoSuchMethodException - Unable to work with the connector provider class

ClassNotFoundException - Connector provider class not in path

InvocationTargetException - Unable to work with the connector provider class

InstantiationException - Unable to work with the connector provider class

IllegalAccessException - Unable to work with the connector provider class

RESTClientFactory

public RESTClientFactory(String serverName,
 String serverPlatformURLRoot,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 AuditLog auditLog)
                  throws ClassNotFoundException,
InvocationTargetException,
NoSuchMethodException,
InstantiationException,
IllegalAccessException

Constructor for authenticated client connector

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

secretsStoreConnectorMap - map from authentication type to supplied secrets store

auditLog - audit log

Throws:

NoSuchMethodException - Unable to work with the connector provider class

ClassNotFoundException - Connector provider class not in path

InvocationTargetException - Unable to work with the connector provider class

InstantiationException - Unable to work with the connector provider class

IllegalAccessException - Unable to work with the connector provider class

Method Details

getClientConnector

public RESTClientConnector getClientConnector()
                                       throws Exception

Retrieve the REST client connector.

Returns:

client connector

Throws:

Exception - an unexpected exception - internal logic error as the parameters should have all been checked before this call.