|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JobManager
The job manager is the heart of the job event handling. It can be used to manage and monitor the queues.
Nested Class Summary | |
---|---|
static class |
JobManager.QueryType
The requested job types for the query. |
Method Summary | |
---|---|
Job |
addJob(String topic,
Map<String,Object> properties)
Add a new job If the topic is null or illegal, no job is created and null is returned. |
Job |
addJob(String topic,
String name,
Map<String,Object> properties)
Add a new job If the topic is null or illegal, no job is created and null is returned. |
org.osgi.service.event.Event |
findJob(String topic,
Map<String,Object> template)
Deprecated. |
Collection<Job> |
findJobs(JobManager.QueryType type,
String topic,
long limit,
Map<String,Object>... templates)
Return all jobs either running or scheduled. |
void |
forceRemoveJob(String jobId)
Deprecated. |
Job |
getJob(String topic,
Map<String,Object> template)
Find a job - either scheduled or active. |
Job |
getJobById(String jobId)
|
Job |
getJobByName(String name)
|
Queue |
getQueue(String name)
Return a queue with a specific name (if running) |
Iterable<Queue> |
getQueues()
Return an iterator for all available queues. |
Statistics |
getStatistics()
Return statistics information about all queues. |
Iterable<TopicStatistics> |
getTopicStatistics()
Return statistics information about job topics. |
boolean |
isJobProcessingEnabled()
Deprecated. This method always returns true |
JobsIterator |
queryJobs(JobManager.QueryType type,
String topic,
long limit,
Map<String,Object>... templates)
Deprecated. |
JobsIterator |
queryJobs(JobManager.QueryType type,
String topic,
Map<String,Object>... templates)
Deprecated. |
boolean |
removeJob(String jobId)
Deprecated. |
boolean |
removeJobById(String jobId)
Removes the job even if it is currently in processing. |
void |
restart()
Restart the job manager. |
Method Detail |
---|
Statistics getStatistics()
Iterable<TopicStatistics> getTopicStatistics()
Queue getQueue(String name)
name
- The queue name
null
Iterable<Queue> getQueues()
void restart()
Job addJob(String topic, Map<String,Object> properties)
null
or illegal, no job is created and null
is returned.
A job topic is a hierarchical name separated by dashes, each part has to start with a letter,
allowed characters are letters, numbers and the underscore.
topic
- The required job topic.properties
- Optional job properties
null
if the job could not be created.Job addJob(String topic, String name, Map<String,Object> properties)
null
or illegal, no job is created and null
is returned.
A job topic is a hierarchical name separated by dashes, each part has to start with a letter,
allowed characters are letters, numbers and the underscore.
This method allows to specify a job name which should uniquely identify this job. If a job with
the same name is started on different instances, the job is still processed only once. However,
the topology api in combination with the leader selection provides a better way for
dealing with this situation and as jobs with name come with a heavy processing overhead
these should be avoided.
topic
- The required job topic.name
- Optional unique job nameproperties
- Optional job properties
null
if the job could not be created.Job getJobByName(String name)
null
Job getJobById(String jobId)
jobId
- The unique identifier from Job.getId()
null
boolean removeJobById(String jobId)
jobId
- The unique identifier from Job.getId()
true
if the job could be removed or does not exist anymore.
false
otherwise.Job getJob(String topic, Map<String,Object> template)
topic
- Topic is required.template
- The map acts like a template. The searched job
must match the template (AND query).
null
Collection<Job> findJobs(JobManager.QueryType type, String topic, long limit, Map<String,Object>... templates)
type
- Required parameter for the type: either all jobs, only queued or only started can be returned.topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.limit
- A positive number indicating the maximum number of jobs returned by the iterator. A value
of zero or less indicates that all jobs should be returned.templates
- A list of filter property maps. Each map acts like a template. The searched job
must match the template (AND query). By providing several maps, different filters
are possible (OR query).
@Deprecated JobsIterator queryJobs(JobManager.QueryType type, String topic, Map<String,Object>... templates)
type
- Required parameter for the type: either all jobs, only queued or only started can be returned.topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.templates
- A list of filter property maps. Each map acts like a template. The searched job
must match the template (AND query). By providing several maps, different filters
are possible (OR query).
@Deprecated JobsIterator queryJobs(JobManager.QueryType type, String topic, long limit, Map<String,Object>... templates)
type
- Required parameter for the type: either all jobs, only queued or only started can be returned.topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.limit
- A positive number indicating the maximum number of jobs returned by the iterator.templates
- A list of filter property maps. Each map acts like a template. The searched job
must match the template (AND query). By providing several maps, different filters
are possible (OR query).
@Deprecated org.osgi.service.event.Event findJob(String topic, Map<String,Object> template)
topic
- Topic is required.template
- The map acts like a template. The searched job
must match the template (AND query).
null
@Deprecated boolean removeJob(String jobId)
jobId
- The unique identifier as found in the property JobUtil.JOB_ID
.
true
if the job could be cancelled or does not exist anymore.
false
otherwise.@Deprecated void forceRemoveJob(String jobId)
removeJob(String)
with the exception that it waits
for a job to finish. The job will be removed when this method returns - however
this method blocks until the job is finished!
jobId
- The unique identifier as found in the property JobUtil.JOB_ID
.@Deprecated boolean isJobProcessingEnabled()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |