Contents

Title and Copyright Information

Preface

• Audience
• Related Documents
• Documentation Accessibility

Part I Monitoring and Managing Instant Messaging Server

1 Instant Messaging Server Administration Overview

• Overview of Instant Messaging Server Administration Tasks
• About Instant Messaging Server Commands
• Directory Placeholders Used in This Guide

2 Administering Instant Messaging Server Components

• Stopping, Starting, Refreshing, and Checking Instant Messaging Server Components
  • Using Service Management Framework (SMF)
  • Starting Instant Messaging Server Components
    • Starting All Components
    • Starting a Single Component
  • Stopping Instant Messaging Server Components
    • Stopping All Components
    • Stopping a Single Component
  • Registering and Unregistering Service Management Framework
    • Registering SMF
    • Unregistering SMF
  • Refreshing Component Configuration
    • Refreshing All Components
    • Refreshing a Single Component
  • Checking the Status of Instant Messaging Server Components
• Changing Instant Messaging Server and Multiplexor Configuration Properties
  • To Change Configuration Properties
• Backing Up Instant Messaging Server Data
  • Backup Information
  • Performing a Backup
  • Restoring Backup Information

3 Using LDAP with Instant Messaging Server

• Managing LDAP Access Configuration for Instant Messaging Server
  • Overview of How Instant Messaging Server Uses LDAP
  • Searching the Directory Anonymously
    • To Enable the Server to Conduct Directory Searches as a Specific End User
• Configuring Instant Messaging Server to Use LDAP Groups
  • To Configure Instant Messaging Server to Use LDAP Groups
  • To Use Group Messaging
  • To Configure Chat Room Membership Based on LDAP Group Membership
  • To Use Chat Rooms Based on LDAP Group Membership

4 Administering Instant Messaging Server End Users

• Overview of Administering Instant Messaging Server End Users
• Registering New Instant Messaging Server Users
  • Configuring Instant Messaging Server to Enable New User Registration
  • To Allow New User Registration Using Policy Module iim_ldap
  • To Allow New User Registration Using Policy Module schema1 or schema2
• Storing Instant Messaging Server User Properties in LDAP
  • To Store Instant Messaging Server User Properties in LDAP

5 Managing Messages for Offline Users

• Managing Instant Messaging Server Messages for Offline Users Overview
• Enabling Support for Offline Messages in Instant Messaging Server
  • To Enable Support for Offline Messaging in Instant Messaging Server

6 Improving Instant Messaging Server Performance

• Tuning Instant Messaging Server Memory
• Instant Messaging Server Thread Pooling and Service Port Configuration
• Sample Load Test of the Instant Messaging Server

7 Configuring Instant Messaging Server for High Availability

• Instant Messaging Server HA Overview
  • HA Configuration Software Requirements
  • HA Configuration Requirements
  • HA Configuration Terms and Checklist
• Starting and Stopping the Instant Messaging Server HA Service
  • Troubleshooting the Instant Messaging Server HA Configuration
• Setting Up HA for Instant Messaging Server
  • Choosing a High Availability Model for Your Instant Messaging Server Deployment
    • High-Level Task List for an Asymmetric HA Deployment
    • High-Level Task List for a Symmetric HA Deployment
    • Installing and Configuring in an Asymmetric HA Environment
    • Installing and Configuring in a Symmetric HA Environment
• Removing HA for Instant Messaging Server
• HA Related Documentation

8 Configuring LDAP Failover

• Configuring LDAP Failover Overview
• Setting Up LDAP Failover

9 Scaling Instant Messaging Server By Using Server Pooling

• Overview of Server Pooling for Instant Messaging Server
• Availability in an Instant Messaging Server Pool
• Configuring Server-to-Server Communication Between Instant Messaging Servers
  • To Set Up Communication Between Two Instant Messaging Servers in a Server Pool
• Adding a New Node to an Existing Instant Messaging Server Deployment
• Securing a Multi-node Deployment
  • To Manually Define the Dialback Key for an Instant Messaging Server in a Server Pool
• Using Shoal for Server Pool Messaging
  • Setting Shoal Properties
  • Using Shoal for Automatic Discovery of Peer Servers in a Pool
  • Using Shoal for Conferences Across Server Pools
  • Using Shoal Across Subnets

10 Managing Archiving in Instant Messaging Server

• Archiving Overview
• Enabling and Disabling Archiving for Instant Messaging Server
  • To Enable Instant Messaging Server Archiving
  • To Disable Instant Messaging Server Archiving
