← Back to plugin index

Advanced Location Interpreter
Description
Highly customizable plugin to transform the given URI and potentially extract a value by applying the following procedure:
  1. The optional "URI Transformers" are called in the configured order to transform the URI to a new URI. The output of a preceding transformer is used as input of a subsequent transformer. If an URI transformer returns a veto, the default value configured in this plugin is used as the resulting value.
    Those plugins are used to perform generic transformations on the URI like regular expression replacements or to use a query parameter as the new URI.
  2. The optional "Value Extractors" are now called in the configured order to extract a string value from the potentially transformed URI. The first extractor able to return a non-empty value stops the chain. If no extractor returns a non-empty value, the whole URI is passed on unchanged.
    Those extractors are used to extract a query parameter or a path segment containing the target value.
  3. Finally the optional "String Transformers" are called in the configured order to transform the final string. The output of the preceding transformer is used as input of the subsequent transformer. If a string transformer returns a veto, the default value configured in this plugin is used as overall value.
    They can for example be used to normalize values, for example convert the string to lowercase or convert values from one format to another (e.g. convert 'GER' to 'de').
Type name
AdvancedLocationInterpreter
Class
com.airlock.iam.login.application.configuration.location.interpret.AdvancedLocationInterpreterConfig
May be used by
Authentication & Authorization UI Location Interpretations Configuration
Properties
Default Value (defaultValue)
Description
The default value to be returned if a transformer produces a veto.
Attributes
String
Optional
URI Transformers (uriTransformers)
Description
The chain of URI transformers that transform the original URI.
Attributes
Plugin-List
Optional
Assignable plugins
Query Parameter URI Transformation Regex-based URI Transformer To Query Parameter URI Transformer
Value Extractors (valueExtractors)
Description
The extractors that extract string values from the transformed URI. The result of the first extractor returning a non-empty value is used.
Attributes
Plugin-List
Optional
Assignable plugins
Query Parameter URI Value Extraction Regex-based URI Value Extraction
String Transformers (stringTransformers)
Description
The chain of string transformers that transform the extracted string value to the final interpretation result.
Attributes
Plugin-List
Optional
Assignable plugins
Lowercase String Transformation Regex String Transformation String Transformation Failed
YAML Template (with default values) 

type: AdvancedLocationInterpreter
id: AdvancedLocationInterpreter-xxxxxx
displayName: 
comment: 
properties:
  defaultValue:
  stringTransformers:
  uriTransformers:
  valueExtractors: