Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForIntegrationServices

java.lang.Object
org.odpi.openmetadata.adminservices.server.OMAGServerAdminForIntegrationServices
public class OMAGServerAdminForIntegrationServices extends Object
OMAGServerAdminForIntegrationServices provides the server-side support for the services that add integration services configuration to an OMAG Server.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OMAGServerAdminForIntegrationServices()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAllIntegrationServices(String userId, String serverName)
    Disable the integration services.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearIntegrationService(String userId, String serverName, String serviceURLMarker)
    Remove an integration service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureIntegrationService(String userId, String serverName, String serviceURLMarker, org.odpi.openmetadata.adminservices.rest.IntegrationServiceRequestBody requestBody)
    Enable a single registered integration service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureIntegrationService(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.IntegrationServiceConfig serviceConfig)
    Add configuration for a single integration service to the server's config document.
    org.odpi.openmetadata.adminservices.rest.IntegrationServiceConfigResponse
    getIntegrationServiceConfiguration(String userId, String serverName, String serviceURLMarker)
    Return the configuration for the requested integration service that is configured for this server.
    org.odpi.openmetadata.adminservices.rest.IntegrationServicesResponse
    getIntegrationServicesConfiguration(String userId, String serverName)
    Return the list of integration services that are configured for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse
    getRegisteredIntegrationServices(String userId, String serverName)
    Return the list of integration services that are configured for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setIntegrationServicesConfig(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.IntegrationServiceConfig> integrationServicesConfig)
    Set up the configuration for all the open metadata integration services (OMISs).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OMAGServerAdminForIntegrationServices

      public OMAGServerAdminForIntegrationServices()
      Default constructor

  • Method Details

    • getRegisteredIntegrationServices

      public org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse getRegisteredIntegrationServices(String userId, 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 org.odpi.openmetadata.adminservices.rest.IntegrationServicesResponse getIntegrationServicesConfiguration(String userId, 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 integration service configurations

    • getIntegrationServiceConfiguration

      public org.odpi.openmetadata.adminservices.rest.IntegrationServiceConfigResponse getIntegrationServiceConfiguration(String userId, String serverName, 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureIntegrationService(String userId, String serverName, String serviceURLMarker, org.odpi.openmetadata.adminservices.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureIntegrationService(String userId, String serverName, org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setIntegrationServicesConfig(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAllIntegrationServices(String userId, 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearIntegrationService(String userId, String serverName, 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.