org.odpi.openmetadata.adminservices.spring

Class ConfigDiscoveryEngineServicesResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigDiscoveryEngineServicesResource

@RestController
 @RequestMapping(value="/open-metadata/admin-services/users/{userId}/servers/{serverName}/discovery-engine-services")
public class ConfigDiscoveryEngineServicesResource
extends Object

ConfigDiscoveryEngineServicesResource provides the API for configuring the discovery engine services. These services support the operation of one or more discovery engines in an OMAG server called the Discovery Server. The discovery engine services are a client to the Discovery Engine Open Metadata Access Services (OMAS). The configuration needs to provide the server name and platform URL root where the metadata server running this service is located. They also need a list of the discovery engines to run. The definitions of these discovery engines are stored in the metadata server and are retrieved when the discovery server starts.

Constructor Summary

Constructors

Constructor and Description
ConfigDiscoveryEngineServicesResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearDiscoveryEngineServicesConfig(String userId, String serverName) Remove this service from the server configuration.
DiscoveryEngineServicesConfigResponse	getDiscoveryEngineServicesConfig(String userId, String serverName) Get the configuration for the discovery engine services for this server.
VoidResponse	setClientConfig(String userId, String serverName, OMAGServerClientConfig clientConfig) Set up the name and platform URL root for the metadata server supporting this discovery server.
VoidResponse	setDiscoveryEngines(String userId, String serverName, List<String> discoveryEngines) Set up the list of discovery engines that are to run in the discovery service.
VoidResponse	setDiscoveryEngineServicesConfig(String userId, String serverName, DiscoveryEngineServicesConfig servicesConfig) Add this service to the server configuration in one call.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDiscoveryEngineServicesResource

public ConfigDiscoveryEngineServicesResource()

Method Detail

setClientConfig

@PostMapping(path="/client-config")
public VoidResponse setClientConfig(@PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        String serverName,
                                                                        @RequestBody
                                                                        OMAGServerClientConfig clientConfig)

Set up the name and platform URL root for the metadata server supporting this discovery server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

clientConfig - URL root and server name for the metadata server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

setDiscoveryEngines

@PostMapping(path="/discovery-engines")
public VoidResponse setDiscoveryEngines(@PathVariable
                                                                                String userId,
                                                                                @PathVariable
                                                                                String serverName,
                                                                                @RequestBody
                                                                                List<String> discoveryEngines)

Set up the list of discovery engines that are to run in the discovery service. The definition of these discovery engines

Parameters:

userId - user that is issuing the request.

serverName - local server name.

discoveryEngines - discoveryEngines for server.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGInvalidParameterException invalid serverName or serverType parameter. OMAGConfigurationErrorException unexpected exception.

setDiscoveryEngineServicesConfig

@PostMapping(path="")
public VoidResponse setDiscoveryEngineServicesConfig(@PathVariable
                                                                           String userId,
                                                                           @PathVariable
                                                                           String serverName,
                                                                           @RequestBody
                                                                           DiscoveryEngineServicesConfig servicesConfig)

Add this service to the server configuration in one call.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

servicesConfig - full configuration for the service.

Returns:

void response or OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

getDiscoveryEngineServicesConfig

@GetMapping(path="")
public DiscoveryEngineServicesConfigResponse getDiscoveryEngineServicesConfig(@PathVariable
                                                                                                   String userId,
                                                                                                   @PathVariable
                                                                                                   String serverName)

Get the configuration for the discovery engine services for this server.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

full configuration for the service. OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.

clearDiscoveryEngineServicesConfig

@DeleteMapping(path="")
public VoidResponse clearDiscoveryEngineServicesConfig(@PathVariable
                                                                               String userId,
                                                                               @PathVariable
                                                                               String serverName)

Remove this service from the server configuration.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

Returns:

void response OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or OMAGConfigurationErrorException unexpected exception or OMAGInvalidParameterException invalid serverName parameter.