Package org.odpi.openmetadata.governanceservers.integrationdaemonservices.api

Interface IntegrationDaemonAPI

public interface IntegrationDaemonAPI
IntegrationDaemonAPI is the interface to control and monitor an integration daemon. The integration daemon is an OMAG Server. It runs one-to-many integration services that in turn manage one-to-many integration connectors. Each integration service focuses on a particular type of third party technology and is paired with an appropriate OMAS. The refresh commands are used to instruct the connectors running in the integration daemon to verify the consistency of the metadata in the third party technology against the values in open metadata. All connectors are requested to refresh when the integration daemon first starts. Then refresh is called on the schedule defined in the configuration and lastly as a result of calls to this API.

  • Method Details

    • getConfigurationProperties

      Map<String,Object> getConfigurationProperties(String userId, String serviceURLMarker, 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:
      userId - calling user
      serviceURLMarker - integration service identifier
      connectorName - name of a requested connector
      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

      void updateConfigurationProperties(String userId, String serviceURLMarker, 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:
      userId - calling user
      serviceURLMarker - integration service identifier
      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 - user not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there was a problem detected by the integration daemon

    • refreshAllServices

      void refreshAllServices(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Refresh all connectors running in the integration daemon, regardless of the integration service they belong to.
      Parameters:
      userId - calling user
      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

    • refreshService

      void refreshService(String userId, String serviceURLMarker, String connectorName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Refresh the requested connectors running in the requested integration service.
      Parameters:
      userId - calling user
      serviceURLMarker - integration service identifier
      connectorName - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are refreshed.
      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

    • restartService

      void restartService(String userId, String serviceURLMarker, String connectorName) 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 service shutdown and recreate its integration connectors. If a connector name is provided, only that connector is restarted.
      Parameters:
      userId - calling user
      serviceURLMarker - integration service identifier
      connectorName - optional name of the connector to target - if no connector name is specified, all connectors managed by this integration service are restarted.
      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

    • getIntegrationDaemonStatus

      IntegrationDaemonStatus getIntegrationDaemonStatus(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return a summary of each of the integration services' and integration groups' status.
      Parameters:
      userId - calling user
      Returns:
      list of statuses - on for each assigned integration services or integration group
      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

    • getIntegrationServicesSummaries

      List<IntegrationServiceSummary> getIntegrationServicesSummaries(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return a summary of each of the integration services' status.
      Parameters:
      userId - calling user
      Returns:
      list of statuses - on for each assigned integration services
      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

    • getIntegrationGroupSummary

      IntegrationGroupSummary getIntegrationGroupSummary(String userId, String integrationGroupName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the description and status of the requested integration group.
      Parameters:
      userId - calling user
      integrationGroupName - qualifiedName of the integration group to target
      Returns:
      integration group summary
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - no available instance for the requested server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user does not have access to the requested server
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the service name is not known - indicating a logic error

    • getIntegrationGroupSummaries

      List<IntegrationGroupSummary> getIntegrationGroupSummaries(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the description and status of all configured integration groups.
      Parameters:
      userId - calling user
      Returns:
      list of integration group summaries
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - no available instance for the requested server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user does not have access to the requested server
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - the service name is not known - indicating a logic error

    • refreshConfig

      void refreshConfig(String userId, 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:
      userId - identifier of calling user
      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.