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

Class GovernanceActionEngineClient

java.lang.Object

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

All Implemented Interfaces:

org.odpi.openmetadata.engineservices.governanceaction.api.GovernanceActionAPI

public class GovernanceActionEngineClient
extends Object
implements org.odpi.openmetadata.engineservices.governanceaction.api.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)	Create a client-side object for calling a governance action engine.
GovernanceActionEngineClient(String serverPlatformRootURL, String serverName, String userId, String password)	Create a client-side object for calling a governance action 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

GovernanceActionEngineClient

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

Throws:

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

GovernanceActionEngineClient

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

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

org.odpi.openmetadata.frameworks.connectors.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.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Validate the connector and return its connector type.

Specified by:

validateConnector in interface org.odpi.openmetadata.engineservices.governanceaction.api.GovernanceActionAPI

Parameters:

userId - calling user

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

Returns:

connector type and other capabilities for this connector

Throws:

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

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

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