• Archiving in Instant Messaging Server
  • Managing Instant Messaging Server File Archive
  • Implementing the Custom File Architecture Provider
  • File Archiver Provider Example
  • Compiling the Custom File Archival Provider Application
• Enabling and Disabling the Instant Messaging Server File Archive Provider
  • To Enable File Archiving
  • To Disable File Archiving
  • Managing Instant Messaging Server Message Archive
  • Implementing the Custom Message Archival Provider
  • Message Archive Provider Example
  • Compiling the Custom Message Archival Provider Application
  • Enabling and Disabling the Instant Messaging Server Message Archive Provider
  • To Disable Message Archiving
• Managing Instant Messaging Server Email Archive
  • Enabling and Disabling the Instant Messaging Server Email Archive Provider
    • To Enable the Instant Messaging Server Email Archive
    • To Disable the Instant Messaging Server Email Archive Provider
  • Configuring Email Archive Settings
    • To Configure Administrator Recipients and the RFC 822 Header Format
  • Email Header Format
    • RFC 822 Email Archive Header Fields for One to One Chat
    • RFC 822 Email Archive Header Fields for Private Conferences
    • RFC 822 Email Archive Header Fields for Public Conferences
    • RFC 822 Email Archive Header Fields for Poll Questions with Replies
    • RFC 822 Email Archive Header Fields for Poll Replies Only
    • RFC 822 Email Archive Header Fields for Alerts
    • RFC 822 Email Archive Header Fields for New Channel Posts
• Enabling and Disabling the Instant Messaging Server Custom Archive Provider
  • To Enable a Custom Archive Provider
  • To Disable a Custom Archive Provider

11 Managing Message Conversion in Instant Messaging

• Message Conversion Overview
• Managing Message Conversion in the Instant Messaging Server
  • Implementing the Custom Message Conversion Provider
  • Message Converter Provider Example
  • Compiling the Custom Message Converter Provider
• Enabling and Disabling the Instant Messaging Message Converter Provider

12 Monitoring Instant Messaging Server

• Overview of Monitoring the Instant Messaging Server
• Configuring Instant Messaging Server Monitoring
  • Steps for Configuring Data Collection and Monitoring
• Installing and Configuring the Oracle Enterprise Manager Plug-in
  • Product Version Requirements
  • Installation Prerequisites
• Downloading the Enterprise Manager Plug-in
• Configuring Instant Messaging Server Targets
  • Adding Instant Messaging Server Host Targets and Installing the Management Agent
  • Setting Up Preferred Credentials
• Deploying the Enterprise Manager Cloud Control Plug-in
  • Deploying the Enterprise Manager Cloud Control Plug-in on the Management Server
  • Deploying the Enterprise Manager Cloud Control Plug-in on Host Targets
• Using the Enterprise Manager to Monitor Instant Messaging Server
  • Viewing Metrics
  • Enabling and Using the Beacon Service
  • Available Metrics
• Customizing Monitoring
  • Setting Thresholds on Monitored Metrics
  • Setting Notification Options
  • Adding Corrective Actions

13 Troubleshooting Instant Messaging Server

• Troubleshooting and Monitoring Instant Messaging Server Overview
• Problems and Solutions
  • Cannot Forward Mail to Offline Users
    • To Configure the Attribute Used for User Email Addresses
  • Calendar Pop-up Reminders Do Not Work
  • Connection Refused or Timed Out
  • Authentication Errors
  • Instant Messaging Server Content is not Archived
  • Server-to-Server Communication Fails to Start
• Troubleshooting Instant Messaging Server and LDAP
  • Using a Directory That Does not Permit Anonymous Bind
  • To Configure Bind Credentials for Instant Messaging Server
  • To Change the Attribute Used to Display Contact Names
  • Searching the Directory by Using Wildcards
  • Using Nonstandard Objectclasses for Users and Groups
  • To Change the Objectclasses Used to Specify Users and Groups
  • Using an Attribute Other than uid for User Authentication
  • To Change the Attribute Used for User Authentication
  • Using an Attribute Other than uid for User IDs
  • To Change the Attribute Used for User IDs
• Troubleshooting Connectivity Issues in a Multi-Node Deployment (Server Pool)
• Managing the Watchdog Process
  • Determining the Status of the Watchdog
  • To Determine the Status of the Watchdog
  • Enabling and Disabling the Watchdog
  • To Enable or Disable the Watchdog
  • Managing Logging for the Watchdog

14 Managing Logging for Instant Messaging Server

