org.odpi.openmetadata.engineservices.governanceaction.client

Class GovernanceActionEngineClient

java.lang.Object

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

public class GovernanceActionEngineClient
extends Object

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

Constructor Summary

Constructors

Constructor and 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 and Description
List<EngineSummary>	getLocalEngines(String userId) Return the names of the the governance engines running in this Governance Action OMES.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceActionEngineClient

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

Throws:

InvalidParameterException - one of the parameters is null or invalid.

GovernanceActionEngineClient

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

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

getLocalEngines

public List<EngineSummary> getLocalEngines(String userId)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Return the names of the the governance engines running in this Governance Action OMES.

Returns:

list of engine summaries or

Throws:

InvalidParameterException - one of the parameters is null or invalid or

UserNotAuthorizedException - user not authorized to issue this request or

PropertyServerException - there was a problem detected by the governance action engine.