com.ibm.wsspi.batch

Class JobClassInterceptor

  • All Implemented Interfaces:
    java.lang.Comparable


    public abstract class JobClassInterceptor
    extends SPI
    JobClassInterceptor is the abstract base class for the Scheduler Job Classification Interceptor System Programming Interface (SPI). Use the JobClassInterceptor to modify the job class after an XJCL has been submitted. The JobClassInterceptor is invoked after the XJCL is parsed but before a job is submitted.

    Implement the JobClassInterceptor SPI, by extending this class and implementing the classifyJob method.

    Configure this SPI with the following custom job scheduler property:

     com.ibm.wsspi.batch.job.class.interceptor=<fully-qualified implementation class name>
     

    The jar file containing the implementation of this SPI should be stored in:
     <WAS install root>/lib/classes.  E.g.
     
           /WebSphere/AppServer/lib/classes
     
    You are responsible for creating the classes directory if it does not already exist.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      abstract java.lang.String classifyJob(java.lang.String jobName, java.lang.String submitter, java.lang.String jobClass) 
      java.lang.String getName()
      Returns the name of this SPI instance.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JobClassInterceptor

        public JobClassInterceptor()
    • Method Detail

      • classifyJob

        public abstract java.lang.String classifyJob(java.lang.String jobName,
                                   java.lang.String submitter,
                                   java.lang.String jobClass)
        Parameters:
        jobName - The XJCL name of the job as specified in the name attribute of the job element.
        submitter - The job submitter
        jobClass - The current job associated with the job.
        Returns:
        The new Job Class to assign to the job. This String will be trimmed for leading and trailing whitespace. Also, null or empty string values will result in the job class to remain as jobClass.
      • getName

        public java.lang.String getName()
        Description copied from class: SPI
        Returns the name of this SPI instance. Should return a unique identifier.
        Specified by:
        getName in class SPI
IBM WebSphere Application ServerTM
Release 8.5