Package org.odpi.openmetadata.viewservices.serverauthor.server.spring

Class ConfigViewServicesViewResource

java.lang.Object

org.odpi.openmetadata.viewservices.serverauthor.server.spring.ConfigViewServicesViewResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/view-services/server-author/users/{userId}/servers/{serverToBeConfiguredName}")
public class ConfigViewServicesViewResource
extends Object

ConfigViewServicesResource provides the configuration for setting up the Open Metadata View Services (OMVSs).

Constructor Summary

Constructors

Constructor	Description
ConfigViewServicesViewResource()

Method Summary

Modifier and Type	Method	Description
ServerAuthorConfigurationResponse	configureViewService(String userId, String serverName, String serverToBeConfiguredName, String serviceURLMarker, Map<String,Object> viewServiceOptions)	Enable a single view service.
ServerAuthorConfigurationResponse	disableViewService(String userId, String serverName, String serverToBeConfiguredName, String serviceURLMarker)	Disable a single view service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigViewServicesViewResource

public ConfigViewServicesViewResource()

Method Detail

configureViewService

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

Enable a single view service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serverToBeConfiguredName - name of the server to be configured.

viewServiceOptions - property name/value pairs used to configure the view services

serviceURLMarker - string indicating which view service it is configuring

Returns:

the current stored configuration 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.

disableViewService

@DeleteMapping(path="/view-services/{serviceURLMarker}")
public ServerAuthorConfigurationResponse disableViewService(@PathVariable
                                                            String userId,
                                                            @PathVariable
                                                            String serverName,
                                                            @PathVariable
                                                            String serverToBeConfiguredName,
                                                            @PathVariable
                                                            String serviceURLMarker)

Disable a single view service.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

serverToBeConfiguredName - name of the server to be configured.

serviceURLMarker - string indicating which view service it is configuring

Returns:

the current stored configuration 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.