step.plugins.notification

Class NotificationServices

java.lang.Object

step.core.deployment.AbstractServices

step.plugins.notification.NotificationServices

@Singleton
 @Path(value="notifications")
public class NotificationServices
extends step.core.deployment.AbstractServices

Field Summary

Fields

Modifier and Type	Field and Description
protected NotificationEngine	notificationEngine
protected NotificationGatewayConfigurationAccessor	notificationGatewayConfigurationAccessor
protected NotificationSubscriptionAccessor	notificationSubscriptionAccessor

Fields inherited from class step.core.deployment.AbstractServices

configuration, controller

Constructor Summary

Constructors

Constructor and Description
NotificationServices()

Method Summary

Modifier and Type	Method and Description
void	deleteNotificationGatewayConfiguration(String id)
void	deleteNotificationSubscription(String id)
NotificationGatewayConfiguration	getNotificationGatewayConfiguration(String id)
List<NotificationGatewayConfiguration>	getNotificationGatewayConfigurations()
List<String>	getNotificationGatewayNames()
NotificationSubscription	getNotificationSubscription(String id)
List<NotificationSubscription>	getNotificationSubscriptionsByPlanRef(step.core.repositories.RepositoryObjectReference planRef)
void	init()
void	saveNotificationGatewayConfiguration(NotificationGatewayConfiguration gatewayConfiguration)
void	saveNotificationSubscription(NotificationSubscription subscription)

Methods inherited from class step.core.deployment.AbstractServices

getContext, getExecutionRunnable, getObjectDrainer, getObjectEnricher, getScheduler, getSession, setSession

Methods inherited from class java.lang.Object

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

Field Detail

notificationGatewayConfigurationAccessor

protected NotificationGatewayConfigurationAccessor notificationGatewayConfigurationAccessor

notificationSubscriptionAccessor

protected NotificationSubscriptionAccessor notificationSubscriptionAccessor

notificationEngine

protected NotificationEngine notificationEngine

Constructor Detail

NotificationServices

public NotificationServices()

Method Detail

init

@PostConstruct
public void init()
                          throws Exception

Overrides:

init in class step.core.deployment.AbstractServices

Throws:

Exception

saveNotificationGatewayConfiguration

@POST
 @Consumes(value="application/json")
 @Path(value="/gateway")
public void saveNotificationGatewayConfiguration(NotificationGatewayConfiguration gatewayConfiguration)

getNotificationGatewayConfiguration

@GET
 @Consumes(value="application/json")
 @Path(value="/gateway/{id}")
public NotificationGatewayConfiguration getNotificationGatewayConfiguration(@PathParam(value="id")
                                                                                                                                                       String id)

deleteNotificationGatewayConfiguration

@DELETE
 @Consumes(value="application/json")
 @Path(value="/gateway/{id}")
public void deleteNotificationGatewayConfiguration(@PathParam(value="id")
                                                                                                                                 String id)

getNotificationGatewayConfigurations

@GET
 @Consumes(value="application/json")
 @Path(value="/gateway/list")
public List<NotificationGatewayConfiguration> getNotificationGatewayConfigurations()

saveNotificationSubscription

@POST
 @Consumes(value="application/json")
 @Path(value="/subscription")
public void saveNotificationSubscription(NotificationSubscription subscription)

getNotificationSubscription

@GET
 @Consumes(value="application/json")
 @Path(value="/subscription/{id}")
public NotificationSubscription getNotificationSubscription(@PathParam(value="id")
                                                                                                                                            String id)

deleteNotificationSubscription

@DELETE
 @Consumes(value="application/json")
 @Path(value="/subscription/{id}")
public void deleteNotificationSubscription(@PathParam(value="id")
                                                                                                                              String id)

getNotificationSubscriptionsByPlanRef

@POST
 @Consumes(value="application/json")
 @Path(value="/subscription/byplan")
public List<NotificationSubscription> getNotificationSubscriptionsByPlanRef(step.core.repositories.RepositoryObjectReference planRef)

getNotificationGatewayNames

@GET
 @Consumes(value="application/json")
 @Path(value="/gateway/list/names")
public List<String> getNotificationGatewayNames()

Returns:

the names of the available gateways. This service is needed for the definition of new subscriptions and is thus requiring the right notification-subscription-write