| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
What are
...
Pipeline Objects?
Inside any pipeline there are objects automatically provided to you at execution time which can be accessed without any further allocation steps. Such an object is called Implicite Pipeline Object. These objects can be accessed using the Pipeline Expression Language (PEL). Some of them are read-only and some are read-write:
...
vars
| Status | ||||
|---|---|---|---|---|
|
...
Also see Pipeline Expression Language (PEL) .
headers
| Status | ||||
|---|---|---|---|---|
|
...
Also see Pipeline Expression Language (PEL) .
body
| Status | ||||
|---|---|---|---|---|
|
...
Also see Pipeline Expression Language (PEL) .
response
| Status | ||||
|---|---|---|---|---|
|
...
These are the attributes accessible via the response object:
response.statusCode
The HTTP status to send back to the client. One of: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
response.headers
A key-value map which contains the headers to be send back to the client.
request
| Status | ||||
|---|---|---|---|---|
|
...
These are the attributes accessible via the request object:
request.headers
A key-value map of all HTTP request headers of the current request.
| Info |
|---|
The HTTP request header keys are all lower cased in this map! |
request.params
A key-value map of all HTT request query parameters of the current request.
request.protocol
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
request.contentLength
The content length of the current request in bytes.
request.contentType
The Content-Type header of the current request. One of the standard content types or a custom one.
request.requestPath
The request path of current request without hostname.
request.method
The HTTP method used for this request.
request.locale
The locale used for this request or null if none was set.
request.cookies
The list of cookies linked to this request.
request.cookies[].name
Returns the name of the cookie. The name cannot be changed after creation.
request.cookies[].value
Returns the value of the cookie as string.
request.cookies[].path
Returns the path as string on the server to which the browser returns this cookie. The cookie is visible to all subpaths on the server.
request.cookies[].version
Returns the version integer of the protocol this cookie complies with. Version 1 complies with RFC 2109, and version 0 complies with the original cookie specification drafted by Netscape. Cookies provided by a browser use and identify the browser's cookie version.
request.cookies[].domain
Returns the domain name set for this cookie as string. The form of the domain name is set by RFC 2109.
request.cookies[].comment
Returns the comment string describing the purpose of this cookie, or null if the cookie has no comment.
request.cookies[].maxAge
Returns the maximum age of the cookie, specified in seconds. By default, -1 indicating the cookie will persist until browser shutdown.
request.cookies[].secure
Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
request.cookies[].httpOnly
Gets the flag that controls if this cookie will be hidden from scripts on the client side. Returns true if the cookie is hidden from scripts, else false.
exception
| Status | ||||
|---|---|---|---|---|
|
...
Depending on the exception type the attributes can differ. Below you can find the common attributes always available:
exception.auth
The name of the principal active when this exception happened. This is typically the username of the currently logged-in user or the systemuser.
exception.domain
The PIPEFORCE domain name (host) where this exception happened.
exception.message
Returns the exception message as string.
exception.more
A link to the log files related to this exception.
exception.namespace
The PIPEFORCE namespace where this exception happened.
exception.spanId
The id of the trace span where this exception happened or null in case there was no span created.
exception.traceId
The id of the tracing where this exception happened. Never null.
exception.type
Returns the type (name) of the current exception.
Common types are:
Type | Description |
|---|---|
| In case the execution of a pipeline util has been failed. |
| In case the execution of a command has been failed. |
| In case a command was not found. |
| In case an argument to any backend function was invalid. |
| In case a pipeline execution has been failed. |
| This type catches any exception. |
exception.statusCode
The status code of the exception if there is any. Usually an HTTP status code is assigned with any exception. By default it is set to 500.
exception.time
The unix timestamp in millis when this exception happened at the backend.
exception.uuid
Returns the unique id of this exception. This is handy for searching in logs for this exact match.
...