25 Configuring the Instant Messaging Server Web Presence API

This chapter describes how to configure the Oracle Communications Instant Messaging Server Web Presence API. The Web Presence API makes it possible for a Web application to obtain presence information from Instant Messaging Server and display it to users, independent of whether they are instant-messaging contacts. For information on using the Web Presence API, see "Using the Web Presence API".

Configuring the Web Presence API

To configure the Web Presence API, set configuration properties as described Table 25-1.

Table 25-1 Web Presence API Configuration Properties

Property	Default Value	Description
presenceapi.idtype	jid	Specifies whether HTTP requests for presence information contain a JID (idtype is jid) or an email address (idtype is email).
presenceapi.wait_time	10	The maximum length of time, in seconds, that the presence component waits to receive a response from Instant Messaging Server that contains presence information for an individual user. If no response is received within the time limit, the presence component returns a presence type of none as the user's availability. The default value is 10 seconds if there is no entry for this property in the Presence API configuration file. In the Presence API configuration template, the value is set to 15 seconds. Thus, if you use the template, then the default is 15. If you create the configuration file from scratch, the default is 10 seconds.
presenceapi.log4j.config	None	The location of the configuration file that Instant Messaging Server uses for Apache-log4j logging. For information on Instant Messaging Server logging, see "Managing Logging for Instant Messaging Server"; for information on Apache-log4j logging, see the Apache website at: http://logging.apache.org At installation, a presenceapi_log4j.conf.template template file to use as the basis for a log4j configuration file is installed in InstantMessaging_home/config. Use the template file to create a log4j configuration file. There is no required name or location for the configuration file.
presenceapi.config	None	A space-separated list of identifiers for Instant Messaging Server deployments that the presence component can communicate with. Each identifier is used as a prefix to presence-API configuration properties for the deployment. For example, given the identifier list ImDeploy1 ImDeploy2, there are separate sets of ImDeploy1.property properties and ImDeploy2.property properties. Each deployment in the list of identifiers must be separately configured to recognize communications from the Web Presence API (see "Configuring an Instant Messaging Server to Recognize the Web Presence API").
identifier.presencepolicy	open	Specifies the way to interpret the list of JID or email domains in the identifier.domains property, one of the following: open (the default value): The Server supports presence requests for users in all domains except those listed in identifier.domains. closed: The Server supports presence requests for users only in the domains listed in identifier.domains.
identifier.domain	None	A space separated list of JID or email domains: If the presenceapi.idtype property is set to jid, list JID domains; if presenceapi.idtype is set to email, list email domains. If the identifier.presencepolicy property is set to open, a list of domains that are not supported and for which presence information will not be retrieved. If the identifier.presencepolicy property is set to closed, a list of domains that are supported and for which presence information is retrieved.
identifier.hosts	None	A space-separated list of Instant Messaging servers and their ports (hostname:port) that make up the deployment identified by identifier.
identifier.component.jid	None	The JID that the Web Presence API uses in establishing a connection with the Instant Messaging server specified by identifier. When you configure Instant Messaging Server, you will need to enter this JID to identify the Web Presence API to the Server (see "Configuring the Instant Messaging Server Web Presence API"). It is recommended that you use the same JID for each Instant Messaging server the Web Presence API communicates with.
identifier.password	None	The password that the presence component uses in establishing a connection with the Instant Messaging server specified by identifier. When you configure Instant Messaging Server, you will need to enter this JID to identify the Web Presence API to the Server (see "Configuring an Instant Messaging Server to Recognize the Web Presence API"). It is recommended that you use the same password for each Instant Messaging server. To generate an encrypted password, use the Instant Messaging Server password tool (see "passwordtool Command Reference").
presenceapi.component.password.cipher.delegate	None	If you want to use an encrypted password, this property is required with a value of com.sun.im.tools.passwordtool.Crypto.
presenceapi.component.password.cipher	None	If you want to use an encrypted password, this property is required with a value of com.sun.im.tools.passwordtool.CommsClientCipher.