Package org.odpi.openmetadata.governanceservers.enginehostservices.client

Class EngineHostClient

java.lang.Object

org.odpi.openmetadata.governanceservers.enginehostservices.client.EngineHostClient

public class EngineHostClient
extends Object

GovernanceEngineClient is a client-side library for calling a specific governance engine with a governance server.

Constructor Summary

Constructors

Constructor	Description
EngineHostClient(String serverPlatformRootURL, String serverName)	Create a client-side object for calling a governance engine.
EngineHostClient(String serverPlatformRootURL, String serverName, String userId, String password)	Create a client-side object for calling a governance engine.

Method Summary

Modifier and Type	Method	Description
List<GovernanceEngineSummary>	getGovernanceEngineSummaries(String userId)	Retrieve the description and status of each governance engine assigned to the Engine Host OMAG Server.
List<GovernanceEngineSummary>	getGovernanceEngineSummaries(String userId, String serviceURLMarker)	Retrieve the description and status of each governance engine assigned to a specific Open Metadata Engine Service (OMES).
GovernanceEngineSummary	getGovernanceEngineSummary(String userId, String governanceEngineName)	Retrieve the description and status of the requested governance engine.
void	refreshConfig(String userId)	Request that all governance engines refresh their configuration by calling the metadata server.
void	refreshConfig(String userId, String governanceEngineName)	Request that the governance engine refresh its configuration by calling the metadata server.

Methods inherited from class java.lang.Object

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

Constructor Details

EngineHostClient

public EngineHostClient(String serverPlatformRootURL,
 String serverName)
                 throws InvalidParameterException

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

Parameters:

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

serverName - the name of the governance server where the governance engine is running

Throws:

InvalidParameterException - one of the parameters is null or invalid.

EngineHostClient

public EngineHostClient(String serverPlatformRootURL,
 String serverName,
 String userId,
 String password)
                 throws InvalidParameterException

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

Parameters:

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

serverName - the name of the governance server where the governance 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 Details

getGovernanceEngineSummary

public GovernanceEngineSummary getGovernanceEngineSummary(String userId,
 String governanceEngineName)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the description and status of the requested governance engine.

Parameters:

userId - calling user

governanceEngineName - qualifiedName of the governance engine to target

Returns:

governance engine summary

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

getGovernanceEngineSummaries

public List<GovernanceEngineSummary> getGovernanceEngineSummaries(String userId,
 String serviceURLMarker)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the description and status of each governance engine assigned to a specific Open Metadata Engine Service (OMES).

Parameters:

userId - calling user

serviceURLMarker - engine service url unique identifier (eg asset-analysis for Asset Analysis OMES)

Returns:

list of governance engine summaries

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

getGovernanceEngineSummaries

public List<GovernanceEngineSummary> getGovernanceEngineSummaries(String userId)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the description and status of each governance engine assigned to the Engine Host OMAG Server.

Parameters:

userId - calling user

Returns:

list of governance engine summaries

Throws:

InvalidParameterException - no available instance for the requested server

UserNotAuthorizedException - user does not have access to the requested server

PropertyServerException - the service name is not known - indicating a logic error

refreshConfig

public void refreshConfig(String userId,
 String governanceEngineName)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request that the governance engine refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.

Parameters:

userId - identifier of calling user

governanceEngineName - qualifiedName of the governance engine to target

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

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

refreshConfig

public void refreshConfig(String userId)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Request that all governance engines refresh their configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the governance server is initializing. This request just ensures that the latest configuration is in use.

Parameters:

userId - identifier of calling user

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

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