Sun Java System Instant Messaging 7.2 Administration Guide

Instant Messaging Server Configuration Parameters

Table A–4 lists and describes the Instant Messaging server configuration parameters.

Table A–4 General Instant Messaging server Configuration Parameters

Parameter 

Default Value 

Description 

iim_server.autosubscribe

FALSE

Indicates whether subscriptions are automatically authorized by the server. The possible values are TRUE and FALSE. If TRUE, subscribe requests are automatically followed by a subscribed response generated by the server. The server then sends the modified roster to the subscriber and the user the subscriber added as a contact. The user and the contact must be in the same domain to use this feature.

iim_server.domainname

host’s domain name

The logical Instant Messaging server domain name you want this server to support. This is the name that is used by other servers in the network to identify this server. It is also the name used by this server to identify its end users to other servers. This is not necessarily the Fully Qualified Domain Name of the system running the Instant Messaging server. 

For example, if the system iim.xyz.com is the only Instant Messaging server for a company xyz.com, then the domain name is likely to be xyz.com.

iim_server.port

5269

IP address and port for the server to bind to, and to listen for connections from other servers. IP address setting is useful for multi homed machines when you want to use only one particular IP address. If no IP address is listed, this indicates a value of INADDR_ANY on localhost.

iim_server.useport

TRUE

Indicates whether the server should listen on the server-to-server communication port. The possible values are TRUE and FALSE. If TRUE, the server listens on the port defined by iim_server.port or on port 5269, if that is not explicitly defined.

iim_server.clienttimeout

15

Specifies the time, in minutes, before the server discards client connections that are no longer active. For example, when a machine is turned off. The minimum accepted value is 5. 

iim_server.usesso

The default value is 1, if you chose to leverage an Access Manager deployment for SSO when you ran the configure utility. Otherwise, the default value is 0.

This parameter tells the server whether or not to depend on the SSO provider during authentication. An SSO provider is a module the server uses to validate a session ID with a SSO service.

TheAccess Manager Session API provides the Instant Messaging server with the ability to validate session IDs sent by the client.

The value for this parameter can either be 0, 1, or -1.

0 - do not use the SSO provider.

1 - use the SSO provider first and default to LDAP if the SSO validation fails.

-1- use SSO provider only without attempting LDAP authentication even when the SSO validation fails.

The iim_server.usesso parameter is used in conjunction with the iim_server.ssoprovider parameter.

iim_server.ssoprovider

None 

Specifies the class implementing the com.sun.im.provider.SSOProvider interface. If iim_server.usesso is not equal to 0 and this option is not set, the server uses the default Access Manager–based SSO Provider.

iim.policy.modules

The default value is identity, if you chose to leverage an Access Manager deployment for policy when you ran the configure utility. Otherwise, the default value is iim_ldap.

If the value is identity, indicates that Sun Java System Access Manager is used for policy storage. If the value is iim_ldap, directory is used.

iim.userprops.store

file

If the value is file, indicates that the user properties are stored in a user properties file. If the value is ldap, directory is used.

iim_server.msg_archive

false

This parameter specifies whether the archive provider should be enabled or disabled. Set this value to false to disable all archiving. Set the value to true to enable all archiving, including Portal, email, and any custom archive provider you want to use.

iim_server.msg_archive.provider

None 

This parameter contains the list of archive providers. This parameter allows multiple values and each value is separated by a comma (,).

If you are using the Portal Server Search based archive, the value should be com.iplanet.im.server.IMPSArchive. If you are using email archiving, the value should be com.iplanet.im.server.EmailIMArchive.

iim_server.conversion

false

This parameter specifies whether message conversion should be enabled. It specifies whether the configured list of Message Conversion Providers should be used for message conversion. 

iim_server.conversion.provider

None 

This parameter contains the list of Message Conversion Providers to be used for message conversion. 

This parameter allows multiple values with each value is separated by a comma (,).

iim_server.servertimeout

-1 

The server can be configured to automatically close the connection opened by a remote server, if the remote server is inactive. This is performed by periodically measuring the time the last request was made by the remote server to the server. The connection to the remote server is terminated, if the time of the last request made by the remote server exceeds the value of the iim_server.servertimeout parameter.

The parameter value is in minutes. 

iim_server.enable

true

This value defines whether or not the Instant Messaging server is enabled. This parameter is set false to enable the Instant Messaging multiplexor. 

iim_server.conversion.external.command

None 

This parameter contains the external command used for message conversion. 

iim_server.stat_frequency

1

This parameter contains the frequency at which the server logs the summary of activities to the log file. The server logs the summary of activities to the log file only if the server minimum log severity is set to INFO or lower. The value is in minutes.

iim_server.certnickname

Server-Cert

This value should contain the name of the certificate you entered while installing the certificate. 

The certificate name is case-sensitive. 

iim_server.sslkeystore

None 

Contains the relative path and filename for the server's Java keystore (JKS). For example:


/im-cfg-base/server-keystore.jks

iim_server.keystorepasswordfile

sslpassword.conf

This value should contain the relative path and the name of the file containing the password for the key database. This file should contain the following line: 

Internal (Software) Token:password

Where password is the password protecting the key database.

iim_server.requiressl

false

If true, the server will terminate any connection that does not request a TLS connection after the initial stream session is set up. This includes connections from clients, other servers, and server components, such as the XMPP/HTTP Gateway and agents, except the multiplexor.

iim_server.trust_all_cert

false

If this value is true than the server will trust all certificates and will also add the certificate information into the log files.