@ProviderType
public interface Queue
Modifier and Type | Method and Description |
---|---|
QueueConfiguration |
getConfiguration()
Get the corresponding configuration.
|
String |
getName()
Get the queue name.
|
Object |
getState(String key)
For monitoring purposes and possible extensions from the different
queue types.
|
String |
getStateInfo()
Return some information about the current state of the queue.
|
Statistics |
getStatistics()
Return statistics information about this queue.
|
boolean |
isSuspended()
Is the queue currently suspended?
|
void |
removeAll()
Remove all outstanding jobs and delete them.
|
void |
resume()
Resume a suspended queue.
|
void |
suspend()
Suspend the queue - when a queue is suspended it stops processing
jobs - however already started jobs are finished (but not rescheduled).
|
String getName()
Statistics getStatistics()
QueueConfiguration getConfiguration()
void suspend()
resume()
.void resume()
suspend()
. If the queue is not
suspended, calling this method has no effect.
Depending on the queue implementation, if a job failed a job queue might
sleep for a configured time, before a new job is processed. By calling this
method, the job queue can be woken up and force an immediate reprocessing.
This feature is only supported by ordered queues at the moment. If a queue
does not support this feature, calling this method has only an effect if
the queue is really suspended.boolean isSuspended()
void removeAll()
String getStateInfo()
Copyright © 2017 The Apache Software Foundation. All rights reserved.