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:
org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent, org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension, org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension
public class OMAGServerPlatformConnector extends org.odpi.openmetadata.frameworks.connectors.ConnectorBase implements org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
Connector to access an OMAG Server Platform.

  • 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<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getAccessServices()
    Retrieve a list of the access services registered on the platform
    Set<org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig>
    getAllServerConfigurations()
    Return all the OMAG Server configurations that are stored on this platform.
    List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getAllServices()
    Retrieve a list of the services known on the platform
    org.odpi.openmetadata.frameworks.auditlog.ComponentDescription
    getConnectorComponentDescription()
    Return the component description that is used by this connector in the audit log.
    org.odpi.openmetadata.frameworks.connectors.properties.beans.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<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getEngineServices()
    Retrieve a list of the engine services registered on the platform
    List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getIntegrationServices()
    Retrieve a list of the integration services registered on the platform
    org.odpi.openmetadata.adminservices.configuration.properties.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<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getViewServices()
    Retrieve a list of the view services registered on the platform
    void
    setAuditLog(org.odpi.openmetadata.frameworks.auditlog.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

    disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, 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

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OMAGServerPlatformConnector

      public OMAGServerPlatformConnector()

  • Method Details

    • setAuditLog

      public void setAuditLog(org.odpi.openmetadata.frameworks.auditlog.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 org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent
      Parameters:
      auditLog - audit log object

    • getConnectorComponentDescription

      public org.odpi.openmetadata.frameworks.auditlog.ComponentDescription getConnectorComponentDescription()
      Return the component description that is used by this connector in the audit log.
      Specified by:
      getConnectorComponentDescription in interface org.odpi.openmetadata.frameworks.auditlog.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 org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.ConnectorBase
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.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 org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType getConnectorType(String connectorProviderClassName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAccessServices

      public List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getAccessServices() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the access services registered on the platform
      Returns:
      List of access services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getEngineServices

      public List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getEngineServices() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the engine services registered on the platform
      Returns:
      List of engine services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getViewServices

      public List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getViewServices() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the view services registered on the platform
      Returns:
      List of view services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getIntegrationServices

      public List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getIntegrationServices() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the integration services registered on the platform
      Returns:
      List of integration services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAllServices

      public List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService> getAllServices() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve a list of the services known on the platform
      Returns:
      List of common services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getAllServerConfigurations

      public Set<org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig> getAllServerConfigurations() throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException, org.odpi.openmetadata.adminservices.ffdc.exception.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:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.

    • deployOMAGServerConfig

      public void deployOMAGServerConfig(String serverName, String destinationPlatformURLRoot) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException, org.odpi.openmetadata.adminservices.ffdc.exception.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:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid serverName or destinationPlatform parameter.

    • getOMAGServerConfig

      public org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getOMAGServerConfig(String serverName) throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
      Return the complete set of configuration properties in use by the server.
      Parameters:
      serverName - local server name
      Returns:
      OMAGServerConfig properties
      Throws:
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid serverName parameter.
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - something went wrong with the REST call stack.

    • activateServer

      public String activateServer(String serverName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the server.

    • shutdownServer

      public void shutdownServer(String serverName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Temporarily deactivate any open metadata and governance services.
      Parameters:
      serverName - server to start
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

    • shutdownAllServers

      public void shutdownAllServers() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Temporarily shutdown all running servers.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

    • shutdownAndUnregisterServer

      public void shutdownAndUnregisterServer(String serverName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Permanently deactivate any open metadata and governance services and unregister from any cohorts.
      Parameters:
      serverName - server to start
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.

    • shutdownAndUnregisterAllServers

      public void shutdownAndUnregisterAllServers() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Shutdown any active servers and unregister them from any cohorts.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the supplied userId is not authorized to issue this command.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - unusual state in the platform.