org.odpi.openmetadata.adminservices.spring

Class ConfigDiscoveryEngineResource

java.lang.Object

org.odpi.openmetadata.adminservices.spring.ConfigDiscoveryEngineResource

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

ConfigDiscoveryEngineResource provides the API for configuring a discovery engine in an OMAG server.

Constructor Summary

Constructors

Constructor and Description
ConfigDiscoveryEngineResource()

Method Summary

Modifier and Type	Method and Description
VoidResponse	setAccessServiceRootURL(String userId, String serverName, String accessServiceRootURL) Set up the root URL of the OMAG Server Platform where the metadata repository for the discovery engines is located.
VoidResponse	setAccessServiceServerName(String userId, String serverName, String accessServiceServerName) Set up the server name of the Discovery Engine OMAS.
VoidResponse	setDiscoveryEngines(String userId, String serverName, List<String> discoveryEngines) Set up the list of discovery engines that are to run in the discovery service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigDiscoveryEngineResource

public ConfigDiscoveryEngineResource()

Method Detail

setAccessServiceRootURL

@RequestMapping(method=POST,
                path="access-service-root-url")
public VoidResponse setAccessServiceRootURL(@PathVariable
                                                                                                                         String userId,
                                                                                                                         @PathVariable
                                                                                                                         String serverName,
                                                                                                                         @RequestParam
                                                                                                                         String accessServiceRootURL)

Set up the root URL of the OMAG Server Platform where the metadata repository for the discovery engines is located.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServiceRootURL - URL root for the access service.

Returns:

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

setAccessServiceServerName

@RequestMapping(method=POST,
                path="access-service-server-name")
public VoidResponse setAccessServiceServerName(@PathVariable
                                                                                                                               String userId,
                                                                                                                               @PathVariable
                                                                                                                               String serverName,
                                                                                                                               @RequestParam
                                                                                                                               String accessServiceServerName)

Set up the server name of the Discovery Engine OMAS.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

accessServiceServerName - server name for the access service.

Returns:

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

setDiscoveryEngines

@RequestMapping(method=POST,
                path="set-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.

Parameters:

userId - user that is issuing the request.

serverName - local server name.

discoveryEngines - discoveryEngines for topic.

Returns:

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