• Instant Messaging Server Log File Location
• Instant Messaging Server Component Logging Levels
• Managing Instant Messaging Server Logging by Using log4j
  • Instant Messaging Server Log4j Configuration File (log4j.conf) Location
  • Instant Messaging Server Log4j Log File Syntax
  • Log4j Log Levels for Instant Messaging Server Components
  • To Specify the Location of the Log4j Configuration File (Log4j.conf)
  • To Enable or Disable Log4j Logging for an Instant Messaging Server Component
  • To Set Log4j Log Levels for Instant Messaging Server
  • To Specify the Maximum Log4j Log File Size for IM Server Components

Part II Configuring Gateways, Protocols, and Features

15 Configuring Hosted Domain Support

• Instant Messaging Server Hosted Domains Overview
• Setting Up Schema 1 and Schema 2 for Instant Messaging Server Hosted Domains
  • Schema 1 Structure
    • To Configure Instant Messaging Server for Schema 1
  • Schema 2 Structure
    • To Configure Instant Messaging Server for Schema 2
• Instant Messaging Server Cross Domain Searches
  • To Enable Instant Messaging Server Cross Domain Searches

16 Federating Instant Messaging Server with External Servers

• Federating Multiple Instant Messaging Servers Overview
  • Securing Server-to-Server Communication
• Configuring Federated Communication Between Instant Messaging Servers
  • Federation Examples
  • Configuring DNS for XMPP Federation
  • Configuring DNS for SIP Federation

17 Configuring the Facebook Gateway

• Configuring the Instant Messaging Server Facebook Gateway and Gateway Connector
  • Using the configure Utility for the Facebook Gateway and Gateway Connector
  • Manually Configuring the Facebook Gateway and Gateway Connector
  • Facebook Gateway Properties
  • Gateway Connector Properties
• Deployment Planning
  • Gateway Connector (GWC)
  • Registering the Facebook Application

18 Configuring the HTTPBIND Gateway

• About the XMPP/HTTP Gateway
• Instant Messaging Server XMPP/HTTP Gateway Configuration Files
• Configuring the Instant Messaging Server XMPP/HTTP Gateway
  • To Enable or Disable the Instant Messaging Server XMPP/HTTP Gateway
  • To Configure HTTPBIND Manually
  • To Configure Concurrent Requests Number Handled by the XMPP/HTTP Gateway
  • To Set the JEP 124 hold Attribute for Client Requests to the XMPP/HTTP Gateway
  • To Specify the Allowed Client Inactivity Time for the XMPP/HTTP Gateway
  • To Set the content-type HTTP Header for the XMPP/HTTP Gateway
  • To Set the Round Trip Delay for the XMPP/HTTP Gateway
  • To Set the XMPP/HTTP Gateway Default Response Time
  • To Configure an XMPP/HTTP Gateway in a Instant Messaging Server Gateway Pool
  • To Configure the List of Key IDs for Supported XMPP/HTTP Gateway Domains
  • To Configure the XMPP/HTTP Gateway to Use a Non-default Configuration
  • To Use Encrypted Passwords
  • To Add a New Hosted Domain Without Restarting GlassFish Server
• Using StartTLS to Secure Communication Between XMPP/HTTP and IM Server
• Managing Logging for the XMPP/HTTP Gateway
  • To Enable or Disable Logging for the XMPP/HTTP Gateway
  • To Change the Location of the XMPP/HTTP Gateway Log Configuration File
  • Oracle Linux and Red Hat Linux: To Set the XMPP/HTTP Gateway Log File Location
  • To Change the Location of the XMPP/HTTP Gateway Log File
  • To Use a Non-default Log File Location for the XMPP/HTTP Gateway
  • To Set the XMPP/HTTP Gateway Logging Level
  • XMPP/HTTP Gateway log4j Log Configuration File Syntax
  • XMPP/HTTP Gateway Log Configuration File Example

19 Configuring the SIP Gateway

• SIP Gateway Overview
• SIP Gateway Architecture
• Configuring the SIP Gateway
  • Prerequisites for Configuring the SIP Gateway
  • To Configure Instant Messaging Server for the SIP Gateway
    • Configuring the SIP Gateway in Component Mode
    • Configuring SIP Gateway in Federation Mode
    • To Enable S2S Communication Using TLS and SASL-External
    • To Enable S2S Communication Using TLS and Dialback
    • To Enable S2S Communication Using Plain Text and Dialback
  • To Configure Logging for the SIP Gateway
  • To Configure the Oracle Communications Converged Application Server
  • To Test the SIP Gateway
