eu.dnetlib.clients.functionality.notification.ws

Class NotificationWebServiceImpl

java.lang.Object

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

eu.dnetlib.clients.functionality.notification.ws.NotificationWebServiceImpl

All Implemented Interfaces:

eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.NotificationService>, NotificationWebService, DriverWebService<eu.dnetlib.api.functionality.NotificationService>, eu.dnetlib.common.rmi.BaseService

public class NotificationWebServiceImpl
extends BaseDriverWebService<eu.dnetlib.api.functionality.NotificationService>
implements NotificationWebService

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

Author:

thanos@di.uoa.gr

See Also:

NotificationWebService, NotificationService, NotificationWebServiceException

Field Summary

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

service

Constructor Summary

Constructors

Constructor and Description
NotificationWebServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addQuery(eu.dnetlib.domain.functionality.NotificationQuery query) Add a query.
void	addSchedule(eu.dnetlib.domain.functionality.NotificationSchedule schedule) Add a schedule.
void	addSubscription(eu.dnetlib.domain.functionality.NotificationSubscription subscription) Add a subscription.
void	disableSchedule(String queryId) Disable a schedule
void	disableSubscription(String queryId, URL alertService) Disable a subscription.
void	enableSchedule(String queryId) Enable a schedule
void	enableSubscription(String queryId, URL alertService) Enable a subscription.
eu.dnetlib.domain.functionality.ResultPage	executeQuery(String queryId, String resultId, Date fromDate, Date toDate, int limit, int offset) Execute a query and return the generated result.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationEvent>	getEvents(int pageNumber, int pageSize) Retrieve a page of events.
eu.dnetlib.domain.functionality.NotificationResult	getPreviousResult(String queryId, Date date, String resultId) Retrieve a result of the previous event of an event of a query.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationQuery>	getQueries(int pageNumber, int pageSize) Retrieve a page of queries.
eu.dnetlib.domain.functionality.NotificationResult	getResult(String queryId, Date date, String resultId) Retrieve a result of an event of a query.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationResult>	getResults(int pageNumber, int pageSize) Retrieve a page of results.
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSchedule>	getSchedules(int pageNumber, int pageSize) Retrieve a page of schedules
eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSubscription>	getSubscriptions(int pageSize, int pageNumber) Retrieve a page of subscriptions
SortedSet<String>	getSupportedQueryLanguages() Retrieve all the supported languages in which queries can be expressed.
void	removeQuery(String queryId) Remove a query.
void	removeSchedule(String queryId) Remove a schedule.
void	removeSubscription(String queryId, URL alertService) Remove a subscription.

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

NotificationWebServiceImpl

public NotificationWebServiceImpl()

Method Detail

getSupportedQueryLanguages

public SortedSet<String> getSupportedQueryLanguages()

Description copied from interface: NotificationWebService

Retrieve all the supported languages in which queries can be expressed.

Specified by:

getSupportedQueryLanguages in interface NotificationWebService

Returns:

a set containing all the supported languages in which queries can be expressed

getQueries

public eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationQuery> getQueries(int pageNumber,
                                                                                                                int pageSize)
                                                                                                         throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Retrieve a page of queries.

Specified by:

getQueries in interface NotificationWebService

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing queries

Throws:

NotificationWebServiceException - if any errors occur

addQuery

public void addQuery(eu.dnetlib.domain.functionality.NotificationQuery query)
              throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Add a query.

Specified by:

addQuery in interface NotificationWebService

Parameters:

query - the query to add

Throws:

NotificationWebServiceException - if any errors occur

removeQuery

public void removeQuery(String queryId)
                 throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Remove a query.

Specified by:

removeQuery in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query to remove

Throws:

NotificationWebServiceException - if any errors occur

executeQuery

public eu.dnetlib.domain.functionality.ResultPage executeQuery(String queryId,
                                                               String resultId,
                                                               Date fromDate,
                                                               Date toDate,
                                                               int limit,
                                                               int offset)
                                                        throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Execute a query and return the generated result.

Specified by:

executeQuery in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query to execute

resultId - the unique result identifier to use

fromDate - the from date to use

toDate - the to date to use

limit - the limit to use

offset - the offset to use

Returns:

a result page containing the generated results

Throws:

NotificationWebServiceException - if any errors occur

getSchedules

public eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationSchedule> getSchedules(int pageNumber,
                                                                                                                     int pageSize)
                                                                                                              throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Retrieve a page of schedules

Specified by:

