Java Agents 2023.11.2

Query Parameter List for Policy Evaluation

A list of query parameters to be retained for policy evaluation and caching purposes. The property has the following format, with no spaces between values:

[Domain[/path]]|parameter[,parameter…​]

Consider the following constraints when constructing the list of parameters:

  • Add a comma (,) character at the beginning or the end of the list to retain all unnamed parameters. For example, myapp.example.com/customers|,lang matches both lang and any unnamed parameters.

  • Add the asterisk (*) character to the list to retain all parameters, including unnamed ones.

  • The remaining parameters (those that match the list of parameters) are sorted alphabetically.

Examples:

org.forgerock.agents.wanted.http.url.param.list[0]=myapp.example.com/news|area

org.forgerock.agents.wanted.http.url.param.list[1]=example.com/news|area,country,location,

The following incoming URL request matches a rule such as myapp.example.com/customers|,lang:

http://myapp.example.com/customers?country=uk&=bristol&lang=en_GB&area=1343456

It is cached by the agent as http://myapp.example.com/customers?=bristol&lang=en_GB, where both lang and the unnamed parameter are retained and sorted alphabetically.

Property name

org.forgerock.agents.wanted.http.url.param.list

Aliases

org.forgerock.openam.agents.config.conditional.wanted.http.url.params
  Introduced in Java Agent 5.6
  Recognized from AM 7

org.forgerock.agents.wanted.http.url.param.list
  Introduced in Java Agent 5.6

Function

Query parameter

Type

List

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: Miscellaneous (from AM 7)

Title: Query Parameter List for Policy Evaluation

Legacy title: Retain Query Parameters