Package org.odpi.openmetadata.adminservices.spring

Class ConfigViewServicesResource

java.lang.Object
org.odpi.openmetadata.adminservices.spring.ConfigViewServicesResource
@RestController @RequestMapping("/open-metadata/admin-services/users/{userId}/servers/{serverName}") public class ConfigViewServicesResource extends Object
ConfigViewServicesResource provides the configuration for setting up the Open Metadata View Services (OMVSs).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigViewServicesResource()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAllViewServices(String userId, String serverName)
    Disable the view services.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearViewService(String userId, String serverName, String serviceURLMarker)
    Remove the config for a view service.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureAllViewServices(String userId, String serverName, org.odpi.openmetadata.adminservices.rest.ViewServiceRequestBody requestBody)
    Enable all view services that are registered with this server platform.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    configureViewService(String userId, String serverName, String serviceURLMarker, org.odpi.openmetadata.adminservices.rest.ViewServiceRequestBody requestBody)
    Configure a single view service.
    org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse
    getConfiguredViewServices(String userId, String serverName)
    Return the list of view services that are configured for this server.
    org.odpi.openmetadata.adminservices.rest.ViewServiceConfigResponse
    getViewServiceConfig(String userId, String serverName, String serviceURLMarker)
    Return the configuration of a specific view service.
    org.odpi.openmetadata.adminservices.rest.ViewServicesResponse
    getViewServicesConfiguration(String userId, String serverName)
    Return the view services configuration for this server.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setViewServicesConfiguration(String userId, String serverName, List<org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig> viewServiceConfigs)
    Add the view services configuration for this server as a single call.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigViewServicesResource

      public ConfigViewServicesResource()

  • Method Details

    • getConfiguredViewServices

      @GetMapping(path="/view-services") public org.odpi.openmetadata.commonservices.ffdc.rest.RegisteredOMAGServicesResponse getConfiguredViewServices(@PathVariable String userId, @PathVariable 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

      @GetMapping(path="/view-services/configuration") public org.odpi.openmetadata.adminservices.rest.ViewServicesResponse getViewServicesConfiguration(@PathVariable String userId, @PathVariable String serverName)
      Return the view services configuration for this server.
      Parameters:
      userId - calling user
      serverName - name of server
      Returns:
      response containing the view services configuration

    • setViewServicesConfiguration

      @PostMapping(path="/view-services/configuration") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setViewServicesConfiguration(@PathVariable String userId, @PathVariable String serverName, @RequestBody List<org.odpi.openmetadata.adminservices.configuration.properties.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

      @GetMapping("/view-services/{serviceURLMarker}") public org.odpi.openmetadata.adminservices.rest.ViewServiceConfigResponse getViewServiceConfig(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker)
      Return the configuration of a specific view service.
      Parameters:
      userId - calling user
      serverName - name of server
      serviceURLMarker - string indicating the view service of interest
      Returns:
      response containing the configuration of the view service

    • configureViewService

      @PostMapping(path="/view-services/{serviceURLMarker}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureViewService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker, @RequestBody org.odpi.openmetadata.adminservices.rest.ViewServiceRequestBody requestBody)
      Configure a single view service.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - string indicating which view service it is configuring
      requestBody - if specified, the view service config containing the remote OMAGServerName and OMAGServerPlatformRootURL that the view service will use.
      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

      @PostMapping(path="/view-services") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse configureAllViewServices(@PathVariable String userId, @PathVariable String serverName, @RequestBody org.odpi.openmetadata.adminservices.rest.ViewServiceRequestBody requestBody)
      Enable all view services that are registered with this server platform.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      requestBody - view service config containing the remote OMAGServerName and OMAGServerPlatformRootURL for view services to use.
      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

      @DeleteMapping(path="/view-services/{serviceURLMarker}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearViewService(@PathVariable String userId, @PathVariable String serverName, @PathVariable String serviceURLMarker)
      Remove the config for a view service.
      Parameters:
      userId - user that is issuing the request.
      serverName - local server name.
      serviceURLMarker - string indicating which view service to clear
      Returns:
      void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName parameter or OMAGConfigurationErrorException unusual state in the admin server.

    • clearAllViewServices

      @DeleteMapping(path="/view-services") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAllViewServices(@PathVariable String userId, @PathVariable String serverName)
      Disable the view services. This removes all configuration for the view 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 or OMAGConfigurationErrorException unusual state in the admin server.