|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Deprecated public interface JobStatusProvider
This service provides the current job processing status.
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_EVENT_ID
Deprecated. Use JobUtil.JOB_ID |
Method Summary | |
---|---|
void |
cancelJob(java.lang.String jobId)
Deprecated. Use removeJob(String) instead. |
void |
cancelJob(java.lang.String topic,
java.lang.String jobId)
Deprecated. Use removeJob(String, String) instead. |
void |
forceRemoveJob(java.lang.String jobId)
Deprecated. Cancel this job. |
void |
forceRemoveJob(java.lang.String topic,
java.lang.String jobId)
Deprecated. Cancel this job. |
java.util.Collection<org.osgi.service.event.Event> |
getAllJobs(java.lang.String topic,
java.util.Map<java.lang.String,java.lang.Object>... filterProps)
Deprecated. Use queryAllJobs(String, Map...) instead. |
java.util.Collection<org.osgi.service.event.Event> |
getCurrentJobs(java.lang.String topic)
Deprecated. Use queryCurrentJobs(String, Map...) instead. |
java.util.Collection<org.osgi.service.event.Event> |
getCurrentJobs(java.lang.String topic,
java.util.Map<java.lang.String,java.lang.Object>... filterProps)
Deprecated. Use queryCurrentJobs(String, Map...) instead. |
java.util.Collection<org.osgi.service.event.Event> |
getScheduledJobs(java.lang.String topic)
Deprecated. Use queryScheduledJobs(String, Map...) instead. |
java.util.Collection<org.osgi.service.event.Event> |
getScheduledJobs(java.lang.String topic,
java.util.Map<java.lang.String,java.lang.Object>... filterProps)
Deprecated. Use queryScheduledJobs(String, Map...) instead. |
JobsIterator |
queryAllJobs(java.lang.String topic,
java.util.Map<java.lang.String,java.lang.Object>... filterProps)
Deprecated. Return all jobs either running or scheduled. |
JobsIterator |
queryCurrentJobs(java.lang.String topic,
java.util.Map<java.lang.String,java.lang.Object>... filterProps)
Deprecated. Return the jobs which are currently in processing. |
JobsIterator |
queryScheduledJobs(java.lang.String topic,
java.util.Map<java.lang.String,java.lang.Object>... filterProps)
Deprecated. Return a list of currently scheduled jobs. |
boolean |
removeJob(java.lang.String jobId)
Deprecated. Cancel this job. |
boolean |
removeJob(java.lang.String topic,
java.lang.String jobId)
Deprecated. Cancel this job. |
void |
wakeUpJobQueue(java.lang.String jobQueueName)
Deprecated. Wake up the named job queue. |
Field Detail |
---|
@Deprecated static final java.lang.String PROPERTY_EVENT_ID
JobUtil.JOB_ID
Method Detail |
---|
boolean removeJob(java.lang.String jobId)
jobId
- The unique identifer as found in the property PROPERTY_EVENT_ID
.
true
if the job could be cancelled or does not exist anymore.
false
otherwise.boolean removeJob(java.lang.String topic, java.lang.String jobId)
topic
- The job topic as put into the property JobUtil.PROPERTY_JOB_TOPIC
.jobId
- The unique identifer as put into the property JobUtil.PROPERTY_JOB_NAME
.
true
if the job could be cancelled or does not exist anymore.
false
otherwise.void forceRemoveJob(java.lang.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 identifer as found in the property PROPERTY_EVENT_ID
.void forceRemoveJob(java.lang.String topic, java.lang.String jobId)
removeJob(String, 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!
This method can be used if the topic and the provided job id is known.
topic
- The job topic as put into the property JobUtil.PROPERTY_JOB_TOPIC
.jobId
- The unique identifer as put into the property JobUtil.PROPERTY_JOB_NAME
.void wakeUpJobQueue(java.lang.String jobQueueName)
jobQueueName
- The name of the queue.JobsIterator queryScheduledJobs(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps)
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.filterProps
- 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).
JobsIterator queryCurrentJobs(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps)
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.filterProps
- 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).
JobsIterator queryAllJobs(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps)
queryScheduledJobs(String, Map...)
and queryCurrentJobs(String, Map...)
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.filterProps
- 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 java.util.Collection<org.osgi.service.event.Event> getScheduledJobs(java.lang.String topic)
queryScheduledJobs(String, Map...)
instead.
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.
@Deprecated java.util.Collection<org.osgi.service.event.Event> getCurrentJobs(java.lang.String topic)
queryCurrentJobs(String, Map...)
instead.
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.
@Deprecated java.util.Collection<org.osgi.service.event.Event> getScheduledJobs(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps)
queryScheduledJobs(String, Map...)
instead.
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.filterProps
- 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 java.util.Collection<org.osgi.service.event.Event> getCurrentJobs(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps)
queryCurrentJobs(String, Map...)
instead.
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.filterProps
- 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 java.util.Collection<org.osgi.service.event.Event> getAllJobs(java.lang.String topic, java.util.Map<java.lang.String,java.lang.Object>... filterProps)
queryAllJobs(String, Map...)
instead.
getScheduledJobs(String, Map...)
and getCurrentJobs(String, Map...)
topic
- Topic can be used as a filter, if it is non-null, only jobs with this topic will be returned.filterProps
- 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 void cancelJob(java.lang.String jobId)
removeJob(String)
instead.
jobId
- The unique identifer as found in the property PROPERTY_EVENT_ID
.@Deprecated void cancelJob(java.lang.String topic, java.lang.String jobId)
removeJob(String, String)
instead.
topic
- The job topic as put into the property EventUtil.PROPERTY_JOB_TOPIC
.jobId
- The unique identifer as put into the property EventUtil.PROPERTY_JOB_ID
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |