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

Class RepositoryGovernanceClient

java.lang.Object

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

All Implemented Interfaces:

org.odpi.openmetadata.engineservices.repositorygovernance.api.RepositoryGovernanceAPI

public class RepositoryGovernanceClient
extends Object
implements org.odpi.openmetadata.engineservices.repositorygovernance.api.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
org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport	validateConnector(String userId, String connectorProviderClassName)	Validate the connector and return its connector type.

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoryGovernanceClient

public RepositoryGovernanceClient(String serverPlatformRootURL,
 String serverName,
 String repositoryGovernanceEngineName)
                           throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.

RepositoryGovernanceClient

public RepositoryGovernanceClient(String serverPlatformRootURL,
 String serverName,
 String repositoryGovernanceEngineName,
 String userId,
 String password)
                           throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.

Method Details

validateConnector

public org.odpi.openmetadata.commonservices.ffdc.properties.ConnectorReport validateConnector(String userId,
 String connectorProviderClassName)
                                                                                       throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException

Validate the connector and return its connector type.

Specified by:

validateConnector in interface org.odpi.openmetadata.engineservices.repositorygovernance.api.RepositoryGovernanceAPI

Parameters:

userId - calling user

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

Returns:

connector report for this connector

Throws:

org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - the connector provider class name is not a valid connector fo this service

org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there was a problem detected by the integration service