Class OMAGServerPlatformConnector
java.lang.Object
org.odpi.openmetadata.frameworks.connectors.Connector
org.odpi.openmetadata.frameworks.connectors.ConnectorBase
org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.platform.OMAGServerPlatformConnector
- All Implemented Interfaces:
AuditLoggingComponent
,SecureConnectorExtension
Connector to access an OMAG Server Platform.
-
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.frameworks.connectors.ConnectorBase
connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, secretsStoreConnectorMap
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionactivateServer
(String serverName) Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.void
deployOMAGServerConfig
(String serverName, String destinationPlatformURLRoot) Push the configuration for the server to another OMAG Server Platform.Retrieve a list of the access services registered on the platformReturn all the OMAG Server configurations that are stored on this platform.Retrieve a list of the services known on the platformReturn the component description that is used by this connector in the audit log.getConnectorType
(String connectorProviderClassName) Return the connector type for the requested connector provider after validating that the connector provider is available on the OMAGServerPlatform's class path.Retrieve a list of the engine services registered on the platformRetrieve a list of the integration services registered on the platformgetOMAGServerConfig
(String serverName) Return the complete set of configuration properties in use by the server.Return the latest status information for the platform.Retrieve a list of the view services registered on the platformvoid
setAuditLog
(AuditLog auditLog) Receive an audit log object that can be used to record audit log messages.void
setClientUserId
(String clientUserId) Set up new calling user.void
setPlatformName
(String platformName) Set up a new platform name (must be called before start()).void
Temporarily shutdown all running servers.void
Shutdown any active servers and unregister them from any cohorts.void
shutdownAndUnregisterServer
(String serverName) Permanently deactivate any open metadata and governance services and unregister from any cohorts.void
shutdownServer
(String serverName) Temporarily deactivate any open metadata and governance services.void
start()
Indicates that the connector is completely configured and can begin processing.Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
disconnect, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getIntConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector
clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, setStatisticProperty, setStatisticTimestamp
-
Constructor Details
-
OMAGServerPlatformConnector
public OMAGServerPlatformConnector()
-
-
Method Details
-
setAuditLog
Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.- Specified by:
setAuditLog
in interfaceAuditLoggingComponent
- Parameters:
auditLog
- audit log object
-
getConnectorComponentDescription
Return the component description that is used by this connector in the audit log.- Specified by:
getConnectorComponentDescription
in interfaceAuditLoggingComponent
- Returns:
- id, name, description, wiki page URL.
-
setPlatformName
Set up a new platform name (must be called before start()).- Parameters:
platformName
- new platform name
-
setClientUserId
Set up new calling user.- Parameters:
clientUserId
- caller's userId
-
start
Indicates that the connector is completely configured and can begin processing. This call can be used to register with non-blocking services.- Overrides:
start
in classConnectorBase
- Throws:
ConnectorCheckedException
- there is a problem within the connector.
-
getPlatformReport
Return the latest status information for the platform.- Returns:
- platform report
- Throws:
Exception
- a variety of exceptions from the different clients
-
getConnectorType
public ConnectorType getConnectorType(String connectorProviderClassName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the connector type for the requested connector provider after validating that the connector provider is available on the OMAGServerPlatform's class path. This method is for tools that are configuring connectors into an Egeria server. It does not validate that the connector will load and initialize.- Parameters:
connectorProviderClassName
- name of the connector provider class- Returns:
- ConnectorType bean or exceptions that occur when trying to create the connector
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getAccessServices
public List<RegisteredOMAGService> getAccessServices() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionRetrieve a list of the access services registered on the platform- Returns:
- List of access services
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getEngineServices
public List<RegisteredOMAGService> getEngineServices() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionRetrieve a list of the engine services registered on the platform- Returns:
- List of engine services
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getViewServices
public List<RegisteredOMAGService> getViewServices() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionRetrieve a list of the view services registered on the platform- Returns:
- List of view services
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getIntegrationServices
public List<RegisteredOMAGService> getIntegrationServices() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionRetrieve a list of the integration services registered on the platform- Returns:
- List of integration services
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getAllServices
public List<RegisteredOMAGService> getAllServices() throws InvalidParameterException, UserNotAuthorizedException, PropertyServerExceptionRetrieve a list of the services known on the platform- Returns:
- List of common services
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-
getAllServerConfigurations
public Set<OMAGServerConfig> getAllServerConfigurations() throws OMAGNotAuthorizedException, OMAGConfigurationErrorException, OMAGInvalidParameterExceptionReturn all the OMAG Server configurations that are stored on this platform.- Returns:
- the OMAG Server configurations that are stored on this platform
- Throws:
OMAGNotAuthorizedException
- the supplied userId is not authorized to issue this command.OMAGInvalidParameterException
- invalid parameter.OMAGConfigurationErrorException
- unusual state in the admin server.
-
deployOMAGServerConfig
public void deployOMAGServerConfig(String serverName, String destinationPlatformURLRoot) throws OMAGNotAuthorizedException, OMAGConfigurationErrorException, OMAGInvalidParameterException Push the configuration for the server to another OMAG Server Platform.- Parameters:
serverName
- local server namedestinationPlatformURLRoot
- location of the platform where the config is to be deployed to- Throws:
OMAGNotAuthorizedException
- the supplied userId is not authorized to issue this command.OMAGConfigurationErrorException
- something went wrong with the REST call stack.OMAGInvalidParameterException
- invalid serverName or destinationPlatform parameter.
-
getOMAGServerConfig
public OMAGServerConfig getOMAGServerConfig(String serverName) throws OMAGNotAuthorizedException, OMAGInvalidParameterException, OMAGConfigurationErrorException Return the complete set of configuration properties in use by the server.- Parameters:
serverName
- local server name- Returns:
- OMAGServerConfig properties
- Throws:
OMAGNotAuthorizedException
- the supplied userId is not authorized to issue this command.OMAGInvalidParameterException
- invalid serverName parameter.OMAGConfigurationErrorException
- something went wrong with the REST call stack.
-
activateServer
public String activateServer(String serverName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.- Parameters:
serverName
- server to start- Returns:
- success message
- Throws:
UserNotAuthorizedException
- the supplied userId is not authorized to issue this command.InvalidParameterException
- invalid parameter.PropertyServerException
- unusual state in the server.
-
shutdownServer
public void shutdownServer(String serverName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException Temporarily deactivate any open metadata and governance services.- Parameters:
serverName
- server to start- Throws:
UserNotAuthorizedException
- the supplied userId is not authorized to issue this command.InvalidParameterException
- invalid parameter.PropertyServerException
- unusual state in the platform.
-
shutdownAllServers
public void shutdownAllServers() throws UserNotAuthorizedException, InvalidParameterException, PropertyServerExceptionTemporarily shutdown all running servers.- Throws:
UserNotAuthorizedException
- the supplied userId is not authorized to issue this command.InvalidParameterException
- invalid parameter.PropertyServerException
- unusual state in the platform.
-
shutdownAndUnregisterServer
public void shutdownAndUnregisterServer(String serverName) throws UserNotAuthorizedException, InvalidParameterException, PropertyServerException Permanently deactivate any open metadata and governance services and unregister from any cohorts.- Parameters:
serverName
- server to start- Throws:
UserNotAuthorizedException
- the supplied userId is not authorized to issue this command.InvalidParameterException
- invalid parameter.PropertyServerException
- unusual state in the platform.
-
shutdownAndUnregisterAllServers
public void shutdownAndUnregisterAllServers() throws UserNotAuthorizedException, InvalidParameterException, PropertyServerExceptionShutdown any active servers and unregister them from any cohorts.- Throws:
UserNotAuthorizedException
- the supplied userId is not authorized to issue this command.InvalidParameterException
- invalid parameter.PropertyServerException
- unusual state in the platform.
-