Class IntegrationDaemon

  • All Implemented Interfaces:
    IntegrationDaemonAPI

    public class IntegrationDaemon
    extends java.lang.Object
    implements IntegrationDaemonAPI
    IntegrationDaemon is the client library for the Integration Daemon's REST API. 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.
    • Constructor Summary

      Constructors 
      Constructor Description
      IntegrationDaemon​(java.lang.String serverName, java.lang.String serverPlatformRootURL)
      Create a new client with no authentication embedded in the HTTP request.
      IntegrationDaemon​(java.lang.String serverName, java.lang.String serverPlatformRootURL, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      IntegrationDaemon​(java.lang.String serverName, java.lang.String serverPlatformRootURL, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      IntegrationDaemon​(java.lang.String serverName, java.lang.String serverPlatformRootURL, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.Object> getConfigurationProperties​(java.lang.String userId, java.lang.String serviceURLMarker, java.lang.String connectorName)
      Retrieve the configuration properties of the named connector.
      java.util.List<IntegrationServiceSummary> getIntegrationDaemonStatus​(java.lang.String userId)
      Return a summary of each of the integration services' status.
      void refreshAllServices​(java.lang.String userId)
      Refresh all connectors running in the integration daemon, regardless of the integration service they belong to.
      void refreshService​(java.lang.String userId, java.lang.String serviceURLMarker, java.lang.String connectorName)
      Refresh the requested connectors running in the requested integration service.
      void restartService​(java.lang.String userId, java.lang.String serviceURLMarker, java.lang.String connectorName)
      Request that the integration service shutdown and recreate its integration connectors.
      void updateConfigurationProperties​(java.lang.String userId, java.lang.String serviceURLMarker, java.lang.String connectorName, boolean isMergeUpdate, java.util.Map<java.lang.String,​java.lang.Object> configurationProperties)
      Update the configuration properties of the connectors, or specific connector if a connector name is supplied.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • IntegrationDaemon

        public IntegrationDaemon​(java.lang.String serverName,
                                 java.lang.String serverPlatformRootURL,
                                 AuditLog auditLog)
                          throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • IntegrationDaemon

        public IntegrationDaemon​(java.lang.String serverName,
                                 java.lang.String serverPlatformRootURL)
                          throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • IntegrationDaemon

        public IntegrationDaemon​(java.lang.String serverName,
                                 java.lang.String serverPlatformRootURL,
                                 java.lang.String userId,
                                 java.lang.String password,
                                 AuditLog auditLog)
                          throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • IntegrationDaemon

        public IntegrationDaemon​(java.lang.String serverName,
                                 java.lang.String serverPlatformRootURL,
                                 java.lang.String userId,
                                 java.lang.String password)
                          throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.