← Back to plugin index

HTTP Query Parameter Context Extractor

Description
A context extractor that matches against an HTTP query parameter in the request and compares the parameter value with a list of patterns. The first matching pattern defines the resulting context.

Notices:

  1. This extractor matches on any request to the UI application (/ui/app/*) but not other (usually static) /ui resources
  2. Most REST requests are POST requests and usually do not contain any query parameters. This context extractor can not analyze the contents of the POST requests
  3. Only for legacy servlets (e.g. Cronto Servlets), this extractor also matches on form POST parameters

Type name
HttpParameterContextExtractor
Class
com.airlock.iam.core.misc.util.context.HttpParameterContextExtractor
May be used by
Properties
HTTP Parameter Name (httpParameterName)
Description
The name of the HTTP parameter. The name is case sensitive, i.e. parameters match this name only if case is identical. If more than one parameter in the request matches, the result is undefined.
Attributes
String
Mandatory
Example
USERNAME
Example
MANDATE
Fallback Context (fallbackContext)
Description
Name of the context to be used if it cannot be determined by the HTTP parameter.
Leave empty to implicitly use the default context. If this plugin is used within a "Combining Context Extractor", use "[DEFAULT]" to explicitly return the default context if necessary.
Attributes
String
Optional
Example
CTX1
Example
EXT
Example
[DEFAULT]
Parameters (parameters)
Description
Defines a list of mappings from regular expressions to configuration contexts. The regular expressions are matched against the parameter value. If it matches, the corresponding configuration context is used and no further patterns considered (thus the first match wins).
Attributes
Plugin-List
Mandatory
Assignable plugins
YAML Template (with default values)

type: HttpParameterContextExtractor
id: HttpParameterContextExtractor-xxxxxx
displayName: 
comment: 
properties:
  fallbackContext:
  httpParameterName:
  parameters: