Class OMAGServerAdminForIntegrationServices


  • public class OMAGServerAdminForIntegrationServices
    extends java.lang.Object
    OMAGServerAdminForIntegrationServices provides the server-side support for the services that add integration services configuration to an OMAG Server.
    • Constructor Detail

      • OMAGServerAdminForIntegrationServices

        public OMAGServerAdminForIntegrationServices()
        Default constructor
    • Method Detail

      • getRegisteredIntegrationServices

        public RegisteredOMAGServicesResponse getRegisteredIntegrationServices​(java.lang.String userId,
                                                                               java.lang.String serverName)
        Return the list of integration services that are configured for this server. If you want to see the configuration for these services, use the getIntegrationServicesConfiguration.
        Parameters:
        userId - calling user
        serverName - name of server
        Returns:
        list of integration service descriptions
      • getIntegrationServicesConfiguration

        public IntegrationServicesResponse getIntegrationServicesConfiguration​(java.lang.String userId,
                                                                               java.lang.String serverName)
        Return the list of integration services that are configured for this server.
        Parameters:
        userId - calling user
        serverName - name of server
        Returns:
        list of access service configurations
      • getIntegrationServiceConfiguration

        public IntegrationServiceConfigResponse getIntegrationServiceConfiguration​(java.lang.String userId,
                                                                                   java.lang.String serverName,
                                                                                   java.lang.String serviceURLMarker)
        Return the configuration for the requested integration service that is configured for this server.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - integration service name used in URL
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serviceURLMarker parameter.
      • configureIntegrationService

        public VoidResponse configureIntegrationService​(java.lang.String userId,
                                                        java.lang.String serverName,
                                                        java.lang.String serviceURLMarker,
                                                        IntegrationServiceRequestBody requestBody)
        Enable a single registered integration service. This builds the integration service configuration for the server's config document.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - integration service name used in URL
        requestBody - minimum values to configure an integration service
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.
      • configureIntegrationService

        public VoidResponse configureIntegrationService​(java.lang.String userId,
                                                        java.lang.String serverName,
                                                        IntegrationServiceConfig serviceConfig)
        Add configuration for a single integration service to the server's config document.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceConfig - all values to configure an integration service
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or OMAGInvalidParameterException invalid serverName parameter.
      • setIntegrationServicesConfig

        public VoidResponse setIntegrationServicesConfig​(java.lang.String userId,
                                                         java.lang.String serverName,
                                                         java.util.List<IntegrationServiceConfig> integrationServicesConfig)
        Set up the configuration for all the open metadata integration services (OMISs). This overrides the current values.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        integrationServicesConfig - list of configuration properties for each integration service.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or integrationServicesConfig parameter.
      • clearAllIntegrationServices

        public VoidResponse clearAllIntegrationServices​(java.lang.String userId,
                                                        java.lang.String serverName)
        Disable the integration services. This removes all configuration for the integration services and disables the enterprise repository services.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.
      • clearIntegrationService

        public VoidResponse clearIntegrationService​(java.lang.String userId,
                                                    java.lang.String serverName,
                                                    java.lang.String serviceURLMarker)
        Remove an integration service. This removes all configuration for the integration service.
        Parameters:
        userId - user that is issuing the request.
        serverName - local server name.
        serviceURLMarker - integration service name used in URL
        Returns:
        void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter.