Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForViewServices

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

  • Constructor Details

    • OMAGServerAdminForViewServices

      public OMAGServerAdminForViewServices()
      Default constructor

  • Method Details

    • getConfiguredViewServices

      public RegisteredOMAGServicesResponse getConfiguredViewServices(String serverName, String delegatingUserId)
      Return the list of view services that are configured for this server.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      Returns:
      list of view service descriptions

    • getViewServicesConfiguration

      public ViewServicesResponse getViewServicesConfiguration(String serverName, String delegatingUserId)
      Return the view services configuration for this server.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      Returns:
      view services response

    • setViewServicesConfiguration

      public VoidResponse setViewServicesConfiguration(String serverName, String delegatingUserId, List<ViewServiceConfig> viewServiceConfigs)
      Add the view services configuration for this server as a single call. This operation is used for editing existing view service configuration.
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      viewServiceConfigs - list of configured view services
      Returns:
      void

    • getViewServiceConfig

      public ViewServiceConfigResponse getViewServiceConfig(String serverName, String delegatingUserId, String serviceURLMarker)
      Return the configuration of a single view service
      Parameters:
      serverName - name of server
      delegatingUserId - external userId making request
      serviceURLMarker - server URL marker identifying the view service
      Returns:
      view services response

    • configureViewService

      public VoidResponse configureViewService(String serverName, String delegatingUserId, String serviceURLMarker, ViewServiceRequestBody requestBody)
      Configure a single view service.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      serviceURLMarker - view service name used in URL
      requestBody - view service config
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • configureAllViewServices

      public VoidResponse configureAllViewServices(String serverName, String delegatingUserId, ViewServiceRequestBody requestBody)
      Enable all view services that are registered with this server platform. The configuration properties for each view service can be changed from their default using setViewServicesConfig operation.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      requestBody - requested View Service Config containing the OMAGServerName and OMAGServerRootPlatformURL, view service options and resource endpoints
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException the event bus has not been configured or InvalidParameterException invalid serverName parameter.

    • clearViewService

      public VoidResponse clearViewService(String serverName, String delegatingUserId, String serviceURLMarker)
      Remove a view service. This removes all configuration for the view service.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      serviceURLMarker - view service name used in URL
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName parameter.

    • clearAllViewServices

      public VoidResponse clearAllViewServices(String serverName, String delegatingUserId)
      Disable the view services. This removes all configuration for the view services and disables the enterprise repository services.
      Parameters:
      serverName - local server name.
      delegatingUserId - external userId making request
      Returns:
      void response or UserNotAuthorizedException the supplied userId is not authorized to issue this command or InvalidParameterException invalid serverName parameter.