Single Sign-on Properties (Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers)

Sun OpenSSO Enterprise 8.0 C API Reference for Application and Web Policy Agent Developers

Single Sign-on Properties

The properties required for SSO are not read from AMAgent.properties but are picked up from either the OpenSSO server (if the mode is centralized) or from the local configuration file (if the mode is local). P

Certain properties must be read and passed to am_sso_init() in order to initialize the Session Service. Thus, am_sso_init() must be called before any other single sign-on interface. The properties required for single sign-on are retrieved from OpenSSO Enterprise if using centralized agent configuration, and from the configuration file local to the agent if using local agent configuration.

Note –

See Sun OpenSSO Enterprise Policy Agent 3.0 User’s Guide for Web Agents or Sun Java System Access Manager Policy Agent 2.2 User’s Guide for more information.

Before using the API be sure the properties in the following table are set.

Table 4–1 Single Sign-on Properties Defined During Web Policy Agent Installation


Property	Definition
`com.sun.am.naming.url`	Specifies the URL for the Naming Service which, in turn, finds the URL of the Session Service. This property must be set as: `com.sun.am.naming.url = protocol://OpenSSO Enterprise-host.domain:port/URI/namingservice`
`com.sun.am.notification.enable`	Specifies whether the Notification Service will be used to update the cache. If enabled, a URL where notification messages from OpenSSO Enterprise are sent must be specified. This property is set as: `com.sun.am.notification.enable = true \| false` Note – If `com.sun.am.notification.enable` is not found in the properties file, the default value is `false`.
`com.sun.am.notification.url`	If `com.sun.am.notification.enable` is set to true, the value of this property specifies a URL where notification messages from OpenSSO Enterprise are sent. This property is set as: `com.sun.am.notification.url = protocol//host.domain:port/notification_URL`
`com.sun.am.sso.polling.period`	Specifies how often, in minutes, the cache should be checked for entries that have reached the cache entry life time. This property must be set as: `com.sun.am.sso.checkCacheInterval=#` Note – By default, this property is not part of the agent configuration properties but can be added when needed.
`com.sun.am.sso.max_threads`	Specifies the maximum number of threads the single sign-on API for C should invoke for handling notifications. The API maintains a thread pool and invokes a thread for each notification. If the maximum number of threads has been reached, the notification will wait until a thread is available. This property must be set as: `com.sun.am.sso.maxThreads=#` If not specified the default maximum number of threads is 10. Note – By default, this property is not part of the agent configuration properties but can be added when needed.

For more information, see the Sun OpenSSO Enterprise Policy Agent 3.0 User’s Guide for Web Agents or Sun Java System Access Manager Policy Agent 2.2 User’s Guide.