QueueConfiguration (Apache Sling 8 API)

@ProviderType
public interface QueueConfiguration

The configuration of a queue.

Since:: 3.0

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class QueueConfiguration.ThreadPriority
The thread priority.

static class QueueConfiguration.Type
The queue type.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`QueueConfiguration.ThreadPriority` The thread priority.
`static class`	`QueueConfiguration.Type` The queue type.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`String[]`	`getApplicationIds()` Deprecated. This information is not used anymore
`int`	`getMaxParallel()` Return the max number of parallel processes.
`int`	`getMaxRetries()` Return the max number of retries, -1 for endless retry!
`int`	`getOwnThreadPoolSize()` Return the size for the optional thread pool for this queue.
`JobUtil.JobPriority`	`getPriority()` Deprecated. Use `getThreadPriority()`
`int`	`getRanking()` Get the ranking of this configuration.
`long`	`getRetryDelayInMs()` Return the retry delay in ms
`QueueConfiguration.ThreadPriority`	`getThreadPriority()` Return the thread priority for the job thread
`String[]`	`getTopics()` The list of topics this queue is bound to.
`QueueConfiguration.Type`	`getType()` Return the queue type.
`boolean`	`isKeepJobs()` Whether successful jobs are kept for a complete history
`boolean`	`isLocalQueue()` Deprecated. This information is not used anymore
`boolean`	`isPreferRunOnCreationInstance()` Prefer to run the job on the same instance it was created on.

- Method Detail
  - getRetryDelayInMs
```
long getRetryDelayInMs()
```
    Return the retry delay in ms
  - getMaxRetries
```
int getMaxRetries()
```
    Return the max number of retries, -1 for endless retry!
  - getType
```
QueueConfiguration.Type getType()
```
    Return the queue type.
  - getPriority
```
@Deprecated
JobUtil.JobPriority getPriority()
```
    Deprecated. Use getThreadPriority()
    
    Return the thread priority for the job thread.
  - getThreadPriority
```
QueueConfiguration.ThreadPriority getThreadPriority()
```
    Return the thread priority for the job thread
  - getMaxParallel
```
int getMaxParallel()
```
    Return the max number of parallel processes.
  - isLocalQueue
```
@Deprecated
boolean isLocalQueue()
```
    Deprecated. This information is not used anymore
  - getApplicationIds
```
@Deprecated
String[] getApplicationIds()
```
    Deprecated. This information is not used anymore
  - getTopics
```
String[] getTopics()
```
    The list of topics this queue is bound to.
  - isKeepJobs
```
boolean isKeepJobs()
```
    Whether successful jobs are kept for a complete history
    
    Returns:
    
    true if successful jobs are kept.
    
    Since:
    
    1.3
  - getOwnThreadPoolSize
```
int getOwnThreadPoolSize()
```
    Return the size for the optional thread pool for this queue.
    
    Returns:
    
    A positive number or 0 if the default thread pool should be used.
    
    Since:
    
    1.3
  - getRanking
```
int getRanking()
```
    Get the ranking of this configuration.
  - isPreferRunOnCreationInstance
```
boolean isPreferRunOnCreationInstance()
```
    Prefer to run the job on the same instance it was created on.
    
    Since:
    
    1.4

Interface QueueConfiguration

Nested Class Summary

Method Summary

Method Detail

getRetryDelayInMs

getMaxRetries

getType

getPriority

getThreadPriority

getMaxParallel

isLocalQueue

getApplicationIds

getTopics

isKeepJobs

getOwnThreadPoolSize

getRanking

isPreferRunOnCreationInstance