agent3properties

OpenSSO Policy Agent 3.0 Property Page

The OpenSSO Policy Agents 3.0 have many properties. Each of the opensso agent properties controls the behavior of an agent feature and allows you to configure your agents. This page contains lists for all the properties in the J2EE agents and the web agents, and each property has a link to a desription of the behavior of each property. Just navigate to or search for the property on this page you want to learn more about.

Below are links to the main categories presented on this page:

Web Agent Properties
In the Sun Federated Access Manager Policy Agent Console, the web agents are divided into the following categories:
-Global
-Application
-OpenSSO Services
-Miscellaneous
-SSO
-Advanced

J2EE Agent Properties
In the Sun Federated Access Manager Policy Agent Console, the J2EE agents are divided into the following categories:
-Global
-Application
-SSO
-OpenSSO Services
-Miscellaneous
-Advanced

How Properties are Presented in This Wiki

The properties are listed on this page as they appear in the Console. Of course, one using the command line (the ssoadm utility) would also find this wiki useful. However, the format of this wiki is not as meaningful for the command line.

In the Federated Access Manager Console, each tab, such as the Global tab, is divided into categories. This wiki is arranged in the same way. In this wiki, each category is presented in its own table, where all the properties for that category are listed. The label and name for each property are provided in the table. Also a Help link and a Details link for each property are provided.

The Details links are being filled in first. These links provide detailed information about the property. Policy Agent developers and others can update a description here whenever a property comes up for discussion. Historically, a property was described in a discussion, such as a forum, but it was not captured somewhere central, such as this wiki. Hopefully, now, someone will add the description to this wiki if no description exists or edit the current description if it can be enhanced.

The Help links might be filled in later. The Help links would go to a property list where the online Help info would be presented. The purpose is two-fold: People can see the quick explanation for the property as it appears in the online Help. Also, people can suggest a better explanation for the online Help. So, changes for the online Help can be stored there until the online Help is updated.

The following task describes how you can access the Policy Agent properties using the Console.

To Access the Properties in the Federated Access Manager Console

  1. Log in to Federated Access Manager Console.
    The following example demonstrates the potential formatting for the URL of the login page:
    http://OpenssoHost.example.com:8080/opensso
  2. Click the Access Control tab.
  3. Click the name of the realm to which the agent will belong.
  4. Click the Agents tab.
  5. If necessary, select the tab for the appropriate agent type.
    • Web Agents:
      The Web tab is for web agents and is the default selection. No further selection is necessary.
    • J2EE Agents:
      The J2EE tab is for J2EE agents. If applicable, click this tab.
  6. In the Agent section, click the name of the agent you want to access.
    Since the Global tab is the default tab, the properties in this tab appear first. You can then navigate from tab to tab, scrolling down through the various properties. You can then edit these properties according to the requirements of the site.

Web Agent Properties

The web agent categories are repeated below as they appear in Sun Federated Access Manager Policy Agent Console:
-Global
-Application
-SSO
-OpenSSO Services
-Miscellaneous
-Advanced

Global: Web Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Global category of web agents is divided into the following subcategories:
-Profile
-General
-Audit
-Fully Qualified Domain Name Checking

Profile (Global web agent properties)

Property Label Property Name Online Help More Details
Group N/A Help Details
Password N/A Help Details
Password (confirm) N/A Help Details
Status N/A Help Details
Location of Agent Configuration Repository N/A Help Details
Agent Configuration Change Notification com.sun.identity.agents.config.change.notification.enable Help Details
Enable Notifications com.sun.identity.agents.config.notification.enable Help Details
Agent Notifcation URL com.sun.identity.client.notification.url Help Details
Agent Deploymet URI Prefix com.sun.identity.agents.config.agenturi.prefix Help Details
Configuration Reload Interval com.sun.identity.agents.config.polling.interval Help Details
Configuration Cleanup Interval com.sun.identity.agents.config.cleanup.interval Help Details
Agent Root URL for CDSSO N/A Help Details

General (Global web agent properties)

