Package org.odpi.openmetadata.accessservices.assetmanager.server.spring

Class AssetManagerOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.server.spring.AssetManagerOMASResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}")
public class AssetManagerOMASResource
extends Object

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

Constructor Summary

Constructors

Constructor	Description
AssetManagerOMASResource()	Instantiates a new Asset Manager OMAS resource.

Method Summary

Modifier and Type	Method	Description
GUIDResponse	createExternalAssetManager(String serverName, String userId, AssetManagerProperties assetManagerProperties)	Create information about the external asset manager.
GUIDResponse	getExternalAssetManagerGUID(String serverName, String userId, String qualifiedName)	Retrieve the unique identifier of the external asset manager from its qualified name.
OCFConnectionResponse	getOutTopicConnection(String serverName, String userId, String callerId)	Return the connection object for the Asset Manager OMAS's out topic.

Methods inherited from class java.lang.Object

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

Constructor Details

AssetManagerOMASResource

public AssetManagerOMASResource()

Instantiates a new Asset Manager OMAS resource.

Method Details

getOutTopicConnection

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

Return the connection object for the Asset Manager OMAS's out topic.

Parameters:

serverName - name of the server to route the request to

userId - identifier of calling user

callerId - unique identifier for the caller

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.

createExternalAssetManager

@PostMapping(path="/asset-managers")
public GUIDResponse createExternalAssetManager(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @RequestBody
 AssetManagerProperties assetManagerProperties)

Create information about the external asset manager. This is represented as a software server capability and all information that is specific to the external asset manager (such as the identifiers of the metadata elements it stores) will be linked to it.

Parameters:

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

userId - calling user

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

Returns:

unique identifier of the asset management's software server capability or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server

getExternalAssetManagerGUID

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

Retrieve the unique identifier of the external asset manager from its qualified name. Typically, the qualified name comes from the integration connector configuration.

Parameters:

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

userId - calling user

qualifiedName - unique name to use for the external asset

Returns:

unique identifier of the external asset manager's software server capability or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException user not authorized to issue this request PropertyServerException problem accessing the property server