Go to main content
1/40
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
Overview of 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
Changing 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
Enabling the Server to Conduct Directory Searches as a Specific End User
Using the mail Attribute for User Authentication
Using LDAP Groups
Configuring Instant Messaging Server to Use LDAP Groups
Using Group Messaging
Configuring Chat Room Membership Based on LDAP Group Membership
Using Chat Rooms Based on LDAP Group Membership
Converting Associated Domain to Canonical Domain
4
Using Oracle Database with Instant Messaging Server
Overview of Using Oracle Database for Storing Messages
Installing and Creating an Oracle Database Instance for Instant Messaging Server
5
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
Allowing New User Registration Using Policy Module iim_ldap
Allowing New User Registration Using Policy Module schema1 or schema2
Storing Instant Messaging Server User Properties in LDAP
6
Managing Messages for Users
About Managing Instant Messaging Server Messages for Offline Users
About Delivering Offline Messages
Enabling Offline Messaging
About Push Notifications for Offline Messages
Enabling Push Notifications for Offline Messages
About Message Carbons
Enabling Message Carbons
7
Improving Instant Messaging Server Performance
Tuning Instant Messaging Server Memory
Tuning Java Virtual Machine Options
Instant Messaging Server and Multiplexor Thread Pooling and Service Port Configuration
Creating Service Port Configurations
Creating Multiplexor Thread Pools
Sample Load Test of the Instant Messaging Server
Controlling the Rate of Incoming Connections
Tuning the XMPP WebSocket Gateway
Configuring Multiplexor Thread Pools
8
Configuring Instant Messaging Server for High Availability
Overview of High Availability for Instant Messaging Server
About Server Pooling
Availability in an Instant Messaging Server Pool
Configuring Server-to-Server Communication Between Instant Messaging Servers
Setting 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
Manually Defining 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
About Multiplexor Failover
Enabling Multiplexor Failover
Overview of Using Oracle Solaris Cluster
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
9
Configuring LDAP Failover
Overview of Configuring LDAP Failover
Setting Up LDAP Failover
10
Managing Archiving in Instant Messaging Server
About Archiving
Enabling and Disabling Archiving for Instant Messaging Server
Enabling Instant Messaging Server Archiving
Disabling 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
Enabling File Archiving
Disabling 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
Enabling the Instant Messaging Server Email Archive
Disabling the Instant Messaging Server Email Archive Provider
Configuring Email Archive Settings
Configuring 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
Enabling a Custom Archive Provider
Disabling a Custom Archive Provider
About Archived Messages Retrieval
Archived Message Management Example
Enabling Retrieval of Archived Messages
Message Archive Retrieval Provider Example
Using Chat Markers
11
Managing Message Conversion in Instant Messaging
About Message Conversion
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 and Multiplexor
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 Server Metrics
Customizing Monitoring
Setting Thresholds on Monitored Metrics
Setting Notification Options
Adding Corrective Actions
Instant Messaging Server Diagnostic Metrics
Enabling and Disabling Instant Messaging Server Diagnostic Metrics
Overview of Monitoring the Instant Messaging Multiplexor
Configuring Instant Messaging Multiplexor Monitoring
Steps for Configuring Data Collection and Monitoring
Available Multiplexor Metrics
Instant Messaging Multiplexor Diagnostic Metrics
Enabling and Disabling Instant Messaging Server Diagnostic Metrics
13
Troubleshooting Instant Messaging Server
Troubleshooting and Monitoring Instant Messaging Server Overview
General Troubleshooting
Cannot Forward Mail to Offline Users
Configuring 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
Configuring Bind Credentials for Instant Messaging Server
Changing the Attribute Used to Display Contact Names
Searching the Directory by Using Wildcards
Using Nonstandard Objectclasses for Users and Groups
Changing the Object Classes Used to Specify Users and Groups
Using an Attribute Other than uid for User Authentication
Changing the Attribute Used for User Authentication
Using an Attribute Other than uid for User IDs
Changing 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
Enabling and Disabling 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
Specifying the Location of the log4j Configuration File (log4j.conf)
Enabling or Disabling log4j Logging for a Component
Setting log4j Log Levels
Specifying the Maximum log4j Log File Size
Part II Configuring Gateways, Protocols, and Features
15
Configuring Hosted Domain Support
About Instant Messaging Server Hosted Domains
Setting Up Schema 1 and Schema 2 for Instant Messaging Server Hosted Domains
Schema 1 Structure
Configuring Instant Messaging Server for Schema 1
Schema 2 Structure
Configuring Instant Messaging Server for Schema 2
Instant Messaging Server Cross Domain Searches
Enabling Instant Messaging Server Cross Domain Searches
About Hosted Domains Communication
Enabling Communication Between Hosted Domains
Disabling Communication Between Hosted Domains
Whitelisting and Blacklisting Domains for Hosted Domain Communication
16
Federating Instant Messaging Server with External Servers
Overview of Federating Multiple Instant Messaging Servers
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 XMPP WebSocket Gateway
About the XMPP WebSocket Gateway
Configuring the XMPP WebSocket Gateway
Managing the XMPP WebSocket Gateway
Configuring XMPP WebSocket Gateway Logging
Configuring XMPP WebSocket Gateway Monitoring
Configuring XMPP WebSocket Gateway Timeout
Configuring XMPP WebSocket Gateway for Server Pool
Enabling Secure Communication Between the XMPP WebSocket Gateway and Instant Messaging Server
Activating TLS on XMPP WebSocket Gateway
18
Configuring the XMPP/HTTP Gateway
About the XMPP/HTTP Gateway
Instant Messaging Server XMPP/HTTP Gateway Configuration Files
Configuring the Instant Messaging Server XMPP/HTTP Gateway
Enabling or Disabling the Instant Messaging Server XMPP/HTTP Gateway
Manually Configuring HTTPBIND
Configuring Concurrent Requests Handled by the XMPP/HTTP Gateway
Setting the JEP 124 hold Attribute for Client Requests to the XMPP/HTTP Gateway
Specifying the Allowed Client Inactivity Time for the XMPP/HTTP Gateway
Setting the content-type HTTP Header for the XMPP/HTTP Gateway
Setting the Round Trip Delay for the XMPP/HTTP Gateway
Setting the XMPP/HTTP Gateway Default Response Time
Configuring an XMPP/HTTP Gateway in an Instant Messaging Server Gateway Pool
Configuring the List of Key IDs for Supported XMPP/HTTP Gateway Domains
Configuring the XMPP/HTTP Gateway to Use a Non-default Configuration
Using Encrypted Passwords
Adding 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
Enabling or Disabling Logging for the XMPP/HTTP Gateway
Changing the Location of the XMPP/HTTP Gateway Log Configuration File
Setting the XMPP/HTTP Gateway Log File Location on Linux
Changing the Location of the XMPP/HTTP Gateway Log File
Using a Non-default Log File Location for the XMPP/HTTP Gateway
Setting the XMPP/HTTP Gateway Logging Level
XMPP/HTTP Gateway log4j Log Configuration File Syntax
XMPP/HTTP Gateway Log Configuration File Example
19
Configuring External Service Discovery
About External Service Discovery
Configuring External Discovery
20
Configuring the SIP Gateway
About the SIP Gateway
SIP Gateway Architecture
Configuring the SIP Gateway
Prerequisites for Configuring the SIP Gateway
Configuring the SIP Gateway in Component Mode
Configuring SIP Gateway in Federation Mode
Enabling S2S Communication Using TLS and SASL-External
Enabling S2S Communication Using TLS and Dialback
Enabling S2S Communication Using Plain Text and Dialback
Configuring Logging for the SIP Gateway
Configuring the Oracle Communications Converged Application Server
Testing the SIP Gateway
Troubleshooting the SIP Gateway
Configuring DNS for XMPP and SIP Federation
21
Configuring the SMS Gateway
About the SMS Gateway
Configuring the SMS Gateway
SMS and Server Configuration Properties
Server-Side Configuration
Configuring the SMS Gateway by Using the imconfutil Command
Configuring the SMS Gateway by Using the configure Utility
Client-Side Settings
Starting and Stopping the SMS Gateway
22
Using Calendar Pop-up Reminders
About Pop-up Reminders
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
23
Configuring the Instant Messaging Server Calendar Agent
Configuring Calendar Agent with Calendar Server
Configuring Instant Messaging Server
Configuring Instant Messaging Server Calendar Agent with Calendar Server
Manually Configuring Instant Messaging Server Calendar Agent with Calendar Server
JMS and Calendar Agent Properties
24
Displaying Availability Based on Calendar Entries
Overview of Displaying Instant Messaging Availability Based on Calendar Entries
Enabling Instant Messaging Availability Based on Calendar Entries
Configuring Java Message Queue Brokers for Calendar Availability
25
Using the Web Presence API
About the Instant Messaging Server Web Presence API
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
Configuring and Testing the Web Presence API
26
Configuring the Instant Messaging Server Web Presence API
Configuring the Web Presence API
Part III Instant Messaging Server Reference
27
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
28
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
XMPP WebSocket Gateway Properties
29
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
30
imadmin Command Reference
imadmin Overview
imadmin Requirements
imadmin Location
imadmin Commands
imadmin Syntax
imadmin Options
imadmin Actions
imadmin Components
31
imconfutil Command Reference
Syntax
Options
Example imconfutil Commands
32
iwadmin Command Reference
Overview of the iwadmin Command
Syntax
iwadmin Options
iwadmin Commands and Command-Specific Options
Example iwadmin Commands
33
passwordtool Command Reference
passwordtool Overview
Syntax
Examples
34
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
Scripting on this page enhances content navigation, but does not change the content in any way.