Property Label Property Name Online Help More Details
SSO Only com.sun.identity.agents.config.sso.only Help Details
Resources Access Denied URL com.sun.identity.agents.config.access.denied.url Help Details
Agent Debug Level com.sun.identity.agents.config.debug.level Help Details
Agent Debug File Rotation com.sun.identity.agents.config.debug.file.rotate Help Details
Agent Debug File Size com.sun.identity.agents.config.debug.file.size Help Details

Audit (Global web agent properties)

Property Label Property Name Online Help More Details
Audit Access Types com.sun.identity.agents.config.audit.accesstype Help Details
Audit Log Location com.sun.identity.agents.config.log.disposition Help Details
Remote Log Filename com.sun.identity.agents.config.remote.logfile Help Details
Remote Audit Log Interval com.sun.identity.agents.config.remote.log.interval Help Details
Rotate Local Audit Log com.sun.identity.agents.config.local.log.rotate Help Details
Local Audit Log Rotation Size com.sun.identity.agents.config.local.log.size Help Details

Fully Qualified Domain Name Checking (Global web agent properties)

Property Label Property Name Online Help More Details
FQDN Check com.sun.identity.agents.config.fqdn.check.enable Help Details
FQDN Default com.sun.identity.agents.config.fqdn.default Help Details
FQDN Virtual Host Map com.sun.identity.agents.config.fqdn.mapping Help Details

Application: Web Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Application category of web agents is divided into the following subcategories:
-Not Enforced URL Processing
-Not Enforced IP Processing
-Profile Attributes Processing
-Response Attributes Processing
-Session Attributes Processing
-Common Attributes Fetching Processing

Not Enforced URL Processing (Application web agent properties)

Property Label Property Name Online Help More Details
Not Enforced URLs com.sun.identity.agents.config.notenforced.url Help Details
Invert Check for Not Enforced URLs com.sun.identity.agents.config.notenforced.url.invert Help Details
Fetch Attributes for Notenforced URLs com.sun.identity.agents.config.notenforced.url.attributes.enable Help Details

Not Enforced IP Processing (Application web agent properties)

Property Label Property Name Online Help More Details
Not Enforced Client IP List com.sun.identity.agents.config.notenforced.ip Help Details
Client IP Validation com.sun.identity.agents.config.client.ip.validation.enable Help Details

Profile Attributes Processing (Application web agent properties)

Property Label Property Name Online Help More Details
Profile Attributes Fetch Mode com.sun.identity.agents.config.profile.attribute.fetch.mode Help Details
Profile Attribute Map com.sun.identity.agents.config.profile.attribute.mapping Help Details

Response Attributes Processing (Application web agent properties)

Property Label Property Name Online Help More Details
Response Attribute Fetch Mode com.sun.identity.agents.config.response.attribute.fetch.mode Help Details
Response Attribute Map com.sun.identity.agents.config.response.attribute.mapping Help Details

Session Attributes Processing (Application web agent properties)

Property Label Property Name Online Help More Details
Session Attribute Fetch Mode com.sun.identity.agents.config.session.attribute.fetch.mode Help Details
Session Attribute Map com.sun.identity.agents.config.session.attribute.mapping Help Details

Common Attributes Fetching Processing (Application web agent properties)

Property Label Property Name Online Help More Details
Attribute Multi Value Separator com.sun.identity.agents.config.attribute.multi.value.separator Help Details

SSO: Web Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the SSO category of web agents is divided into the following subcategories:
-Cookie
-Cross Domain SSO
-Cookie Reset

Cookie (SSO web agent properties)

Property Label Property Name Online Help More Details
Cookie Name com.sun.identity.agents.config.cookie.name Help Details
Cookie Security com.sun.identity.agents.config.cookie.secure) Help Details

Cross Domain SSO (SSO web agent properties)

Property Label Property Name Online Help More Details
Cross Domain SSO com.sun.identity.agents.config.cdsso.enable Help Details
CDSSO Servlet URL com.sun.identity.agents.config.cdsso.cdcservlet.url Help Details
Cookies Domain List com.sun.identity.agents.config.cookie.domain Help Details

Cookie Reset (SSO web agent properties)

Property Label Property Name Online Help More Details
Cookie Reset com.sun.identity.agents.config.cookie.reset.enable Help Details
Cookies Reset Name List com.sun.identity.agents.config.cookie.reset Help Details

