org.odpi.openmetadata.accessservices.datamanager.server.spring

Class DataManagerOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.server.spring.DataManagerOMASResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/data-manager/users/{userId}")
public class DataManagerOMASResource
extends Object

Server-side REST API support for data manager independent REST endpoints

Constructor Summary

Constructors

Constructor and Description
DataManagerOMASResource() Instantiates a new Data Manager OMAS resource.

Method Summary

Modifier and Type	Method and Description
GUIDResponse	createDataManagerIntegrator(String serverName, String userId, SoftwareServerCapabilitiesProperties integratorCapabilities) Create information about the integration daemon that is managing the acquisition of metadata from the data manager.
GUIDResponse	getDataManagerIntegratorGUID(String serverName, String userId, String qualifiedName) Retrieve the unique identifier of the integration daemon.
ConnectionResponse	getOutTopicConnection(String serverName, String userId) Return the connection object for the Discovery Engine OMAS's out topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataManagerOMASResource

public DataManagerOMASResource()

Instantiates a new Data Manager OMAS resource.

Method Detail

getOutTopicConnection

@GetMapping(path="/topics/out-topic-connection")
public ConnectionResponse getOutTopicConnection(@PathVariable
                                                                                                 String serverName,
                                                                                                 @PathVariable
                                                                                                 String userId)

Return the connection object for the Discovery Engine OMAS's out topic.

Parameters:

serverName - name of the server to route the request to.

userId - identifier of calling user.

Returns:

connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

createDataManagerIntegrator

@PostMapping(path="/integrators")
public GUIDResponse createDataManagerIntegrator(@PathVariable
                                                                                  String serverName,
                                                                                  @PathVariable
                                                                                  String userId,
                                                                                  @RequestBody
                                                                                  SoftwareServerCapabilitiesProperties integratorCapabilities)

Create information about the integration daemon that is managing the acquisition of metadata from the data manager. Typically this is Egeria's data manager proxy.

Parameters:

serverName - name of the server to route the request to.

userId - calling user

integratorCapabilities - description of the integration daemon (specify qualified name at a minimum)

Returns:

unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

getDataManagerIntegratorGUID

@GetMapping(path="integrators/by-name/{qualifiedName}")
public GUIDResponse getDataManagerIntegratorGUID(@PathVariable
                                                                                                         String serverName,
                                                                                                         @PathVariable
                                                                                                         String userId,
                                                                                                         @PathVariable
                                                                                                         String qualifiedName)

Retrieve the unique identifier of the integration daemon.

Parameters:

serverName - name of the server to route the request to.

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server