Documentation Home
> Sun Java System Instant Messaging 7.2 Administration Guide
Sun Java System Instant Messaging 7.2 Administration Guide
Book Information
Index
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
R
S
T
U
V
W
X
Preface
Part I Postinstallation Configuration
Chapter 1 Configuring Instant Messaging After Installation
Completing the Configuration Checklist
Creating a UNIX System User and Group
To Create the Appropriate UNIX User and Group
Overview of the configure Utility
Configuring Instant Messaging After Installing or Upgrading
To Create the PASSFILE for the BEA Web Container
To Configure Instant Messaging After Installation
Adding Instant Messaging and Presence Services to a Sub-organization in Access Manager for Single Sign-On and Policy Management Support
To Manually Assign Instant Messaging and Presence Services to a Sub-organization in Access Manager
Performing a Silent Instant Messaging Configuration
To Generate a Configure State File and ID for Instant Messaging
Creating Multiple Instances from a Single Instant Messaging Installation
To Create an Additional Instance of Instant Messaging from an Existing Installation
Chapter 2 Setting up and Launching Instant Messenger
Enabling Java Web Start
To Add the MIME Type to Sun Java System Web Server Enterprise Edition
To Add the MIME Type to Apache Web Container
Configuring Client Systems for Instant Messaging
Launching Instant Messenger
Running Instant Messenger From a Web Browser
To Run Instant Messenger as an Applet Within a Web Browser:
Running Instant Messenger as a Standalone Application
To Run Instant Messenger as a Standalone Application
Part II Administering Instant Messaging
Chapter 3 Instant Messaging Configuration File and Directory Structure Overview
Instant Messaging Server Directory Structure
Instant Messaging Server Configuration File
Instant Messaging Data
Chapter 4 Configuring Instant Messaging for High Availability (Solaris Only)
Instant Messaging HA Overview
Instant Messaging HA Configuration Software Requirements
Instant Messaging HA Configuration Permission Requirements
Instant Messaging HA Configuration Terms and Checklist
Setting Up HA for Instant Messaging
Choosing a Local or Shared Disk for Configuration Files and Binaries
Preparing Each Node in the Cluster
Selecting the Installation Directory (im-svr-base)
Installing Sun Java System Products and Packages
Configuring the HA Environment
To Configure HA on Node 1 Using a Local Disk for Configuration Files and Binaries
To Configure HA on Node n Using a Local Disk for Configuration Files and Binaries
To Configure HA on Node 1 Using a Shared Disk for Configuration Files and Binaries
To Configure HA on Node n Using a Shared Disk for Configuration Files and Binaries
Configuring the Logical Host
To Configure the Resource Group With the Logical Host
Registering and Activating the Storage Resource
To Register and Enable the Storage Resource
Registering the Resource Type and Creating a Resource
To Register the Resource Type and Create a Resource
Verifying the Instant Messaging HA Configuration
To Verify the HA Configuration for Instant Messaging
Troubleshooting the Instant Messaging HA Configuration
Stopping, Starting, and Restarting the Instant Messaging HA Service
To Start the Instant Messaging HA Service
To Stop the Instant Messaging HA Service
To Restart the Instant Messaging HA Service
Stopping, Starting, and Restarting Instant Messaging Components in a Deployment with Sun Cluster
Managing the HA RTR File for Instant Messaging
Instant Messaging RTR File Parameters
Customizing the RTR File for Instant Messaging
Removing HA for Instant Messaging
To Remove HA for Instant Messaging
HA Related Documentation
Chapter 5 Enabling Single Sign-On (SSO) for Instant Messaging
SSO Limitations and Notices
Configuring Instant Messaging to Support Access Manager-Based SSO and Policies
To Enable SSO for Instant Messaging
Troubleshooting SSO for Instant Messaging
Chapter 6 Scaling an Instant Messaging Deployment Using Server Pooling
Overview of Server Pooling for Instant Messaging
Availability in an Instant Messaging Server Pool
Configuring Server-to-Server Communication Between Instant Messaging Servers in a Server Pool
To Set Up Communication Between Two Instant Messaging Servers in a Server Pool
Adding a New Node to an Existing Instant Messaging Deployment
Securing a Multi-node Deployment
To Manually Define the Dialback Key for an Instant Messaging Server in a Server Pool
Chapter 7 Optimizing an Instant Messaging Server Pool Using the Redirect Server
Overview of Instant Messaging Redirect
Instant Messaging User Partitioning Algorithm
About the Instant Messaging Redirect Database
Instant Messaging Redirect Server Overview
Instant Messaging Redirect Server and StartTLS
Configuring an Instant Messaging Server Instance as a Redirect Server
To Configure an Instant Messaging Server as a Redirect Server
Administering the Instant Messaging Redirect Server
Stopping, Starting, Restarting, Refreshing, and Checking the Status of the Instant Messaging Redirect Server
Instant Messaging Redirect Server Logging
Setting the Partition Size for the Instant Messaging Redirect Server
Specifying the List of Partitions for the Instant Messaging Redirect Server
Creating and Managing the Instant Messaging Redirect Table Using the rdadmin Utility
To Create a New or Update an Existing Instant Messaging Redirect Database
Instant Messaging Redirect Server Physical Host Monitoring
Setting the Instant Messaging Redirect Server Host Polling Frequency
Instant Messaging Redirect Server Best Practices and Troubleshooting
Redirect Server Certificates
Instant Messaging Redirect Server Supported Clients
Using Redirect Server and Storing User Properties in LDAP
Determining the Partition Size for the Redirect Database
Using a Redirect Server as a Partition Host
Chapter 8 Federating Deployment of Multiple Instant Messaging Servers
Configuring Federated Communication Between Instant Messaging Servers
To Federate Communication Between Two Instant Messaging Servers
Chapter 9 Administering Instant Messaging Components
Stopping, Starting, Refreshing, and Checking Instant Messaging Components
Starting Instant Messaging Components
To Start All Components
To Start a Single Component
Stopping Instant Messaging Components
To Stop All Components
To Stop a Single Component
Refreshing Component Configuration
To Refresh All Components
To Refresh a Single Component
Checking the Status of Instant Messaging Components
To Check the Status of All Components
To Check the Status of a Single Component
Changing Instant Messaging Server and Multiplexor Configuration Parameters
To Change Configuration Parameters
Backing Up Instant Messaging Data
Backup Information
Performing a Backup
Restoring Backup Information
To Restore End-user Data from Backup
Chapter 10 Using the Instant Messaging XMPP/HTTP Gateway
Instant Messaging XMPP/HTTP Gateway Configuration Files
Configuring the Instant Messaging XMPP/HTTP Gateway
To Enable or Disable the Instant Messaging XMPP/HTTP Gateway
To Configure the Number of Concurrent Requests 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 Default Time Within Which the XMPP/HTTP Gateway Will Send a Response to the Client
To Configure an XMPP/HTTP Gateway in a Instant Messaging Gateway Pool
To Configure the List of Key IDs for Supported XMPP/HTTP Gateway Domains
To Configure the Instant Messaging XMPP/HTTP Gateway to Use a Non-default Configuration File
Securing Communication Between the XMPP/HTTP Gateway and Instant Messaging Server Using StartTLS
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
Linux: To Set the Location of the XMPP/HTTP Gateway Log File After Install or Upgrade
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
Chapter 11 Managing Instant Messaging's LDAP Access Configuration
Overview of how Instant Messaging Uses LDAP
Searching the Directory Anonymously
To Enable the Server to Conduct Directory Searches as a Specific End User
Configuring Instant Messaging to Use LDAP Dynamic Groups
To Configure Instant Messaging to Use Dynamic Groups
Chapter 12 Securing Instant Messaging Using TLS and Legacy SSL
Overview of Using TLS and Legacy SSL in Instant Messaging
Setting Up TLS for the Instant Messaging Server
Activating TLS on the Instant Messaging Server
To Activate TLS Communication in the Instant Messaging Server
Setting Up Legacy SSL for the Multiplexor and Instant Messenger
Requesting an SSL Certificate for the Instant Messaging Multiplexor from the CA
To Request a Certificate for the Instant Messaging Multiplexor
Installing the Certificate
To Install the Certificate for the Instant Messaging Multiplexor
Enabling Legacy SSL Between the Multiplexor and Instant Messenger
To Enable SSL Between Instant Messenger and the Multiplexor
Invoking the Secure Version of Instant Messenger
To Verify a Secure Instant Messenger Connection
Chapter 13 Managing Logging for Instant Messaging
Instant Messaging Logging Overview
Instant Messaging Log File Location
Instant Messaging Component Logging Levels
Managing Instant Messaging Logging Using Log4j
Instant Messaging Log4j Configuration File (log4j.conf) Location
Instant Messaging Log4j Log File Syntax
Log4j Log Levels for Instant Messaging Components
To Specify the Location of the Log4j Configuration File (Log4j.conf)
To Enable or Disable Log4j Logging for an Instant Messaging Component
To Set Log4j Log Levels for Instant Messaging
To Specify the Maximum Log4j Log File Size for Instant Messaging Components
Configuring Logging for Instant Messaging Components Using iim.conf Parameters
To Set Log Levels for Instant Messaging Components Using iim.conf Parameters
Administering Logging for Instant Messenger
Setting Up Logging for Instant Messenger
To Enable Logging for Instant Messenger
Locating the Instant Messenger Log File (messenger.log)
Instant Messenger Log File Content Options
Chapter 14 Administering Instant Messaging End Users
Disabling End User Access to Instant Messenger
To Disable Instant Messaging End Users
Registering New Instant Messaging Users
Configuring the Instant Messaging Server to Allow New User Registration
To Configure the Instant Messaging Server to Allow New User Registration
Customizing Instant Messenger to Allow New User Registration
To Customize Instant Messenger to Allow New User Registration
Registering as a New Instant Messaging User
To Register as a New Instant Messaging User
Storing Instant Messaging User Properties in LDAP
To Store Instant Messaging User Properties in LDAP
Assigning Instant Messaging and Presence Services to End Users
To Assign Instant Messaging and Presence Services to End Users
Chapter 15 Managing Instant Messenger
Configuring Instant Messenger
Invoking Instant Messenger
To Invoke Instant Messenger Using a Direct URL
To Invoke Instant Messenger From the Command-Line (Solaris Only)
To Invoke Instant Messenger Using a Desktop Shortcut
Changing the Codebase
To Change the Codebase in the Resource Templates
Changing the Web Container Port
Customizing Instant Messenger
Instant Messenger Resource Files
Customizing the index.html and im.html Files
Launching Instant Messenger Using Sun Java System Access Manager SSO
Customizing the Application (Java Web Start)
Contents of imbrand.jar
Rebranding Instant Messenger
To Rebrand Instant Messenger
Customizing User Name and Group Name Display
To Change the Attribute Used to Display a User's Name
To Change the Attribute Used to Display a Group's Name
To Customize User Name Display in Search Results
To Customize Tooltip Contents
Modifying How Client Users Search for Contacts
To Allow Users to Search on Custom Attributes
To Allow Wildcards in Searches
Administering Conference Rooms and News Channels
Modifying Instant Messenger Proxy Settings
To Set Proxy Settings Manually for a Single Instant Messenger Client Using Java Web Start
To Configure Proxy Settings for all Instant Messaging Client Connections in im.jnlp
Controlling the Exposed Messenger Feature Set
Instant Messenger Data Stored in the End User’s System
Redeploying Resource Files
To Redeploy Resource Files to Sun Java System Application Server or Sun Java System Web Server
Chapter 16 Using Calendar Pop-up Reminders
Pop-up Reminders Overview
Pop-up Reminders Operation
Pop-up Reminders Architectural Flow
iim.conf Calendar Pop-up Configuration Parameters
Configuring Instant Messaging Pop-ups
To Configure Instant Messaging Server for Calendar Pop-ups Using the configure Utility
To Manually Configure Instant Messaging Server for Calendar Pop-ups
To Configure Calendar Server for Pop-ups
To Configure Instant Messenger for Calendar Pop-ups
Configuring Calendar Pop-ups in a Server Pool
Administering the Calendar Agent
Enabling and Disabling Instant Messaging Agents
Chapter 17 Managing Instant Messaging and Presence Policies
Overview of Privacy, Security, and Site Policies
Site Policies
Conference Room and News Channel Access Controls
User Privacy
Methods for Controlling End User and Administrator Privileges
Setting the Policy Management Method
To Set the Policy Management Method
Policy Configuration Parameters
Managing Policies Using Access Control Files
To Change End-user Privileges in Access Control Files
Using Access Control Files in a Server Pool
Access Control File Location
Access Control File Format
Managing Policies using Sun Java System Access Manager
Instant Messaging Service Attributes
Modifying Attributes Directly
Predefined Instant Messaging and Presence Policies
Creating New Instant Messaging Policies
To Create a New Policy
Assigning Policies to a Role, Group, Organization, or User
To Assign a Policy
Creating New Suborganizations Using Access Manager
To Create a New Suborganization
Assigning Roles to End Users in New Suborganizations
To Assign Roles to End Users in a New Suborganization
Chapter 18 Managing Archiving for Instant Messaging
Archiving Overview
Enabling and Disabling Archiving for Instant Messaging
To Enable Instant Messaging Archiving
To Disable Instant Messaging Archiving
Managing the Instant Messaging Email Archive
Enabling and Disabling the Instant Messaging Email Archive Provider
To Enable the Instant Messaging Email Archive
To Disable the Instant Messaging Email Archive Provider
Configuring Email Archive Settings
To Configure Administrator Recipients and the RFC 822 Header Format for the Instant Messaging Email Archive
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 News Channel Posts
Managing the Instant Messaging Portal Archive
Instant Messaging Portal Archive Overview
Enabling and Disabling the Portal Archive Provider
To Enable the Instant Messaging Portal Archive Provider
To Disable the Portal Archive Provider
Configuring the Instant Messaging Portal Archive Provider
To Configure the Archive Provider
To Store Archived Messages in a Non-default Database
Managing Archived Data in the Portal Server Search Database
rdmgr Command
To Invoke the rdmgr Command
Searching Resource Descriptors
Deleting Resource Descriptors
Changing the Display of Archived Data
To Modify the Default System Message
Sample Deployment Scenario for Archive Provider
To Archive All Instant Messaging Chat Data Based on Time
To Archive and Back up Instant Messaging Chat Data for the Month of December 2005 to the Subcategory
To Remove Archived Instant Messaging Chat Data for the Month of December 2005 from the Portal Server Search Database
Using a Custom Archive Provider
To Enable a Custom Archive Provider
To Disable a Custom Archive Provider
Chapter 19 Troubleshooting and Monitoring Instant Messaging
Troubleshooting Instant Messenger
Obtaining Instant Messenger Runtime Information
To Obtain Instant Messenger Runtime Information from the About Dialog
Obtaining Instant Messenger Logs
Problems and Solutions
Unable to Connect to Instant Messaging Redirect Server from Client
Unable to Log into Instant Messenger through the XMPP/HTTP Gateway
To Configure Instant Messenger to Authenticate from a Specific Domain
Messages Not Archived With Sun Java System Portal Server 7 2006Q1 or Later
Instant Messenger Resource Customizations Lost After patchrm and patchadd
Cannot Forward Mail to Offline Users
To Configure the Attribute Used for User Email Addresses
Calendar Pop-up Reminders Do Not Work
To Troubleshoot Calendar Client and Instant Messenger Configuration for Pop-Ups
Single Sign-on Does Not Work
Instant Messenger Does Not Load or Start
Connection Refused or Timed Out
Authentication Errors
Instant Messenger Channel Display Error
Instant Messaging Content is not Archived
Server-to-Server Communication Fails to Start
Catastrophic Installation Failure Leaves Server in an Inconsistent State
To Manually Remove All Instant Messaging Components
Instant Messaging Services Do Not Appear in the Access Manager Console (amconsole)
Troubleshooting Instant Messaging and LDAP
Using a Directory That Does not Permit Anonymous Bind
To Configure Bind Credentials for the Instant Messaging Server
Displaying Contact Names Using an Attribute Other than cn
To Change the Attribute Used to Display Contact Names
Searching the Directory 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)
Monitoring Instant Messaging
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
Part III Reference Information
Appendix A Instant Messaging Configuration Parameters in iim.conf
iim.conf File Location
iim.conf File Syntax
General Configuration Parameters
LDAP and User Registration Configuration Parameters
Logging Configuration Parameters
Instant Messaging Server Configuration Parameters
Multiple Server Configuration Parameters
Multiplexor Configuration Parameters
Redirect Server Parameters
Archive Parameters
Watchdog Parameters
Monitoring Parameters
Agent Parameters
Appendix B Instant Messaging XMPP/HTTP Gateway Configuration Parameters in httpbind.conf
httpbind.conf File Location
httpbind.conf File Syntax
Instant Messaging XMPP/HTTP Gateway Configuration Parameters
Gateway Domain ID Key Parameters for httpbind.config
Appendix C Instant Messaging imadmin Tool Reference
imadmin Overview
imadmin Requirements
imadmin Location
imadmin Commands
imadmin Syntax
imadmin Options
imadmin Actions
imadmin Components
Appendix D Instant Messaging APIs
Instant Messaging APIs Overview
Instant Messaging Service API
Messenger Beans
Service Provider Interfaces
Archive Provider API
Message Conversion API
Authentication Provider API
Appendix E Instant Messaging LDAP Schema
Instant Messaging Objectclasses
© 2010, Oracle Corporation and/or its affiliates