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 repositoryGovernanceEngineName)	Create a client-side object for calling a archive engine.
RepositoryGovernanceClient(String serverPlatformRootURL, String serverName, String repositoryGovernanceEngineName, String userId, String password)	Create a client-side object for calling a archive engine.

Method Summary

Modifier and Type	Method	Description
ConnectorReport	validateConnector(String userId, 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 Detail

RepositoryGovernanceClient

public RepositoryGovernanceClient(String serverPlatformRootURL,
                                  String serverName,
                                  String repositoryGovernanceEngineName)
                           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

repositoryGovernanceEngineName - the unique name of the archive engine.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

RepositoryGovernanceClient

public RepositoryGovernanceClient(String serverPlatformRootURL,
                                  String serverName,
                                  String repositoryGovernanceEngineName,
                                  String userId,
                                  String password)
                           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

repositoryGovernanceEngineName - the unique name of the archive engine.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

InvalidParameterException - one of the parameters is null or invalid.

Method Detail

validateConnector

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

Validate the connector and return its connector type.

Specified by:

validateConnector in interface RepositoryGovernanceAPI

Parameters:

userId - calling user

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