com.hcl.voltmx.middleware.api.events

Interface EventSubscriber

All Known Implementing Classes:

AbstractServiceEvent, IntegrationServiceEvent, ObjectServiceEvent

public interface EventSubscriber

EventSubscriber provides mechanism for receiving notification from notifier and perform specified actions. The same subscriber may listen to multiple event names or topics. There is no specific order in which the events are delivered to subscribers. This class needs to be thread-safe as onEvent method may be called by multiple threads simultaneously.

Event for successful order: Say, we want to write a subscriber which will send mail when order is successful.

 
    import java.util.Map;
    
    import com.hcl.voltmx.middleware.api.events.EventData;
    import com.hcl.voltmx.middleware.api.events.EventSubscriber;
    import com.hcl.voltmx.middleware.api.events.IntegrationEventSubscriber;

    @IntegrationEventSubscriber(topics = {"apps/order/success"})
    public class OrderSuccessEvent implements EventSubscriber {
      private static final String SUCCESS_MESSAGE = "Dear %s, Your order for %s is successful. "
          + "Your order id is%s. Order details:%s.";

      @Override
      public void onEvent(EventData eventData) {
        Map<String, Object> additionalMetadata = eventData.getAdditionalMetadata();
        Object userId = additionalMetadata.get("userId");
        Object product = additionalMetadata.get("product");
        Object orderId = additionalMetadata.get("orderId");
        String message = String.format(SUCCESS_MESSAGE, userId, product, orderId, eventData.getData());
        sendSuccessMail(String.valueOf(userId), message);
      }

      private static void sendSuccessMail(String userId, String message) {
      }
    }
 
 

Event for failed order: Say, we want to write a subscriber which will send mail when order is failed.

 
    import java.util.Map;

    import com.hcl.voltmx.middleware.api.events.EventData;
    import com.hcl.voltmx.middleware.api.events.EventSubscriber;
    import com.hcl.voltmx.middleware.api.events.IntegrationEventSubscriber;

    @IntegrationEventSubscriber(topics = {"apps/order/fail"})
    public class OrderFailedEvent implements EventSubscriber {
      private static final String FAILURE_MESSAGE = "Dear %s, Your order for %s is failed. "
          + "Your tracking id is %s. Details: %s.";

      @Override
      public void onEvent(EventData eventData) {
        Map<String, Object> additionalMetadata = eventData.getAdditionalMetadata();
        Object userId = additionalMetadata.get("userId");
        Object product = additionalMetadata.get("product");
        Object trackingId = additionalMetadata.get("trackingId");
        String message = String.format(FAILURE_MESSAGE, userId, product, trackingId,
            eventData.getData());

        sendFailureMail(String.valueOf(userId), message);
      }

      private static void sendFailureMail(String userId, String message) {
      }
    }
 
 

Since:

Foundry V8 SP4 FP2 (8.4.2) release

See Also:

EventData, EventManager, EventNotifier, IntegrationEventSubscriber, IntegrationServiceEvent

Method Summary

Modifier and Type	Method and Description
void	onEvent(EventData eventData) Receives notification when any event of subscribed name or topic is triggered.

Method Detail

onEvent

void onEvent(EventData eventData)

Receives notification when any event of subscribed name or topic is triggered. This method needs to be thread-safe as it may be called by multiple threads simultaneously.

Parameters:

eventData - The event data.