Package org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers

Class EngineHostConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.EngineHostConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

public class EngineHostConnector
extends OMAGServerConnectorBase

EngineHostConnector provides access to an Engine Host Server

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

extractor

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
EngineHostConnector()

Method Summary

Modifier and Type	Method	Description
List<RegisteredOMAGService>	getEngineServices()	Retrieve a list of the engine services registered on the platform
void	refreshEngineConfig()	Request that all governance engines refresh their configuration by calling the metadata server.
void	refreshEngineConfig(String governanceEngineName)	Request that the governance engine refresh its configuration by calling the metadata server.

Methods inherited from class org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.servers.OMAGServerConnectorBase

activateServer, connectToCohort, disconnectFromCohort, getActiveConfiguration, getActiveServerStatus, getActiveServices, getConnectorComponentDescription, getOMAGServerConfig, getServerReport, getServerStatus, setAuditLog, setClientUserId, shutdownAndUnregisterServer, shutdownServer, start, unregisterFromCohort

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnect, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Constructor Details

EngineHostConnector

public EngineHostConnector()

Method Details

getEngineServices

public List<RegisteredOMAGService> getEngineServices()
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve a list of the engine services registered on the platform

Returns:

List of engine services

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

refreshEngineConfig

public void refreshEngineConfig(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.

refreshEngineConfig

public void refreshEngineConfig()
                         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.