Sun OpenSSO Enterprise Policy Agent 3.0 User's Guide for Web Agents

Policy Agent 3.0: Web Agent Properties

The web agent properties changed names from the 2.2 release to the 3.0 release. This section lists those name changes. Furthermore, when applicable, this section provides the property label used with the property names. In prior releases, only property names were used for the properties. However, in Policy Agent 3.0 you can centralize the properties on the OpenSSO Enterprise Console, where labels are more useful.

Web Agent Properties in the OpenSSOAgentBootstrap.properties File

The properties listed in the table that follows can be configured by accessing the OpenSSOAgentBootstrap.properties file. This properties file, which is new for the 3.0 release, resides locally on the system where the agent is installed and stores the properties required for the agent to start up and initialize itself.

The properties listed in the web agent OpenSSOAgentBootstrap.properties file are either new for 3.0 or their property names have changed as indicated in the table. Labels are not assigned for the properties in this file.

Former Web Agent Property Name 

Web Agent 3.0 Property Name 

com.sun.am.naming.url

com.sun.identity.agents.config.naming.url

com.sun.am.log.level

com.sun.identity.agents.config.debug.level

com.sun.am.policy.agents.config.local.log.file

com.sun.identity.agents.config.local.logfile

com.sun.am.policy.am.username

com.sun.identity.agents.config.username

com.sun.am.policy.am.password

com.sun.identity.agents.config.password

com.sun.am.sslcert.dir

com.sun.identity.agents.config.sslcert.dir

com.sun.am.certdb.prefix

com.sun.identity.agents.config.certdb.prefix

com.sun.am.certdb.password

com.sun.identity.agents.config.certdb.password

com.sun.am.auth.certificate.alias

com.sun.identity.agents.config.certificate.alias

com.sun.am.trust_server_certs

com.sun.identity.agents.config.trust.server.certs

com.sun.am.receive_timeout

com.sun.identity.agents.config.receive.timeout

com.sun.am.connect_timeout

com.sun.identity.agents.config.connect.timeout

com.sun.am.tcp_nodelay.enable

com.sun.identity.agents.config.tcp.nodelay.enable

New 

com.sun.identity.agents.config.organization.name

New 

com.sun.identity.agents.config.key

New 

com.sun.identity.agents.config.debug.file

New 

com.sun.identity.agents.config.forward.proxy.host

New 

com.sun.identity.agents.config.forward.proxy.port

New 

com.sun.identity.agents.config.forward.proxy.user

New 

com.sun.identity.agents.config.forward.proxy.password

New 

com.sun.identity.agents.config.profilename

Web Agent Properties Available Using the OpenSSO Enterprise Console or Other Methods

This section does not describe the agent properties. For a description of the agent properties, see the following link: http://wikis.sun.com/display/OpenSSO/agent3properties

The properties listed in the various tables that follow can be configured using any of the three following methods, depending on how agent is deployed:

The property names have changed for the 3.0 release as indicated in the various tables that follow in this section. Labels are associated with most of these properties, as indicated. The labels are most useful when using the Console.

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.am.login.url

com.sun.identity.agents.config.login.url

Label: OpenSSO Login URL

com.sun.am.cookie.name

com.sun.identity.agents.config.cookie.name

Label: Cookie Name

com.sun.am.cookie.secure

com.sun.identity.agents.config.cookie.secure

Label: Cookie Security

com.sun.am.policy.agents.config.local.log.rotate

com.sun.identity.agents.config.local.log.rotate

Label: Rotate Local Audit Log

com.sun.am.policy.agents.config.local.log.size

com.sun.identity.agents.config.local.log.size

Label: Local Audit Log Rotation Size

com.sun.am.policy.agents.config.audit.accesstype

com.sun.identity.agents.config.audit.accesstype

Label: Audit Access Types

com.sun.am.policy.agents.config.remote.log

com.sun.identity.agents.config.remote.logfile

Label: Remote Log Filename

com.sun.am.notification.enable

com.sun.identity.agents.config.notification.enable

Label: Enable Notifications

com.sun.am.policy.am.url_comparison.case_ignore

com.sun.identity.agents.config.url.comparison.case.ignore

Label: URL Comparison Case Sensitivity Check

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.am.polling.interval

com.sun.identity.agents.config.policy.cache.polling.interval

Label: Policy Cache Polling Period

com.sun.am.sso.polling.period

com.sun.identity.agents.config.sso.cache.polling.interval

Label: SSO Cache Polling Period

com.sun.am.policy.am.userid.param

com.sun.identity.agents.config.userid.param

Label: User ID Parameter

com.sun.am.policy.am.userid.param.type

