Package org.odpi.openmetadata.engineservices.repositorygovernance.client

Class RepositoryGovernanceClient

java.lang.Object

org.odpi.openmetadata.engineservices.repositorygovernance.client.RepositoryGovernanceClient

All Implemented Interfaces:

RepositoryGovernanceAPI

public class RepositoryGovernanceClient
extends Object
implements RepositoryGovernanceAPI

RepositoryGovernanceClient is a client-side library for calling a specific archive engine with an engine host server.

Constructor Summary

Constructors

Constructor	Description
RepositoryGovernanceClient(String serverPlatformRootURL, String serverName, String localServerSecretsStoreProvider, String localServerSecretsStoreLocation, String localServerSecretsStoreCollection, String delegatingUserId, AuditLog auditLog)	Create a client-side object for calling a archive engine.
RepositoryGovernanceClient(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

RepositoryGovernanceClient

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

Create a client-side object for calling a archive engine.

Parameters:

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

serverName - the name of the engine host server where the archive engine is running

localServerSecretsStoreProvider - secrets store connector for bearer token

localServerSecretsStoreLocation - secrets store location for bearer token

localServerSecretsStoreCollection - secrets store collection for bearer token

delegatingUserId - external userId making request

auditLog - destination for log messages

Throws:

InvalidParameterException - one of the parameters is null or invalid.

RepositoryGovernanceClient

public RepositoryGovernanceClient(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 RepositoryGovernanceAPI

Parameters:

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

Returns:

connector report 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