JobPoller (OFBiz R18.12 API)

java.lang.Object
- org.apache.ofbiz.service.job.JobPoller

All Implemented Interfaces:: ServiceConfigListener

public final class JobPoller
extends java.lang.Object
implements ServiceConfigListener

Job poller. Queues and runs jobs.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String module

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static JobPoller`	`getInstance()`	Returns the `JobPoller` instance.
`java.util.Map<java.lang.String,java.lang.Object>`	`getPoolState()`	Returns a `Map` containing `JobPoller` statistics.
`void`	`onServiceConfigChange(ServiceConfig serviceConfig)`	Processes `serviceengine.xml` changes.
`void`	`queueNow(Job job)`	Adds a job to the job queue.
`static void`	`registerJobManager(JobManager jm)`	Register a `JobManager` with the job poller.
`void`	`stop()`	Stops the `JobPoller`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - module
```
public static final java.lang.String module
```
- Method Detail
  - getInstance
```
public static JobPoller getInstance()
```
    Returns the JobPoller instance.
  - registerJobManager
```
public static void registerJobManager(JobManager jm)
```
    Register a JobManager with the job poller.
    
    Parameters:
    
    jm - The JobManager to register.
    
    Throws:
    
    java.lang.IllegalArgumentException - if jm is null
  - getPoolState
```
public java.util.Map<java.lang.String,java.lang.Object> getPoolState()
```
    Returns a Map containing JobPoller statistics.
  - onServiceConfigChange
```
public void onServiceConfigChange(ServiceConfig serviceConfig)
```
    Description copied from interface: ServiceConfigListener
    
    Processes serviceengine.xml changes.
    
    Specified by:
    
    onServiceConfigChange in interface ServiceConfigListener
    
    Parameters:
    
    serviceConfig - The new ServiceConfig instance.
  - queueNow
```
public void queueNow(Job job)
              throws InvalidJobException
```
    Adds a job to the job queue.
    
    Throws:
    
    InvalidJobException - if the job is in an invalid state.
    
    java.util.concurrent.RejectedExecutionException - if the poller is stopped.
  - stop
```
public void stop()
```
    Stops the JobPoller. This method is called when OFBiz shuts down. The JobPoller cannot be restarted.