Access Manager properties are contained in the AMConfig.properties file. Generate the AMConfig.properties for the Client SDK by running the following command:
# make -f Makefile.clientsdk properties
The following sections describe the properties expected by the Access Manager Client SDK. A client application deployed within a servlet container can register for changes to session, user attributes and policy decisions. These properties must be set to receive such notifications.
This is a required property. The value of this property represents the URL where the Client SDK would retrieve the URLs of Access Manager internal services. This is the URI for the Naming Service. Example:
This property can be used by any remote SDK application that wants failover in, for example, session validation or getting the service URLs. Example:
Specifies the debug level. Possible values are levels are: off, error , warning, or message.
The value of this property is the output directory for the debug information. This directory should be writable by the server process. Example:
The value of this property is the URI of the Notification Service running on the host machine where you installed the Client SDK. Example:
Enables or disables notifications for remote policy API. Example:
Defines the notification URL for remote policy API.
Reads configuration data. Example:
Reads configuration data. Example:
Contains the encrypted value of the password. . Example:
This key is needed to decrypt passwords stored in the SMS configuration. Example:
Encryption key that will be used to encrypt and decrypt data used locally within the client. Example:
Property to set JCE as the default encryption classes.
Cache update time (in minutes) for service configuration data if notification URL is not provided. Example:
Cache update time (in minutes) for user management cache if notification URL is not provided. Example: com.iplanet.am.sdk.remote.pollingTime=1
Server protocol to be used by Authentication Service. Example:
Server host to be used by Authentication Service. Example:
Server port to be used by Authentication Service. Example:
Indicates the Access Manager cookie name. Example:
Identifies the certificate database directory path for initializing the JSS Socket Factory when the Access Manager web container is configured for SSL. Example:
Identifies the certificate database password file for initializing the JSS Socket Factory when the Access Manager web container is configured for SSL. Example:
Identifies the certificate database prefix for initializing the JSS Socket Factory when the Access Manager web container is configured for SSL. Example:
Specifies file name for the policy decision log file. Example:
Possible values for policy decision logging level are NONE, ALLOW, DENY, BOTH, and DECISION.
Enables Notification URL for updating cache. Default value is false.
Specifies use of Notification URL for updating cache. Example:com.sun.identity.agents.notification.url=NOTIFICATION_URL
Cache time in minutes. Example:
Information to cache. Possible value are subtree or self.
Define and set this property to false if you do not want to use Boolean values. The default value is true if the property is not defined.
Explicitly disables Java Enterprise System (JES) monitoring services in the sample client applications.
If you want to use a remote instance of the Client SDK, set the value of this property as follows:
The default value is ldap if the property is not defined.
The following properties are used to configure interactions in a federated environment. These properties are not automatically generated and placed in the AMConfig.properties file when you run the make -f Makefile.clientsdk properties command. You must manually add the properties to the file as needed.
Supported SOAP actors. Each actor must be separated by a pipe (|). Example:
Indicates the URL for WSPRedirectHandlerServlet to handle Liberty the WSF web service provider-resource owner. Interactions are based on user agent redirects. The servlet should be running in the same JVM where the Liberty service provider is running.
Indicates whether the web service client should participate in an interaction. Valid values are interactIfNeeded | doNotInteract | doNotInteractForData . Default value is interactIfNeeded. Default value is used if an invalid value is specified.
Indicates whether the web service client should include userInteractionHeader. Valid values are yes and no (case ignored). Default value is yes. Default value is used if no value is specified.
Indicates whether the web service client will redirect user for an interaction. Valid values are yes and no. Default value is yes. Default value is used if no value is specified.
Indicates the web service client preference for acceptable duration (in seconds) for an interaction. If the value is not specified or if a non-integer value is specified, then the default value is 60.
Indicates whether the web service client enforces that redirected to URL is HTTPS. Valid values are yes and no (case ignored). The Liberty specification requires the value to be yes. Default value is yes. Default value is used if no value is specified.
Indicates whether the web service provider redirects the user for an interaction. Valid values are yes and no (case ignored). Default value is yes. Default value is if no value is specified.
Indicates whether the web service provider redirects the user for an interaction for data. Valid values are yes and no. Default value is yes. If no value is specified, the value is yes.
Web service provider expected duration (in seconds) for an interaction. Default value if the value is not specified or is a non-integer value is 30.
Indicates whether the web service client enforces that returnToURL is HTTP. Valid values are yes and no (case ignored). Liberty specification requires the value to be yes. Default value is yes. If no value is specified, then the value used is yes.
Indicates whether the web services client enforces that returnToHost and requestHost are the same. Valid values are yes and no. Liberty specification requires the value to be yes.
Indicates the path to the style sheet used to render the interaction page in HTML.
Indicates the path to the style sheet used to render the interaction page in WML.
Default value is false.
Used by the web services provider to determine the plug-in that will be used to store the configuration.
Used by the web services clients in ClientSDK mode. Example:
Indicates the Liberty authentication service URL.
Used to determine which version of the Liberty identity web services framework is to be used when the framework can not determine from the inbound message or from the resource offering. This property is used when Access Manager is acting as the web service client. The default version is 1.1. The possible values are 1.0 or 1.1.
Value is set during installation. Client certificate alias that will be used in SSL connection for Liberty SOAP Binding.
Default value is 60000. Specifies the number of milliseconds to elapse before cache cleanup events begin. Each message is stored in a cache with its ownmessageID to avoid duplicate messages. When a message's current time less the received time exceeds thestaleTimeLimit value, the message is removed from the cache.
Default value is 300000. Determines if a message is stale and thus no longer trustworthy. If the message timestamp is earlier than the current timestamp by the specified number of milliseconds, the message the considered to be stale.
Value is set during installation. Specifies default certificate alias for issuing web service security token for this web service client.
Value is set during installation. Specifies certificate aliases for trusted CA. SAML or SAML BEARER token of incoming request. Message must be signed by a trusted CA in this list. The syntax is cert alias 1[:issuer 1]|cert alias 2[:issuer 2]|..... Example: myalias1:myissuer1|myalias2|myalias3:myissuer3. The value issuer is used when the token doesn't have a KeyInfo inside the signature. The issuer of the token must be in this list, and the corresponding certificate alias will be used to verify the signature. If KeyInfo exists, the keystore must contain a certificate alias that matches the KeyInfo and the certificate alias must be in this list.