getSchedules in interface NotificationWebService

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing schedules

Throws:

NotificationWebServiceException - if any errors occur

addSchedule

public void addSchedule(eu.dnetlib.domain.functionality.NotificationSchedule schedule)
                 throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Add a schedule.

Specified by:

addSchedule in interface NotificationWebService

Parameters:

schedule - the schedule to add

Throws:

NotificationWebServiceException - if any errors occur

enableSchedule

public void enableSchedule(String queryId)
                    throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Enable a schedule

Specified by:

enableSchedule in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query whose schedule to enable

Throws:

NotificationWebServiceException - if any errors occur

disableSchedule

public void disableSchedule(String queryId)
                     throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Disable a schedule

Specified by:

disableSchedule in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query whose schedule to disable

Throws:

NotificationWebServiceException - if any errors occur

removeSchedule

public void removeSchedule(String queryId)
                    throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Remove a schedule.

Specified by:

removeSchedule in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query of the schedule to remove

Throws:

NotificationWebServiceException - if any errors occur

getEvents

public eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationEvent> getEvents(int pageNumber,
                                                                                                               int pageSize)
                                                                                                        throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Retrieve a page of events.

Specified by:

getEvents in interface NotificationWebService

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing events

Throws:

NotificationWebServiceException - if any errors occur

getResults

public eu.dnetlib.domain.functionality.ObjectPage<eu.dnetlib.domain.functionality.NotificationResult> getResults(int pageNumber,
                                                                                                                 int pageSize)
                                                                                                          throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Retrieve a page of results.

Specified by:

getResults in interface NotificationWebService

Parameters:

pageNumber - the number of the page to retrieve

pageSize - the size of the page to retrieve

Returns:

an object page containing results

Throws:

NotificationWebServiceException - if any errors occur

getResult

public eu.dnetlib.domain.functionality.NotificationResult getResult(String queryId,
                                                                    Date date,
                                                                    String resultId)
                                                             throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Retrieve a result of an event of a query.

Specified by:

getResult in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query of the event of the result to retrieve

date - the date corresponding to the event of the result to retrieve

resultId - the unique identifier of the result to retrieve

Returns:

the specified result of the specified event of the specified query or null if no such result exists

Throws:

NotificationWebServiceException - if any errors occur

getPreviousResult

public eu.dnetlib.domain.functionality.NotificationResult getPreviousResult(String queryId,
                                                                            Date date,
                                                                            String resultId)
                                                                     throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Retrieve a result of the previous event of an event of a query.

Specified by:

getPreviousResult in interface NotificationWebService

Parameters:

queryId - the unique identifier of the query of the event of the result to retrieve

date - the date corresponding to the next event of the event whose result to retrieve

resultId - the unique identifier of the result to retrieve

Returns:

the specified result of the previous event of the specified event of the specified query or null if no such result exists

Throws:

NotificationWebServiceException - if any errors occur

getSubscriptions

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

Description copied from interface: NotificationWebService

Retrieve a page of subscriptions

Specified by:

getSubscriptions in interface NotificationWebService

Parameters:

pageSize - the number of the page to retrieve

pageNumber - the size of the page to retrieve

Returns:

an object page containing subscriptions

Throws:

NotificationWebServiceException - if any errors occur

addSubscription

public void addSubscription(eu.dnetlib.domain.functionality.NotificationSubscription subscription)
                     throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Add a subscription.

Specified by:

addSubscription in interface NotificationWebService

Parameters:

subscription - the subscription to add

Throws:

NotificationWebServiceException - if any errors occur

enableSubscription

public void enableSubscription(String queryId,
                               URL alertService)
                        throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Enable a subscription.

Specified by:

enableSubscription in interface NotificationWebService

Parameters:

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

alertService - the URL of the alert service to enable

Throws:

NotificationWebServiceException - if any errors occur

disableSubscription

public void disableSubscription(String queryId,
                                URL alertService)
                         throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Disable a subscription.

Specified by:

disableSubscription in interface NotificationWebService

Parameters:

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

alertService - the URL of the alert service to disable

Throws:

NotificationWebServiceException - if any errors occur

removeSubscription

public void removeSubscription(String queryId,
                               URL alertService)
                        throws NotificationWebServiceException

Description copied from interface: NotificationWebService

Remove a subscription.

Specified by:

removeSubscription in interface NotificationWebService

Parameters:

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

alertService - the URL of the alert service to remove

Throws:

NotificationWebServiceException - if any errors occur