com.sun.identity.agents.config.userid.param.type

Label: User ID Parameter Type

com.sun.am.policy.agents.config.profile.attribute.fetch.mode

com.sun.identity.agents.config.profile.attribute.fetch.mode

Label: Profile Attribute Fetch Mode

com.sun.am.policy.agents.config.profile.attribute.map

com.sun.identity.agents.config.profile.attribute.mapping

Label: Profile Attribute Mapping

com.sun.am.policy.agents.config.session.attribute.fetch.mode

com.sun.identity.agents.config.session.attribute.fetch.mode

Label: Session Attribute Fetch Mode

com.sun.am.policy.agents.config.session.attribute.map

com.sun.identity.agents.config.session.attribute.mapping

Label: Session Attribute Mapping

com.sun.am.policy.agents.config.response.attribute.fetch.mode

com.sun.identity.agents.config.response.attribute.fetch.mode

Label: Response Attribute Fetch Mode

com.sun.am.policy.agents.config.response.attribute.map

com.sun.identity.agents.config.response.attribute.mapping

Label: Response Attribute Mapping

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.load_balancer.enable

com.sun.identity.agents.config.load.balancer.enable

Label: Load Balancer Setup

com.sun.am.policy.agents.config.agenturi.prefix

com.sun.identity.agents.config.agenturi.prefix

Label: Agent Deployment URI Prefix

com.sun.am.policy.agents.config.locale

com.sun.identity.agents.config.locale

Label: Agent Locale

com.sun.am.policy.agents.config.do_sso_only

com.sun.identity.agents.config.sso.only

Label: SSO Only

com.sun.am.policy.agents.config.accessdenied.url

com.sun.identity.agents.config.access.denied.url

Label: Resources Access Denied URL

com.sun.am.policy.agents.config.fqdn.check.enable

com.sun.identity.agents.config.fqdn.check.enable

Label: FQDN Check

com.sun.am.policy.agents.config.fqdn.default

com.sun.identity.agents.config.fqdn.default

Label: FQDN Default

com.sun.am.policy.agents.config.fqdn.map

com.sun.identity.agents.config.fqdn.mapping

Label: FQDN Virtual Host Map

com.sun.am.policy.agents.config.cookie.reset.enable

com.sun.identity.agents.config.cookie.reset.enable

Label: Cookie Reset

com.sun.am.policy.agents.config.cookie.reset.list

com.sun.identity.agents.config.cookie.reset

Label: Cookies Reset Name List

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.agents.config.cookie.domain.list

com.sun.identity.agents.config.cookie.domain

Label: Cookies Domain List

com.sun.am.policy.agents.config.anonymous_user

com.sun.identity.agents.config.anonymous.user.id

Label: Anonymous User Default Value

com.sun.am.policy.agents.config.anonymous_user.enable

com.sun.identity.agents.config.anonymous.user.enable

Label: Anonymous User

com.sun.am.policy.agents.config.notenforced_list

com.sun.identity.agents.config.notenforced.url

Label: Not Enforced URLs

com.sun.am.policy.agents.config.notenforced_list.invert

com.sun.identity.agents.config.notenforced.url.invert

Label: Invert Check for Not Enforced URLs

com.sun.am.policy.agents.config.notenforced_client_ip_list

com.sun.identity.agents.config.notenforced.ip

Label: Not Enforced Client IP List

com.sun.am.policy.agents.config.ignore_policy_evaluation_if_notenforced

com.sun.identity.agents.config.notenforced.url.attributes.enable

Label: Fetch Attributes for Notenforced URLs

com.sun.am.policy.agents.config.postdata.preserve.enable

com.sun.identity.agents.config.postdata.preserve.enable

Label: POST Data Preservation

com.sun.am.policy.agents.config.postcache.entry.lifetime

com.sun.identity.agents.config.postcache.entry.lifetime

Label: POST Data Entries Cache Period

com.sun.am.policy.agents.config.client_ip_validation.enable

com.sun.identity.agents.config.client.ip.validation.enable

Label: Client IP Validation

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.agents.config.profile.attribute.cookie.prefix

com.sun.identity.agents.config.profile.attribute.cookie.prefix

Label: Profile Attributes Cookie Prefix

com.sun.am.policy.agents.config.profile.attribute.cookie.maxage

com.sun.identity.agents.config.profile.attribute.cookie.maxage

Label: Profile Attributes Cookie Maxage

com.sun.am.policy.agents.config.cdsso.enable

com.sun.identity.agents.config.cdsso.enable

Label: Cross Domain SSO

com.sun.am.policy.agents.config.cdcservlet.url

com.sun.identity.agents.config.cdsso.cdcservlet.url

