Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Default

Description

id

mandatory

Unique ID of the pipeline.

name

optional

Name of the pipeline. If no name is provided then the ID will also be used as name.

description

optional

Description of the pipeline.

coreThreads

mandatory

The core thread size defines the standard size of the thread pool. The size of the thread will only be extended to the maximum size in case the the queue reaches its maximum size. For further details please refer to ThreadPoolExecutor.

maxThreads

-1

Maximum amount of threads that will be used by the pipeline. In standard working mode the pipeline will not use more threads then defined by coreThreads. Only when the queue reaches its limit max threads will be used. By default maxThreads will have the same size as coreThreads.

threadPriority

5

Valid values as defined by Java must be within 1 and 10.

maxThreadKeepAlive

60000

Maximum time in milliseconds until threads that exceed the minimum pool size are kept alive if they are not used. Default is 60 seconds.

queueType

FIFO

Implementation type of the queue that is used to implement the workload pipeline.

Currently NOT_QUEUED and FIFO are supported.

maxQueueDepth

50

Maximum size of the queue that is used for requests in case that all threads of the pipeline are currently occupied.

maxLatency

-1

Maximum latency in the defined timeUnit that is accepted due to queuing of requests. If the defined maximum time is exceeded then the request will be rejected. This value is similar to a connection wait timeout for JDBC connections.

timeUnit

MILLISECONDS

Time unit that is used for all time values. Default is MILLISECONDS.

defaultPipeline

false

Parameter define if this pipeline definition is the default pipeline. The default pipeline will be used if no other more specific pipeline could be found for a certain request type.

Keys for Pipelines

A pipeline can be connected with multiple keys. JEAF Workload Proxy know two types of keys: Generic Keys and REST Keys.

Generic keys result from key resolution rules that are define in a proxy target. Using the keys a request is dispatched to a pipeline with the matching key. REST Keys are directly created based on the received request using URI and HTTP method of the request.

genericKeys

optional

List contains one or more generic key. Entries are described in {genericKeys}.key.

key

mandatory

Name of the generic key. The key also should be defined for at least one of the proxy targets.

restKeys

optional

List contains one or more

endpointURL

mandatory

Endpoint URL of the REST Key.

httpMethod

optional

Optional HTTP method of the REST Key.

Valid values are GET, POST, PUT, PATCH, DELETE, HEAD, CONNECT, OPTIONS and TRACE

Example

Expand
titleSimplePipelineConfiguration.yaml
Bitbucket file macro
urlhttps://bitbucket.org/anaptecs/jeaf-workload-proxy/src/master/jeaf-workload-proxy/src/test/resources/simple/SimplePipelineConfiguration.yaml
syntaxHighlightingYaml