org.odpi.openmetadata.adminservices.spring

Class ConfigViewServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigViewServicesResource

@RestController
 @RequestMapping(value="/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 and Description
ConfigViewServicesResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearAllViewServices(String userId, String serverName) Disable the view services.
VoidResponse	configureAllViewServices(String userId, String serverName, Map<String,Object> viewServiceOptions) Enable all view services that are registered with this server platform.
VoidResponse	configureViewService(String userId, String serverName, String serviceURLMarker, Map<String,Object> viewServiceOptions) Configure a single view service.
RegisteredOMAGServicesResponse	getConfiguredViewServices(String userId, String serverName) Return the list of registered view services that are configured for this server.
ViewServicesResponse	getViewServices(String userId, String serverName) Return the list of view services 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/configuration")
public RegisteredOMAGServicesResponse getConfiguredViewServices(@PathVariable
                                                                                                                 String userId,
                                                                                                                 @PathVariable
                                                                                                                 String serverName)

Return the list of registered view services that are configured for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

list of view service descriptions

getViewServices

@GetMapping(value="/view-services")
public ViewServicesResponse getViewServices(@PathVariable
                                                                                String userId,
                                                                                @PathVariable
                                                                                String serverName)

Return the list of view services for this server.

Parameters:

userId - calling user

serverName - name of server

Returns:

response containing the list of enabled view services

configureViewService

@PostMapping(path="/view-services/{serviceURLMarker}")
public VoidResponse configureViewService(@PathVariable
                                                                                                String userId,
                                                                                                @PathVariable
                                                                                                String serverName,
                                                                                                @PathVariable
                                                                                                String serviceURLMarker,
                                                                                                @RequestBody(required=false)
                                                                                                Map<String,Object> viewServiceOptions)

Configure a single view service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

viewServiceOptions - view service options

serviceURLMarker - string indicating which view service it is configuring

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(value="/view-services")
public VoidResponse configureAllViewServices(@PathVariable
                                                                                  String userId,
                                                                                  @PathVariable
                                                                                  String serverName,
                                                                                  @RequestBody(required=false)
                                                                                  Map<String,Object> viewServiceOptions)

Enable all view services that are registered with this server platform. The view services are set up to use the default event bus.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

viewServiceOptions - view service options

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.

clearAllViewServices

@DeleteMapping(value="/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.

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.