Package org.jppf.server.job.management

Interface DriverJobManagementMBean

All Superinterfaces:
NotificationBroadcaster, NotificationEmitter
@MBeanNotif(description="notification on the status of a job", notifClass=JobNotification.class) public interface DriverJobManagementMBean extends NotificationEmitter
This is the job management MBean interface.
Author:
Laurent Cohen

  • Field Details

    • MBEAN_NAME

      static final String MBEAN_NAME
      The name under which this MBean is registered with the MBean server.
      See Also:

  • Method Details

    • cancelJob

      void cancelJob(String jobUuid) throws Exception
      Cancel the job with the specified id.
      Parameters:
      jobUuid - the uuid of the job to cancel.
      Throws:
      Exception - if any error occurs.

    • cancelJobs

      void cancelJobs(JobSelector selector) throws Exception
      Cancel the jobs specified with a given job selector.
      Parameters:
      selector - determines which jobs to cancel.
      Throws:
      Exception - if any error occurs.
      Since:
      5.1

    • suspendJob

      void suspendJob(String jobUuid, Boolean requeue) throws Exception
      Suspend the job with the specified uuid.
      Parameters:
      jobUuid - the uuid of the job to suspend.
      requeue - true if the sub-jobs running on each node should be canceled and requeued, false if they should be left to execute until completion.
      Throws:
      Exception - if any error occurs.

    • suspendJobs

      void suspendJobs(JobSelector selector, Boolean requeue) throws Exception
      Suspend the jobs specified with a given job selector.
      Parameters:
      selector - determines which jobs to suspend.
      requeue - true if the sub-jobs running on each node should be canceled and requeued, false if they should be left to execute until completion.
      Throws:
      Exception - if any error occurs.
      Since:
      5.1

    • resumeJob

      void resumeJob(String jobUuid) throws Exception
      Resume the job with the specified uuid.
      Parameters:
      jobUuid - the uuid of the job to resume.
      Throws:
      Exception - if any error occurs.

    • resumeJobs

      void resumeJobs(JobSelector selector) throws Exception
      Resume the jobs specified with a given job selector.
      Parameters:
      selector - determines which jobs to resume.
      Throws:
      Exception - if any error occurs.
      Since:
      5.1

    • updateMaxNodes

      void updateMaxNodes(String jobUuid, Integer maxNodes) throws Exception
      Update the maximum number of nodes the job with the specified uuid can run on.
      Parameters:
      jobUuid - the uuid of the job to update.
      maxNodes - the new maximum number of nodes for the job.
      Throws:
      Exception - if any error occurs.

    • updateMaxNodes

      void updateMaxNodes(JobSelector selector, Integer maxNodes) throws Exception
      Update the maximum number of nodes the specified jobs can run on.
      Parameters:
      selector - determines for which jobs to change the maximum number of nodes.
      maxNodes - the new maximum number of nodes for the job.
      Throws:
      Exception - if any error occurs.
      Since:
      5.1

    • getAllJobUuids

      String[] getAllJobUuids() throws Exception
      Get the set of uuids for all the jobs currently queued or executing.
      Returns:
      an array of uuids as strings.
      Throws:
      Exception - if any error occurs.
      Since:
      5.1

    • getJobInformation

      JobInformation getJobInformation(String jobUuid) throws Exception
      Get an object describing the job with the specified uuid.
      Parameters:
      jobUuid - the uuid of the job to get information about.
      Returns:
      an instance of JobInformation.
      Throws:
      Exception - if any error occurs.

    • getJobInformation

      JobInformation[] getJobInformation(JobSelector selector) throws Exception
      Get the job information for all the jobs accepted by the specified selector.
      Parameters:
      selector - determines for which jobs to return information.
      Returns:
      an array of JobInformation objects, possibly empty if no job matches the selector.
      Throws:
      Exception - if any error occurs.
      Since:
      5.1

    • getNodeInformation

      NodeJobInformation[] getNodeInformation(String jobUuid) throws Exception
      Get a list of objects describing the nodes to which the whole or part of a job was dispatched.
      Parameters:
      jobUuid - the uuid of the job for which to find node information.
      Returns:
      an array of NodeManagementInfo, JobInformation instances.
      Throws:
      Exception - if any error occurs.

    • getNodeInformation

      Map<String,NodeJobInformation[]> getNodeInformation(JobSelector selector) throws Exception
      Get a list of objects describing the nodes to which the whole or part of a job was dispatched, for all the jobs specified by a job selector.
      Parameters:
      selector - determines for which jobs to return the node disptaches.
      Returns:
      a mapping of job uuids to a corresponding array of NodeJobInformation instances.
      Throws:
      Exception - if any error occurs.

    • updatePriority

      void updatePriority(String jobUuid, Integer newPriority)
      Update the priority of the job with the specified uuid.
      Parameters:
      jobUuid - the uuid of the job to update.
      newPriority - the job's new priority value.

    • updatePriority

      void updatePriority(JobSelector selector, Integer newPriority)
      Update the priority of the jobs specified by a job selector.
      Parameters:
      selector - determines for which jobs to change the maximum number of nodes.
      newPriority - the jobs new priority value.

    • updateJobs

      void updateJobs(JobSelector selector, JobSLA sla, JobMetadata metadata)
      Update the SLA and/or metadata of the specified jobs.
      Parameters:
      selector - specifies which jobs to update.
      sla - the new job SLA; if null then the sla is not changed.
      metadata - the new job metadata; if null then the metadata is not changed.
      Since:
      5.1