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

Class GovernanceServerOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.governanceserver.server.spring.GovernanceServerOMASResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-server/users/{userId}")
public class GovernanceServerOMASResource
extends Object

GovernanceServerOMASResource supports the REST APIs for running governance servers.

Constructor Summary

Constructors

Constructor	Description
GovernanceServerOMASResource()

Method Summary

Modifier and Type	Method	Description
OCFConnectionResponse	getOutTopicConnection(String serverName, String userId, String callerId)	Return the connection object for the Governance Server OMAS's out topic.
VoidResponse	logAssetAuditMessage(String serverName, String userId, String assetGUID, String governanceService, String message)	Log an audit message about an asset.

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceServerOMASResource

public GovernanceServerOMASResource()

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 Governance Server OMAS's out topic.

Parameters:

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

userId - identifier of calling user.

callerId - unique identifier of 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 topic connection.

logAssetAuditMessage

@PostMapping(path="/assets/{assetGUID}/log-records/{governanceService}")
public VoidResponse logAssetAuditMessage(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String assetGUID,
 @PathVariable
 String governanceService,
 @RequestBody
 String message)

Log an audit message about an asset.

Parameters:

serverName - name of server instance to route request to

userId - userId of user making request.

assetGUID - unique identifier for asset.

governanceService - unique name for governance service.

message - message to log

Returns:

void or InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem that occurred within the property server.