eu.dnetlib.clients.functionality.alert.ws

Class AlertWebServiceImpl

java.lang.Object

eu.dnetlib.clients.ws.BaseDriverWebService<eu.dnetlib.api.functionality.AlertService>

eu.dnetlib.clients.functionality.alert.ws.AlertWebServiceImpl

All Implemented Interfaces:

eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.AlertService>, AlertWebService, DriverWebService<eu.dnetlib.api.functionality.AlertService>, eu.dnetlib.common.rmi.BaseService

public class AlertWebServiceImpl
extends BaseDriverWebService<eu.dnetlib.api.functionality.AlertService>
implements AlertWebService

This class implements alert web service using a plain alert service.

Author:

thanos@di.uoa.gr

See Also:

AlertWebService, AlertService, AlertWebServiceException

Field Summary

Fields inherited from class eu.dnetlib.clients.ws.BaseDriverWebService

service

Constructor Summary

Constructors

Constructor and Description
AlertWebServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addSubscription(eu.dnetlib.domain.functionality.AlertSubscription subscription) Add a new subscription.
void	addTemplate(eu.dnetlib.domain.functionality.AlertTemplate template) Add a template.
void	alert(URL notificationService, eu.dnetlib.domain.functionality.NotificationEvent event) Alert this service about an event generated by a notification service.
int	countAlertResults(URL notificationService, String queryId, Date date, String resultId) Count the results of an alert.
void	disableSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber) Disable a subscription.
void	enableSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber) Enable a subscription.
eu.dnetlib.domain.functionality.ResultPage	getAlertResults(URL notificationService, String queryId, String resultId, Date fromDate, Date toDate, int limit, int offset) Retrieve a page of the results of an alert.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertSubscription>	getSubscriptions(int pageNumber, int pageSize) Retrieve a page of subscriptions.
SortedSet<eu.dnetlib.domain.functionality.AlertSubscription>	getSubscriptions(String alertMode, String subscriber, int limit, int offset) Retrieve some subscriptions by alert mode and subscriber.
SortedSet<String>	getSupportedAlertModes() Retrieve all the supported modes in which alerts can be sent.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertTemplate>	getTemplates(int pageNumber, int pageSize) Retrieve a page of templates.
void	removeSubscription(String templateId, URL notificationService, String queryId, String resultId, String alertMode, URI subscriber) Remove a subscription.
void	removeTemplate(String templateId) Remove a template.

Methods inherited from class eu.dnetlib.clients.ws.BaseDriverWebService

identify, notify, setService, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Constructor Detail

AlertWebServiceImpl

public AlertWebServiceImpl()

Method Detail

getSupportedAlertModes

public SortedSet<String> getSupportedAlertModes()

Description copied from interface: AlertWebService

Retrieve all the supported modes in which alerts can be sent.

Specified by:

getSupportedAlertModes in interface AlertWebService

Returns:

a sorted set containing all the supported modes in which alerts can be sent

getTemplates

public eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertTemplate> getTemplates(int pageNumber,
                                                                                                              int pageSize)
                                                                                                       throws AlertWebServiceException

Description copied from interface: AlertWebService

Retrieve a page of templates.

Specified by:

getTemplates in interface AlertWebService

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing templates

Throws:

AlertWebServiceException - if any errors occur

addTemplate

public void addTemplate(eu.dnetlib.domain.functionality.AlertTemplate template)
                 throws AlertWebServiceException

Description copied from interface: AlertWebService

Add a template.

Specified by:

addTemplate in interface AlertWebService

Parameters:

template - the template to add

Throws:

AlertWebServiceException - if any errors occur

removeTemplate

public void removeTemplate(String templateId)
                    throws AlertWebServiceException

Description copied from interface: AlertWebService

Remove a template.

Specified by:

removeTemplate in interface AlertWebService

Parameters:

templateId - the unique identifier of the template to remove

Throws:

AlertWebServiceException - if any errors occur

getSubscriptions

public eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.AlertSubscription> getSubscriptions(int pageNumber,
                                                                                                                      int pageSize)
                                                                                                               throws AlertWebServiceException

Description copied from interface: AlertWebService

Retrieve a page of subscriptions.

Specified by:

getSubscriptions in interface AlertWebService

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing subscriptions

Throws:

AlertWebServiceException - if any errors occur

getSubscriptions

public SortedSet<eu.dnetlib.domain.functionality.AlertSubscription> getSubscriptions(String alertMode,
                                                                                     String subscriber,
                                                                                     int limit,
                                                                                     int offset)
                                                                              throws AlertWebServiceException

Description copied from interface: AlertWebService

Retrieve some subscriptions by alert mode and subscriber.

Specified by:

