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

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, VirtualConnectorExtension

public class OMAGServerPlatformConnector
extends ConnectorBase
implements AuditLoggingComponent

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, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
OMAGServerPlatformConnector()

Method Summary

Modifier and Type	Method	Description
String	activateServer(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.
List<RegisteredOMAGService>	getAccessServices()	Retrieve a list of the access services registered on the platform
Set<OMAGServerConfig>	getAllServerConfigurations()	Return all the OMAG Server configurations that are stored on this platform.
List<RegisteredOMAGService>	getAllServices()	Retrieve a list of the services known on the platform
ComponentDescription	getConnectorComponentDescription()	Return the component description that is used by this connector in the audit log.
ConnectorType	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.
List<RegisteredOMAGService>	getEngineServices()	Retrieve a list of the engine services registered on the platform
List<RegisteredOMAGService>	getIntegrationServices()	Retrieve a list of the integration services registered on the platform
OMAGServerConfig	getOMAGServerConfig(String serverName)	Return the complete set of configuration properties in use by the server.
OMAGServerPlatformProperties	getPlatformReport()	Return the latest status information for the platform.
List<RegisteredOMAGService>	getViewServices()	Retrieve a list of the view services registered on the platform
void	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	shutdownAllServers()	Temporarily shutdown all running servers.
void	shutdownAndUnregisterAllServers()	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

combineConfigurationProperties, disconnect, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, 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

Methods inherited from class java.lang.Object

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

Constructor Details

OMAGServerPlatformConnector

public OMAGServerPlatformConnector()

Method Details

setAuditLog

public void setAuditLog(AuditLog auditLog)

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 interface AuditLoggingComponent

Parameters:

auditLog - audit log object

getConnectorComponentDescription

public ComponentDescription getConnectorComponentDescription()

Return the component description that is used by this connector in the audit log.

Specified by:

getConnectorComponentDescription in interface AuditLoggingComponent

Returns:

id, name, description, wiki page URL.

setPlatformName

public void setPlatformName(String platformName)

Set up a new platform name (must be called before start()).

Parameters:

platformName - new platform name

setClientUserId

public void setClientUserId(String clientUserId)

Set up new calling user.

Parameters:

clientUserId - caller's userId

start

public void start()
           throws ConnectorCheckedException

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 class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

getPlatformReport

public OMAGServerPlatformProperties getPlatformReport()
                                               throws Exception

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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getAccessServices

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

Retrieve a list of the access services registered on the platform

Returns:

List of access 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)

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)

getViewServices

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

Retrieve a list of the view services registered on the platform

Returns:

List of view 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)

getIntegrationServices

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

Retrieve a list of the integration services registered on the platform

Returns:

List of integration 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)

getAllServices

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

Retrieve a list of the services known on the platform

Returns:

List of common 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)

getAllServerConfigurations

public Set<OMAGServerConfig> getAllServerConfigurations()
                                                 throws OMAGNotAuthorizedException,
OMAGConfigurationErrorException,
OMAGInvalidParameterException

Return 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 name

destinationPlatformURLRoot - 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,
PropertyServerException

Temporarily 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,
PropertyServerException

Shutdown 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.