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 serverName, String serverPlatformURLRoot, String secretsStoreProvider, String secretsStoreLocation, String secretsStoreCollection, AuditLog auditLog)	Create a client-side object for calling a governance engine.
EngineHostClient(String serverName, String serverPlatformURLRoot, Map<String,SecretsStoreConnector> secretsStoreConnectorMap, AuditLog auditLog)	Create a client-side object for calling a governance engine.

Method Summary

Modifier and Type	Method	Description
List<GovernanceEngineSummary>	getGovernanceEngineSummaries()	Retrieve the description and status of each governance engine assigned to the Engine Host OMAG Server.
GovernanceEngineSummary	getGovernanceEngineSummary(String governanceEngineName)	Retrieve the description and status of the requested governance engine.
void	refreshConfig()	Request that all governance engines refresh their configuration by calling the metadata server.
void	refreshConfig(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 serverName,
 String serverPlatformURLRoot,
 String secretsStoreProvider,
 String secretsStoreLocation,
 String secretsStoreCollection,
 AuditLog auditLog)
                 throws InvalidParameterException

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

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

secretsStoreProvider - secrets store connector for bearer token

secretsStoreLocation - secrets store location for bearer token

secretsStoreCollection - secrets store collection for bearer token

auditLog - destination for log messages.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

EngineHostClient

public EngineHostClient(String serverName,
 String serverPlatformURLRoot,
 Map<String,SecretsStoreConnector> secretsStoreConnectorMap,
 AuditLog auditLog)
                 throws InvalidParameterException

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

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running

secretsStoreConnectorMap - connectors to secrets stores

auditLog - destination for log messages.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

Method Details

getGovernanceEngineSummary

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

Retrieve the description and status of the requested governance engine.

Parameters:

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()
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

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 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:

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()
                   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.

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.