IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.grid.spi
Class WSGridNotificationSPI

java.lang.Object
  extended by com.ibm.websphere.grid.spi.SPI
      extended by com.ibm.websphere.grid.spi.WSGridNotificationSPI
All Implemented Interfaces:
java.lang.Comparable

public abstract class WSGridNotificationSPI
extends SPI


Field Summary
static java.lang.String JOB_STATE_ENDED
          Identifies the job ended notification type.
static java.lang.String JOB_STATE_STARTED
          Identifies the job started notification type.
static java.lang.String STEP_STATE_ENDED
          Identifies the step ended notification type.
static java.lang.String STEP_STATE_STARTED
          Identifies the step started notification type.
 
Constructor Summary
WSGridNotificationSPI()
           
 
Method Summary
abstract  void notificationReceived(java.util.Properties jobProps, java.lang.String xdJobID, java.lang.String notification, int rc)
           Callback method invoked by job scheduler job lifecycle events.
 
Methods inherited from class com.ibm.websphere.grid.spi.SPI
compareTo, getInvocationOrder, getName, setInvocationOrder, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JOB_STATE_STARTED

public static final java.lang.String JOB_STATE_STARTED

Identifies the job started notification type.

See Also:
Constant Field Values

STEP_STATE_STARTED

public static final java.lang.String STEP_STATE_STARTED

Identifies the step started notification type.

See Also:
Constant Field Values

STEP_STATE_ENDED

public static final java.lang.String STEP_STATE_ENDED

Identifies the step ended notification type.

See Also:
Constant Field Values

JOB_STATE_ENDED

public static final java.lang.String JOB_STATE_ENDED

Identifies the job ended notification type.

See Also:
Constant Field Values
Constructor Detail

WSGridNotificationSPI

public WSGridNotificationSPI()
Method Detail

notificationReceived

public abstract void notificationReceived(java.util.Properties jobProps,
                                          java.lang.String xdJobID,
                                          java.lang.String notification,
                                          int rc)

Callback method invoked by job scheduler job lifecycle events. This method must be implemented by the WSGridNotificationSPI subclass implementor.

Parameters:
jobProps - contains the properties specified in the WSGrid properties file(s) for this job.
xdJobID - specifies the job id of the job corresponding to this notification.
notification - specifies the lifecycle event that occurred for the specified job. The event type is defined by the following constants:
  1. JOB_STATE_STARTED
  2. STEP_STATE_STARTED
  3. STEP_STATE_ENDED
  4. JOB_STATE_ENDED
rc - specifies the step or job return code. It is defined only for notification types:
  1. STEP_STATE_ENDED
  2. JOB_STATE_ENDED

IBM WebSphere Application ServerTM
Release 7