getSubscriptions in interface AlertWebService

Parameters:

alertMode - part of the alert mode to match

subscriber - part of the subscriber URI to match

limit - the maximum number of subscriptions to retrieve

offset - the offset to start at

Returns:

a sorted set of subscriptions

Throws:

AlertWebServiceException - if any errors occur

addSubscription

public void addSubscription(eu.dnetlib.domain.functionality.AlertSubscription subscription)
                     throws AlertWebServiceException

Description copied from interface: AlertWebService

Add a new subscription.

Specified by:

addSubscription in interface AlertWebService

Parameters:

subscription - the subscription to add

Throws:

AlertWebServiceException - if any errors occur

enableSubscription

public void enableSubscription(String templateId,
                               URL notificationService,
                               String queryId,
                               String resultId,
                               String alertMode,
                               URI subscriber)
                        throws AlertWebServiceException

Description copied from interface: AlertWebService

Enable a subscription.

Specified by:

enableSubscription in interface AlertWebService

Parameters:

templateId - the unique identifier of the template of the subscription to enable

notificationService - the URL of the notification service of the subscription to enable

queryId - the unique identifier of the notification query of the subscription to enable

resultId - the unique identifier of the result of the subscription to enable

alertMode - the alert mode of the subscription to enable

subscriber - the URI of the subscriber of the subscription to enable

Throws:

AlertWebServiceException - if any errors occur

disableSubscription

public void disableSubscription(String templateId,
                                URL notificationService,
                                String queryId,
                                String resultId,
                                String alertMode,
                                URI subscriber)
                         throws AlertWebServiceException

Description copied from interface: AlertWebService

Disable a subscription.

Specified by:

disableSubscription in interface AlertWebService

Parameters:

templateId - the unique identifier of the template of the subscription to disable

notificationService - the URL of the notification service of the subscription to disable

queryId - the unique identifier of the notification query of the subscription to disable

resultId - the unique identifier of the result of the subscription to disable

alertMode - the alert mode of the subscription to disable

subscriber - the URI of the subscriber of the subscription to disable

Throws:

AlertWebServiceException - if any errors occur

removeSubscription

public void removeSubscription(String templateId,
                               URL notificationService,
                               String queryId,
                               String resultId,
                               String alertMode,
                               URI subscriber)
                        throws AlertWebServiceException

Description copied from interface: AlertWebService

Remove a subscription.

Specified by:

removeSubscription in interface AlertWebService

Parameters:

templateId - the unique identifier of the template of the subscription to remove

notificationService - the URL of the notification service of the subscription to remove

queryId - the unique identifier of the notification query of the subscription to remove

resultId - the unique identifier of the result of the subscription to remove

alertMode - the alert mode of the subscription to remove

subscriber - the URI of the subscriber of the subscription to remove

Throws:

AlertWebServiceException - if any errors occur

countAlertResults

public int countAlertResults(URL notificationService,
                             String queryId,
                             Date date,
                             String resultId)
                      throws AlertWebServiceException

Description copied from interface: AlertWebService

Count the results of an alert.

Specified by:

countAlertResults in interface AlertWebService

Parameters:

notificationService - the URL of the notification service of the alert results to count

queryId - the unique identifier of the notification query of the alert results to count

date - the date that corresponds to the notification event of the alert results to count

resultId - the unique identifier of the notification result of the alert results to count

Returns:

the total number of the specified alert results

Throws:

AlertWebServiceException

getAlertResults

public eu.dnetlib.domain.functionality.ResultPage getAlertResults(URL notificationService,
                                                                  String queryId,
                                                                  String resultId,
                                                                  Date fromDate,
                                                                  Date toDate,
                                                                  int limit,
                                                                  int offset)
                                                           throws AlertWebServiceException

Description copied from interface: AlertWebService

Retrieve a page of the results of an alert.

Specified by:

getAlertResults in interface AlertWebService

Parameters:

notificationService - the URL of the notification service of the alert results to retrieve

queryId - the unique identfier of the notification query of the alert results to retrieve

resultId - the unique identifier of the notification result of the alert results to retrieve

fromDate - the date from which to retrieve alert results

toDate - the date up to which to retrieve alert results

limit - the maximum number of alert results to retrieve

offset - the offset to start at

Returns:

a result page

Throws:

AlertWebServiceException - if any errors occur

alert

public void alert(URL notificationService,
                  eu.dnetlib.domain.functionality.NotificationEvent event)
           throws AlertWebServiceException

Description copied from interface: AlertWebService

Alert this service about an event generated by a notification service.

Specified by:

alert in interface AlertWebService

Parameters:

notificationService - the URL of the notification service

event - the notification event

Throws:

AlertWebServiceException - if any errors occur