← Back to plugin index

Request URL Pattern UI Resource Set Rule
Description
Changes the directory from which UI resources are retrieved if the request URL for this resource matches a regex pattern.
Type name
RequestUrlPatternUiResourceSetRule
Class
com.airlock.iam.login.application.configuration.uiresource.RequestUrlPatternUiResourceSetRuleConfig
May be used by
UI Settings
Properties
Request URL Pattern (requestUrlPattern)
Description

If the request URL to a UI resource matches this pattern, then the resource is retrieved from the resource set specified in the "UI Resource Set File Name" property.

Note that each request for a resource has its URL matched separately.

The request URL checked against this pattern includes the protocol, host, port and path, but excludes query parameters.

This feature is intended to be used to set a custom UI resource set for a particular domain. Changing the UI resource set, e.g. between different flows with the same domain, is not supported. Therefore it is not advised to define a "Request URL Pattern" matching specific request paths.

Attributes
RegEx
Mandatory
UI Resource Set File Name (uiResourceSetFileName)
Description

Name of the UI resource set zip file that contains the Loginapp Design Kit customization.

If the request URL matches the pattern configured in the "Request URL Pattern" property, the resource is retrieved from this zip file instead of the default UI resource set.

The zip file is required to be located in the directory specified in the instance.properties file under iam.loginapp.ui.resource-sets.dir. It can also be located in a subfolder if necessary.

It must be ensured that the zip file names only occur once, regardless of the file path.

It is possible to add new zip files or replace existing zip files while the application is running. Note that it is important to use an atomic file operation so that the zip files are recognized correctly.

Changing the folder structure by adding, renaming or removing folders as well as moving, renaming or deleting existing zip files is not supported. A restart is required for this to work properly.

Note that "UI Resource Set File Name" must only contain the file name without the file extension and only the characters A-Z, a-z, 0-9 as well as the special characters '-' and '_' are allowed as zip file names.

If there are zip files with duplicate names in the iam.loginapp.ui.resource-sets.dir directory, an exception is thrown during startup. If a duplicate zip file is added while the application is running, an error message is displayed in the console.

Attributes
String
Mandatory
Validation RegEx: [\w_-]+
Example
resource-set-A
Example
resource_set_B
YAML Template (with default values) 

type: RequestUrlPatternUiResourceSetRule
id: RequestUrlPatternUiResourceSetRule-xxxxxx
displayName: 
comment: 
properties:
  requestUrlPattern:
  uiResourceSetFileName: