← Back to plugin index

HTTP Request Cookie Value Provider

Description
Provides the value of an HTTP cookie from the current HTTP request.

Only the actual value of the cookie is returned, without meta data as path or expiry time. If the cookie is not present in the request, the value provider will provide no value.

Type name
HttpRequestCookieStringValueProvider
Class
com.airlock.iam.common.application.configuration.valueprovider.HttpRequestCookieStringValueProviderConfig
May be used by
Properties
Cookie Name (cookieName)
Description
The name of the HTTP cookie of which the value will be extracted from the current request.
Attributes
String
Mandatory
Allowed Cookie Value Pattern (allowedCookieValuePattern)
Description
In case a cookie is present, its value has to match the configured Regex pattern. If URL decoding is enabled, the decoded value is tested against the pattern. No value is returned, if it does not match.
Attributes
RegEx
Optional
Default value
[a-zA-Z0-9 ._-]+
URL Decode (urlDecode)
Description
If enabled, the cookie value is URL decoded by the provider.
Attributes
Boolean
Optional
Default value
false
YAML Template (with default values)

type: HttpRequestCookieStringValueProvider
id: HttpRequestCookieStringValueProvider-xxxxxx
displayName: 
comment: 
properties:
  allowedCookieValuePattern: [a-zA-Z0-9 ._-]+
  cookieName:
  urlDecode: false