Package org.odpi.openmetadata.engineservices.governanceaction.client

Class GovernanceActionEngineClient

java.lang.Object

org.odpi.openmetadata.engineservices.governanceaction.client.GovernanceActionEngineClient

All Implemented Interfaces:

GovernanceActionAPI

public class GovernanceActionEngineClient
extends Object
implements GovernanceActionAPI

GovernanceActionEngineClient is a client-side library for calling a specific governance action OMES within an engine host server.

Constructor Summary

Constructors

Constructor	Description
GovernanceActionEngineClient(String serverPlatformRootURL, String serverName, String localServerSecretsStoreProvider, String localServerSecretsStoreLocation, String localServerSecretsStoreCollection, String delegatingUserId, AuditLog auditLog)	Create a client-side object for calling a governance action engine.
GovernanceActionEngineClient(String serverPlatformRootURL, String serverName, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, String delegatingUserId, AuditLog auditLog)	Create a new client with bearer token from supplied secrets store.

Method Summary

Modifier and Type	Method	Description
ConnectorReport	validateConnector(String connectorProviderClassName)	Validate the connector and return its connector type.

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceActionEngineClient

public GovernanceActionEngineClient(String serverPlatformRootURL,
 String serverName,
 String localServerSecretsStoreProvider,
 String localServerSecretsStoreLocation,
 String localServerSecretsStoreCollection,
 String delegatingUserId,
 AuditLog auditLog)
                             throws InvalidParameterException

Create a client-side object for calling a governance action engine.

Parameters:

serverPlatformRootURL - the root url of the platform where the governance action engine is running.

serverName - the name of the engine host server where the governance action engine is running

localServerSecretsStoreProvider - class name of the secrets store

localServerSecretsStoreLocation - location (networkAddress) of the secrets store

localServerSecretsStoreCollection - name of the collection of secrets to use to connect to the remote server

delegatingUserId - external userId making request

auditLog - destination for log messages.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

GovernanceActionEngineClient

public GovernanceActionEngineClient(String serverPlatformRootURL,
 String serverName,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 String delegatingUserId,
 AuditLog auditLog)
                             throws InvalidParameterException

Create a new client with bearer token from supplied secrets store.

Parameters:

serverPlatformRootURL - the root url of the platform where the governance action engine is running.

serverName - the name of the engine host server where the governance action engine is running

secretsStoreConnectorMap - connectors to secrets stores

delegatingUserId - external userId making request

auditLog - destination for log messages.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

validateConnector

public ConnectorReport validateConnector(String connectorProviderClassName)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Validate the connector and return its connector type.

Specified by:

validateConnector in interface GovernanceActionAPI

Parameters:

connectorProviderClassName - name of a specific connector or null for all connectors

Returns:

connector type and other capabilities for this connector

Throws:

InvalidParameterException - the connector provider class name is not a valid connector fo this service

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - there was a problem detected by the integration service