com.genesyslab.soa.event
Interface EventService

All Superinterfaces:
IService, java.rmi.Remote
All Known Subinterfaces:
EventService

public interface EventService
extends IService


Method Summary
 SubscriberResult createSubscriber(Notification notification, TopicsService[] topicServices)
          Creates a subscriber.
 Event[] getEvents(java.lang.String subscriberId, long timeout)
          Retrieves events in pulling mode.
 TopicsService[] getTopics(java.lang.String subscriberId)
          Retrieves all topics.
 void removeSubscriber(java.lang.String subscriberId)
          Removes the subscriber.
 void setNotification(java.lang.String subscriberId, Notification notification)
          Sets notification mode.
 TopicServiceError[] subscribeTopics(java.lang.String subscriberId, TopicsService[] topicServices)
          Subscribes to new topics.
 void unsubscribeAllTopics(java.lang.String subscriberId)
          Unsubscribes all topics.
 TopicServiceError[] unsubscribeTopics(java.lang.String subscriberId, TopicsServiceRemove[] topicServicesRemove)
          Unsubscribes topics.
 

Method Detail

createSubscriber

public SubscriberResult createSubscriber(Notification notification,
                                         TopicsService[] topicServices)
                                  throws ServiceException,
                                         java.rmi.RemoteException
Creates a subscriber.

Parameters:
notification - If null, pulling mode is enabled; otherwise push mode is used.
topicServices - The topics to subscribe to. Sets (attributes, filters) couple on each (serviceName, eventName, trigger) tuple.
Returns:
The subscriber identifier and errors (if any).
Throws:
ServiceException
java.rmi.RemoteException

setNotification

public void setNotification(java.lang.String subscriberId,
                            Notification notification)
                     throws ServiceException,
                            java.rmi.RemoteException
Sets notification mode.

Parameters:
subscriberId - The subscriber identifier.
notification - If null, pulling mode is enabled; otherwise push mode is used.
Throws:
ServiceException
java.rmi.RemoteException

subscribeTopics

public TopicServiceError[] subscribeTopics(java.lang.String subscriberId,
                                           TopicsService[] topicServices)
                                    throws ServiceException,
                                           java.rmi.RemoteException
Subscribes to new topics.

Parameters:
subscriberId - The subscriber identifier.
topicServices - The topics to subscribe to. Sets (attributes, filters) couple on each (serviceName, eventName, trigger) tuple.
Returns:
Errors, if any.
Throws:
ServiceException
java.rmi.RemoteException

unsubscribeAllTopics

public void unsubscribeAllTopics(java.lang.String subscriberId)
                          throws ServiceException,
                                 java.rmi.RemoteException
Unsubscribes all topics.

Parameters:
subscriberId - The subscriber identifier.
Throws:
ServiceException
java.rmi.RemoteException

unsubscribeTopics

public TopicServiceError[] unsubscribeTopics(java.lang.String subscriberId,
                                             TopicsServiceRemove[] topicServicesRemove)
                                      throws ServiceException,
                                             java.rmi.RemoteException
Unsubscribes topics.

Parameters:
subscriberId - The subscriber identifier.
topicServicesRemove - The topics to unsubscribe to. Indicates subscription removal on each specified (serviceName, eventName, trigger) tuple.
Returns:
Errors, if any.
Throws:
ServiceException
java.rmi.RemoteException

getTopics

public TopicsService[] getTopics(java.lang.String subscriberId)
                          throws ServiceException,
                                 java.rmi.RemoteException
Retrieves all topics.

Parameters:
subscriberId - The subscriber identifier.
Returns:
All the topics to which your application has subscribed.
Throws:
ServiceException
java.rmi.RemoteException

removeSubscriber

public void removeSubscriber(java.lang.String subscriberId)
                      throws ServiceException,
                             java.rmi.RemoteException
Removes the subscriber.

Parameters:
subscriberId - The subscriber identifier.
Throws:
ServiceException
java.rmi.RemoteException

getEvents

public Event[] getEvents(java.lang.String subscriberId,
                         long timeout)
                  throws ServiceException,
                         java.rmi.RemoteException
Retrieves events in pulling mode.

Parameters:
subscriberId - The subscriber identifier.
timeout - Time (in seconds) to wait for an event to occur. 0, do not wait.
Returns:
Events sent.
Throws:
ServiceException
java.rmi.RemoteException