Package org.odpi.openmetadata.frameworkservices.oif.server.spring

Class OpenIntegrationResource

java.lang.Object

org.odpi.openmetadata.frameworkservices.oif.server.spring.OpenIntegrationResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/{serviceURLMarker}/open-integration/users/{userId}")
public class OpenIntegrationResource
extends Object

OpenIntegrationResource supports the REST APIs for running the Open Integration Service.

Constructor Summary

Constructors

Constructor	Description
OpenIntegrationResource()

Method Summary

Modifier and Type	Method	Description
GUIDResponse	createMetadataSource(String serverName, String serviceURLMarker, String userId, MetadataSourceRequestBody requestBody)	Create a new metadata element to represent a software capability.
GUIDResponse	getMetadataSourceGUID(String serverName, String serviceURLMarker, String userId, NameRequestBody requestBody)	Retrieve the unique identifier of the software server capability representing a metadata source.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenIntegrationResource

public OpenIntegrationResource()

Method Details

getMetadataSourceGUID

@PostMapping(path="metadata-sources/by-name")
public GUIDResponse getMetadataSourceGUID(@PathVariable
 String serverName,
 @PathVariable
 String serviceURLMarker,
 @PathVariable
 String userId,
 @RequestBody
 NameRequestBody requestBody)

Retrieve the unique identifier of the software server capability representing a metadata source.

Parameters:

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

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

userId - calling user

requestBody - 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

createMetadataSource

@PostMapping(path="/metadata-sources/new")
public GUIDResponse createMetadataSource(@PathVariable
 String serverName,
 @PathVariable
 String serviceURLMarker,
 @PathVariable
 String userId,
 @RequestBody
 MetadataSourceRequestBody requestBody)

Create a new metadata element to represent a software capability. This describes the metadata source.

Parameters:

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

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

userId - calling user

requestBody - properties of the software capability

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