public interface TraditionalWorkQueueCfgClient extends WorkQueueCfgClient
The Traditional Work Queue is a type of work queue that uses a number of worker threads that watch a queue and pick up an operation to process whenever one becomes available.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient,? extends TraditionalWorkQueueCfg> |
definition()
Get the configuration definition associated with this Traditional Work Queue.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<Integer> |
getMaxWorkQueueCapacity()
Gets the "max-work-queue-capacity" property.
|
ValueOrExpression<Integer> |
getNumWorkerThreads()
Gets the "num-worker-threads" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setMaxWorkQueueCapacity(ValueOrExpression<Integer> value)
Sets the "max-work-queue-capacity" property.
|
void |
setNumWorkerThreads(ValueOrExpression<Integer> value)
Sets the "num-worker-threads" property.
|
commit, properties
ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient,? extends TraditionalWorkQueueCfg> definition()
definition
in interface ConfigurationClient
definition
in interface WorkQueueCfgClient
ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.
getJavaClass
in interface WorkQueueCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.
setJavaClass
in interface WorkQueueCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getMaxWorkQueueCapacity()
Specifies the maximum number of queued operations that can be in the work queue at any given time.
If the work queue is already full and additional requests are received by the server, then the server front end, and possibly the client, will be blocked until the work queue has available capacity.
void setMaxWorkQueueCapacity(ValueOrExpression<Integer> value) throws PropertyException
Specifies the maximum number of queued operations that can be in the work queue at any given time.
If the work queue is already full and additional requests are received by the server, then the server front end, and possibly the client, will be blocked until the work queue has available capacity.
value
- The value of the "max-work-queue-capacity" property.PropertyException
- If the new value is invalid.ValueOrExpression<Integer> getNumWorkerThreads()
Specifies the number of worker threads to be used for processing operations placed in the queue.
If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.
void setNumWorkerThreads(ValueOrExpression<Integer> value) throws PropertyException
Specifies the number of worker threads to be used for processing operations placed in the queue.
If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.
value
- The value of the "num-worker-threads" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.