Package com.broadleafcommerce.notification.web.endpoint

Class NotificationEndpoint

java.lang.Object

com.broadleafcommerce.notification.web.endpoint.NotificationEndpoint

@FrameworkRestController
@FrameworkMapping("/notifications")
public class NotificationEndpoint
extends Object

Author:

BroadleafCommerce

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NOTIFICATION_LOCATION_URI

Constructor Summary

Constructors

Constructor	Description
NotificationEndpoint(NotificationService<Notification> notificationService)

Method Summary

Modifier and Type	Method	Description
Notification	createNewNotification(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Notification notification)	Creates a brand new Notification.
void	deleteNotification(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)	Deletes or archives an existing Notification.
protected NotificationService<Notification>	getNotificationService()
Notification	readNotificationByContextId(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Reads an Notification by context ID.
NotificationResponse	sendNotification(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, Notification notification)
Notification	updateNotification(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Notification notification)	Updates an existing Notification.

Methods inherited from class java.lang.Object

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

Field Details

NOTIFICATION_LOCATION_URI

public static final String NOTIFICATION_LOCATION_URI

See Also:

• Constant Field Values

Constructor Details

NotificationEndpoint

public NotificationEndpoint(NotificationService<Notification> notificationService)

Method Details

sendNotification

@Policy(permissionRoots="SEND_NOTIFICATION")
@FrameworkPostMapping(value="/sendNotification",
                      consumes="application/json")
public NotificationResponse sendNotification(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 Notification notification)

Parameters:

notification -

contextInfo -

Returns:

createNewNotification

@Policy(permissionRoots="NOTIFICATION")
@FrameworkPostMapping(consumes="application/json")
public Notification createNewNotification(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 Notification notification)

Creates a brand new Notification.

Parameters:

context -

notification -

Returns:

readNotificationByContextId

@Policy(permissionRoots="NOTIFICATION")
@FrameworkGetMapping("/{id}")
public Notification readNotificationByContextId(@PathVariable("id")
 String id,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Reads an Notification by context ID.

Parameters:

id -

context -

Returns:

updateNotification

@Policy(permissionRoots="NOTIFICATION")
@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
public Notification updateNotification(@PathVariable("id")
 String id,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 Notification notification)

Updates an existing Notification.

Parameters:

id -

context -

notification -

Returns:

deleteNotification

@Policy(permissionRoots="NOTIFICATION")
@FrameworkDeleteMapping("/{id}")
public void deleteNotification(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

Deletes or archives an existing Notification.

Parameters:

context -

id -

getNotificationService

@NonNull
protected NotificationService<Notification> getNotificationService()