Label: CDSSO Servlet URL

com.sun.am.policy.agents.config.logout.url

com.sun.identity.agents.config.logout.url

Label: OpenSSO Logout URL

com.sun.am.policy.agents.config.logout.cookie.reset.list

com.sun.identity.agents.config.logout.cookie.reset

Label: Logout Cookies List for Reset

com.sun.am.policy.am.fetch_from_root_resource

com.sun.identity.agents.config.fetch.from.root.resource

Label: Fetch Policies from Root Resource

com.sun.am.policy.agents.config.get_client_host_name

com.sun.identity.agents.config.get.client.host.name

Label: Retrieve Client Hostname

com.sun.am.policy.agents.config.convert_mbyte.enable

com.sun.identity.agents.config.convert.mbyte.enable

Label: Native Encoding of Profile Attributes

com.sun.am.policy.agents.config.encode_url_special_chars.enable

com.sun.identity.agents.config.encode.url.special.chars.enable

Label: Encode URL's Special Characters

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.agents.config.ignore_path_info

com.sun.identity.agents.config.ignore.path.info

Label: Ignore Path Info in Request URL

com.sun.am.policy.agents.config.override_protocol

com.sun.identity.agents.config.override.protocol

Label: Override Request URL Protocol

com.sun.am.policy.agents.config.override_host

com.sun.identity.agents.config.override.host

Label: Override Request URL Host

com.sun.am.policy.agents.config.override_port

com.sun.identity.agents.config.override.port

Label: Override Request URL Port

com.sun.am.policy.agents.config.override_notification.url

com.sun.identity.agents.config.override.notification.url

Label: Override Notification URL

com.sun.am.policy.agents.config.connection_timeout

com.sun.identity.agents.config.auth.connection.timeout

Label: Agent Connection Timeout

com.sun.am.ignore_server_check

com.sun.identity.agents.config.ignore.server.check

Label: Ignore Server Check

com.sun.am.poll_primary_server

com.sun.identity.agents.config.poll.primary.server

Label: Polling Period for Primary Server

com.sun.am.ignore.preferred_naming_url

com.sun.identity.agents.config.ignore.preferred.naming.url

Label: Ignore Preferred Naming URL in Naming Request

com.sun.am.policy.agents.config.proxy.override_host_port

com.sun.identity.agents.config.proxy.override.host.port

Label: Override Proxy Server's Host and Port

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.agents.config.domino.check_name_database

com.sun.identity.agents.config.domino.check.name.database

Label: Check User in Domino Database

com.sun.am.policy.agents.config.domino.ltpa.enable

com.sun.identity.agents.config.domino.ltpa.enable

Label: Use LTPA token

com.sun.am.policy.agents.config.domino.ltpa.cookie_name

com.sun.identity.agents.config.domino.ltpa.cookie.name

Label: LTPA Token Cookie Name

com.sun.am.policy.agents.config.domino.ltpa.config_name

com.sun.identity.agents.config.domino.ltpa.config.name

Label: LTPA Token Configuration Name

com.sun.am.policy.agents.config.domino.ltpa.org_name

com.sun.identity.agents.config.domino.ltpa.org.name

Label: LTPA Token Organization Name

com.sun.am.policy.agents.config.iis.auth_type

com.sun.identity.agents.config.iis.auth.type

Label: Authentication Type

com.sun.am.replaypasswd.key

com.sun.identity.agents.config.replaypasswd.key

Label: Replay Password Key

com.sun.am.policy.agents.config.iis.filter_priority

com.sun.identity.agents.config.iis.filter.priority

Label: Filter Priority

com.sun.am.policy.agents.config.iis.owa_enabled

com.sun.identity.agents.config.iis.owa.enable

Label: Filter configured with OWA

com.sun.am.policy.agents.config.iis.owa_enabled_change_protocol

com.sun.identity.agents.config.iis.owa.enable.change.protocol

Label: Change URL Protocol to https

Former Web Agent Property Name 

Web Agent 3.0 Property Name and Label 

com.sun.am.policy.agents.config.iis.owa_enabled_session_timeout_url

com.sun.identity.agents.config.iis.owa.enable.session.timeout.url

Label: Idle Session Timeout Page URL

NEW 

com.sun.identity.agents.config.repository.location

This product is available in OpenSSO Enterprise Console. However, only the label is provided, not the property name. 

Label: Location of Agent Configuration Repository

NEW 

com.sun.identity.agents.config.freeformproperties

Label: Custom Properties

NEW 

com.sun.identity.agents.config.polling.interval

Label: Configuration Reload Interval

NEW 

com.sun.identity.agents.config.cleanup.interval

Label: Configuration Cleanup Interval