• Troubleshooting the SIP Gateway
• Configuring DNS for XMPP and SIP Federation

20 Configuring the SMS Gateway

• SMS Gateway Overview
• Configuring the SMS Gateway
  • SMS and Server Configuration Properties
  • Server-Side Configuration
    • To Configure the SMS Gateway by Using the imconfutil Command
    • To Configure the SMS Gateway by Using the configure Utility
  • Client-Side Settings
• Starting and Stopping the SMS Gateway

21 Using Calendar Pop-up Reminders

• Pop-up Reminders Overview
  • Pop-up Reminders Operation
  • Pop-up Reminders Architectural Flow
• Configuring Calendar Server and Instant Messaging Server to use Pop-ups
• Configuring Calendar Pop-ups in a Server Pool
• Administering the Calendar Agent

22 Configuring the Instant Messaging Server Calendar Agent

• Configuring Calendar Agent with Calendar Server 7
  • Configuring Instant Messaging Server
    • To Configure IM Server 9 Calendar Agent with Calendar Server 7
    • To Manually Configure IM Server 9 Calendar Agent with Calendar Server 7
    • JMS and Calendar Agent Properties

23 Displaying Availability Based on Calendar Entries

• Instant Messaging Availability Based on Calendar Entries Overview
• Enabling Instant Messaging Availability Based on Calendar Entries
• Configuring Java Message Queue (JMQ) Brokers for Calendar Availability

24 Using the Web Presence API

• Instant Messaging Server Web Presence API Overview
• Web Presence API for Requesting Presence Information
  • web.xml File for the Web Presence API
  • HTTP GET Requests for Presence Information
    • GET Requests for Presence Information on an Individual User
    • GET Requests for Presence Information on Multiple Users
  • HTTP POST Requests for Presence Information
  • JSON Response to Requests for Presence Information
• Configuring the Instant Messaging Server Web Presence API
• Configuring an Instant Messaging Server to Recognize the Web Presence API
• Steps for Configuring and Testing the Web Presence API

25 Configuring the Instant Messaging Server Web Presence API

• Configuring the Web Presence API

Part III Instant Messaging Server Reference

26 Configuration File and Directory Structure Overview

• Program Files
  • Oracle Solaris Location of Program Files
  • Red Hat Linux and Oracle Linux Location of Program Files
• Server Configuration Files
  • Oracle Solaris Location of Server Configuration Files
  • Red Hat Linux and Oracle Linux Location of Server Configuration Files
• Runtime Directory
  • Oracle Solaris Location of the Runtime Directory
  • Red Hat Linux and Oracle Linux Location of the Runtime Directory
• Database Directory
  • Oracle Solaris Location of the Database Directory
  • Red Hat Linux and Oracle Linux Location of the Database Directory
• Instant Messaging Server Configuration File
  • Instant Messaging Server Data

27 Configuration Properties

• iim.conf.xml File Location
• iim.conf.xml File Syntax
• Multiple Server Configuration Properties
• Shoal Configuration Properties
• Multiplexor Configuration Properties
• Archive Properties
• Watchdog Properties
• Monitoring Properties
• Agent Properties
• JMQ Properties
• HTTP/XMPP Gateway Properties
• SMS Integration Properties
• Facebook Gateway Properties
• Gateway Connector Properties

28 Instant Messaging Server APIs

• Instant Messaging Server APIs Overview
• Instant Messaging Server Service API
• Service Provider Interfaces
  • Archive Provider API
  • Message Conversion API
  • Authentication Provider API
• Web Presence API

29 imadmin Command Reference

• imadmin Overview
• imadmin Requirements
• imadmin Location
• imadmin Commands
• imadmin Syntax
• imadmin Options
• imadmin Actions
• imadmin Components

30 imconfutil Command Reference

• Syntax
• Options
• Example imconfutil Commands

31 iwadmin Command Reference

• Overview of the iwadmin Command
• Syntax
• iwadmin Options
• iwadmin Commands and Command-Specific Options
• Example iwadmin Commands

32 passwordtool Command Reference

• passwordtool Overview
• Syntax
• Examples

33 XMPP and HTTP Gateway Configuration Parameters

• httpbind.conf File Location
• httpbind.conf File Syntax
• How Load Balancing Occurs
• Instant Messaging Server XMPP/HTTP Gateway Configuration Parameters
• Gateway Domain ID Key Parameters for httpbind.config