OpenSSO Services: Web Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the OpenSSO Services category of web agents is divided into the following subcategories:
-Login URL
-Agent Logout URL
-Policy Client Service

Login URL (OpenSSO Services web agent properties)

Property Label Property Name Online Help More Details
OpenSSO Login URL com.sun.identity.agents.config.login.url Help Details
Agent Connection Timeout com.sun.identity.agents.config.auth.connection.timeout Help Details
Polling Period for Primary Server com.sun.identity.agents.config.poll.primary.server Help Details

Agent Logout URL (OpenSSO Services web agent properties)

Property Label Property Name Online Help More Details
Logout URL List com.sun.identity.agents.config.logout.url Help Details
Logout Cookies List for Reset com.sun.identity.agents.config.logout.cookie.reset Help Details

Policy Client Service (OpenSSO Services web agent properties)

Property Label Property Name Online Help More Details
Policy Cache Polling Period com.sun.identity.agents.config.policy.cache.polling.interval Help Details
SSO Cache Polling Period com.sun.identity.agents.config.sso.cache.polling.interval Help Details
User ID Parameter com.sun.identity.agents.config.userid.param Help Details
User ID Parameter Type com.sun.identity.agents.config.userid.param.type Help Details
Fetch Policies from Root Resource com.sun.identity.agents.config.fetch.from.root.resource Help Details
Retrieve Client Hostname com.sun.identity.agents.config.get.client.host.name Help Details
Policy Clock Skew com.sun.identity.agents.config.policy.clock.skew Help Details

Miscellaneous: Web Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Miscellaneous category of web agents is divided into the following subcategories:
-Locale
-Anonymous user
-Cookie Processing
-URL Handling
-Ignore Naming URL
-Ignore Server Check
-Ignore Path Info
-Multi-byte Enable
-Deprecated Agent Properties

