Java Agents 2024.3

Session Attribute Fetch Mode

Map the name of an AM session attribute specified in Session Attribute Map as follows:

  • NONE: Do not map

  • HTTP_HEADER: Map the to the name of an HTTP session header

  • HTTP_COOKIE: Map to the name of an HTTP cookie

  • REQUEST_ATTRIBUTE: Map to the name of an HTTP session attribute

When the value is HTTP_COOKIE, Cookie Reset is automatically set to true. Before redirecting the client for login, and when the client logs out, the agent resets profile and session attributes cookies, and cookies in the Reset Cookie List.

Property name

org.forgerock.agents.session.attribute.fetch.mode

Aliases

org.forgerock.agents.session.attribute.fetch.mode
  Introduced in Java Agent 5.6

com.sun.identity.agents.config.session.attribute.fetch.mode
  Introduced in Java Agent 5.0
  Recognized from AM 6

Function

Attributes, Cookie reset, Session

Supported settings
NONE

No AM attributes are mapped.

HTTP_HEADER

The named AM attributes are mapped to headers in the outgoing HTTP response.

REQUEST_ATTRIBUTE

The named AM attributes are mapped to request attributes in the outgoing HTTP response.

HTTP_COOKIE

The named AM attributes are mapped to cookies in the outgoing HTTP response.

Default

NONE

Bootstrap property

No

Required property

No

Restart required

No

Local configuration file

AgentConfig.properties

AM console

Tab: Application

Title: Session Attribute Fetch Mode