Package org.odpi.openmetadata.adminservices.server

Class OMAGServerAdminForViewServices

java.lang.Object
org.odpi.openmetadata.adminservices.server.OMAGServerAdminForViewServices
public class OMAGServerAdminForViewServices extends Object
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 userId, String serverName)
      Return the list of view services that are configured for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      list of view service descriptions

    • getViewServicesConfiguration

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

    • setViewServicesConfiguration

      public VoidResponse setViewServicesConfiguration(String userId, String serverName, 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:
      userId - calling user
      serverName - name of server
      viewServiceConfigs - list of configured view services
      Returns:
      void

    • getViewServiceConfig

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

    • configureViewService

      public VoidResponse configureViewService(String userId, String serverName, String serviceURLMarker, ViewServiceRequestBody requestBody)
      Configure a single view service.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - view service name used in URL
      requestBody - view service config
      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.

    • configureAllViewServices

      public VoidResponse configureAllViewServices(String userId, String serverName, 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:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - requested View Service Config containing the OMAGServerName and OMAGServerRootPlatformURL, view service options and resource endpoints
      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.

    • clearViewService

      public VoidResponse clearViewService(String userId, String serverName, String serviceURLMarker)
      Remove a view service. This removes all configuration for the view service.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - view 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.

    • clearAllViewServices

      public VoidResponse clearAllViewServices(String userId, String serverName)
      Disable the view services. This removes all configuration for the view 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.