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
VoidResponse	clearAllViewServices(String userId, String serverName)	Disable the view services.
VoidResponse	clearViewService(String userId, String serverName, String serviceURLMarker)	Remove the config for a view service.
VoidResponse	configureViewService(String userId, String serverName, String serviceURLMarker, ViewServiceConfig requestBody)	Configure a single view service.
RegisteredOMAGServicesResponse	getConfiguredViewServices(String userId, String serverName)	Return the list of view services that are configured for this server.
ViewServiceConfigResponse	getViewServiceConfig(String userId, String serverName, String serviceURLMarker)	Return the configuration of a specific view service.
ViewServicesResponse	getViewServicesConfiguration(String userId, String serverName)	Return the view services configuration for this server.
VoidResponse	setViewServicesConfig(String userId, String serverName, List<ViewServiceConfig> viewServicesConfig)	Set up the configuration for selected open metadata view services (OMVSs).

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigViewServicesResource

public ConfigViewServicesResource()

Method Detail

getConfiguredViewServices

@GetMapping(path="/view-services")
public 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 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

getViewServiceConfig

@GetMapping("/view-services/{serviceURLMarker}")
public 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 VoidResponse configureViewService(@PathVariable
                                         String userId,
                                         @PathVariable
                                         String serverName,
                                         @PathVariable
                                         String serviceURLMarker,
                                         @RequestBody
                                         ViewServiceConfig 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.

setViewServicesConfig

@PostMapping(path="/view-services/configuration")
public VoidResponse setViewServicesConfig(@PathVariable
                                          String userId,
                                          @PathVariable
                                          String serverName,
                                          @RequestBody
                                          List<ViewServiceConfig> viewServicesConfig)

Set up the configuration for selected open metadata view services (OMVSs). This overrides the current default values.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

viewServicesConfig - list of configuration properties for each view service.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or viewServicesConfig parameter or OMAGConfigurationErrorException unusual state in the admin server.

clearViewService

@DeleteMapping(path="/view-services/{serviceURLMarker}")
public 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 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.