Message handler properties

Use this page to configure the properties of a message handler such as the user locator, authorization controller, or event logger.

Message handlers, also known as plug-ins, process instant messages as they pass through IBM Sametime® Gateway Server. They perform such tasks as locating users, checking the access list to use, checking for spam instant messages, and logging events. Messages are processed by handlers in the order that the message handlers appear in the list. Message handlers that are installed and started but are not yet configured are labeled Undefined in the message handler list. The User locator message handler must always be first on the message handler list. The event log handler must run and appear last in the list.

Message handlers are WebSphere® Application Server applications that you install through the Integrated Solutions Console by clicking Applications > Enterprise Applications.

You add a message handler by first installing it as a WebSphere Application Server application, configuring its properties, and then enabling the message handler.

Name

There are three message handlers that are part of Sametime Gateway Server and cannot be removed:

Table 1. Message handlers
Message handler name	Purpose
User locator	The User locator finds the profiles associated with the originator and the target user of the message using the user name and domain from email addresses. The User locator returns an error if an inbound request contains a blacklisted domain name. The handler adds the community identifiers of the originating and target users to the message header.
Authorization controller	Only messages successfully processed by the User locator are passed to the Authorization controller for further processing. The Authorization controller's main task is to allow or disallow the initiator of the message in one community to perform the requested operation with the destination user in another community.
Event logger	The Event logger records instant messaging content and events and publishes them to the SystemOut.log file. Logged events contain the following information: Message request type - subscription or instant messaging request Message initiator's email address and community name Message receiver's email address and community name Event status: success or failure Reason for failure Date and time Optional message content You must install the Sametime Gateway Server samples EAR file available from the Sametime Software Development Kit before you enable the Event logger.

Type

Select the type of message handler. Choices are User locator, Access control, Event log, and Other. When a message handler is first installed, the default type is undefined and its status is disabled. To enable the message handler, you must select Enable the message handler .

Run this message handler regardless of the status of previous message handlers

Select to make running the message handler mandatory. That is, run the message handler regardless of whether a previously run message handler completed its process or encountered an error. If this setting is not selected, and any preceding message handler raises an error, the message handler will not run. A message handler that is not mandatory is considered conditional.

For example, the table that follows shows that in processing a message the Custom User Locator raises an error. Consequently, the mandatory Virus Checker and System Logger handlers run (in that order), while the conditional handlers, the SPIM Filter and the Custom Logger are skipped.

Table 2. Example of mandatory messaging handling
Name	Type	Mandatory or Conditional	Status
Default User Locator	Access Control List	Conditional	Run
Custom User Locator	Access Control List	Conditional	Error
Virus Checker	Virus Checker	Mandatory	Run
SPIM Filter	Other	Conditional	Skip
Custom Logger	Event Logger	Conditional	Skip
System Logger	Event Logger	Mandatory	Run

Custom properties

Click Custom properties to configure additional message handler properties such as name and value pairs.