Locale (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Agent Locale com.sun.identity.agents.config.locale Help Details

Anonymous user (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Anonymous User com.sun.identity.agents.config.anonymous.user.enable Help Details

Cookie Processing (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Profile Attributes Cookie Prefix com.sun.identity.agents.config.profile.attribute.cookie.prefix Help Details
Profile Attributes Cookie Maxage com.sun.identity.agents.config.profile.attribute.cookie.maxage Help Details

URL Handling (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
URL Comparison Case Sensitivity Check com.sun.identity.agents.config.url.comparison.case.ignore Help Details
Encode URL's Special Characters com.sun.identity.agents.config.encode.url.special.chars.enable Help Details

Ignore Naming URL (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Ignore Preferred Naming URL in Naming Request com.sun.identity.agents.config.ignore.preferred.naming.url Help Details

Ignore Server Check (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Ignore Server Check com.sun.identity.agents.config.ignore.server.check Help Details

Ignore Path Info (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Ignore Path Info in Request URL com.sun.identity.agents.config.ignore.path.info Help Details

Multi-byte Enable (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Native Encoding of Profile Attributes com.sun.identity.agents.config.convert.mbyte.enable Help Details

Deprecated Agent Properties (Miscellaneous web agent properties)

Property Label Property Name Online Help More Details
Anonymous User Default Value com.sun.identity.agents.config.anonymous.user.id Help Details

Advanced: Web Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Advanced category of web agents is divided into the following subcategories:
-Load Balancer
-Sun Java System Web Server
-Sun Java System Proxy Server
-Microsoft IIS Server
-IBM Lotus Domino Server
-Custom Properties

Load Balancer (Advanced web agent properties)

Property Label Property Name Online Help More Details
Load Balancer Setup com.sun.identity.agents.config.load.balancer.enable Help Details
Override Request URL Protocol com.sun.identity.agents.config.override.protocol Help Details
Override Request URL Host com.sun.identity.agents.config.override.host Help Details
Override Request URL Port com.sun.identity.agents.config.override.port Help Details
Override Notification URL com.sun.identity.agents.config.override.notification.url Help Details

Sun Java System Web Server (Advanced web agent properties)

Property Label Property Name Online Help More Details
POST Data Preservation com.sun.identity.agents.config.postdata.preserve.enable Help Details
POST Data Entries Cache Period com.sun.identity.agents.config.postcache.entry.lifetime Help Details

Sun Java System Proxy Server (Advanced web agent properties)

Property Label Property Name Online Help More Details
Override Proxy Server's Host and Port com.sun.identity.agents.config.proxy.override.host.port Help Details

Microsoft IIS Server (Advanced web agent properties)

Property Label Property Name Online Help More Details
Authentication Type com.sun.identity.agents.config.iis.auth.type Help Details
Replay Password Key com.sun.identity.agents.config.replaypasswd.key Help Details
Filter Priority com.sun.identity.agents.config.iis.filter.priority Help Details
Filter configured with OWA com.sun.identity.agents.config.iis.owa.enable Help Details
Change URL Protocol to https com.sun.identity.agents.config.iis.owa.enable.change.protocol Help Details
Idle Session Timeout Page URL com.sun.identity.agents.config.iis.owa.enable.session.timeout.url Help Details

IBM Lotus Domino Server (Advanced web agent properties)

Property Label Property Name Online Help More Details
Check User in Domino Database com.sun.identity.agents.config.domino.check.name.database Help Details
Use LTPA token com.sun.identity.agents.config.domino.ltpa.enable Help Details
LTPA Token Cookie Name com.sun.identity.agents.config.domino.ltpa.cookie.name Help Details
LTPA Token Configuration Name com.sun.identity.agents.config.domino.ltpa.config.name Help Details
LTPA Token Organization Name com.sun.identity.agents.config.domino.ltpa.org.name Help Details

Custom Properties (Advanced web agent properties)

Property Label Property Name Online Help More Details
Custom Properties com.sun.identity.agents.config.freeformproperties Help Details


J2EE Agent Properties

The J2EE agent categories are repeated below as they appear in Sun Federated Access Manager Policy Agent Console:
-Global
-Application
-SSO
-OpenSSO Services
-Miscellaneous
-Advanced

Global: J2EE Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Global category of J2EE agents is divided into the following subcategories:
-Profile
-General
-User Mapping
-Audit
-Fully Qualified Domain Name Checking

Profile (Global J2EE agent properties)

Property Label Property Name Online Help More Details
Group N/A Help Details
Password N/A Help Details
Password (confirm) N/A Help Details
Status N/A Help Details
Agent Notification URL com.sun.identity.client.notification.url Help Details
Location of Agent Configuration Repository N/A Help Details
Configuration Reload Interval com.sun.identity.agents.config.load.interval Help Details
Agent Configuration Change Notification com.sun.identity.agents.config.change.notification.enable Help Details
Agent Root URL for CDSSO N/A Help Details

General (Global J2EE agent properties)

Property Label Property Name Online Help More Details
Agent Filter Mode com.sun.identity.agents.config.filter.mode Help Details
HTTP Session Binding com.sun.identity.agents.config.httpsession.binding Help Details
Login Attempt Limit com.sun.identity.agents.config.login.attempt.limit Help Details
Custom Response Header com.sun.identity.agents.config.response.header Help Details
Redirect Attempt Limit com.sun.identity.agents.config.redirect.attempt.limit Help Details
Agent Debug Level com.iplanet.services.debug.level Help Details

User Mapping (Global J2EE agent properties)

Property Label Property Name Online Help More Details
User Mapping Mode com.sun.identity.agents.config.user.mapping.mode Help Details
User Attribute Name com.sun.identity.agents.config.user.attribute.name Help Details
User Principal Flag com.sun.identity.agents.config.user.principal Help Details
User Token Name com.sun.identity.agents.config.user.token Help Details

Audit (Global J2EE agent properties)

Property Label Property Name Online Help More Details
Audit Access Types com.sun.identity.agents.config.audit.accesstype Help Details
Audit Log Location com.sun.identity.agents.config.log.disposition Help Details
Remote Log File Name com.sun.identity.agents.config.remote.logfile Help Details
Rotate Local Audit Log com.sun.identity.agents.config.local.log.rotate Help Details
Local Audit Log Rotation Size com.sun.identity.agents.config.local.log.size Help Details

Fully Qualified Domain Name Checking (Global J2EE agent properties)

Property Label Property Name Online Help More Details
FQDN Check com.sun.identity.agents.config.fqdn.check.enable Help Details
FQDN Default com.sun.identity.agents.config.fqdn.default Help Details
FQDN Virtual Host Map com.sun.identity.agents.config.fqdn.mapping Help Details

Application: J2EE Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Application category of J2EE agents is divided into the following subcategories:
-Login Processing
-Logout Processing
-Access Denied URI Processing
-Not Enforced URI Processing
-Not Enforced IP Processing
-Profile Attributes Processing
-Response Attributes Processing
-Common Attributes Fetching Processing
-Session Attributes Processing
-Privilege Attributes Processing
-Custom Authentication Processing

Login Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Login Form URI com.sun.identity.agents.config.login.form Help Details
Login Error URI com.sun.identity.agents.config.login.error.uri Help Details
Use Internal Login com.sun.identity.agents.config.login.use.internal Help Details
Login Content File Name com.sun.identity.agents.config.login.content.file Help Details

Logout Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Application Logout Handler com.sun.identity.agents.config.logout.application.handler Help Details
Application Logout URI com.sun.identity.agents.config.logout.uri Help Details
Logout Request Parameter com.sun.identity.agents.config.logout.request.param Help Details
Logout Introspect Enabled com.sun.identity.agents.config.logout.introspect.enabled Help Details
Logout Entry URI com.sun.identity.agents.config.logout.entry.uri Help Details

Access Denied URI Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Resource Access Denied URI com.sun.identity.agents.config.access.denied.uri Help Details

Not Enforced URI Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Not Enforced URIs com.sun.identity.agents.config.notenforced.uri Help Details
Invert Not Enforced URIs com.sun.identity.agents.config.notenforced.uri.invert Help Details
Not Enforced URIs Cache Enabled com.sun.identity.agents.config.notenforced.uri.cache.enable Help Details
Not Enforced URIs Cache Size com.sun.identity.agents.config.notenforced.uri.cache.size Help Details

Not Enforced IP Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Not Enforced Client IP List com.sun.identity.agents.config.notenforced.ip Help Details
Not Enforced IP Invert List com.sun.identity.agents.config.notenforced.ip.invert Help Details
Not Enforced IP Cache Flag com.sun.identity.agents.config.notenforced.ip.cache.enable Help Details
Not Enforced IP Cache Size com.sun.identity.agents.config.notenforced.ip.cache.size Help Details

Profile Attributes Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Profile Attribute Fetch Mode com.sun.identity.agents.config.profile.attribute.fetch.mode Help Details
Profile Attribute Mapping com.sun.identity.agents.config.profile.attribute.mapping Help Details

Response Attributes Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Response Attribute Fetch Mode com.sun.identity.agents.config.response.attribute.fetch.mode Help Details
Response Attribute Mapping com.sun.identity.agents.config.response.attribute.mapping Help Details

Common Attributes Fetching Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Cookie Separator Character com.sun.identity.agents.config.attribute.cookie.separator Help Details
Fetch Attribute Date Format com.sun.identity.agents.config.attribute.date.format Help Details
Attribute Cookie Encode com.sun.identity.agents.config.attribute.cookie.encode Help Details

Session Attributes Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Session Attribute Fetch Mode com.sun.identity.agents.config.session.attribute.fetch.mode Help Details
Session Attribute Mapping com.sun.identity.agents.config.session.attribute.mapping Help Details

Privilege Attributes Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Default Privileged Attribute com.sun.identity.agents.config.default.privileged.attribute Help Details
Privileged Attribute Type com.sun.identity.agents.config.privileged.attribute.type Help Details
Privileged Attributes To Lower Case com.sun.identity.agents.config.privileged.attribute.tolowercase Help Details
Privileged Session Attribute com.sun.identity.agents.config.privileged.session.attribute Help Details
Enable Privileged Attribute Mapping com.sun.identity.agents.config.privileged.attribute.mapping.enable Help Details
Privileged Attribute Mapping com.sun.identity.agents.config.privileged.attribute.mapping Help Details

Custom Authentication Processing (Application J2EE agent properties)

Property Label Property Name Online Help More Details
Custom Authentication Handler com.sun.identity.agents.config.auth.handler Help Details
Custom Logout Handler com.sun.identity.agents.config.logout.handler Help Details
Custom Verification Handler com.sun.identity.agents.config.verification.handler Help Details

SSO: J2EE Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the SSO category of J2EE agents is divided into the following subcategories:
-Cookie Name
-Caching
-Cross Domain SSO
-Cookie Reset

Cookie Name (SSO J2EE agent properties)

Property Label Property Name Online Help More Details
Cookie Name com.iplanet.am.cookie.name Help Details

Caching (SSO J2EE agent properties)

Property Label Property Name Online Help More Details
SSO Cache Enable com.sun.identity.agents.config.amsso.cache.enable Help Details

Cross Domain SSO (SSO J2EE agent properties)

Property Label Property Name Online Help More Details
Cross Domain SSO com.sun.identity.agents.config.cdsso.enable Help Details
CDSSO Redirect URI com.sun.identity.agents.config.cdsso.redirect.uri Help Details
CDSSO Servlet URL com.sun.identity.agents.config.cdsso.cdcservlet.url Help Details
CDSSO Clock Skew com.sun.identity.agents.config.cdsso.clock.skew Help Details
CDSSO Trusted ID Provider com.sun.identity.agents.config.cdsso.trusted.id.provider Help Details
CDSSO Secure Enable com.sun.identity.agents.config.cdsso.secure.enable Help Details
CDSSO Domain List com.sun.identity.agents.config.cdsso.domain Help Details

Cookie Reset (SSO J2EE agent properties)

Property Label Property Name Online Help More Details
Cookie Reset com.sun.identity.agents.config.cookie.reset.enable Help Details
Cookies Reset Name List com.sun.identity.agents.config.cookie.reset.name Help Details
Cookies Reset Domain Map com.sun.identity.agents.config.cookie.reset.domain Help Details
Cookies Reset Path Map com.sun.identity.agents.config.cookie.reset.path Help Details

OpenSSO Services: J2EE Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the OpenSSO Services category of J2EE agents is divided into the following subcategories:
-Login URL
-Logout URL
-Authentication Service
-Policy Client Service
-User Data Cache Service
-Session Client Service

Login URL (OpenSSO Services J2EE agent properties)

Property Label Property Name Online Help More Details
OpenSSO Login URL com.sun.identity.agents.config.login.url Help Details
Login URL Prioritized com.sun.identity.agents.config.login.url.prioritized Help Details
Login URL Probe com.sun.identity.agents.config.login.url.probe.enabled Help Details
Login URL Probe Timeout com.sun.identity.agents.config.login.url.probe.timeout Help Details

Logout URL (OpenSSO Services J2EE agent properties)

Property Label Property Name Online Help More Details
OpenSSO Logout URL com.sun.identity.agents.config.logout.url Help Details
Logout URL Prioritized com.sun.identity.agents.config.logout.url.prioritized Help Details
Logout URL Probe com.sun.identity.agents.config.logout.url.probe.enabled Help Details
Logoout URL Probe Timeout com.sun.identity.agents.config.logout.url.probe.timeout Help Details

Authentication Service (OpenSSO Services J2EE agent properties)

Property Label Property Name Online Help More Details
OpenSSO Authentication Service Protocol com.iplanet.am.server.protocol Help Details
OpenSSO Authentication Service Host Name com.iplanet.am.server.host Help Details
OpenSSO Authentication Service Port com.iplanet.am.server.port Help Details

Policy Client Service (OpenSSO Services J2EE agent properties)

Property Label Property Name Online Help More Details
Enable Policy Notifications com.sun.identity.agents.notification.enabled Help Details
Policy Client Polling Interval com.sun.identity.agents.polling.interval Help Details
Policy Client Cache Mode com.sun.identity.policy.client.cacheMode Help Details
Policy Client Boolean Action Values com.sun.identity.policy.client.booleanActionValues Help Details
Policy Client Resource Comparators com.sun.identity.policy.client.resourceComparators Help Details
Policy Client Clock Skew com.sun.identity.policy.client.clockSkew Help Details
URL Policy Env GET Parameters com.sun.identity.agents.config.policy.env.get.param Help Details
URL Policy Env POST Parameters com.sun.identity.agents.config.policy.env.post.param Help Details
URL Policy Env jsession Parameters com.sun.identity.agents.config.policy.env.jsession.param Help Details

User Data Cache Service (OpenSSO Services J2EE agent properties)

Property Label Property Name Online Help More Details
Enable Notification of User Data Caches com.sun.identity.idm.remote.notification.enabled Help Details
User Data Cache Polling Time com.iplanet.am.sdk.remote.pollingTime Help Details
Enable Notification of Service Data Caches com.sun.identity.sm.notification.enabled Help Details
Service Data Cache Time com.sun.identity.sm.cacheTime Help Details

Session Client Service (OpenSSO Services J2EE agent properties)

Property Label Property Name Online Help More Details
Enable Client Polling com.iplanet.am.session.client.polling.enable Help Details
Client Polling Period com.iplanet.am.session.client.polling.period Help Details

Miscellaneous: J2EE Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Miscellaneous category of J2EE agents is divided into the following subcategories:
-Locale
-Port Check Processing
-Bypass Principal List
-Agent Password Encryptor
-Ignore Path Info
-Deprecated Agent Properties

Locale (Miscellaneous J2EE agent properties)

Property Label Property Name Online Help More Details
Locale Language com.sun.identity.agents.config.locale.language Help Details
Locale Country com.sun.identity.agents.config.locale.country Help Details

Port Check Processing (Miscellaneous J2EE agent properties)

Property Label Property Name Online Help More Details
Port Check Enable com.sun.identity.agents.config.port.check.enable Help Details
Port Check File com.sun.identity.agents.config.port.check.file Help Details
Port Check Setting com.sun.identity.agents.config.port.check.setting Help Details

Bypass Principal List (Miscellaneous J2EE agent properties)

Property Label Property Name Online Help More Details
Bypass Principal List com.sun.identity.agents.config.bypass.principal Help Details

Agent Password Encryptor (Miscellaneous J2EE agent properties)

Property Label Property Name Online Help More Details
Encryption Provider com.iplanet.security.encryptor Help Details

Ignore Path Info (Miscellaneous J2EE agent properties)

Property Label Property Name Online Help More Details
Ignore Path Info in Request URL com.sun.identity.agents.config.ignore.path.info Help Details

Deprecated Agent Processing (Miscellaneous J2EE agent properties)

Property Label Property Name Online Help More Details
GOTO Parameter Name com.sun.identity.agents.config.redirect.param Help Details
Legacy Support Enable com.sun.identity.agents.config.legacy.support.enable Help Details
Legacy User Agent com.sun.identity.agents.config.legacy.user.agent Help Details
Legacy Redirect URI com.sun.identity.agents.config.legacy.redirect.uri Help Details

Advanced: J2EE Agent Properties

In the Sun Federated Access Manager Policy Agent Console, the Advanced category of J2EE agents is divided into the following subcategories:
-Client Identification
-Web Service Processing
-Alternate Agent URL
-Custom Properties

Client Identification (Advanced J2EE agent properties)

Property Label Property Name Online Help More Details
Client IP Address Header com.sun.identity.agents.config.client.ip.header Help Details
Client Hostname Header com.sun.identity.agents.config.client.hostname.header Help Details

Web Service Processing (Advanced J2EE agent properties)

Property Label Property Name Online Help More Details
Web Service Enable com.sun.identity.agents.config.webservice.enable Help Details
Web Service End Points com.sun.identity.agents.config.webservice.endpoint Help Details
Web Service Process GET Enable com.sun.identity.agents.config.webservice.process.get.enable Help Details
Web Service Authenticator com.sun.identity.agents.config.webservice.authenticator Help Details
Web Service Internal Error Content File com.sun.identity.agents.config.webservice.internalerror.content Help Details
Web Service Authorization Error Content File com.sun.identity.agents.config.webservice.autherror.content Help Details

Alternate Agent URL (Advanced J2EE agent properties)

Property Label Property Name Online Help More Details
Alternative Agent Host Name com.sun.identity.agents.config.agent.host Help Details
Alternative Agent Port Name com.sun.identity.agents.config.agent.port Help Details
Alternative Agent Protocol com.sun.identity.agents.config.agent.protocol Help Details

Custom Properties (Advanced J2EE agent properties)

Property Label Property Name Online Help More Details
Custom Properties com.sun.identity.agents.config.freeformproperties Help Details


Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
j2eeadvancedalternateagenturl
j2eeadvancedclientidentification
j2eeadvancedcustomproperties
j2eeadvancedwebserviceprocessing
j2eeapplicationcommonattributesfetchingprocessing
j2eeapplicationcustomauthenticationprocessing
j2eeapplicationloginprocessing
j2eeapplicationlogoutprocessing
j2eeapplicationnotenforcedipprocessing
j2eeapplicationnotenforceduriprocessing
j2eeapplicationprivilegeattributesprocessing
j2eeapplicationprofileattributesprocessing
j2eeapplicationresponseattributesprocessing
j2eeapplicationsessionattributesprocessing
j2eeglobalaudit
j2eeglobalfullyqualifiedomainnamechecking
j2eeglobalgeneralagentdebuglevel
j2eeglobalgeneralagentfiltermode
j2eeglobalgeneralcustomresponseheader
j2eeglobalgeneralhttpsessionbinding
j2eeglobalgeneralloginattemptlimit
j2eeglobalgeneralredirectattemptlimit
j2eeglobalgeneralresourceaccessdenieduridetails
j2eeglobalprofileagentconfigurationchangenotification
j2eeglobalprofileagentnotificationurl
j2eeglobalprofileagentrooturlforcdsso
j2eeglobalprofileconfigurationreloadinterval
j2eeglobalprofilegroup
j2eeglobalprofilelocationofagentconfigurationrepository
j2eeglobalprofilepasswordrelatedproperties
j2eeglobalprofilestatus
j2eeglobalusermapping
j2eemiscellaneousagentpasswordencryptor
j2eemiscellaneousbypassprincipallistbypassprincipallist
j2eemiscellaneousdeprecatedagentproperties
j2eemiscellaneousdeprecatedagentpropertiesgotoparametername
j2eemiscellaneousignorepathinfo
j2eemiscellaneouslocale
j2eemiscellaneousportcheckprocessing
j2eeopenssoenterpriseloginprops
j2eeopenssoenterpriselogoutprops
j2eeopenssoenterpriseservicesauthenticationservice
j2eeopenssoenterpriseservicespolicyclientservice
j2eeopenssoenterpriseservicessessionclientservice
j2eeopenssoenterpriseservicesuserdatacacheservice
j2eessocaching
j2eessocookiename
j2eessocookiereset
j2eessocrossdomainsso
miscellaneouswebignorepathinfo
webglobalgeneralgroup
webglobalprofileagentconfigurationchangenotification
webglobalprofileagentdeploymenturiprefix
webglobalprofileagentnotificationurl
webglobalprofileagentrooturlforcdsso
webglobalprofileconfigurationreloadcleanup
webglobalprofileconfigurationreloadinterval
webglobalprofilelocationofagentconfigurationrepository
webglobalprofilenotifications
webglobalprofilepasswordrelatedproperties
webglobalprofilestatus
  1. Nov 03, 2008

    dcovey says:

    Is there some documentation somewhere that adequately describes the meaning of t...

    Is there some documentation somewhere that adequately describes the meaning of the properties in the http://wikis.sun.com/display/OpenSSO/agent3properties#agent3properties-advancedwebloadbalancer (load balancer) section?

    Under what circumstances do need to have this configured, what is the effect if I dont?

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Sun Microsystems community and they might not be employed or in any way formally affiliated with Sun Microsystems. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Sun nor any other party necessarily agrees with them.

Copyright 1994-2009 Sun Microsystems, Inc.
Powered by Atlassian Confluence
Sun Guidelines on Public Discourse Privacy Policy Terms of Use Trademarks Site Map Employment Investor Relations Contact