Package org.odpi.openmetadata.viewservices.notificationmanager.server.spring

Class NotificationManagerResource

java.lang.Object

org.odpi.openmetadata.viewservices.notificationmanager.server.spring.NotificationManagerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/notification-manager")
public class NotificationManagerResource
extends Object

The NotificationManagerResource provides part of the server-side implementation of the Notification Manager OMVS. =

Constructor Summary

Constructors

Constructor	Description
NotificationManagerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	detachMonitoredResource(String serverName, String notificationTypeGUID, String elementGUID, DeleteRelationshipRequestBody requestBody)	Detach a monitored resource from a notification type.
VoidResponse	detachNotificationSubscriber(String serverName, String notificationTypeGUID, String elementGUID, DeleteRelationshipRequestBody requestBody)	Detach a subscriber from a notification type.
VoidResponse	linkMonitoredResource(String serverName, String notificationTypeGUID, String elementGUID, NewRelationshipRequestBody requestBody)	Attach a monitored resource to a notification type.
VoidResponse	linkNotificationSubscriber(String serverName, String notificationTypeGUID, String elementGUID, NewRelationshipRequestBody requestBody)	Attach subscriber to a notification type.

Methods inherited from class java.lang.Object

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

Constructor Details

NotificationManagerResource

public NotificationManagerResource()

Default constructor

Method Details

linkMonitoredResource

@PostMapping(path="/notification-types/{notificationTypeGUID}/monitored-resources/{elementGUID}/attach")
public VoidResponse linkMonitoredResource(@PathVariable
 String serverName,
 @PathVariable
 String notificationTypeGUID,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a monitored resource to a notification type.

Parameters:

serverName - name of called server

notificationTypeGUID - unique identifier of the notification type

elementGUID - unique identifier of the element to monitor

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachMonitoredResource

@PostMapping(path="/notification-types/{notificationTypeGUID}/monitored-resources/{elementGUID}/detach")
public VoidResponse detachMonitoredResource(@PathVariable
 String serverName,
 @PathVariable
 String notificationTypeGUID,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a monitored resource from a notification type.

Parameters:

serverName - name of called server

notificationTypeGUID - unique identifier of the notification type

elementGUID - unique identifier of the element to monitor

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkNotificationSubscriber

@PostMapping(path="/notification-types/{notificationTypeGUID}/notification-subscribers/{elementGUID}/attach")
public VoidResponse linkNotificationSubscriber(@PathVariable
 String serverName,
 @PathVariable
 String notificationTypeGUID,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach subscriber to a notification type.

Parameters:

serverName - name of called server

notificationTypeGUID - unique identifier of the notification type

elementGUID - unique identifier of the subscriber element

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

detachNotificationSubscriber

@PostMapping(path="/notification-types/{notificationTypeGUID}/notification-subscribers/{elementGUID}/detach")
public VoidResponse detachNotificationSubscriber(@PathVariable
 String serverName,
 @PathVariable
 String notificationTypeGUID,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a subscriber from a notification type.

Parameters:

serverName - name of called server

notificationTypeGUID - unique identifier of the notification type

elementGUID - unique identifier of the subscriber element

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.