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

Class EgeriaExtractor

java.lang.Object
org.odpi.openmetadata.adapters.connectors.egeriainfrastructure.extractor.EgeriaExtractor
public class EgeriaExtractor extends Object
EgeriaExtractor extracts information from the Egeria runtimes. It covers both the OMAG Server Platform and the OMAG Servers.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EgeriaExtractor(String platformURLRoot, String platformName, String serverOfInterest, String clientUserId)
    Constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    activateServer()
    Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
    String
    activateServer(String serverName)
    Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
    void
    addOpenMetadataArchive(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Add a new open metadata archive to running repository.
    void
    addOpenMetadataArchiveContent(org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties.OpenMetadataArchive openMetadataArchive)
    Add a new open metadata archive to running repository.
    void
    addOpenMetadataArchiveFile(String fileName)
    Add a new open metadata archive to running repository.
    boolean
    connectToCohort(String cohortName)
    A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository.
    boolean
    connectToCohort(String userId, String cohortName)
    A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository.
    void
    deployOMAGServerConfig(String serverName, String destinationPlatformURLRoot)
    Push the configuration for the server to another OMAG Server Platform.
    boolean
    disconnectFromCohort(String cohortName)
    Disconnect communications from a specific cohort.
    boolean
    disconnectFromCohort(String userId, String cohortName)
    Disconnect communications from a specific cohort.
    List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getAccessServices()
    Retrieve a list of the access services registered on the platform
    org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig
    getActiveConfiguration()
    Return the configuration used for the current active instance of the server.
    org.odpi.openmetadata.serveroperations.properties.ServerServicesStatus
    getActiveServerStatus()
    Return the status of a running server (use platform services to find out if the server is running).
    List<String>
    getActiveServices()
    Retrieve a list of the active services on a server
    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
    Map<String,Object>
    getConfigurationProperties(String connectorName)
    Retrieve the configuration properties of the named connector.
    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()
    Return the complete set of configuration properties in use by the server.
    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.
    OMAGServerProperties
    getServerReport()
    Return the latest status information about a particular service.
    org.odpi.openmetadata.serveroperations.properties.ServerStatus
    getServerStatus()
    Retrieve the server status
    List<org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGService>
    getViewServices()
    Retrieve a list of the view services registered on the platform
    void
    publishOpenLineageEvent(String event)
    Pass an open lineage event to the integration service.
    void
    refreshConnector(String connectorName)
    Issue a refresh() request on a specific connector
    void
    refreshConnectors()
    Issue a refresh() request on a connector running in the integration daemon.
    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.
    void
    refreshIntegrationGroupConfig(String integrationGroupName)
    Request that the integration group refresh its configuration by calling the metadata server.
    void
    restartConnector(String connectorName)
    Issue a restart() request on a specific connector
    void
    restartConnectors()
    Issue a restart() request on a connector running in the integration daemon.
    void
    shutdownAllServers()
    Temporarily shutdown all running servers.
    void
    shutdownAndUnregisterAllServers()
    Shutdown any active servers and unregister them from any cohorts.
    void
    shutdownAndUnregisterServer()
    Permanently deactivate any open metadata and governance services and unregister from any cohorts.
    void
    shutdownAndUnregisterServer(String serverName)
    Permanently deactivate any open metadata and governance services and unregister from any cohorts.
    void
    shutdownServer()
    Temporarily deactivate any open metadata and governance services.
    void
    shutdownServer(String serverName)
    Temporarily deactivate any open metadata and governance services.
    boolean
    unregisterFromCohort(String cohortName)
    Unregister from a specific cohort and disconnect from cohort communications.
    boolean
    unregisterFromCohort(String userId, String cohortName)
    Unregister from a specific cohort and disconnect from cohort communications.
    void
    updateConfigurationProperties(String connectorName, boolean isMergeUpdate, Map<String,Object> configurationProperties)
    Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
    void
    updateConnectorConnection(String connectorName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection)
    Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
    void
    updateEndpointNetworkAddress(String connectorName, String networkAddress)
    Update the configuration properties of the connectors, or specific connector if a connector name is supplied.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EgeriaExtractor

      public EgeriaExtractor(String platformURLRoot, String platformName, String serverOfInterest, String clientUserId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException, org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
      Constructor
      Parameters:
      platformURLRoot - platform URL root
      platformName - name of the platform
      serverOfInterest - optional server name
      clientUserId - userId to use for calls to the
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - invalid parameter
      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - invalid parameter
      org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException

  • Method Details

    • 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)

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

    • activateServer

      public String activateServer() 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.
      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.

    • shutdownServer

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

    • shutdownAndUnregisterServer

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

    • connectToCohort

      public boolean connectToCohort(String userId, String cohortName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository. It only needs to do this once and uses a timestamp to record that the registration event has been sent. If the server has already registered in the past, it sends a reregistration request.
      Parameters:
      userId - calling user
      cohortName - name of cohort
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the supplied parameters caused a problem
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the remote server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to perform the operation requested

    • disconnectFromCohort

      public boolean disconnectFromCohort(String userId, String cohortName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Disconnect communications from a specific cohort.
      Parameters:
      userId - calling user
      cohortName - name of cohort
      Returns:
      boolean flag to indicate success.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the supplied parameters caused a problem
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the remote server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to perform the operation requested

    • unregisterFromCohort

      public boolean unregisterFromCohort(String userId, String cohortName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Unregister from a specific cohort and disconnect from cohort communications.
      Parameters:
      userId - calling user
      cohortName - name of cohort
      Returns:
      boolean flag to indicate success.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the supplied parameters caused a problem
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem communicating with the remote server.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to perform the operation requested

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

    • getOMAGServerConfig

      public org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getOMAGServerConfig() 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.
      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.

    • getServerStatus

      public org.odpi.openmetadata.serveroperations.properties.ServerStatus getServerStatus() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the server status
      Returns:
      The server status
      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)

    • getActiveConfiguration

      public org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getActiveConfiguration() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the configuration used for the current active instance of the server. Null is returned if the server instance is not running.
      Returns:
      configuration properties used to initialize the server or null if not running
      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.

    • getActiveServerStatus

      public org.odpi.openmetadata.serveroperations.properties.ServerServicesStatus getActiveServerStatus() throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the status of a running server (use platform services to find out if the server is running).
      Returns:
      status of the server
      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.

    • getActiveServices

      public List<String> getActiveServices() 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 active services on a server
      Returns:
      List of service names
      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)

    • addOpenMetadataArchiveFile

      public void addOpenMetadataArchiveFile(String fileName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a new open metadata archive to running repository.
      Parameters:
      fileName - name of the open metadata archive file.
      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.

    • addOpenMetadataArchive

      public void addOpenMetadataArchive(org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a new open metadata archive to running repository.
      Parameters:
      connection - connection for the open metadata archive.
      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.

    • addOpenMetadataArchiveContent

      public void addOpenMetadataArchiveContent(org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.properties.OpenMetadataArchive openMetadataArchive) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Add a new open metadata archive to running repository.
      Parameters:
      openMetadataArchive - openMetadataArchive for the open metadata archive.
      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.

    • getServerReport

      public OMAGServerProperties getServerReport() throws Exception
      Return the latest status information about a particular service.
      Returns:
      server report
      Throws:
      Exception - a variety of exceptions from the different clients

    • getConfigurationProperties

      public Map<String,Object> getConfigurationProperties(String connectorName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the configuration properties of the named connector.
      Parameters:
      connectorName - name of a specific connector or null for all connectors
      Returns:
      property map
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

    • updateConfigurationProperties

      public void updateConfigurationProperties(String connectorName, boolean isMergeUpdate, Map<String,Object> configurationProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
      Parameters:
      connectorName - name of a specific connector or null for all connectors
      isMergeUpdate - should the properties be merged into the existing properties or replace them
      configurationProperties - new configuration properties
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • updateEndpointNetworkAddress

      public void updateEndpointNetworkAddress(String connectorName, String networkAddress) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
      Parameters:
      connectorName - name of a specific connector or null for all connectors
      networkAddress - new address
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • updateConnectorConnection

      public void updateConnectorConnection(String connectorName, org.odpi.openmetadata.frameworks.connectors.properties.beans.Connection connection) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
      Parameters:
      connectorName - name of a specific connector or null for all connectors
      connection - new address
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the connector name is not recognized
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

    • refreshConnector

      public void refreshConnector(String connectorName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Issue a refresh() request on a specific connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

    • refreshConnectors

      public void refreshConnectors() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Issue a refresh() request on a connector running in the integration daemon.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

    • restartConnector

      public void restartConnector(String connectorName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Issue a restart() request on a specific connector
      Parameters:
      connectorName - connector
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

    • restartConnectors

      public void restartConnectors() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Issue a restart() request on a connector running in the integration daemon.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

    • refreshIntegrationGroupConfig

      public void refreshIntegrationGroupConfig(String integrationGroupName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Request that the integration group refresh its configuration by calling the metadata server. This request is useful if the metadata server has an outage, particularly while the integration daemon is initializing. This request just ensures that the latest configuration is in use.
      Parameters:
      integrationGroupName - qualifiedName of the integration group to target
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration group.

    • publishOpenLineageEvent

      public void publishOpenLineageEvent(String event) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Pass an open lineage event to the integration service. It will pass it on to the integration connectors that have registered a listener for open lineage events.
      Parameters:
      event - open lineage event to publish.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the caller is not authorized to call the service
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem processing the request

    • refreshEngineConfig

      public void refreshEngineConfig(String governanceEngineName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the governance engine.

    • refreshEngineConfig

      public void refreshEngineConfig() throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the governance engine.

    • connectToCohort

      public boolean connectToCohort(String cohortName) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException, org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException, org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException
      A new server needs to register the metadataCollectionId for its metadata repository with the other servers in the open metadata repository. It only needs to do this once and uses a timestamp to record that the registration event has been sent. If the server has already registered in the past, it sends a reregistration request.
      Parameters:
      cohortName - name of cohort
      Returns:
      boolean to indicate that the request has been issued. If false it is likely that the cohort name is not known
      Throws:
      org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the supplied parameters caused a problem
      org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem communicating with the remote server.
      org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the user is not authorized to perform the operation requested

    • disconnectFromCohort

      public boolean disconnectFromCohort(String cohortName) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException, org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException, org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException
      Disconnect communications from a specific cohort.
      Parameters:
      cohortName - name of cohort
      Returns:
      boolean flag to indicate success.
      Throws:
      org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the supplied parameters caused a problem
      org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem communicating with the remote server.
      org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the user is not authorized to perform the operation requested

    • unregisterFromCohort

      public boolean unregisterFromCohort(String cohortName) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException, org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException, org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException
      Unregister from a specific cohort and disconnect from cohort communications.
      Parameters:
      cohortName - name of cohort
      Returns:
      boolean flag to indicate success.
      Throws:
      org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - one of the supplied parameters caused a problem
      org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - there is a problem communicating with the remote server.
      org.odpi.openmetadata.repositoryservices.ffdc.exception.UserNotAuthorizedException - the user is not authorized to perform the operation requested