Interaction SDK
(Web Services)

Service: EventService



Attribute Summary
boolean subscriber:isChangeNode
           The subscriber has moved to another node. NB : during the swapping, some events can be lost.

Method Summary
com.genesyslab.ail.ws.event.SubscriberResult createSubscriber
           Creates a subscriber.
com.genesyslab.ail.ws.event.Event[] getEvents
           Retrieves events in pulling mode.
com.genesyslab.ail.ws.event.TopicsService[] getTopics
           Retrieves all topics.
void removeSubscriber
           Removes the subscriber.
void setNotification
           Sets notification mode.
com.genesyslab.ail.ws.event.TopicServiceError[] subscribeTopics
           Subscribes to new topics.
void unsubscribeAllTopics
           Unsubscribes all topics.
com.genesyslab.ail.ws.event.TopicServiceError[] unsubscribeTopics
           Unsubscribes topics.

Event Summary
SubscriberEvent
           Subscriber service event

Attribute Detail

Attributes of domain subscriber

Subscriber attributes definition


isChangeNode

Type: boolean
The subscriber has moved to another node. NB : during the swapping, some events can be lost.
Properties: event-default event


Method Detail

createSubscriber

Creates a subscriber.
Parameters:

  notification  com.genesyslab.ail.ws.event.Notification
   If null, pulling mode is enabled; otherwise push mode is used.

  topicServices  com.genesyslab.ail.ws.event.TopicsService[]
   The topics to subscribe to. Sets (attributes, filters) couple on each (serviceName, eventName, trigger) tuple.

Returns:

  Type:  com.genesyslab.ail.ws.event.SubscriberResult

   The subscriber identifier and errors (if any).

Errors:

  error.common.AilFactoryNotInitialized

  error.event.AdapterTypeNotFound

  error.event.NotificationEndpointInvalid

  error.event.BadTopicService
  

  error.event.BadTopicEvent
  

  error.event.BadEventName
  

  error.event.TriggerKeyInvalid
  

  error.event.TriggerValueInvalid
  

  error.event.FilterKeyInvalid
  

  error.event.FilterValueInvalid
  


getEvents

Retrieves events in pulling mode.
Parameters:

  subscriberId  String
   The subscriber identifier.

  timeout  long
   Time (in seconds) to wait for an event to occur. 0, do not wait.

Returns:

  Type:  com.genesyslab.ail.ws.event.Event[]

   Events sent.

Errors:

  error.event.SubscriberNotFound

  error.common.ParameterInvalid


getTopics

Retrieves all topics.
Parameters:

  subscriberId  String
   The subscriber identifier.

Returns:

  Type:  com.genesyslab.ail.ws.event.TopicsService[]

   All the topics to which your application has subscribed.

Errors:

  error.event.SubscriberNotFound


removeSubscriber

Removes the subscriber.
Parameters:

  subscriberId  String
   The subscriber identifier.

Returns:

  void

Errors:

  error.event.SubscriberNotFound


setNotification

Sets notification mode.
Parameters:

  subscriberId  String
   The subscriber identifier.

  notification  com.genesyslab.ail.ws.event.Notification
   If null, pulling mode is enabled; otherwise push mode is used.

Returns:

  void

Errors:

  error.event.SubscriberNotFound

  error.event.AdapterTypeNotFound

  error.event.NotificationEndpointInvalid


subscribeTopics

Subscribes to new topics.
Parameters:

  subscriberId  String
   The subscriber identifier.

  topicServices  com.genesyslab.ail.ws.event.TopicsService[]
   The topics to subscribe to. Sets (attributes, filters) couple on each (serviceName, eventName, trigger) tuple.

Returns:

  Type:  com.genesyslab.ail.ws.event.TopicServiceError[]

   Errors, if any.

Errors:

  error.event.SubscriberNotFound

  error.event.BadTopicService
  

  error.event.BadTopicEvent
  

  error.event.BadEventName
  

  error.event.TriggerKeyInvalid
  

  error.event.TriggerValueInvalid
  

  error.event.FilterKeyInvalid
  

  error.event.FilterValueInvalid
  


unsubscribeAllTopics

Unsubscribes all topics.
Parameters:

  subscriberId  String
   The subscriber identifier.

Returns:

  void

Errors:

  error.event.SubscriberNotFound


unsubscribeTopics

Unsubscribes topics.
Parameters:

  subscriberId  String
   The subscriber identifier.

  topicServicesRemove  com.genesyslab.ail.ws.event.TopicsServiceRemove[]
   The topics to unsubscribe to. Indicates subscription removal on each specified (serviceName, eventName, trigger) tuple.

Returns:

  Type:  com.genesyslab.ail.ws.event.TopicServiceError[]

   Errors, if any.

Errors:

  error.event.SubscriberNotFound

  error.event.BadServiceName


Event Detail

SubscriberEvent

Subscriber service event
Available attributes:  subscriber:*

Filters:

Triggers:

  Key: *   Value: *  -  can be null.


Interaction SDK
(Web Services)