com.ibm.websphere.scheduler

Interface NotificationSink

  • All Superinterfaces:
    javax.ejb.EJBObject, java.rmi.Remote


    public interface NotificationSink
    extends javax.ejb.EJBObject
    The remote interface for all NotificationSink stateless session beans.

    A NotificationSink bean is used to receive notifications with various state information for a specific task that was scheduled using the Scheduler.create method. Use the TaskInfo.setNotificationSink to set the NotificationSink of a particular task. When the task fires a notification, a TaskNotificationInfo object with the current state information will be sent to the registered NotificationSink bean's handleEvent method. All NotificationSinks are required to use this remote interface and the com.ibm.websphere.scheduler.NotificationSinkHome home interface .

    Since:
    5.0
    Version:
    5.0
    See Also:
    NotificationSinkHome, TaskNotificationInfo, Scheduler.create(com.ibm.websphere.scheduler.TaskInfo), TaskInfo.setNotificationSink(com.ibm.websphere.scheduler.NotificationSinkHome)
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void handleEvent(TaskNotificationInfo task)
      Called when a scheduled task is scheduled, cancelled, suspended, resumed, purged and fired.
      • Methods inherited from interface javax.ejb.EJBObject

        getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
    • Method Detail

      • handleEvent

        void handleEvent(TaskNotificationInfo task)
                         throws java.rmi.RemoteException
        Called when a scheduled task is scheduled, cancelled, suspended, resumed, purged and fired. The TaskNotificationInfo object will contain the event being fired and TaskStatus of the respective task.
        Parameters:
        task - the TaskNotificationInfo object
        Throws:
        java.rmi.RemoteException
        Since:
        5.0
        See Also:
        TaskNotificationInfo, TaskStatus
IBM WebSphere Application ServerTM
Release 9.0