Class IntegrationDaemonConfigurationClient


  • public class IntegrationDaemonConfigurationClient
    extends GovernanceServerConfigurationClient
    IntegrationDaemonConfigurationClient provides the configuration services for integration daemons. This involves creating a list of integration services.
    • Constructor Detail

      • IntegrationDaemonConfigurationClient

        public IntegrationDaemonConfigurationClient​(java.lang.String adminUserId,
                                                    java.lang.String serverName,
                                                    java.lang.String serverPlatformRootURL)
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • IntegrationDaemonConfigurationClient

        public IntegrationDaemonConfigurationClient​(java.lang.String adminUserId,
                                                    java.lang.String serverName,
                                                    java.lang.String serverPlatformRootURL,
                                                    java.lang.String connectionUserId,
                                                    java.lang.String connectionPassword)
                                             throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException
        Create a new client that passes a connection userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is passed as the admin userId.
        Parameters:
        adminUserId - administrator's (end user's) userId to associate with calls.
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the admin services
        connectionUserId - caller's system userId embedded in all HTTP requests
        connectionPassword - caller's system password embedded in all HTTP requests
        Throws:
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • getRegisteredIntegrationServices

        public java.util.List<RegisteredOMAGService> getRegisteredIntegrationServices()
                                                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of integration services for this server.
        Returns:
        list of integration service descriptions
        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.
      • getConfiguredIntegrationServices

        public java.util.List<RegisteredOMAGService> getConfiguredIntegrationServices()
                                                                               throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                      org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the list of integration services for this server.
        Returns:
        list of integration service descriptions
        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.
      • getIntegrationServicesConfiguration

        public java.util.List<IntegrationServiceConfig> getIntegrationServicesConfiguration()
                                                                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the configuration for the integration services in this server.
        Returns:
        list of integration service configuration
        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.
      • getIntegrationServiceConfiguration

        public IntegrationServiceConfig getIntegrationServiceConfiguration​(java.lang.String serviceURLMarker)
                                                                    throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                                           org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Return the configuration for the named integration service for this server.
        Parameters:
        serviceURLMarker - integration service name used in URL
        Returns:
        response containing the integration services configuration
        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.
      • configureIntegrationService

        public void configureIntegrationService​(java.lang.String partnerOMASServerURLRoot,
                                                java.lang.String partnerOMASServerName,
                                                java.lang.String serviceURLMarker,
                                                java.util.Map<java.lang.String,​java.lang.Object> integrationServiceOptions,
                                                java.util.List<IntegrationConnectorConfig> integrationConnectorConfigs)
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Enable a single integration service.
        Parameters:
        partnerOMASServerURLRoot - URL root of the OMAG Server Platform where the access service used by this integration service is running
        partnerOMASServerName - name of server where the access service used by this integration service is running
        serviceURLMarker - string indicating which integration service it is configuring
        integrationServiceOptions - property name/value pairs used to configure the integration service
        integrationConnectorConfigs - Connection 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 parameter.
        org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException - unusual state in the admin server.
      • disableIntegrationService

        public void disableIntegrationService​(java.lang.String serviceURLMarker)
                                       throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                              org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                              org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable a single integration service.
        Parameters:
        serviceURLMarker - string indicating which integration service it is configuring
        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.
      • configureIntegrationService

        public void configureIntegrationService​(IntegrationServiceConfig serviceConfig)
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Add configuration for a single integration service to the server's config document.
        Parameters:
        serviceConfig - all values to configure an integration service
        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.
      • setIntegrationServicesConfig

        public void setIntegrationServicesConfig​(java.util.List<IntegrationServiceConfig> integrationServicesConfig)
                                          throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                 org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Set up the configuration for all the open metadata integration services (OMISs). This overrides the current values.
        Parameters:
        integrationServicesConfig - list of configuration properties for each integration service.
        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.
      • clearAllIntegrationServices

        public void clearAllIntegrationServices()
                                         throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                                org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable the integration services. This removes all configuration for the integration daemon.
        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.
      • clearIntegrationService

        public void clearIntegrationService​(java.lang.String serviceURLMarker)
                                     throws org.odpi.openmetadata.adminservices.ffdc.exception.OMAGNotAuthorizedException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGInvalidParameterException,
                                            org.odpi.openmetadata.adminservices.ffdc.exception.OMAGConfigurationErrorException
        Disable the integration services. This removes all configuration for the integration daemon.
        Parameters:
        serviceURLMarker - integration service name used in URL
        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.