TIBCO Enterprise Message

Service™
User’s Guide
Software Release 4.0.0
February 2004
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE.
THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY
ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT,
THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING
DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE
TIBCO ENTERPRISE MESSAGE SERVICE USER’S GUIDE). USE OF THIS DOCUMENT IS
SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL
CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright
laws and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
TIB, TIBCO, Information Bus, The Power of Now, TIBCO ActiveEnterprise, TIBCO Adapter, TIBCO
Hawk, TIBCO Rendezvous, TIBCO Enterprise, TIBCO Enterprise Message Service, and the TIBCO
logo are either registered trademarks or trademarks of TIBCO Software Inc. in the United States
and/or other countries.
EJB, J2EE, JMS and all Java-based trademarks and logos are trademarks or registered trademarks of
Sun Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of
their respective owners and are mentioned for identification purposes only.
This software may be available on multiple operating systems. However, not all operating system
platforms for a specific software version are released at the same time. Please see the readme.txt file
for the availability of this software version on a specific operating system platform.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
Copyright © 1999–2004 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
 | iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
TIBCO Enterprise Message Service Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvi
Third Party Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii

Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
JMS Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
JMS Message Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Point-to-Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Publish and Subscribe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Bridges Between Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Controlling the Flow of Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Performance Features of Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Additional Queue and Topic Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Client APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
TIBCO Rendezvous Java Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
String Encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Message Tracing and Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Administering the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
User and Group Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Using TIBCO Hawk. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Fault Tolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Integrating With Third-Party Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Transaction Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

TIBCO Enterprise Message Service User’s Guide

iv
| Contents

Chapter 2 Working With the Client API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
C and C# Client APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Programming Model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
ConnectionFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
MessageProducer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
MessageConsumer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Durable Subscribers for Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Synchronous or Asynchronous Message Consumption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
MessageListener. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 3 Working With Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Destination Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Static Queues and Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Dynamic Queues and Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Destination Bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Destination Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Wildcards * and >. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Wildcards in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Wildcards in Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Inheritance of Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Inheritance of Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Destination Bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Creating a Bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Access Control and Bridges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Enabling Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Enforcing Flow Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Routes and Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Destination Bridges and Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Chapter 4 Working With Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

JMS Message Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Header Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

TIBCO Enterprise Message Service User’s Guide

 Contents v
|
Message Bodies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Message Persistence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Character Encoding in Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Supported Character Encodings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Sending Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Receiving Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Message Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
About Message Compression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Setting Message Compression. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Message Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Undelivered Message Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Including the Message Sender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
MapMessage Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
EMS Message Delivery Mode Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Reliable Message Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
No-Acknowledgement Message Receipt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Chapter 5 Working With TIBCO Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Message Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Deprecated Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Configuring Transports for Rendezvous . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Transport Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Import Only when Subscribers Exist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Certified Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Import—Start and Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Import Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Import Destination Names Must be Unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
JMSReplyTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Guaranteed Delivery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Export Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
JMSReplyTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Certified Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Guaranteed Delivery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Message Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

TIBCO Enterprise Message Service User’s Guide

vi
| Contents
JMS Header Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
JMS Property Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Message Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Data Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Pure Java Rendezvous Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Chapter 6 Working With TIBCO SmartSockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Message Translation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Starting the Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Configuring Transports for SmartSockets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Transport Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Subscribe Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Destination Name—Syntax and Semantics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Import Only when Subscribers Exist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Import—Start and Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Wildcards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Import Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Import Destination Names Must be Unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
JMSReplyTo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Export Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
JMSReplyTo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Wildcard Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Guaranteed Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Message Translation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
JMS Header Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
JMS Property Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Message Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Data Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Destination Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Chapter 7 Using the Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Using the Main Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Using Other Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

TIBCO Enterprise Message Service User’s Guide

 Contents vii
|
topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
acl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
bridges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
transports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
tibrvcm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
durables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Chapter 8 Using the Administration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Starting the Administration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
When You First Start tibemsadmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Command Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Chapter 9 Authentication and Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Overview of Users, Groups, and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Setting Up Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Enabling Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Server Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Destination Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Configuring an External Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Example of Setting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Inheritance of Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Revoking Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
When Permissions Are Checked . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Example of Permission Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Administrator Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Predefined Administrative User and Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Granting and Revoking Administration Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Enforcement of Administrator Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Global Administrator Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Destination-Level Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Protection Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

TIBCO Enterprise Message Service User’s Guide

viii
| Contents

Chapter 10 Monitoring Server Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Log Files and Tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Configuring the Log File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Tracing on the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Message Tracing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Enabling Message Tracing for a Destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Enabling Message Tracing on a Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Monitoring Server Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
System Monitor Topics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Monitoring Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Viewing Monitor Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Performance Implications of Monitor Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Working with Server Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Overall Server Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Enabling Statistic Gathering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Displaying Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Chapter 11 Deploying the Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Running the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Starting the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Security Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Running TIBCO Enterprise Message Service Client-Side Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Programmer’s Checklist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Connecting Directly to TIBCO Enterprise Message Service Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Using JNDI with TIBCO Enterprise Message Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Dynamic Topics and Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Static Topics and Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Using SSL with JNDI Lookups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Performing Fault-Tolerant JNDI Lookups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Chapter 12 Using the SSL Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

SSL Support in TIBCO Enterprise Message Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Digital Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Digital Certificate File Formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Private Key Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Overview of the SSL Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Cipher Suite Negotiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Client and Server Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Renegotiating the Session Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

TIBCO Enterprise Message Service User’s Guide

 Contents ix
|
File Names for Certificates and Keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Configuring SSL in the Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
SSL Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Command Line Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Configuring SSL in EMS Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Client Digital Certificates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Configuring SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Specifying Cipher Suites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Syntax for Cipher Suites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Supported Cipher Suites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Third-Party SSL Hardware Accelerators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Ingrian Accelerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

Chapter 13 Making the Server Fault-Tolerant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Fault Tolerance Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Shared State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Implementing Shared State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Which Messages Are Stored . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Storage Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Controlling Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Setting Up Fault-Tolerant Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Using SSL for Connections Between Primary and Backup Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Reconnect Timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Setting Up Clients for Fault-Tolerant Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Specifying More Than Two URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Failover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Message Redelivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Heartbeat Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Chapter 14 Working With Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Overview of Routing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Basic Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Global Destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Unique Routing Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Zone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Basic Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Eliminating Redundant Paths with a One-Hop Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Overlapping Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

TIBCO Enterprise Message Service User’s Guide

x
| Contents
Active and Passive Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Configuring Routes and Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Routes to Fault-Tolerant Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Routing and SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Routed Topic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Propagating Registered Interest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Selectors for Routing Topic Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Routed Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Routing and Authorization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Appendix A Using the Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299

Starting Work with the Client Sample Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Compiling the Sample Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Publish and Subscribe Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Overview of the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Creating a Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Creating Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Publishing and Subscribing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Running Client Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

Appendix B Using TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Overview of Server Management With TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Installing the Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Windows Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
UNIX Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Method Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Appendix C Monitor Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

Description of Monitor Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Description of Topic Message Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

Appendix D Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

TIBCO Enterprise Message Service User’s Guide

 | xi

Figures

Figure 1 Message Delivery. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Figure 2 Point-to-point messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 3 Publish and subscribe messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 4 JMS API programming model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 5 Specific interfaces for topics and queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Figure 6 Bridging a topic to a queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 7 Bridging a topic to multiple destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Figure 8 Clients sending UTF-8 encoded messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Figure 9 Clients sending messages with a specific encoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Figure 10 Clients receiving messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Figure 11 Message Delivery and Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Figure 12 Rendezvous Transports in the EMS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Figure 13 SmartSockets Transports in the EMS Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Figure 14 Users, groups, and permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Figure 15 SSL Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Figure 16 Ingrian Accelerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Figure 17 Primary Server and Backup Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Figure 18 Routes: bidirectionality and corresponding destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Figure 19 Routes: global destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Figure 20 Routes: Unique Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Figure 21 Zones: multi-hop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Figure 22 Zones: one-hop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Figure 23 Zones: overlap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Figure 24 Routing: Propagating Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Figure 25 Routing: Topic Selectors, example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Figure 26 Routing: Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Figure 27 Routing: Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

TIBCO Enterprise Message Service User’s Guide

xii
| Figures

TIBCO Enterprise Message Service User’s Guide

 | xiii

Tables

Table 1 Summary of message properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Table 2 Summary of administration features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Table 3 API object summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 4 Destination properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 5 JMS Message Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 6 JMS Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 7 Rendezvous: Transport Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Table 8 Rendezvous: Mapping JMS Header Fields to RV Datatypes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Table 9 Rendezvous: Mapping Message Types (Import) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Table 10 Rendezvous: Mapping Message Types (Export) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Table 11 Rendezvous: Mapping Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Table 12 TibrvJMSTransport class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Table 13 SmartSockets: Transport Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Table 14 SmartSockets: Mapping Message Types (Export) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Table 15 SmartSockets: Mapping Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Table 16 Configuration parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Table 17 tibemsadmin Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Table 18 Set server parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Table 19 Show connections table information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Table 20 Show durables table information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Table 21 Show queues table information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Table 22 Show topics table information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Table 23 Default configuration for popular LDAP servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Table 24 Queue Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Table 25 Topic Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Table 26 Global administrator permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Table 27 Destination-level administration permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Table 28 Server tracing options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

TIBCO Enterprise Message Service User’s Guide

xiv
| Tables
Table 29 Message monitoring qualifiers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Table 30 tibemsd Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Table 31 SSL properties for client applications using JNDI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Table 32 File types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Table 33 ConnectionFactory SSL parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Table 34 Qualifiers for cipher suites in the Java client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Table 35 OpenSSL qualifiers for cipher suites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Table 36 Supported cipher suites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Table 37 SSL Parameters for Routes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Table 38 TIBCO Enterprise Message Service classes in TIBCO Hawk. . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Table 39 TIBCO Hawk method names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Table 40 Monitor topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Table 41 Message properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Table 42 Event Reason Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

TIBCO Enterprise Message Service User’s Guide

 | xv

Preface

TIBCO Enterprise Message Service™ software lets you send messages from your
applications according to the Java Messaging Service (JMS) protocol. It also
integrates with TIBCO Rendezvous and TIBCO SmartSockets message products.

This software may be available on multiple operating systems. However, not

all operating system platforms for a specific software version are released at the
same time. Please see the readme.txt file for the availability of this software
version on a specific operating system platform.

Topics

• Related Documentation, page xvi

• How to Contact TIBCO Customer Support, page xviii

TIBCO Enterprise Message Service User’s Guide

xvi Preface
|

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Enterprise Message Service Documentation

The following documents form the TIBCO Enterprise Message Service
documentation set:
• TIBCO Enterprise Message Service User’s Guide Read this manual to gain an
understanding of the product that you can apply to the various tasks you may
undertake.
• TIBCO Enterprise Message Service Application Integration Guide Read this
manual to learn how to integrate TIBCO Enterprise Message Service with
third-party products.
• TIBCO Enterprise Message Service Installation Read this manual before
installing this product.
• TIBCO Enterprise Message Service Java API Reference Read the API references
for more information on the Java API. The Java API reference is available in
JavaDoc, and you can access the reference by way of the HTML
documentation interface.
• TIBCO Enterprise Message Service C API Reference Read the API references for
more information on the C API. The C API reference is available in HTML and
PDF formats.
• TIBCO Enterprise Message Service .NET API Reference Read the API references
for more information on the .NET API. The .NET API reference is available in
HTML format.
• TIBCO Enterprise Message Service Release Notes Read this document for new
features, known and closed issues.

Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO
products:
• TIBCO Rendezvous™ software
• TIBCO SmartSockets™ software

TIBCO Enterprise Message Service User’s Guide

 Related Documentation xvii
|

Third Party Documentation

• Java™ Message Service specification, available through
java.sun.com/products/jms/index.html
• Java™ Message Service by Richard Monson-Haefel and David A. Chappell,
O’Reilly and Associates, Sebastopol, California, 2001.

TIBCO Enterprise Message Service User’s Guide

xviii Preface
|

How to Contact TIBCO Customer Support

For comments or problems with this manual or the software it addresses, please
contact TIBCO Support Services as follows.
• For an overview of TIBCO Support Services, and information about getting
started with TIBCO Product Support, visit this site:
http://www.tibco.com/services/support/default.jsp
• If you already have a valid maintenance or support contract, visit this site:
http://support.tibco.com
Entry to this site requires a username and password. If you do not have a
username, you can request one.

TIBCO Enterprise Message Service User’s Guide

 |1

Chapter 1 Overview

This chapter contains a general overview of Java Message Service (JMS) and
TIBCO Enterprise Message Service™ (EMS) concepts.

Topics

• JMS Overview, page 2

• JMS Message Models, page 3
• Client APIs, page 7
• Messages, page 8
• Sample Code, page 10
• Administration, page 11
• Fault Tolerance, page 13
• Routing, page 14
• SSL, page 15
• Integrating With Third-Party Products, page 16

TIBCO Enterprise Message Service User’s Guide

2
| Chapter 1 Overview

JMS Overview

Java Message Service 1.1 (JMS) is a Java framework specification for messaging
between applications. Sun Microsystems developed this specification, in
conjunction with TIBCO and others, to supply a uniform messaging interface
among enterprise applications.
Using a message service allows you to integrate the applications within an
enterprise. For example, you may have several applications: one for customer
relations, one for product inventory, and another for raw materials tracking. Each
application is crucial to the operation of the enterprise, but even more crucial is
communication between the applications to ensure the smooth flow of business
processes. Message-oriented-middleware (MOM) creates a common
communication protocol between these applications and allows you to easily
integrate new and existing applications in your enterprise computing
environment.
The JMS framework (an interface specification, not an implementation) is
designed to supply a basis for MOM development. TIBCO Enterprise Message
Service implements and integrates several message services, including JMS. This
chapter describes the concepts of JMS and its implementation in TIBCO
Enterprise Message Service. For more information on JMS requirements and
features, the following sources are recommended:
• Java Message Service specification, available through
http://java.sun.com/products/jms/index.html.
• Java Message Service by Richard Monson-Haefel and David A. Chappell,
O’Reilly and Associates, Sebastopol, California, 2001.

TIBCO Enterprise Message Service User’s Guide

 JMS Message Models 3
|

JMS Message Models

JMS is based on creation and delivery of messages. Messages are structured data
that one application sends to another. The creator of the message is known as the
producer and the receiver of the message is known as the consumer. The TIBCO
EMS server acts as an intermediary for the message and sends it to the correct
destination. The server also provides enterprise-class functionality such as
fault-tolerance, message routing, and communication with other messaging
systems, such as TIBCO Rendezvous™ and TIBCO SmartSockets™.
Figure 1 illustrates an application producing a message, sending it by way of the
server, and a different application receiving the message.

Figure 1 Message Delivery

Message Message Message Message

TIBCO EMS
Producer Consumer
Server

EMS Client EMS Client

JMS supports two messaging models:

• Point-to-point (queues)
• Publish and subscribe (topics)

Point-to-Point
Point-to-point messaging has one producer and one consumer per message. This
style of messaging uses a queue to store messages until they are received. The
message producer sends the message to the queue; the message consumer
retrieves messages from the queue and sends acknowledgement that the message
was received.
More than one producer can send messages to the same queue, and more than
one consumer can retrieve messages from the same queue. The queue can be
configured to be exclusive, if desired. If the queue is exclusive, then all queue
messages can only be retrieved by the first consumer specified for the queue.
Exclusive queues are useful when you want only one application to receive
messages for a specific queue. If the queue is not exclusive, any number of

TIBCO Enterprise Message Service User’s Guide

4
| Chapter 1 Overview

receivers can retrieve messages from the queue. Non-exclusive queues are useful
for balancing the load of incoming messages across multiple receivers. Regardless
of whether the queue is exclusive or not, only one consumer can ever retrieve
each message that is placed on the queue.
Figure 2 illustrates point-to-point messaging using a non-exclusive queue. Each
message consumer receives a message from the queue and acknowledges receipt
of the message. The message is taken off the queue so that no other consumer can
receive it.

Figure 2 Point-to-point messages

TIBCO EMS
Server
Message
Message Queue Receive Message Consumers
Producer Send Message
Acknowledge
EMS Clients
EMS Client

Publish and Subscribe

In a publish and subscribe message system, producers address messages to a
topic. In this model, the producer is known as a publisher and the consumer is
known as a subscriber.
Many publishers can publish to the same topic, and a message from a single
publisher can be received by many subscribers. Subscribers subscribe to topics,
and all messages published to the topic are received by all subscribers to the topic.
This type of message protocol is also known as broadcast messaging because
messages are sent over the network and received by all interested subscribers,
similar to how radio or television signals are broadcast and received.
Figure 3 illustrates publish and subscribe messaging. Each message consumer
subscribes to a topic. When a message is published to that topic, all subscribed
consumers receive the message.

TIBCO Enterprise Message Service User’s Guide

 JMS Message Models 5
|

Figure 3 Publish and subscribe messages

TIBCO EMS
Server
Subscribe to
Topic Message
Message Consumers
Producer Publish Message Topic
Deliver Message
Acknowledge EMS Clients
EMS Client (if necessary)

There can be a time dependency in the publish and subscribe model. By default,
subscribers only receive messages when they are active. If messages are delivered
when the subscriber is not available, the subscriber does not receive those
messages. JMS specifies a way to remove part of the timing dependency by
allowing subscribers to create durable subscriptions. Messages for durable
subscriptions are stored on the server until the message expires or the storage
limit is reached. Subscribers can receive messages from a durable subscription
even if the subscriber was not available when the message was originally
delivered.

Bridges Between Destinations

You can also create bridges between destinations of the same or different types to
create a hybrid messaging model for your application. This can be useful if your
application requires that you send the same message to both a topic and a queue.
For more information on creating bridges between destinations and situations
where this may be useful, see Destination Bridges on page 43.

Controlling the Flow of Messages

You can control the flow of messages to a destination. This is useful when
message producers send messages much faster than message consumers can
receive them. For more information on flow control, see Flow Control on page 46.

Performance Features of Queues

You can specify that a queue receiver can receive a batch of messages in the
background to improve performance. Alternatively, you can specify that queue
receivers should only receive one message at a time, if you must guarantee that no
queue receivers should receive more than one message at a time.

TIBCO Enterprise Message Service User’s Guide

6
| Chapter 1 Overview

Additional Queue and Topic Features

TIBCO Enterprise Message Service allows you to specify several properties for
topics and queues that enhance the functionality of each messaging model. Queue
and topic properties are set when the destination is created. Queue and topic
properties can add the following functionality:
• A fail safe mode allows messages to be written to disk synchronously to
guarantee no messages are ever lost due to server failure.
• Enforcement of permissions can be set at the queue or topic level so that some
destinations may require access control and others may not.
• You can limit the size of messages stored on a queue. If a receiver is offline for
a long time, queue messages can accumulate and consume machine resources.
• You can limit the size of messages stored for durable topic subscriptions. If a
subscriber is offline for a long time, topic messages can accumulate and
consume machine resources.
• Messages sent to destinations can be routed to other servers.
• TIBCO Rendezvous messages can be received by a queue. Topics can either
receive or send Rendezvous messages.
• Queues can be set to be exclusive or non-exclusive. Only one receiver can
receive messages from an exclusive queue. More than one receiver can receive
messages from non-exclusive queues.
• Queues can specify a redelivery policy. When messages must be redelivered,
you can specify a property on the queue that determines the maximum
number of times a message should be redelivered.
• All messages passing through a destination can be traced and logged.
• The user name of message producer that sends messages can be included in
the message.
• TIBCO Enterprise Message Service allows you to create wildcard destinations.
The wildcard destination name is the parent, and any names that match the
wildcard destination name inherit the properties of the parent.
See Chapter 3, Working With Destinations, on page 29 for more information about
working with destinations.

TIBCO Enterprise Message Service User’s Guide

 Client APIs 7
|

Client APIs

Java applications use the javax.jms package to send or receive JMS messages.
This is a standard set of interfaces, specified by the JMS specification, for creating
the connection to the EMS server, specifying the type of message to send, and
creating the destination (topic or queue) to send to or receive from. You can find a
description of the javax.jms package in TIBCO Enterprise Message Service Java
API Reference included in the online documentation. Because TIBCO Enterprise
Message Service implements the JMS standard, you can also view the
documentation on these interfaces along with the JMS specification at
java.sun.com/products/jms/index.html.
TIBCO Enterprise Message Service includes a parallel API for C client programs;
see TIBCO Enterprise Message Service C API Reference (online documentation).
TIBCO Enterprise Message Service includes a parallel API for .NET client
programs; see TIBCO Enterprise Message Service .NET API Reference.

TIBCO Rendezvous Java Applications

TIBCO Enterprise Message Service includes a Java class that allows pure Java
TIBCO Rendezvous applications to connect directly with the TIBCO Enterprise
Message Service server; see Pure Java Rendezvous Programs on page 84.

TIBCO Enterprise Message Service User’s Guide

8
| Chapter 1 Overview

Messages

JMS messages have a standard structure. This structure includes the following
sections:
• Header (required)
• Properties (optional)
• Body (optional)
The JMS specification details a standard format for the header and body of a
message. Properties are provider-specific and can include information on specific
implementations or enhancements to JMS functionality. Table 1 describes the
message properties available with TIBCO Enterprise Message Service.

Table 1 Summary of message properties (Sheet 1 of 2)

More
Property Description
Info
JMS_TIBCO_COMPRESS Allows messages to be 59
compressed for more efficient
storage.

JMS_TIBCO_DISABLE_SENDER Specifies that the user name of 62

the message sender should not
be included in the message, if
possible.

JMS_TIBCO_IMPORTED Set by the server when the 80

message has been imported
101
from TIBCO Rendezvous.

JMS_TIBCO_MSG_EXT Extends the functionality of 63

map messages to include
submessages or arrays.

JMS_TIBCO_MSG_TRACE Specifies the message should 213

be traced from producer to
consumer.

JMS_TIBCO_PRESERVE_UNDELIVERED Specifies the message is to be 61

placed on the undelivered
message queue if the message
must be removed.

TIBCO Enterprise Message Service User’s Guide

 Messages 9
|
Table 1 Summary of message properties (Sheet 2 of 2)

More
Property Description Info
JMS_TIBCO_SENDER Contains the user name of the 62
message sender.

The JMS standard specifies two delivery modes for messages, PERSISTENT and
NON_PERSISTENT. TIBCO Enterprise Message Service also includes
RELIABLE_DELIVERY. This delivery mode eliminates some of the overhead
associated with the other delivery modes.
For consumer sessions, you can also specify that consumers do not need to
acknowledge receipt of messages, if desired.
See Chapter 4, Working With Messages, on page 49 for more information about
working with messages. Also, more information about properties specific to
TIBCO Enterprise Message Service can be found in the TIBCO Enterprise Message
Service Java API Reference included in the online documentation.

String Encoding
TIBCO Enterprise Message Service Java and C clients can use the functions and
libraries provided for handling strings with specific character encodings. This is
important for applications handling international data or any non-ASCII
characters. See Character Encoding in Messages on page 54 for more information
about character encoding in TIBCO Enterprise Message Service clients.

Message Tracing and Monitoring

Administrators can configure the server to trace messages as they are processed.
Message information can be written to the log file or to the console. Message
monitoring topics can also be used to receive messages that provide details about
each message’s processing. See Chapter 10, Monitoring Server Activity, on
page 207 for more information about monitoring messages or tracing message
activity.

TIBCO Enterprise Message Service User’s Guide

10
| Chapter 1 Overview

Sample Code

TIBCO Enterprise Message Service includes several example programs. These

examples illustrate various features of TIBCO Enterprise Message Service. You
may wish to view these example programs when reading about the
corresponding features in this manual. The examples are included in the samples
subdirectory of the TIBCO Enterprise Message Service installation directory.
For more information about running the examples, see Appendix A, Using the
Samples, on page 299.

TIBCO Enterprise Message Service User’s Guide

 Administration 11
|

Administration

TIBCO Enterprise Message Service provides mechanisms for administering

server operations and creating objects that are managed by the server, such as
ConnectionFactories and Destinations; see Chapter 2, Working With the Client
API, on page 17.
Administration functions can be issued either using the command-line
administration tool or by creating an application that uses the administration API.
The command-line administration tool is described in Chapter 8, Using the
Administration Tool, on page 145. The administration API is described in TIBCO
Enterprise Message Service Java API Reference included in the online documentation.
The administration interfaces allow you to create and manage administered
objects such as ConnectionFactories, Topics, and Queues. EMS clients can retrieve
references to these administered objects by using Java Naming and Directory
Interface (JNDI). Creating static administered objects allows clients to use these
objects without having to implement the objects within the client.

Administering the Server

The TIBCO Enterprise Message Service has several administration features that
allow you to monitor and manage the server. The following table provides a
summary of administration features and details where in the documentation you
can find more information.

Table 2 Summary of administration features (Sheet 1 of 2)

Feature More Information

Configuration files allow you to specify Chapter 7, Using the
server characteristics. Configuration Files, on page 105

Administration tool provides a command Chapter 8, Using the

line interface for managing the server. Administration Tool, on page 145

Authentication and permissions can Chapter 9, Authentication and

restrict access to the server and to Permissions, on page 179
destinations. You can also specify who
can perform administrative activities with
administrator permissions.

Log files can be configured to provide Chapter 10, Monitoring Server

information about various server activity. Activity, on page 207

TIBCO Enterprise Message Service User’s Guide

12
| Chapter 1 Overview

Table 2 Summary of administration features (Sheet 2 of 2)

Feature More Information

The server can publish messages when Chapter 10, Monitoring Server
various system events occur. This allows Activity, on page 207
you to create robust monitoring
applications that subscribe to these
system monitor topics.

The server can provide various statistics Chapter 10, Monitoring Server
at the desired level of detail. Activity, on page 207

User and Group Management

TIBCO Enterprise Message Service provides facilities for creating and managing
users and groups locally for the server. The TIBCO Enterprise Message Service
server can also use an external system, such as an LDAP server or the UNIX
system password file for authenticating users and storing group information. See
Chapter 9, Authentication and Permissions, on page 179 for more information
about configuring TIBCO Enterprise Message Service to work with external
systems for user and group management.

Using TIBCO Hawk

You can use TIBCO Hawk for monitoring and managing the TIBCO Enterprise
Message Service server. See Appendix B, Using TIBCO Hawk, on page 307 for
more information.

TIBCO Enterprise Message Service User’s Guide

 Fault Tolerance 13
|

Fault Tolerance

You can configure TIBCO Enterprise Message Service servers as primary and
backup servers to provide fault tolerance for your environment. The primary and
backup servers act as a pair, with the primary server accepting client connections
and performing the work of handling messages, and the secondary server acting
as a backup in case of failure. When the active server fails, the backup server
assumes operation and becomes the primary active server.
See Chapter 13, Making the Server Fault-Tolerant, on page 265 for more
information about the fault-tolerance features of TIBCO Enterprise Message
Service.

TIBCO Enterprise Message Service User’s Guide

14
| Chapter 1 Overview

Routing

TIBCO Enterprise Message Service provides the ability for servers to route
messages between each other. Topic messages can be routed across multiple hops,
provided there are no cycles (that is, the message can not be routed to any server
it has already visited). Queue messages can travel at most one hop to any other
server from the server that owns the queue.
TIBCO Enterprise Message Service stores and forwards messages in most
situations to provide operation when a route is not connected.
See Chapter 14, Working With Routes, on page 277 for more information about
the routing features of TIBCO Enterprise Message Service.

TIBCO Enterprise Message Service User’s Guide

 SSL 15
|

SSL

Secure Sockets Layer (SSL) is a protocol for transmitting encrypted data over the
Internet or an internal network. SSL works by using public and private keys to
encrypt data that is transferred over the SSL connection. Most web browsers
support SSL, and many Web sites and Java applications use the protocol to obtain
confidential user information, such as credit card numbers.
TIBCO Enterprise Message Service supports SSL. SSL is supported between the
following components:
• between an EMS Java client and the TIBCO Enterprise Message Service server
• between an EMS C or C# client and the TIBCO Enterprise Message Service
server
• between the administration tool and the TIBCO Enterprise Message Service
server
• between routed servers
• between fault-tolerant servers
The TIBCO Enterprise Message Service server and the EMS C and C# client
libraries use OpenSSL for SSL support. You can find out more about OpenSSL at
www.openssl.org. TIBCO Enterprise Message Service can also be used with
Ingrian Accelerator products to enhance the performance of SSL communication.
See Chapter 12, Using the SSL Protocol, on page 241 for more information about
SSL support in TIBCO Enterprise Message Service.

TIBCO Enterprise Message Service User’s Guide

16
| Chapter 1 Overview

Integrating With Third-Party Products

TIBCO Enterprise Message Service allows you to work with third-party

naming/directory service products or with third-party application servers; see
TIBCO Enterprise Message Service Application Integration Guide.

Transaction Support
TIBCO Enterprise Message Service can integrate with Java Transaction API (JTA)
compliant transaction managers. TIBCO Enterprise Message Service implements
all interfaces necessary to be JTA compliant.

TIBCO Enterprise Message Service User’s Guide

 | 17

Chapter 2 Working With the Client API

This chapter gives an introduction to working with the interfaces of the

javax.jms package. For more information about the interfaces of this package,
see TIBCO Enterprise Message Service Java API Reference.

Topics

• API Overview, page 18

• ConnectionFactory, page 23
• Connection, page 24
• Session, page 25
• MessageProducer, page 26
• MessageConsumer, page 27
• MessageListener, page 28

TIBCO Enterprise Message Service User’s Guide

18
| Chapter 2 Working With the Client API

API Overview

Java applications use the javax.jms package to send or receive messages. This is
a standard set of interfaces, specified by the JMS specification, for creating the
connection to the EMS server, specifying the type of message to send, and creating
the destination (topic or queue) to send to or receive from. You can find a
description of the javax.jms package in TIBCO Enterprise Message Service Java
API Reference included in the online documentation.
The JMS specification also allows vendor-specific implementations of several
features. TIBCO Enterprise Message Service provides a package containing
classes and constants for all TIBCO-specific aspects of TIBCO Enterprise Message
Service. See the description of the com.tibco.tibems package in TIBCO
Enterprise Message Service Java API Reference included in the online documentation.

C and C# Client APIs

TIBCO Enterprise Message Service includes parallel APIs for clients written in C
or in C#. For details, see TIBCO Enterprise Message Service C API Reference (online
documentation), and TIBCO Enterprise Message Service .NET API Reference.

Programming Model
Figure 4 illustrates the interfaces involved in the EMS API.

TIBCO Enterprise Message Service User’s Guide

 API Overview 19
|

Figure 4 JMS API programming model

ConnectionFactory

Creates
Connection

Creates
Session Message

Creates
Creates

MessageProducer MessageConsumer

Registers With
Sends To Receives From
MessageListener

Topic or Queue

Applications using the point to point (queues) or publish and subscribe (topics)
models use the same interfaces to create objects. The JMS specification refers to
these interfaces as common facilities because these interfaces create objects that can
be used for either topics or queues.
Previous versions of the JMS specification defined specific interfaces for topics
and for queues. While these interfaces continue to be supported, they may be
deprecated in future releases of the JMS specification. You should use the
common facilities in your new EMS applications and upgrade old applications to
use the common facilities at your earliest convenience.
The JMS API interfaces prior to the JMS 1.1 specification have the same structure
as the common facilities, but the interfaces are specific to topics or queues.
Figure 5 illustrates the previous interface model used by the JMS API.

TIBCO Enterprise Message Service User’s Guide

20
| Chapter 2 Working With the Client API

Figure 5 Specific interfaces for topics and queues

QueueConnectionFactory
or
TopicConnectionFactory

Creates
QueueConnection
or
TopicConnection
Creates

QueueSession
or Message
TopicSession
Creates

Creates

QueueReceiver,
QueueSender QueueBrowser,
or or
TopicPublisher TopicSubscriber

Registers With
Sends To Receives From
MessageListener

Queue
or
Topic

Table 3 summarizes the interfaces used in the JMS API.

Table 3 API object summary (Sheet 1 of 2)

Common Facilities
Interfaces Specific Interfaces Description

ConnectionFactory QueueConnectionFactory Object used to create connections to EMS

server.
TopicConnectionFactory

Connection QueueConnection A connection encapsulates a physical

connection with a provider (server).
TopicConnection
Connections are used to create sessions.

TIBCO Enterprise Message Service User’s Guide

 API Overview 21
|
Table 3 API object summary (Sheet 2 of 2)

Common Facilities
Interfaces Specific Interfaces Description

Session QueueSession A session is a single-threaded object that

creates instances of message producers,
TopicSession
message consumers, messages and
transacted message groups.
Sessions can also be transacted. In a
transacted session, a group of messages are
sent and received in a single transaction.

MessageProducer QueueSender A message producer is an object created by a

session that is used for sending messages to
TopicPublisher
a destination.

MessageConsumer QueueBrowser A message consumer is an object created by

a session that receives messages sent to a
QueueReceiver
destination.
TopicSubscriber

MessageListener A message listener is an object that acts as an

asynchronous event handler for messages.
Message listeners must be registered with a
specific MessageConsumer.

MessageSelector Message selectors are optional filters that can

be used by the application. They transfer the
filtering work to the message provider,
rather than the message consumer.
A message selector is a String that contains
an expression. The syntax of the expression
is based on a subset of the SQL92 conditional
expression syntax.

Message Several types of message bodies are available

for queues and topics.

Queue Queue The destination that messages can be sent to

or received from.
Topic Topic
Normally these are created and managed by
the server, but clients can create destinations
dynamically by using methods on the
Session object.

TIBCO Enterprise Message Service User’s Guide

22
| Chapter 2 Working With the Client API

The following sections describe many of the API interfaces. Queues and Topics
are described in Chapter 3, Working With Destinations, on page 29. Messages are
described in Chapter 4, Working With Messages, on page 49.

TIBCO Enterprise Message Service User’s Guide

 ConnectionFactory 23
|

ConnectionFactory

The ConnectionFactory object encapsulates a set of connection configuration

parameters. These objects are created using the administration interface and they
are stored and managed by the TIBCO Enterprise Message Service server. See
Using the Administration Tool on page 145 for more information about creating
and managing connection factories.
When a client starts, it typically performs a Java Naming and Directory Interface
(JNDI) lookup for the ConnectionFactories that it needs. For example, the
following code retrieves the InitialContext using the JNDI properties specified by
env, then looks up a ConnectionFactory named myConnectionFactory.

Context ctx = new InitialContext(env);

ConnectionFactory myConnectionFactory =
(ConnectionFactory) ctx.lookup("myConnectionFactory");

See Using JNDI with TIBCO Enterprise Message Service on page 232 for more
information about using JNDI with TIBCO Enterprise Message Service.

TIBCO Enterprise Message Service User’s Guide

24
| Chapter 2 Working With the Client API

Connection

A Connection object encapsulates a virtual connection with the server.

ConnectionFactory objects create Connection objects. You use a Connection to
create one or more Session objects. For example, using the myConnectionFactory
object created in ConnectionFactory on page 23, the following creates a
Connection:
Connection myConnection =
myConnectionFactory.createConnection()

A connection is a fairly heavyweight object, and therefore most clients will use
one connection for all messaging. You may create multiple connections, if needed
by your application.
Before consuming messages, the application must call the start() method on the
connection. See MessageConsumer on page 27 for more details about
MessageConsumers. If you wish to temporarily suspend message delivery, call
the stop() method on the connection.
When a client application completes, all open connections must be closed.
Unused open connections are eventually closed, but they do consume resources
that could be used for other applications. Closing a connection also closes any
Sessions created by the Connection. To close a connection, use the close()
method. For example:
myConnection.close();

TIBCO Enterprise Message Service User’s Guide

 Session 25
|

Session

A Session is a single-threaded context for producing or consuming messages. You

create MessageProducers or MessageConsumers using Session objects. For
example, using the myConnection object created in Connection on page 24, the
following creates a Session:
Session mySession =
myConnection.createSession(false, Session.AUTO_ACKNOWLEDGE);

The first parameter to the CreateSession() method determines whether the

Session is transactional or not. The second parameter specifies the acknowledge
mode of messages received by the session. See Message Confirmation on page 60
and No-Acknowledgement Message Receipt on page 65 for more information
about message acknowledgment modes supported in TIBCO Enterprise Message
Service.

TIBCO Enterprise Message Service User’s Guide

26
| Chapter 2 Working With the Client API

MessageProducer

A MessageProducer object is created by a Session object and is used for sending

messages to destinations. For example, using the mySession object created in
Session on page 25, the following creates a MessageProducer that sends messages
to a queue named myQueue:
MessageProducer myQueueSender = mySession.createProducer(myQueue);

Once you have created a MessageProducer, you can use it to send messages. See
Chapter 4, Working With Messages, on page 49 for more information about
creating messages. For example, the following sends a message using the
queueSender created above:

myQueueSender.send(message);

You can create MessageProducers that do not identify a destination. When the
sender or publisher does not specify a destination, you must specify the
destination when you send or publish a message as the first parameter of the
send() or publish() method.

TIBCO Enterprise Message Service User’s Guide

 MessageConsumer 27
|

MessageConsumer

A MessageConsumer object is created by a Session object and is used for receiving

messages sent to destinations. For example, using the mySession object created in
Session on page 25, the following creates a MessageConsumer that retrieves
messages from a queue named myQueue:
MessageConsumer myQueueReceiver =
mySession.createConsumer(myQueue);

For queues, messages remain on the queue until they are consumed by a
MessageConsumer, the message expiration time has been reached, or the
maximum size of the queue is reached.
The following sections describe how message consumers can obtain messages.

Durable Subscribers for Topics

Only MessageConsumers whose client applications are running receive messages
published on a topic. Optionally, Sessions can create durable subscribers to ensure
that messages are received, even if the application is not currently running.
Use the Session.createDurableSubscriber() method to create a durable
subscription. Messages are stored by the server as long as durable subscribers
exist for the topic, or until the message expiration time for the message has been
reached, or until the storage limit has been reached for the topic.
When an application restarts and recreates a durable subscriber with the same ID,
all messages stored on the server for that topic are published to the durable
subscriber.
For more information on using the createDurableSubscriber() method, see
the TIBCO Enterprise Message Service Java API Reference.

Synchronous or Asynchronous Message Consumption

The API allows for synchronous or asynchronous message consumption. For
synchronous consumption, the MessageConsumer explicitly calls the receive()
method on the topic or queue. For asynchronous consumption, the client registers
a MessageListener for the topic or queue. When a message arrives at the
destination, the TIBCO Enterprise Message Service server delivers the message by
calling the listener’s onMessage() method.

TIBCO Enterprise Message Service User’s Guide

28
| Chapter 2 Working With the Client API

MessageListener

A MessageListener object acts as an asynchronous event handler for messages.

This object implements the MessageListener interface and has one method,
onMessage().

The onMessage() method is called by the TIBCO Enterprise Message Service

server when a message arrives on a destination. You implement the onMessage()
method in your MessageListener class to perform the desired actions when a
message arrives. Your implementation should handle all exceptions, and it should
not throw any exceptions.
Once you create a MessageListener object, you must register it with a specific
MessageConsumer. For example, using the myQueueReceiver object created in
MessageConsumer on page 27, the following creates a queueListener (an
implementation of the MessageListener interface) and registers it with the
QueueReceiver object:
MessageListener queueListener = new MessageListener();
myQueueReceiver.setMessageListener(queueListener);

You should register the MessageListener with the MessageConsumer before

calling the Connection’s start() method to begin receiving messages.
A MessageListener is not specific to the type of the destination. The same listener
can obtain messages from a queue or a topic depending upon whether the
MessageConsumer that registered the listener is a TopicSubscriber or a
QueueReceiver.
The J2EE 1.3 platform introduced message-driven beans (MDBs) that are a special
kind of MessageListener. See the J2EE documentation for more information about
MDBs.

TIBCO Enterprise Message Service User’s Guide

 | 29

Chapter 3 Working With Destinations

This chapter describes destinations (topics and queues).

Topics

• Destination Overview, page 30

• Destination Properties, page 32
• Wildcards, page 39
• Inheritance, page 41
• Destination Bridges, page 43
• Flow Control, page 46

TIBCO Enterprise Message Service User’s Guide

30
| Chapter 3 Working With Destinations

Destination Overview

Destinations for messages can be either Topics or Queues. A destination can be

created statically in the server configuration files, or dynamically by a client
application.
TIBCO Enterprise Message Service supports temporary queues and topics as
defined in JMS specification 1.1 and its API. For more information on temporary
queues and topics, refer to the JMS documentation described in Third Party
Documentation on page xvii.

Static Queues and Topics

Configuration information for static queues and topics is stored in configuration
files for the TIBCO Enterprise Message Service server. Changes to the
configuration information can be made in a variety of ways. To manage static
destinations, you can edit the configuration files using a text editor, you can use
the administration tool, or you can use the administration API.
Static queues and topics are administered by the server. Clients retrieve the
destination using JNDI. For example, the following code retrieves the
InitialContext using the JNDI properties specified by env, then looks up a Topic
named MyTopic.
Context ctx = new InitialContext(env);
Topic myTopic = (Topic) ctx.lookup("MyTopic");

See Using JNDI with TIBCO Enterprise Message Service on page 232 for more
information about using JNDI with TIBCO Enterprise Message Service.

Dynamic Queues and Topics

Dynamic queues and topics are created on-the-fly by applications using
QueueSession.createQueue() and TopicSession.createTopic(). Dynamic
queues and topics do not appear in the configuration files, and exist as long as
there are messages or consumers on the destination. A client cannot use JNDI to
lookup dynamic queues and topics.
When you use the show queues or show topics command in the administration
tool, you see both static and dynamic topics and queues. The dynamic topics and
queues have an asterisk (*) in front of their name in the list of topics or queues.

TIBCO Enterprise Message Service User’s Guide

 Destination Overview 31
|

Dynamic queues and topics inherit properties from their respective parents.
When shown by the administration tool, properties of a queue or topic may have
an asterisk (*) character in front of its name. This means that this property was
inherited from the parent queue or topic and cannot be changed. For more
information, refer to Inheritance of Properties on page 41 and Wildcards * and >
on page 39.

Destination Bridges
You can create server-based bridges between destinations. This allows all
messages delivered to one destination to also be delivered to the bridged
destination. You can bridge between different destination types, between the
same destination type, or to more than one destination. For example, you can
create a bridge between a topic and a queue or from a topic to another topic.
See Destination Bridges on page 43 for more information about destination
bridging.

TIBCO Enterprise Message Service User’s Guide

32
| Chapter 3 Working With Destinations

Destination Properties

This section contains a description of properties for topics and queues. Table 4
lists the properties that can be assigned to topics and queues. The following
sections describe each property.

Table 4 Destination properties (Sheet 1 of 2)

Property Described on Page Topic Queue

failsafe 33 Yes Yes

secure 33 Yes Yes

maxbytes 34 Yes Yes

global 34 Yes Yes

sender_name 34 Yes Yes

sender_name_enforced 35 Yes Yes

flowControl 35 Yes Yes

trace 36 Yes Yes

import 36 Yes Yes

export 36 Yes No

maxRedelivery 37 No Yes

exclusive 37 No Yes

prefetch 38 No Yes

expiration 38 Yes Yes

Deprecated Properties
The following properties are available for backward-compatibility with
previous versions. The functionality of these properties is replaced with the
import and export properties.

tibrv_import — Yes Yes

tibrvcm_import — Yes Yes

TIBCO Enterprise Message Service User’s Guide

 Destination Properties 33
|
Table 4 Destination properties (Sheet 2 of 2)

Property Described on Page Topic Queue

tibrv_export — Yes No

tibrvcm_export — Yes No

failsafe
TIBCO Enterprise Message Service provides two modes for persisting
topic/queue messages in external storage. These two modes are:
• normal
• failsafe
Normal mode writes all messages into the file on disk in asynchronous mode. In
this mode, the data may remain in system buffers for a short time before it is
written to disk.
Asynchronous mode storage includes a small probability that, in case of software
or hardware failure, some data may be lost without the possibility of recovery. In
many applications, when a rare loss of a few messages is acceptable, this mode
provides the best combination of performance and reliability.
For situations in which any loss of data is not acceptable, the administrator
should set the failsafe property for the topic or the queue. In failsafe mode, all
data for that queue or topic are written into external storage in synchronous
mode. In synchronous mode, a write operation is not complete until the data is
physically recorded on the external device.
The failsafe property ensures that no messages are ever lost in case of server
failure. Although failsafe mode guarantees no messages are lost, it also
significantly affects the performance.

secure
The secure property, when set on a destination, specifies permissions should be
checked for that destination. When a topic or a queue does not have the secure
property turned on, any authenticated user can perform any actions with that
topic or queue. When the property is turned on, the administrator can assign
permissions to the users.

The secure property does not mean SSL-level security. secure only controls basic
authentication and permission verification using unencrypted, non-secure
communication between the clients and the server.

TIBCO Enterprise Message Service User’s Guide

34
| Chapter 3 Working With Destinations

User permissions on secure destinations are only checked when the

authorization property is enabled in the main configuration file. Therefore,
both the authorization configuration parameter and the secure property on the
destination must be set for permissions to be enforced for a particular destination.
See Chapter 9, Authentication and Permissions, on page 179 for more information
on permissions and the secure property.

maxbytes
Topics and queues can specify the maxbytes property in the form:
maxbytes=NNNNN where NNNN is the number of bytes.

For queues, maxbytes defines the maximum size (in bytes) of all messages that
can be waiting in the queue. By default, or if maxbytes is set to 0, there is no limit
to the size of a queue. If a receiver is off-line for a long time, maxbytes limits the
memory allocation for the receiver’s pending messages. Messages that would
exceed the limit will not be accepted into storage and an error is returned to the
message producer.
For topics, maxbytes limits the total size (in bytes) of all messages waiting for
delivery to each durable subscriber on that topic. The limit applies separately to
each durable subscriber on the topic. For example, when a durable subscriber is
off-line for a long time, pending messages accumulate in the server; maxbytes
limits the memory allocation for those pending messages for the subscriber; when
the subscriber consumes messages (freeing storage) the topic can deliver
additional messages.

global
Messages destined for a topic or queue with the global property set are routed to
the other servers that are participating in routing with this server. For further
information on routing between servers, see Chapter 14, Working With Routes, on
page 277.

sender_name
The sender_name property specifies that the server may include the sender’s
username for messages sent to this destination. When this property is enabled, the
server takes the user name supplied by the message producer when the
connection is established and places that user name into the JMS_TIBCO_SENDER
property in the message.
The message producer can override this behavior by specifying a property on a
message. If a message producer sets the JMS_TIBCO_DISABLE_SENDER property to
true for a message, the server overrides the sender_name property and does not
add the sender name to the message.

TIBCO Enterprise Message Service User’s Guide

 Destination Properties 35
|

If authentication for the server is turned off, the server places whatever user name
the message producer supplied when the message producer created a connection
to the server. If authentication for the server is enabled, the server authenticates
the user name supplied by the connection and the user name placed in the
message property will be an authenticated user. If SSL is used, the SSL connection
protocol guarantees the client is authenticated using the client’s digital certificate.

sender_name_enforced
The sender_name_enforced property specifies that messages sent to this
destination must include the sender’s user name. The server retrieves the user
name of the message producer using the same procedure described in the
sender_name property above. However, unlike, the sender_name property, there
is no way for message producers to override this property.
If the sender_name property is also set on the destination, this property overrides
the sender_name property.

In some business situations, clients may not be willing to disclose the username of
their message producers. If this is the case, these clients may wish to avoid
sending messages to destinations that have the sender_name or
sender_name_enforced properties enabled.

In these situations, the operator of the EMS server should develop a policy for
disclosing a list of destinations that have these properties enabled. This will allow
clients to avoid sending messages to destinations that would cause their message
producer usernames to be exposed.

flowControl
The flowControl property specifies the target maximum size the server can use
to store pending messages for the destination. This is useful when message
producers send messages much more quickly than message consumers can
consume them. Using this property can prevent the pending messages from
consuming too many machine resources.
The value specified for this property is in bytes, unless you specify the units for
the amount of storage using KB, MB, or GB. For example, flowControl=60MB
specifies the target maximum storage for pending messages of the destination is
60 Megabytes. You can specify the flowControl property without a value to set it
to the default of 256KB.
Flow control must be enabled for the server before the value in this property is
enforced by the server. See Flow Control on page 46 for more information about
flow control.

TIBCO Enterprise Message Service User’s Guide

36
| Chapter 3 Working With Destinations

trace
Specifies that tracing should be enabled for this destination. This property can be
specified as either trace or trace=body. Specifying trace (without =body),
generates trace messages that include only the message sequence and message ID.
Specifying trace=body generates trace messages that include the message body.
See Message Tracing on page 213 for more information about message tracing.

import
The import property allows messages published by an external system to be
received by a TIBCO Enterprise Message Service destination (a topic or a queue),
as long as the transport to the external system is configured. Currently you can
configure transports for TIBCO Rendezvous reliable and certified messaging
protocols. You can specify the name of one or more transports of the same type in
the import property.
You must purchase, install, and configure the external system (for example,
Rendezvous) before configuring topics with the import property. Also, you must
configure the communication parameters to the external system by creating a
named transport in the transports.conf file.
For complete details about external message services, see these chapters:
• Chapter 5, Working With TIBCO Rendezvous, on page 67
• Chapter 6, Working With TIBCO SmartSockets, on page 87

export
The export property allows messages published by a client to a topic to be
exported to the external systems with configured transports. Currently you can
configure transports for Rendezvous reliable and certified messaging protocols.
You can specify the name of one or more transports of the same type in the export
property.
You must purchase, install, and configure the external system (for example,
Rendezvous) before configuring topics with the export property. Also, you must
configure the communication parameters to the external system by creating a
named transport in the transports.conf file.
For complete details about external message services, see these chapters:
• Chapter 5, Working With TIBCO Rendezvous, on page 67
• Chapter 6, Working With TIBCO SmartSockets, on page 87

TIBCO Enterprise Message Service User’s Guide

 Destination Properties 37
|

maxRedelivery
The maxRedelivery property specifies the number of attempts the server should
make to redeliver a message sent to a queue. The value of this parameter can be
set to an integer between 2 and 255. Once the server has attempted to deliver the
message the specified number of times, the message is either destroyed or it is
placed on the undelivered queue, if the JMS_TIBCO_PRESERVE_UNDELIVERED
property on the message is set to true.
For messages that have been redelivered, the JMSRedelivered header property is
set to true and the JMSXDeliveryCount property is set to the number of times the
message has been delivered to the queue. If the server restarts, the current
number of delivery attempts in the JMSXDeliveryCount property is not retained.
For more information about undelivered messages, see Undelivered Message
Queue on page 61.

exclusive
The exclusive property is set on queues only. It defines how the server delivers
messages to queue consumers when multiple queue consumers are present. In
exclusive mode, the first queue consumer receives all of the messages until the
consumer fails. At that point, messages are delivered to the next consumer.
The first queue consumer is the first-activated queue receiver. When that receiver
fails in any way, the messages are delivered to the receiver which was activated
next. Note that these activations may be in the past; that is, the first-activated and
the second-activated are determined at the onset of receiver activation, not at the
onset of first-receiver failure.
Non-exclusive queues cause messages to be delivered in a round-robin fashion to
the set of queue receivers. This prevents a large buildup of messages at one
receiver and thereby balances the load of incoming messages across all queue
receivers.
If a message cannot be delivered to a queue receiver (because its pre-fetch limit is
reached), TIBCO Enterprise Message Service attempts to deliver the message to
the next queue receiver. If the server attempts to deliver the message to all
registered queue receivers and none of them can accept the new message, the
message is returned to the queue and message delivery is paused until a queue
receiver reports that it can accept the message.

TIBCO Enterprise Message Service User’s Guide

38
| Chapter 3 Working With Destinations

prefetch
Prefetch applies only to queues. Prefetch sets the maximum number of messages
a receiver can receive in the background from the server at any point in time. A
message is considered prefetched when it leaves the server. It is no longer
considered prefetched when it is delivered to the application by way of the
receive method or by callback.
For example, if the prefetch is set to 7, the server ensures that at most 7 messages
are prefetched into the client. The prefetch value is the maximum number of
messages, not a strict amount. Therefore, as the application receives the messages,
the server sends more messages to the client but not necessarily one message for
each message received. That is, the server can batch the delivery of messages.
With multiple receivers, the prefetch value is the maximum and should not be
used to force a particular delivery pattern. There are too many variable conditions
to accurately predict a delivery pattern.
Assigning a larger prefetch number can improve performance by decreasing
return message traffic.
You can set the prefetch property to none to disable prefetching messages. When a
queue has prefetch=none specified, the server sends only one message at a time
to a receiver. That is, a message is only sent by the server when a receiver calls the
receive methods or when the receiver returns from the callback processing the
current message. Queues with prefetch=none receive messages more slowly
than queues where prefetch is set to a positive integer.

Setting prefetch=0 or not specifying any prefetch property specifies that the
queue should inherit the prefetch value of its parent. If there are no parents or the
parents do not have prefetch set, prefetch is set to the default value of 5.
Setting prefetch=none is not the same as setting prefetch=0.

expiration
The expiration property overrides the expiration property of messages. It
applies to queues and topics.
When this property is set for a destination, and the server delivers a message to it,
the server replaces the producer’s expiration value with this value.
Specify this value as an integer with units. Legal units are msec, sec, min, hour
and day. For example, expiration=10min. When units are absent, the default
unit is seconds.
Zero is a special value, which indicates that messages to the destination never
expire.

TIBCO Enterprise Message Service User’s Guide

 Wildcards 39
|

Wildcards

Static queues and topics are assigned certain properties in the configuration file.
These static queues and topics become the parents of dynamic queues and topics,
which inherit properties from the parents. You must understand wildcards to
understand the inheritance rules.

Wildcards * and >

To understand the rules for inheritance of properties, it is important to
understand the use of the two wildcards, * and >.
• The wildcard * means that any token can be in the place of *
For example: foo.* matches all two-part destination names beginning with
foo. including foo.bar and foo.boo, but not foo.bar.boo.

However, foo.*.bar matches all three-part destination names with a token

in the wildcard position. In this case, foo.boo.bar is matched, but foo.bar
is not.
• The wildcard > matches one or more trailing elements.
For example, foo.> matches foo.bar and foo.bar.boo

Wildcards in Topics
TIBCO Enterprise Message Service enables you to use wildcards in topic names in
some situations:
• You can subscribe to wildcard topics.
If you subscribe to a topic containing a wildcard, you will receive any message
published to a matching topic. For example, if you subscribe to foo.* you will
receive messages published to a topic named foo.bar.
You can subscribe to a wildcard topic (for example foo.*), whether or not
there is a matching topic in the configuration file (for example, foo.*, foo.>,
or foo.bar). However, if there is no matching topic name in the configuration
file, no messages will be published on that topic, so it is not useful to subscribe
to the wildcard topic in that case.
• You cannot publish to wildcard topics.
• If foo.bar is not in the configuration file, then you can publish to foo.bar if
foo.* or foo.> exists in the configuration file.

TIBCO Enterprise Message Service User’s Guide

40
| Chapter 3 Working With Destinations

Wildcards in Queues
TIBCO Enterprise Message Service enables you to use wildcards in queue names
in some situations. You can not send or receive to wildcard queue names.
However, you can use wildcard queue names in the configuration files. The
wildcard queue names in the configuration files must have non-wildcard children
to send and receive messages.
For example, if the queue configuration file includes a line:
foo.*

then users can create queues foo.bar, foo.bob, and so forth, but not
foo.bar.bob.

TIBCO Enterprise Message Service User’s Guide

 Inheritance 41
|

Inheritance

This section describes the inheritance of properties and permissions. For more
information on wildcards, refer to Wildcards on page 39. For more information on
properties, refer to Destination Properties on page 32. For more information on
permissions, refer to Chapter 9, Authentication and Permissions, on page 179.

Inheritance of Properties
All properties are inheritable for both topics and queues. This means that a
property set for a destination is inherited by all destinations with matching
names. For example, if topic foo.* is failsafe, then topics foo.bar and
foo.bob inherit failsafe from foo.*.

Currently there is no way to make topic foo.* failsafe without making

foo.bar failsafe. In other words, the system does not offer the ability to remove
inherited properties.
Property inheritance is powerful, but complex to understand and administer. You
must plan before assigning properties to topics and queues. Using wildcards to
assign properties is a powerful tool, but must be used carefully.
For example, if you enter the following line in the topics configuration file:
> failsafe

you make every topic failsafe, regardless of additional entries. This might
require a great deal of memory for storage and greatly decrease the system
performance.

There is one property that is an exception to the rules of inheritance. The

maxbytes property has the following rules of inheritance:

• If there is not a direct property value for the child, the most liberal (largest) of
the parent or ancestor property values is used.
• The child value, which is directly assigned to the child, overrides any values
assigned to ancestors.

Inheritance of Permissions
Inheritance of permissions is similar to inheritance of properties. If the parent has
a permission, then the child inherits that permission. For example, if Bob belongs
to GroupA, and GroupA has publish permission on a topic, then Bob has
publish permission on that topic.

TIBCO Enterprise Message Service User’s Guide

42
| Chapter 3 Working With Destinations

Permissions for a single user are the union of the permissions set for that user, and
of all permissions set for every group in which the user is a member. These
permission sets are additive. Permissions have positive boolean inheritance. Once
a permission right has been granted through inheritance, it can not be removed.
All rules for wildcards apply to inheritance of permissions. For example, if a user
has permission to publish on topic foo.*, the user also has permission to publish
on foo.bar and foo.new. For more information on wildcards, refer to Wildcards
on page 39. For more information on permissions, refer to Chapter 9,
Authentication and Permissions, on page 179.

TIBCO Enterprise Message Service User’s Guide

 Destination Bridges 43
|

Destination Bridges

Some applications require the same message to be sent to more than one
destination, possibly of different types. For example, an application may send
messages to a queue for distributed load balancing. That same application,
however, may also need the messages to be published to several monitoring
applications. Another example is an application that publishes messages to
several topics. All messages however, must also be sent to a database for backup
and for data mining. A queue is used to collect all messages and send them to the
database.
An application can process messages so that they are sent multiple times to the
required destinations. However, such processing requires significant coding effort
in the application. TIBCO Enterprise Message Service provides a server-based
solution to this problem. You can create bridges between destinations so that
messages sent to one destination are also delivered to all bridged destinations.
Bridges are created between one destination and one or more other destinations
of the same or of different types. That is, you can create a bridge from a topic to a
queue or from a queue to a topic. You can also create a bridge between one
destination and multiple destinations. For example, you can create a bridge from
topic a.b to queue q.b and topic a.c.
When specifying a bridge, you can specify a particular destination name, or you
can use wildcards. For example, if you specify a bridge on topic foo.* to queue
foo.queue, messages delivered to any topic matching foo.* are sent to
foo.queue.

Figure 6 and Figure 7 illustrate example bridging scenarios.

Figure 6 Bridging a topic to a queue

TIBCO EMS Server

Subscriber
Topic
Publisher
A.B
Subscriber

Queue
Consumer
queue.B

TIBCO Enterprise Message Service User’s Guide

44
| Chapter 3 Working With Destinations

Figure 7 Bridging a topic to multiple destinations

TIBCO EMS Server

Subscriber
Topic
Publisher
A.B
Subscriber

Queue Topic
Subscriber
queue.B C.B

Consumer

Bridges are not transitive. That is, messages sent to a destination with a bridge are
only delivered to the specified bridged destinations and are not delivered across
multiple bridges. For example, topic A.B has a bridge to queue Q.B. Queue Q.B
has a bridge to topic B.C. Messages delivered to A.B are also delivered to Q.B, but
not to B.C.

Creating a Bridge
Bridges are configured in the bridges.conf configuration file. You specify a
bridge using the following syntax:
[<destinationType>:<destinationName>]
<destinationType>=<destinationToBridgeTo> selector="<messageSelector>"

where <destinationType> is the type of the destination (either topic or queue),

<destinationName> is the name of the destination from which you wish to create a
bridge, <destinationToBridgeTo> is the name of the destination you wish to create a
bridge to, and selector="<messsgeSelector>" is an optional message selector to
specify the subset of messages the destination should receive.
Each <destinationName> can specify wildcards, and therefore any destination
matching the pattern will have the specified bridge. Each <destinationName> can
specify more than one <destinationToBridgeTo>.
For example, the bridge illustrated in Figure 6 and Figure 7 would be specified as
the following in bridges.conf:
[topic:A.B]
queue=queue.B
topic=C.B

Specifying a message selector on a bridged destination is described in the

following section.

TIBCO Enterprise Message Service User’s Guide

 Destination Bridges 45
|

Selecting the Messages to Bridge

By default, all messages sent to a destination with a bridge are sent to all bridged
destinations. This can cause unnecessary network traffic if each bridged
destination is only interested in a subset of the messages sent to the original
destination. You can optionally specify a message selector for each bridge to
determine which messages are sent over that bridge.
Message selectors for bridged destinations are specified as the selector property
on the bridge. The following is an example of specifying a selector on the bridges
defined in the previous section:
[topic:A.B]
queue=queue.B
topic=C.B selector="urgency in(’medium’, ’high’)"

For detailed information about message selector syntax, see documentation for
the Message class in TIBCO Enterprise Message Service Java API Reference.

Access Control and Bridges

Message producers must have access to a destination in order to send messages to
that destination. Messages can only be sent to bridged destinations to which the
message producer has access.
For example, in Figure 7, the publisher has access to publish messages to topic
A.B and send messages to Queue queue.B. The publisher does not have access to
publish messages to Topic C.B. Therefore, messages sent by the publisher are only
received by subscribers of Topic A.B and consumers of queue.B. Subscribers of
Topic C.B will not receive any messages from the publisher.
Access control is dynamic. Therefore, messages sent after a change in access
control are subject to the newly set permissions.

Transactions
When a message producer sends a message within a transaction, all messages
sent across a bridge are part of the transaction. Therefore, if the transaction
succeeds, all messages are delivered to all bridged destinations. If the transaction
fails, no consumers for bridged destinations receive the messages.
If a message cannot be delivered to a bridged destination because the message
consumer does not have the correct permissions for the bridged destination, the
transaction cannot complete, and therefore fails and is rolled back.

TIBCO Enterprise Message Service User’s Guide

46
| Chapter 3 Working With Destinations

Flow Control

In some situations, message producers may send messages more rapidly than
message consumers can receive them. The pending messages for a destination are
stored by the server until they can be delivered, and the server can potentially
exhaust its storage capacity if the message consumers do not receive messages
quickly enough. To avoid this, TIBCO Enterprise Message Service allows you to
control the flow of messages to a destination. Each destination can specify a target
maximum size for storing pending messages. When the target is reached, TIBCO
Enterprise Message Service blocks message producers when new messages are
sent. This effectively slows down message producers until the message
consumers can receive the pending messages.

Enabling Flow Control

The flow_control parameter in tibemsd.conf enables and disables flow control
globally for the TIBCO Enterprise Message Service server. When flow_control is
disabled (the default setting), the server does not enforce any flow control on
destinations. When flow_control is enabled, the server enforces any flow
control settings specified for each destination. See Chapter 7, Using the
Configuration Files, on page 105 for more information about working with
configuration parameters.
When you wish to control the flow of messages on a destination, set the
flowControl property on that destination. The flowControl property specifies
the target maximum size of stored pending messages for the destination. The size
specified is in bytes, unless you specify the units for the size. You can specify KB,
MB, or GB for the units. For example, flowControl = 60MB specifies the target
maximum storage for pending messages for a destination is 60 Megabytes.

Enforcing Flow Control

The value specified for the flowControl property on a destination is a target
maximum for pending message storage. When flow control is enabled, the server
may use slightly more or less storage before enforcing flow control, depending
upon message size, number of message producers, and other factors. Setting the
flowControl property on a destination but specifying no value causes the server
to use a default value of 256KB.

TIBCO Enterprise Message Service User’s Guide

 Flow Control 47
|

When the storage for pending messages is near the specified limit, the server
blocks all new calls to send a message from message producers. The calls do not
return until the storage has decreased below the specified limit. Once message
consumers have received messages and the pending message storage goes below
the specified limit, the server allows the send message calls to return to the caller
and the message producers can continue processing.
If there are no message consumers for a destination, the server does not enforce
flow control for the destination. That is, if a queue has no started receivers, the
server cannot enforce flow control for that queue. Also, if a topic has inactive
durable subscriptions or no current subscribers, the server cannot enforce flow
control for that topic. For topics, if flow control is set on a specific topic (for
example, foo.bar), then flow control is enforced as long as there are subscribers
to that topic or any parent topic (for example, if there are subscribers to foo.*).

Routes and Flow Control

For global topics where messages are routed between servers, flow control can be
specified for a topic on either the server where messages are produced or the
server where messages are received. Flow control is not relevant for queue
messages that are routed to another server.
If the flowControl property is set on the topic on the server receiving the
messages, when the pending message size limit is reached, messages are not
forwarded by way of the route until the topic subscriber receives enough
messages to lower the pending message size below the specified limit.
If the flowControl property is set on the topic on the server sending the
messages, the server may block any topic publishers when sending new messages
if messages cannot be sent quickly enough by way of the route. This could be due
to network latency between the routed servers or it could be because flow control
on the other server is preventing new messages from being sent.

Destination Bridges and Flow Control

Flow control can be specified on destinations that are bridged to other
destinations. If you wish the flow of messages send by way of the bridge to slow
down when receivers on the bridged-to destination cannot process the messages
quickly enough, you must set the flowControl property on both destinations on
either side of the bridge.

TIBCO Enterprise Message Service User’s Guide

48
| Chapter 3 Working With Destinations

TIBCO Enterprise Message Service User’s Guide

 | 49

Chapter 4 Working With Messages

This chapter describes JMS messages and how to work with them in a client
program.

Topics

• JMS Message Structure, page 50

• Message Persistence, page 53
• Character Encoding in Messages, page 54
• Message Compression, page 59
• Message Confirmation, page 60
• Undelivered Message Queue, page 61
• MapMessage Extensions, page 63
• EMS Message Delivery Mode Extensions, page 64

TIBCO Enterprise Message Service User’s Guide

50
| Chapter 4 Working With Messages

JMS Message Structure

A JMS message has the same structure, regardless of whether it is addressed to a

topic or a queue. A JMS message has three sections:
• Header (some header fields are required)
• Properties (optional)
• Body (optional)

Header Fields
The header contains ten predefined fields that contain values used to route and
deliver messages. Table 5 describes the message header fields.

Table 5 JMS Message Headers (Sheet 1 of 2)

Header Field Set by Comments

JMSDestination sendor publish Destination to which message is sent
method

JMSDeliveryMode sendor publish Persistent or non-persistent message

method

JMSExpiration sendor publish Length of time that message will live before
method expiration. If set to 0, message does not expire.
The time-to-live is specified in milliseconds.

JMSPriority sendor publish Uses a numerical ranking, between 0 and 9, to

method define message priority as normal or expedited.
Larger numbers represent higher priority.

JMSMessageID sendor publish Value uniquely identifies each message sent by a

method provider.

JMSTimestamp sendor publish Timestamp of time when message was handed off
method to a provider to be sent. Message may actually be
sent later than this timestamp.

JMSCorrelationID message client This ID can be used to link messages, such as

linking a response message to a request message.
Entering a value in this field is optional.

TIBCO Enterprise Message Service User’s Guide

 JMS Message Structure 51
|
Table 5 JMS Message Headers (Sheet 2 of 2)

Header Field Set by Comments

JMSReplyTo message client A destination to which a message reply should be
sent. Entering a value for this field is optional.

JMSType message client message type identifier

JMSRedelivered JMS provider If this field is set, it is possible that the message
was delivered to the client earlier, but not
acknowledged at that time.

Properties
In the properties area, applications, vendors, and administrators on JMS systems
can add optional properties. The properties area is optional, and can be left empty.
TIBCO Enterprise Message Service includes several vendor-specific properties in
this area. TIBCO-specific property names begin with JMS_TIBCO. These properties
are described in subsequent sections in this chapter.

Message Bodies
A JMS message has one of several types of message bodies, or no message body at
all.
The types of messages are described in Table 6.

Table 6 JMS Message Types (Sheet 1 of 2)

Message Type Contents of Message Body

Message This message type has no body. This is useful for simple
event notification.

TextMessage A java.lang.String. For example, this can be the

contents of an XML file.

MapMessage A set of name/value pairs. The names are

java.lang.String objects, and the values are Java
primitive value types or their wrappers. The entries can be
accessed sequentially by enumeration or directly by name.
The order of entries is undefined.

TIBCO Enterprise Message Service User’s Guide

52
| Chapter 4 Working With Messages

Table 6 JMS Message Types (Sheet 2 of 2)

Message Type Contents of Message Body

BytesMessage A stream of uninterrupted bytes. The bytes are not typed;
that is, they are not assigned to a primitive data type.

StreamMessage A stream of primitive values in the Java programming

language. Each set of values belongs to a primitive data
type, and must be read sequentially.

ObjectMessage A serializable object constructed in the Java programming

language.

TIBCO Enterprise Message Service User’s Guide

 Message Persistence 53
|

Message Persistence

JMS defines two message delivery modes, persistent and non-persistent. This
mode is set by the message sender or publisher in the JMSDeliveryMode message
header field. Non-Persistent messages are never written to persistent storage.
Persistent messages are logged to persistent storage when they are sent.
Messages with the persistent delivery mode are always written to persistent
storage, except when they are published to a topic that has no durable
subscribers. When a topic has no durable subscribers, there are no subscribers
that need messages resent in the event of a server failure. Therefore, messages do
not need to be saved, and performance is improved because disk I/O is not
required.
This behavior is consistent with the JMS specification because durable subscribers
for a topic cause published messages to be saved. However, non-durable
subscribers that re-connect after a server failure are considered newly created
subscribers and are not entitled to receive any messages created prior to the time
they are created (that is, messages published before the subscriber re-connects are
not resent).

TIBCO Enterprise Message Service User’s Guide

54
| Chapter 4 Working With Messages

Character Encoding in Messages

Character encodings are named sets of numeric values for representing

characters. For example, ISO 8859-1, also known as Latin-1, is the character
encoding containing the letters and symbols used by most Western European
languages. If your applications are sending and receiving messages that use only
English language characters (that is, the ASCII character set), you do not need
alter your programs to handle different character encodings. The TIBCO
Enterprise Message Service server and application APIs automatically handle
ASCII characters in messages.
Character sets become important when your application is handling messages
that use non-ASCII characters (such as Japanese or Western European languages).
Also, clients encode messages by default as UTF-8. Some character encodings use
only one byte to represent each character, but UTF-8 can potentially use two bytes
to represent the same character. For example, the Latin-1 is a single-byte character
encoding. If all strings in your messages contain only characters that appear in the
Latin-1 encoding, you can potentially improve performance by specifying Latin-1
as the encoding for strings in the message.
TIBCO Enterprise Message Service clients can specify a variety of common
character encodings for strings in messages. The character encoding for a message
applies to strings that appear in any of the following places within a message:
• property names and property values
• MapMessage field names and values
• data within the message body
The Java and C programmatic interfaces for clients have mechanisms for handling
strings and specifying the character encoding used for all strings within a
message. The following sections describe the implications of string character
encoding for TIBCO Enterprise Message Service Java and C clients.

The TIBCO Enterprise Message Service C# API has not implemented the
mechanisms for specifying character encodings for this release. A future release
will contain this functionality in the C# API.

Supported Character Encodings

Each message contains the name of the character encoding used to encode strings
within the message. This character encoding name is one of the canonical names
for character encodings contained in the Java specification. You can obtain a list of
canonical character encoding names from the following location:
http://java.sun.com/j2se/1.4/docs/guide/intl/encoding.doc.html

TIBCO Enterprise Message Service User’s Guide

 Character Encoding in Messages 55
|

Java clients use these canonical character encoding names when setting or
retrieving the character encoding names. C clients have a list of macros that
correspond to these canonical names. See the C API references for a list of
supported character encodings in these interfaces.

Sending Messages
When a client sends a message, the message stores the character encoding name
used for strings in that message. Java clients represent strings using Unicode. A
message created by a Java client that does not specify an encoding will use UTF-8
as the named encoding within the message. UTF-8 uses up to four bytes to
represent each character, so a Java client can improve performance by explicitly
using a single-byte character encoding, if possible.
Java clients can globally set the encoding to use with the setEncoding method or
the client can set the encoding for each message with the setMessageEncoding
method. For more information about these methods, see the TIBCO Enterprise
Message Service Java API Reference.
Typically, C clients manipulate strings using the character encoding of the
machine on which they are running. TIBCO Enterprise Message Service provides
a character encoding library for C clients to determine the encoding in messages
and convert strings to and from Unicode. C clients should explicitly set the
character encoding they are using when they create and send a message. For more
information, see TIBCO Enterprise Message Service C API Reference.
Figure 8 illustrates TIBCO Enterprise Message Service clients sending messages
encoded in UTF-8. Java clients use this encoding by default. C clients must
explicitly set this encoding and convert strings from the local encoding to UTF-8
before sending the message.

TIBCO Enterprise Message Service User’s Guide

56
| Chapter 4 Working With Messages

Figure 8 Clients sending UTF-8 encoded messages

Java EMS Client
...
javax.jms.MapMessage msg =
session.createMapMessage();
...
java.lang.String myName = "François"; Java clients automatically
java.lang.String myAddr = "555 rue de encode strings as UTF-8.
L'Arbalète";
...
msg.setString("name",myName);
msg.setString("address",myAddr);
Message
...
Encoding: UTF-8
C EMS Client name XXXXXXX
address XXXXXXX
...
...
tibiconv_LocalToUTF8("François",
UTF8name, 8);
tibiconv_LocalToUTF8("555 rue de
L'Arbalète", UTF8addr, 21); To create a message with UTF-8
... encoding, the C client must use the
tibemsMsg_SetEncoding(message, tibconv library if the local machine does
"TIBICONV_UTF8"); not use UTF-8 as the local encoding. The
... C client must also specify the string
tibemsMapMsg_SetString(message, encoding used in the message with the
"name", UTF8name); tibemsMsg_SetEncoding function.
tibemsMapMsg_SetString(message,
"address", UTF8addr);

...

Figure 9 illustrates clients explicitly setting the encoding of strings within a

message to ISO-8859-1 (Latin-1). The client must set this encoding explicitly for
the message, but there is no need to convert the strings — this happens
automatically. The C client’s local encoding is Latin-1, so there is no need to
convert the strings. However, the C client must specify the encoding of the
message before sending.

TIBCO Enterprise Message Service User’s Guide

 Character Encoding in Messages 57
|

Figure 9 Clients sending messages with a specific encoding

Java EMS Client
...
javax.jms.MapMessage msg =
session.createMapMessage();
setMessageEncoding(msg ,"ISO-8859-1 ")
...
java.lang.String myName = "François";
Java clients can set the character
java.lang.String myAddr = "555 rue de
encoding globally or for each
L'Arbalète";
message.
...
msg.setString("name",myName);
msg.setString("address",myAddr);
... Message
Encoding: ISO-8859-1
C EMS Client name XXXXXXX
address XXXXXXX
...
...
name = "François";
addr = "555 rue de L'Arbalète";
...
tibemsMsg_SetEncoding(message,
"TIBICONV_LATIN_1"); If the C client wishes to send the message
... with locally-encoded strings, the client
tibemsMapMsg_SetString(message, should set the encoding of the message to
"name", name); the name of the local encoding. This allows
tibemsMapMsg_SetString(message, any client receiving the message to
"address", addr); properly read the encoded strings in the
message.
...

Receiving Messages
Each message stores the name of the character encoding the sender used. A
message receiver can use this information to decode the strings in the message, if
necessary.
Java automatically performs any necessary conversion and represents strings in
Unicode. Java clients do not need to explicitly perform any operations to display
strings stored in a message.
C clients must compare the encoding used for the message with the encoding of
the local machine. If the encodings match, the C client can display the string
without conversion. If the encodings do not match, the C client must use the
tibconv library functions to convert the string to the local encoding before the
string can be displayed.

TIBCO Enterprise Message Service User’s Guide

58
| Chapter 4 Working With Messages

Figure 10 illustrates TIBCO Enterprise Message Service clients receiving

messages. The Java client can receive the message and display the strings without
any additional conversion. The C client must determine the encoding in the
message, compare it to the encoding used on the local machine, and then perform
conversion, if the encodings do not match.

Figure 10 Clients receiving messages

Regardless of the message encoding,

strings in Java clients are always
represented in Unicode. A Java client Java EMS Client
does not need to manually convert ...
strings to a local encoding when javax.jms.Message message =
receiving messages. subscriber.receive();
...
Message java.lang.String myName =
msg.getString("name");
Encoding: ISO-8859-1 java.lang.String myAddr =
name XXXXXXX msg.getString("address");
address XXXXXXX ...
... System.println(myName + "," + myAddr);
...

Message
Encoding: UTF-8 C EMS Client
name XXXXXXX
address XXXXXXX ...
... tibconv_GetDefaultEncoding(
defEncoding);
tibjmsMsg_GetEncoding(message,
msgEncoding);
C clients must compare the encoding of
...
the message to the local machine's default
tibjmsMapMsg_GetString(message,
encoding. If the message's encoding is the
"name", name);
same as the local encoding, the client can
tibjmsMapMsg_GetString(message,
retrieve strings from the message and
"address", addr);
display them. If the encodings are different,
...
the client must convert the message
strings into the local encoding using
functions in tibconv before displaynig the
strings.

TIBCO Enterprise Message Service User’s Guide

 Message Compression 59
|

Message Compression

TIBCO Enterprise Message Service allows the message body to be compressed by

the client before the message is sent to the TIBCO Enterprise Message Service
server.

About Message Compression

Message compression is especially useful when messages will be stored on the
server (persistent queue messages, or topics with durable subscribers). Setting
compression ensures that messages will take less memory space in storage.
When messages are compressed and then stored, they are handled by the server
in the compressed form. Compression assures that the messages will usually
consume less space on disk and will be handled faster by the EMS server.
The compression option only compresses the body of a message. Headers and
properties are never compressed. It is best to use compression when the message
bodies will be large and the messages will be stored on a server.
When messages will not be stored, compression is not as useful. Compression
normally takes time, and therefore the time to send or publish and receive
compressed messages is generally longer than the time to send the same messages
uncompressed. There is little purpose to message compression for small messages
that are not be stored by the server.

Setting Message Compression

Message compression is specified for individual messages. That is, message
compression, if desired, is set at the message level. TIBCO Enterprise Message
Service does not define a way to set message compression at the per-topic or
per-queue level.
To set message compression, the application that sends or publishes the message
must access the message properties and set the boolean property
JMS_TIBCO_COMPRESS to true before sending or publishing the message. For
example:
message.setBooleanProperty("JMS_TIBCO_COMPRESS",true);

Compressed messages are handled transparently. The client code only sets the
JMS_TIBCO_COMPRESS property. The client code does not need to take any other
action.

TIBCO Enterprise Message Service User’s Guide

60
| Chapter 4 Working With Messages

Message Confirmation

The interface specification for JMS requires that message delivery be guaranteed
under many, but not all, circumstances. The specification defines three levels of
acknowledgement:
• DUPS_OK_ACKNOWLEDGE, for consumers that are tolerant of duplicate
messages.
• AUTO_ACKNOWLEDGE, in which the session automatically acknowledges
a client’s receipt of a message.
• CLIENT_ACKNOWLEDGE, in which the client acknowledges the message
by calling the message’s acknowledge method.
Figure 11 illustrates the basic structure of message delivery and
acknowledgement.

Figure 11 Message Delivery and Acknowledgement

3
1 Message
Message
4
Message TIBCO EMS Acknowledgement Message
Producer 2 Server Consumer
Confirmation 5 Confirmation of
acknowledgement

The following describes the steps in message delivery and acknowledgement:

1. A message is sent from the message producer to the machine on which the
TIBCO Enterprise Message Service server resides.
2. The EMS server acknowledges that the message was received.
3. The server sends the message to the consumer.
4. The consumer sends acknowledgement to the server that the message was
received.
5. In many cases, the server then confirms acknowledgement to the consumer.
Acknowledgement from the consumer to the server prevents the delivery of
duplicate messages.

TIBCO Enterprise Message Service User’s Guide

 Undelivered Message Queue 61
|

Undelivered Message Queue

If a message is to be removed from the system in any way besides being properly
consumed by a message consumer, the server checks the message for the
JMS_TIBCO_PRESERVE_UNDELIVERED property.

When JMS_TIBCO_PRESERVE_UNDELIVERED is set to true, the server moves the

message to the undelivered message queue, $sys.undelivered.
This undelivered message queue is a system queue that is always present and can
not be deleted.
To set use of the undelivered message queue, the application that sends or
publishes the message must set the boolean JMS_TIBCO_PRESERVE_UNDELIVERED
property to true before sending or publishing the message. For example:
message.setBooleanProperty("JMS_TIBCO_PRESERVE_UNDELIVERED",true);

You can only set the undelivered property on individual messages, there is no
way to set the undelivered message queue as an option at the per-topic or
per-queue level.
You should create a queue receiver to receive and handle messages as they arrive
on the undelivered message queue. If you wish to remove messages from the
undelivered message queue without receiving them, you can purge the
$sys.undelivered queue with the administration tool, using the purge queue
command described under Command Listing on page 151. You can also remove
the message using the administrative API included with TIBCO Enterprise
Message Service.

TIBCO Enterprise Message Service User’s Guide

62
| Chapter 4 Working With Messages

Including the Message Sender

Within a message, TIBCO Enterprise Message Service can supply the user name
given by the message producer when a connection is created. The sender_name
and sender_name_enforced properties on the destination determine whether the
message producer’s user name is included in the sent message.
When a user name is included in a message, a message consumer can retrieve that
user name by getting the string message property named JMS_TIBCO_SENDER.
The following illustrates retrieving the property:
userID = message.getStringProperty("JMS_TIBCO_SENDER");

When the sender_name property is enabled and the sender_name_enforced

property is not enabled on a destination, message producers can specify that the
user name is to be left out of the message. Message producers can specify the
JMS_TIBCO_DISABLE_SENDER boolean property for a particular message, and the
message producer’s user name will not be included in the message. However, if
the sender_name_enforced property is enabled, the
JMS_TIBCO_DISABLE_SENDER property is ignored and the user name is always
included in the message.
The following illustrates setting the JMS_TIBCO_DISABLE_SENDER property:
message.setBooleanProperty("JMS_TIBCO_DISABLE_SENDER",true);

TIBCO Enterprise Message Service User’s Guide

 MapMessage Extensions 63
|

MapMessage Extensions

TIBCO Enterprise Message Service extends the MapMessage body type in two
ways. These extensions allow TIBCO Enterprise Message Service to exchange
messages with TIBCO Rendezvous and ActiveEnterprise formats that have
certain features not available within the JMS MapMessage. TIBCO Enterprise
Message Service adds two extensions to the MapMessage body type:
• You can insert another MapMessage instance as a submessage into a
MapMessage, generating a series of nested messages, instead of a flat
message.
• You can use arrays as well as primitive types for the values.
These extensions add considerable flexibility to the MapMessage body type.
However, they are extensions and therefore not compliant with JMS
specifications. Extended MapMessages are tagged as extensions with the vendor
property tag JMS_TIBCO_MSG_EXT.
For more information on MapMessage compatibility with Rendezvous messages,
see Message Body on page 81.

TIBCO Enterprise Message Service User’s Guide

64
| Chapter 4 Working With Messages

EMS Message Delivery Mode Extensions

TIBCO Enterprise Message Service introduces two types of message delivery

which are extensions to the JMS specification.
JMS delivery requirements ensure delivery in almost all circumstances, even if the
message receiver is off-line for some time. However, this ensured delivery has a
price. This type of delivery requires:
• Two-way network traffic (message and a return message concerning the
receipt of the message) for each message or committed transaction of a group
of messages.
• Memory allocated for message storage for each persistent message and
durable subscriber.
For higher throughput, you may choose one or both of the extensions provided by
TIBCO Enterprise Message Service. You might choose this especially if the content
of the messages is time-dependent data, such as a stock price quotation.
TIBCO Enterprise Message Service has two extensions to the JMS specification:
• Reliable Message Delivery.
• No-Acknowledgement Message Receipt.

Reliable Message Delivery

JMS has PERSISTENT and NON_PERSISTENT delivery modes for both topic and
queue. In addition to these modes, you can use Tibjms.RELIABLE_DELIVERY
mode from TIBCO Enterprise Message Service.
PERSISTENT and NON_PERSISTENT delivery require the TIBCO Enterprise
Message Service server to return a system message to the client application to
ensure proper handling of messages. Using Tibjms.RELIABLE_DELIVERY as the
JMSDeliveryMode precludes the TIBCO Enterprise Message Service server from
sending this system message.
In reliable delivery mode, the client application does not have to wait for this
system message because it will not be sent. This allows higher message volume.
Reliable mode decreases the volume of message traffic, allowing better usage of
system resources, and higher message rates.
You can set the delivery mode to reliable in one of two ways:
• Use a publish() or send() method that accepts a javax.jms.DeliveryMode
as a parameter.

TIBCO Enterprise Message Service User’s Guide

 EMS Message Delivery Mode Extensions 65
|

• Set the delivery mode for the message producer using the following
expression:
messageProducer.setDeliveryMode(
com.tibco.tibjms.Tibjms.RELIABLE_DELIVERY);

Delivery mode cannot be set by using the Message.setJMSDeliveryMode()

method. According to the JMS specification, the publisher ignores the value of the
JMSDeliveryMode header field when a message is being published.

When you use the reliable delivery mode, the client application does not receive
any response from the server. Therefore, all publish calls will always succeed (not
throw an exception) unless the connection to the server has been terminated.
In some cases a message published in reliable mode may be disqualified and not
handled by the server because the destination is not valid or access has been
denied. In this case, the message is not sent to any message consumer. However,
unless the connection to the server has been terminated, the publishing
application will not receive any exceptions, despite the fact that no consumer
received the message.

No-Acknowledgement Message Receipt

TIBCO Enterprise Message Service provides a mechanism for not acknowledging
the receipt of messages.
In no-acknowledge receipt mode, after the server sends a message to the client, all
information regarding that message for that consumer is eliminated from the
server. Therefore, there is no need for the client application to send an
acknowledgement to the server about the received message. Not sending
acknowledgements decreases the message traffic and saves time for the receiver,
therefore allowing better utilization of system resources.
No-acknowledgement receipt mode is configured at the session level. Add the
com.tibco.tibjms.Tibjms.NO_ACKNOWLEDGE constant when you create the
session. For example:
javax.jms.TopicSession session =
topicConnection.createTopicSession(
false,com.tibco.tibjms.Tibjms.NO_ACKNOWLEDGE);

Sessions created in no-acknowledge receipt mode cannot be used to create

durable subscribers.
Also, queue receivers on a queue that is routed from another server are not
permitted to specify NO_ACKNOWLEDGE mode.

TIBCO Enterprise Message Service User’s Guide

66
| Chapter 4 Working With Messages

TIBCO Enterprise Message Service User’s Guide

 | 67

Chapter 5 Working With TIBCO Rendezvous

This chapter describes the interoperation of TIBCO Enterprise Message Service

and TIBCO Rendezvous.

Topics

• Overview, page 68
• Configuring Transports for Rendezvous, page 70
• Topics, page 73
• Queues, page 75
• Import Issues, page 77
• Export Issues, page 78
• Message Translation, page 79
• Pure Java Rendezvous Programs, page 84

TIBCO Enterprise Message Service User’s Guide

68
| Chapter 5 Working With TIBCO Rendezvous

Overview

TIBCO Enterprise Message Service (release 4 and later) can exchange messages
with TIBCO Rendezvous (release 6.9 and later).

Scope • EMS can import and export messages to an external system through an EMS
topic.
• EMS can import messages from an external system to an EMS queue (but
queues cannot export).

Figure 12 Rendezvous Transports in the EMS Server

EMS Server
Export

TIBCO Rendezvous
EMS Topic Translation tibrv
Transport

EMS Destination Translation tibrv Import

(Topic or Queue) Transport

Message Translation
EMS and Rendezvous use different formats for messages and their data. When
tibemsd imports or exports a messages, it translates the message and its data to
the appropriate format; for details, see Message Translation on page 101.

Configuration
tibemsd uses definitions and parameters in four configuration files to guide the
exchange of messages with Rendezvous.

Enabling The parameter tibrv_transports (in the configuration file tibemsd.conf)

globally enables or disables message exchange with Rendezvous. The default
value is disabled. To use these transports, you must explicitly set this parameter
to enabled.

TIBCO Enterprise Message Service User’s Guide

 Overview 69
|
Transports Transport definitions (in the configuration file transports.conf) specify the
communication protocol between EMS and the external system; for details, see
Configuring Transports for Rendezvous on page 70.

Destinations Destination definitions (in the configuration files topics.conf and

queues.conf) can set the import and export properties to specify one or more
transports:
• import instructs tibemsd to import messages that arrive on those transports
from Rendezvous, and deliver them to the EMS destination.
• export instructs tibemsd to take messages that arrive on the EMS destination,
and export them to Rendezvous via those transports.

For details, see Topics on page 95, and Queues on page 97.

RVCM Listeners When exporting messages on a transport configured for certified message
delivery, you can pre-register RVCM listeners in the file tibrvcm.conf.
For details, see tibrvcm on page 142, and Certified Messages on page 78

Deprecated Configuration Properties

Previous releases of TIBCO Enterprise Message Service provided properties in

tibemsd.conf and destination properties for configuring communication with
TIBCO Rendezvous. These properties are supported for backward-compatibility,
but they are deprecated. This configuration method may not be supported in
future releases of TIBCO Enterprise Message Service. You can achieve the same
functionality that these parameters provide by using transports.conf and the
export and import properties on destinations described in this chapter.

You may continue to use the deprecated properties with this release, but you
should switch to using the new approach as soon as possible. For lists of
deprecated parameters and properties, see TIBCO Rendezvous Parameters—
Deprecated on page 132, and Deprecated Properties on page 32.

TIBCO Enterprise Message Service User’s Guide

70
| Chapter 5 Working With TIBCO Rendezvous

Configuring Transports for Rendezvous

Transports mediate the flow of messages between TIBCO Enterprise Message

Service and TIBCO Rendezvous.
timemsd connects to Rendezvous daemons in the same way as any other
Rendezvous client would. Transport definitions (in the file transports.conf)
configure the behavior of these connections. You must properly configure these
transports.

Transport Definitions
transports.conf contains zero or more transport definitions. Each definition
begins with the name of a transport, surrounded by square brackets. Subsequent
lines set the parameters of the transport.

Table 7 Rendezvous: Transport Parameters (Sheet 1 of 3)

Parameter Description
type Required. For Rendezvous transports, the value must be either tibrv or
tibrvcm.

Rendezvous Parameters
The syntax and semantics of these parameters are identical to the corresponding parameters in
Rendezvous clients. For full details, see the Rendezvous documentation set.

service When absent, the default value is 7500.

network When absent, the default value is the host computer’s primary network.

daemon When absent, the default value is an rvd process on the local host
computer.
To connect to a non-default daemon, supply hostname:protocol:port. You
may omit any of the three parts. The default hostname is the local host
computer. The default protocol is tcp. The default port is 7500.

Rendezvous Certified Messaging (RVCM) Parameters

Use these properties only for tibrvcm transports.
The syntax and semantics of these parameters are identical to the corresponding parameters in
Rendezvous CM clients. For full details, see the Rendezvous documentation set.

cm_name Correspondent name.

TIBCO Enterprise Message Service User’s Guide

 Configuring Transports for Rendezvous 71
|
Table 7 Rendezvous: Transport Parameters (Sheet 2 of 3)

Parameter Description
rv_tport Required. Each RVCM transport depends in turn upon an ordinary
Rendezvous transport. Set this parameter to the name of a Rendezvous
transport (type tibrv) defined in the EMS configuration file
transports.conf.

ledger_file Name for file-based ledger.

sync_ledger true or false. If true, operations that update the ledger do not return
until changes are written to the storage medium.

request_old true or false. If true, this transport server requests unacknowledged

messages sent from other RVCM senders while this transport was
unavailable.

default_ttl This parameter sets default CM time limit (in seconds) for all CM
messages exported on this transport.

explicit_config_only true or false. If true, tibemsd allows RVCM listeners to register for
certified delivery only if they are configured in advance with the EMS
server (either in tibrvcm.conf or using the create rvcmlistener
command). That is, tibemsd ignores registration requests from
non-configured listeners.
If false (the default), tibemsd allows any RVCM listener to register.

EMS Parameters

topic_import_dm EMS sending clients can set the JMSDeliveryMode header field for each
message. However, Rendezvous clients cannot set this header. Instead,
queue_import_dm
these two parameters determine the delivery modes for all topic
messages and queue messages that tibemsd imports on this transport.
TIBEMS_PERSISTENT | TIBEMS_NON_PERSISTENT | TIBEMS_RELIABLE

When absent, the default is TIBEMS_NON_PERSISTENT.

export_headers When true, tibemsd includes JMS header fields in exported messages.
When false, tibemsd suppresses JMS header fields in exported
messages.
When absent, the default value is true.

TIBCO Enterprise Message Service User’s Guide

72
| Chapter 5 Working With TIBCO Rendezvous

Table 7 Rendezvous: Transport Parameters (Sheet 3 of 3)

Parameter Description
export_properties When true, tibemsd includes JMS properties in exported messages.
When false, tibemsd suppresses JMS properties in exported messages.
When absent, the default value is true.

Example
These examples from transports.conf illustrate the syntax of transport
definitions.
[RV01]
type = tibrv
topic_import_dm = TIBEMS_RELIABLE
queue_import_dm = TIBEMS_PERSISTENT
service = 7780
network = lan0
daemon = tcp:host5:7885

[RV02]
type = tibrv
service = 7890
network = lan0
daemon = tcp:host5:7995

[RVCM01]
type = tibrvcm
export_headers = true
export_properties = true
rv_tport = RV02
cm_name = RVCMTrans1
ledger_file = ledgerFile.store
sync_ledger = true
request_old = true
default_ttl = 600

TIBCO Enterprise Message Service User’s Guide

 Topics 73
|

Topics

Topics can both export and import messages. Accordingly, you can configure
topic definitions (in the configuration file topics.conf) with import and export
properties that specify one or more external transports:

import • import instructs tibemsd to import messages that arrive on those transports
from Rendezvous, and deliver them to the EMS destination.

export • export instructs tibemsd to take messages that arrive on the EMS destination,
and export them to Rendezvous via those transports.

The EMS server never re-exports an imported message on the same topic.

(For general information about topics.conf syntax and semantics, see topics on
page 136. You can also configure topics using the administration tool command
addprop topic.)

Example For example, the following tibemsadmin commands configure the topic
myTopics.news to import messages on the transports RV01 and RV02, and to
export messages on the transport RV02.
addprop topic myTopics.news import="RV01,RV02"
addprop topic myTopics.news export="RV02"

Rendezvous messages with subject myTopics.news arrive at tibemsd over the

transports RV01 and RV02. EMS clients can receive those messages by subscribing
to myTopics.news.
EMS messages sent to myTopics.news are exported to Rendezvous over transport
RV02. Rendezvous clients of the corresponding daemons can receive those
messages by subscribing to myTopics.news.

Import Only when Subscribers Exist

When a topic specifies import on a connected transport, tibemsd imports
messages only when the topic has registered subscribers.

TIBCO Enterprise Message Service User’s Guide

74
| Chapter 5 Working With TIBCO Rendezvous

Wildcards
Wildcards in the import and export properties obey EMS syntax and semantics
(which is identical to Rendezvous syntax and semantics); see Destination Name—
Syntax and Semantics on page 93.

Certified Messages
You can import and export TIBCO Rendezvous certified messages (tibrvcm
transport) to EMS topics. Rendezvous certified transports guarantee message
delivery.

RVCM Ledger tibrvcm transports can store information about subjects in a ledger file. You can
review the ledger file using an administration tool command; see show
rvcmtransportledger on page 175).

For more information about ledger files, see TIBCO Rendezvous documentation.

TIBCO Enterprise Message Service User’s Guide

 Queues 75
|

Queues

Queues can import messages, but cannot export them.

Configuration
You can configure queue definitions (in the configuration file queues.conf) with
the import property that specify one or more external transports.
• import instructs tibemsd to import messages that arrive on those transports
from Rendezvous, and deliver them to the EMS destination.

(For general information about queues.conf syntax and semantics, see queues on
page 136. You can also configure queues using the administration tool command
addprop queue.)

Example For example, the following tibemsadmin command configures the queue
myTopics.news to import messages on the transports RV01 and RV02.

addprop topic myQueue.in import="RV01,RV02"

Rendezvous messages with subject myQueue.in arrive at tibemsd over the

transports SS01 and SS02. EMS clients can receive those messages by subscribing
to myQueue.in.

Import—Start and Stop

When a queue specifies import on a connected transport, tibemsd immediately
begins importing messages to the queue, even when no receivers exist for the
queue.
For static queues (configured by an administrator) tibemsd continues importing
until you explicitly delete the queue.

Wildcards
Wildcards in the import property obey EMS syntax and semantics (not
Rendezvous syntax and semantics); see Destination Name—Syntax and
Semantics on page 93.
EMS clients cannot subscribe to wildcard queues—however, you can define
wildcards queues in the EMS server for the purpose of property inheritance. That
is, you can configure a static queue named foo.* and set properties on it, so that
child queues named foo.bar and foo.baz will both inherit those properties.

TIBCO Enterprise Message Service User’s Guide

76
| Chapter 5 Working With TIBCO Rendezvous

If you define a queue that imports foo.*, tibemsd begins importing all matching
messages from Rendezvous. As messages arrive, tibemsd creates dynamic child
queues (for example, foo.bar and foo.baz) and delivers the messages to them.
Notices that tibemsd delivers messages to these dynamic child queues even
when no subscribers exist to drain them.

TIBCO Enterprise Message Service User’s Guide

 Import Issues 77
|

Import Issues

This section presents issues associated with importing messages to EMS from
Rendezvous—whether on a topic or a queue.

Import Destination Names Must be Unique

When a topic and a queue share the same name, at most one of them may set the
import property. For example, if a topic foo.bar and a queue foo.bar are both
defined, only one may specify the import property.

JMSReplyTo
When tibemsd imports and translates a Rendezvous message, it sets the
JMSReplyTo field of the EMS message to the value of the Rendezvous reply
subject, so that EMS clients can reply to the message.
Usually this value represents a Rendezvous subject. You must explicitly configure
tibemsd to create a topic with a corresponding name, which exports messages to
Rendezvous.

Guaranteed Delivery

For full end-to-end certified delivery from Rendezvous to EMS, all three of these
conditions must be true:
• Rendezvous senders must send labeled messages on RVCM transports.
• The transport definition must set topic_import_dm or queue_import_dm (as
appropriate) to TIBEMS_PERSISTENT.
• A durable subscription for the EMS topic or queue must exist.

TIBCO Enterprise Message Service User’s Guide

78
| Chapter 5 Working With TIBCO Rendezvous

Export Issues

This section presents issues associated with exporting messages from EMS to
Rendezvous.

JMSReplyTo
Topics Consider an EMS message in which the field JMSReplyTo contains a topic. When
exporting such a message to Rendezvous, you must explicitly configure tibemsd
to import replies from Rendezvous to that reply topic.

Temporary Topics Consider an EMS message in which the field JMSReplyTo contains a temporary
topic. When tibemsd exports such a message to Rendezvous, it automatically
arranges to import replies to that temporary topic from Rendezvous; you do not
need to configure it explicitly.

Certified Messages
RVCM When an RVCM listener receives its first labeled message, it registers to receive
Registration subsequent messages as certified messages. Until the registration is complete, it
receives labeled messages as reliable messages. When exporting messages on a
tibrvcm transport, we recommend either of two actions to ensure certified
delivery for all exported messages:
• Create the RVCM listener before sending any messages from EMS clients.
• Pre-register an RVCM listener, either with the administration tool (see create
rvcmlistener on page 154), or in the configuration file tibrvcm.conf (see
tibrvcm on page 142).

Guaranteed Delivery

For full end-to-end certified delivery to Rendezvous from EMS, the following
condition must be true:
• EMS senders must send persistent messages.

TIBCO Enterprise Message Service User’s Guide

 Message Translation 79
|

Message Translation

JMS Header Fields

EMS supports the ten predefined JMS header fields; see Header Fields on page 50.

Two Special These two header fields are special cases:

Cases
• JMS header JMSDestination corresponds to Rendezvous subject.
• JMS header JMSReplyTo corresponds to Rendezvous reply subject.

Import When importing a Rendezvous message to an EMS message, tibemsd does not
set any JMS header fields, except for the special cases noted above.

Export When exporting an EMS message to a Rendezvous message, tibemsd groups all
the JMS header fields (except for the special cases noted above) into a single
submessage within the Rendezvous message. The field JMSHeaders contains that
submessage. Fields of the submessage map the names of JMS header fields to
their values.
tibemsd ignores any JMS header fields that are null or absent—it omits them
from the exported message.
You can instruct tibemsd to suppress the entire header submessage in all
exported messages by setting the transport property export_headers = false.

Table 8 presents the mapping of JMS header fields to Rendezvous data types (that
is, the type of the corresponding field in the exported message).

Table 8 Rendezvous: Mapping JMS Header Fields to RV Datatypes (Sheet 1 of 2)

JMS Header Name Rendezvous Type

JMSDeliveryMode TIBRVMSG_U8

JMSPriority TIBRVMSG_U8

JMSTimestamp TIBRVMSG_U64

JMSExpiration TIBRVMSG_U64

JMSType TIBRVMSG_STRING

JMSMessageID TIBRVMSG_STRING

JMSCorrelationID TIBRVMSG_STRING

TIBCO Enterprise Message Service User’s Guide

80
| Chapter 5 Working With TIBCO Rendezvous

Table 8 Rendezvous: Mapping JMS Header Fields to RV Datatypes (Sheet 2 of 2)

JMS Header Name Rendezvous Type

JMSRedelivered TIBRVMSG_BOOL

JMSDestination send subject in TIBCO Rendezvous

JMSReplyTo reply subject in TIBCO Rendezvous

JMS Property Fields

Import When importing a Rendezvous message to an EMS message, tibemsd sets these
JMS properties:
• JMS_TIBCO_IMPORTED gets the value true, to indicates that the message did
not originate from an EMS client.
• JMS_TIBCO_MSG_EXT gets the value true, to indicate that the message might
contain submessage fields or array fields.

Import RVCM In addition to the two fields described above, when tibemsd imports a certified
message on a tibrvcm transport, it can also set these properties (if the
corresponding information is set in the Rendezvous message):
• JMS_TIBCO_CM_PUBLISHER gets a string value indicating the correspondent
name of the Rendezvous CM transport that sent the message (that is, the
sender name).
• JMS_TIBCO_CM_SEQUENCE gets a long value indicating the CM sequence
number of the message.

Export When exporting an EMS message to a Rendezvous message, tibemsd groups all
the JMS property fields into a single submessage within the Rendezvous message.
The field JMSProperties contains that submessage. Fields of the submessage
map the names of JMS property fields to their values.
tibemsd ignores any JMS property fields that are not set, or are set to null—it
omits them from the exported message.
You can instruct tibemsd to suppress the entire properties submessage in the
exported message by setting the transport property
export_properties = false.

TIBCO Enterprise Message Service User’s Guide

 Message Translation 81
|

Message Body
tibemsd can export messages with any JMS message body type to TIBCO
Rendezvous. Conversely, tibemsd can import messages with any message type
from TIBCO Rendezvous.
For information about JMS body types, see Message Bodies on page 51.
For information about the structure of messages, see JMS Message Structure on
page 50.

Import When importing a Rendezvous message, tibemsd translates it to an EMS message

body types based on the presence of the fields in Table 9.

Table 9 Rendezvous: Mapping Message Types (Import)

Rendezvous Field EMS Body Type

JMSBytes JMSBytesMessage

JMSObject JMSObjectMessage

JMSStream JMSStreamMessage

JMSText JMSTextMessage

None of these fields are present. JMSMapMessage

Export When exporting an EMS message, tibemsd translates it to a Rendezvous message

with the following structure:
• The field JMSHeaders contains a submessage; see JMS Header Fields on
page 79. When the transport parameter export_headers is false, this field is
omitted.
• The field JMSProperties contains a submessage; see JMS Property Fields on
page 80. When the transport parameter export_properties is false, this
field is omitted.
• When translating the data fields of an EMS message, the results depend on the
JMS body type. Table 10 specifies the mapping.

Table 10 Rendezvous: Mapping Message Types (Export) (Sheet 1 of 2)

JMS Body Type Export Translation

BytesMessage The message data translates to a byte array that contains the bytes of the
original EMS message.
The field JMSBytes receives this data. It has type TIBRVMSG_OPAQUE.

TIBCO Enterprise Message Service User’s Guide

82
| Chapter 5 Working With TIBCO Rendezvous

Table 10 Rendezvous: Mapping Message Types (Export) (Sheet 2 of 2)

JMS Body Type Export Translation

ObjectMessage The message data translates to a byte array containing the serialized Java
object.
The field JMSObject receives this data. It has type TIBRVMSG_OPAQUE.

StreamMessage The message data translates to a byte array that encodes the objects in the
original EMS message.
The field JMSStream receives this data. It has type TIBRVMSG_OPAQUE.

TextMessage The message data translates to a UTF-8 string corresponding to the text of the
original EMS message.
The field JMSText receives this data. It has type TIBRVMSG_STRING.

MapMessage The message data fields map directly to top-level fields in the Rendezvous
message. The fields retain the same names as in the original EMS message.
See also, MapMessage Extensions on page 63.

Data Types
Table 11 presents the mapping between EMS datatypes and Rendezvous
datatypes. The mapping is bidirectional, except for the Rendezvous types that
have no corresponding EMS type (for these types the mapping is marked as
unidirectional in the middle column of Table 11).

Table 11 Rendezvous: Mapping Data Types (Sheet 1 of 2)

EMS Map Rendezvous

Boolean TIBRVMSG_BOOL

Byte TIBRVMSG_I8

Short <— TIBRVMSG_U8

Short TIBRVMSG_I16

Integer <— TIBRVMSG_U16

Integer TIBRVMSG_I32

Long <— TIBRVMSG_U32

TIBCO Enterprise Message Service User’s Guide

 Message Translation 83
|

Table 11 Rendezvous: Mapping Data Types (Sheet 2 of 2)

EMS Map Rendezvous

Long TIBRVMSG_I64

Long <— TIBRVMSG_U64

Float TIBRVMSG_F32

Double TIBRVMSG_F64

Short <— TIBRVMSG_IPPORT16

Integer <— TIBRVMSG_IPADDR32

MapMessage TIBRVMSG_MSG

Long <— TIBRVMSG_DATETIME

byte[] TIBRVMSG_OPAQUE

java.lang.String TIBRVMSG_STRING

byte[] <— TIBRVMSG_XML

byte[] <— TIBRVMSG_I8ARRAY

short[] <— TIBRVMSG_U8ARRAY

short[] TIBRVMSG_I16ARRAY

int[] <— TIBRVMSG_U16ARRAY

int[] TIBRVMSG_I32ARRAY

long[] <— TIBRVMSG_U32ARRAY

long[] TIBRVMSG_I64ARRAY

long[] <— TIBRVMSG_U64ARRAY

float[] TIBRVMSG_F32ARRAY

double[] TIBRVMSG_F64ARRAY

TIBCO Enterprise Message Service User’s Guide

84
| Chapter 5 Working With TIBCO Rendezvous

Pure Java Rendezvous Programs

TIBCO Enterprise Message Service is shipped with the tibrvjms.jar file that
you can include in your TIBCO Rendezvous applications. This JAR file includes
the implementation of the com.tibco.tibrv.TibrvJMSTransport class. This
class extends the com.tibco.tibrv.TibrvNetTransport class and allows your
pure Java Rendezvous programs to communicate directly with the EMS server
instead of through rva.
To use the TibrvJMSTransport class, your application must include
tibrvjms.jar (included with TIBCO Enterprise Message Service) and
tibrvjweb.jar (included with TIBCO Rendezvous).

You can use TibrvJMSTransport only in Rendezvous applications. This class is

not intended for use in your EMS Java clients.
Both TIBCO Rendezvous and TIBCO Enterprise Message Service must be
purchased, installed, and configured before creating pure Java Rendezvous
applications that use the TibrvJMSTransport class.

The TibrvJMSTransport class provides Rendezvous reliable communication

only. Other types of communication, such as certified messaging, are not
supported by this transport.
Applications using this transport can send messages to a topic on an EMS server
that has the same topic name as the subject of the message. EMS topics receiving
Rendezvous messages sent by way of the TibrvJMSTransport do not need to
specify the import property. This transport cannot be used to send messages to
JMS queues.
For more information about TibrvNetTransport and how to create use
transports in TIBCO Rendezvous Java programs, see TIBCO Rendezvous
documentation. Table 12 on page 85 describes the additional methods of
TibrvJMSTransport.

TIBCO Enterprise Message Service User’s Guide

 Pure Java Rendezvous Programs 85
|

Table 12 TibrvJMSTransport class

Method Description
TibrvJMSTransport() Constructor for creating a
throws TibrvException
TibrvJMSTransport.

TibrvJMSTransport(
If no parameters are passed, the
String serverURL) transport assumes the server is
throws TibrvException running on the same machine with the
default listener port.
TibrvJMSTransport( You can also pass the serverURL to
String serverURL,
String clientId, connect to the TIBCO Enterprise
String userName, Message Service server at the specified
String password) location.
throws TibrvException
You may also pass the clientID of
your client connection, and a username
and a password to use to connect to the
server.

destroy() Destroys the transport and all

associated listeners.

toString() Returns a string representation of this

transport.

setPersistentDelivery( Sets the TIBCO Enterprise Message

boolean persistent)
Service persistent delivery mode for
messages sent or received on this
transport.

isPersistentDelivery() Returns true if persistent delivery

mode is set for this transport.

TIBCO Enterprise Message Service User’s Guide

86
| Chapter 5 Working With TIBCO Rendezvous

TIBCO Enterprise Message Service User’s Guide

 | 87

Chapter 6 Working With TIBCO SmartSockets

This chapter describes the interoperation of TIBCO Enterprise Message Service

and TIBCO SmartSockets.

Topics

• Overview, page 88
• Configuring Transports for SmartSockets, page 90
• Topics, page 95
• Queues, page 97
• Import Issues, page 99
• Export Issues, page 100
• Message Translation, page 101

TIBCO Enterprise Message Service User’s Guide

88
| Chapter 6 Working With TIBCO SmartSockets

Overview

TIBCO Enterprise Message Service (release 4 and later) can exchange messages
with TIBCO SmartSockets (release 6.5 and later).

Scope • EMS can import and export messages to an external system through an EMS
topic.
• EMS can import messages from an external system to an EMS queue (but
queues cannot export).

Figure 13 SmartSockets Transports in the EMS Server

EMS Server
Export

TIBCO SmartSockets
EMS
EMS
Topic
Topic Translation
Translation tibss
Transport

EMSEMS
EMS
Destination Translation
Translation tibss Import
Destination
(Topic
Destination
or Queue) Transport
(Topic or Queue)

Message Translation
EMS and SmartSockets use different formats for messages and their data. When
tibemsd imports or exports a messages, it translates the message and its data to
the appropriate format; for details, see Message Translation on page 101.

Configuration
tibemsd uses definitions and parameters in three configuration files to guide the
exchange of messages with SmartSockets.

Enabling The parameter tibss_transports (in the configuration file tibemsd.conf)

globally enables or disables message exchange with SmartSockets. The default
value is disabled. To use these transports, you must explicitly set this parameter
to enabled.

TIBCO Enterprise Message Service User’s Guide

 Overview 89
|

The parameter tibss_config_dir (in the configuration file tibemsd.conf)

specifies the location of SmartSockets files needed by the SmartSockets client
within tibemsd.

Transports Transport definitions (in the configuration file transports.conf) specify the
communication protocol between EMS and the external system; for details, see
Configuring Transports for SmartSockets on page 90.

Destinations Destination definitions (in the configuration files topics.conf and

queues.conf) can set the import and export properties to specify one or more
transports:
• import instructs tibemsd to import messages that arrive on those transports
from SmartSockets, and deliver them to the EMS destination.
• export instructs tibemsd to take messages that arrive on the EMS destination,
and export them to SmartSockets via those transports.

For details, see Topics on page 95, and Queues on page 97.

Starting the Servers

We recommend starting the SmartSockets RTserver before starting tibemsd.

TIBCO Enterprise Message Service User’s Guide

90
| Chapter 6 Working With TIBCO SmartSockets

Configuring Transports for SmartSockets

Transports mediate the flow of messages between TIBCO Enterprise Message

Service and TIBCO SmartSockets.
timemsd connects to SmartSockets RTservers in the same way as any other
SmartSockets client. Transport definitions (in the file transports.conf)
configure the behavior of these connections. You must properly configure these
transports.

Transport Definitions
transports.conf contains zero or more transport definitions. Each definition
begins with the name of a transport, surrounded by square brackets. Subsequent
lines set the parameters of the transport.

Table 13 SmartSockets: Transport Parameters (Sheet 1 of 3)

Parameter Description
type Required. For SmartSockets transports, the value must be tibss.

SmartSockets Parameters
The syntax and semantics of these parameters are identical to the corresponding parameters in
SmartSockets clients. For full details, see the SmartSockets documentation set.

server_names Required. The value is a comma-separated list specifying connections to

one or more SmartSockets RTservers.
Each item in the list has the form protocol:hostname:port. You may omit any of
the three parts. The default protocol is tcp. The default hostname is the local
host computer. The default port is 5101.
A list of several servers specifies fault tolerance—timemsd attempts to
connect to them in the order listed.

username timemsd uses these two parameters to authenticate itself to the

SmartSockets servers.
password

project SmartSockets uses projects to maintain orthogonal subject name-spaces.

When absent, the default project is rtworks.

TIBCO Enterprise Message Service User’s Guide

 Configuring Transports for SmartSockets 91
|

Table 13 SmartSockets: Transport Parameters (Sheet 2 of 3)

Parameter Description
delivery_mode This parameter determines the quality of service with which delivers
messages to the SmartSockets server over this transport:
best_effort | gmd_all | gmd_some | ordered

When absent, the default is best_effort.

lb_mode SmartSockets servers balance the message load by distributing messages

among several clients. This parameter determines the load balancing
regimen for messages that this transport exports to the SmartSockets server.
none | round_robin | weighted | sorted

When absent, the default is none.

override_lb_mode enable instructs the RTserver to deliver all messages on this client
connection—even if other clients participate in load balancing. For
example, even though many order-processing clients might share the load
of order messages, a message logging facility would require all order
messages, rather than a subset.
disable informs the RTserver that this client (that is, the EMS server)
participates in load balancing (for example, sharing the load with other
EMS servers).
When absent, the default is enable.

gmd_file_delete SmartSockets clients keep data for guaranteed message delivery (GMD) in a
store file.
disable instructs tibemsd to open the existing GMD store file.
enable instructs tibemsd to delete the GMD store file and create a new one
when creating this transport.
When absent, the default is disable.

EMS Parameters

topic_import_dm EMS sending clients can set the JMSDeliveryMode header field for each
message. However, SmartSockets clients cannot set this header. Instead,
queue_import_dm
these two parameters determine the delivery modes for all topic messages
and queue messages that tibemsd imports on this transport.
TIBEMS_PERSISTENT | TIBEMS_NON_PERSISTENT | TIBEMS_RELIABLE

When absent, the default is TIBEMS_NON_PERSISTENT.

TIBCO Enterprise Message Service User’s Guide

92
| Chapter 6 Working With TIBCO SmartSockets

Table 13 SmartSockets: Transport Parameters (Sheet 3 of 3)

Parameter Description
export_headers When true, tibemsd includes JMS header fields in exported messages.
When false, tibemsd suppresses JMS header fields in exported messages.
When absent, the default value is true.

export_properties When true, tibemsd includes JMS properties in exported messages.

When false, tibemsd suppresses JMS properties in exported messages.
When absent, the default value is true.

subscribe_mode • When subscriptions do not collide, specify exact, for best performance.
• When subscriptions collide, specify all, for correct semantics.

When absent, the default is exact.

For a definition of wildcard collision, and complete details about the
operation of these two modes, see Subscribe Mode on page 92.

Example
These examples from transports.conf illustrate the syntax of transport
definitions.
[SS01]
type = tibss
server_names = rtHost1
username = emsServer6
password = myPasswd
project = sales_order_entry

[SS02]
type = tibss
server_names = tcp:rtHost2A:5555, ssl:rtHost2B:5571
username = emsServer6
password = myPasswd
project = mfg_process_control
override_lb_mode = enable
delivery_mode = gmd_some

Subscribe Mode
Both EMS and SmartSockets allow wildcard subscriptions to collide (for example,
in EMS syntax, foo.* collides with foo.bar; and foo.* collides with *.bar).
The transport parameter subscribe_mode governs SmartSockets message

TIBCO Enterprise Message Service User’s Guide

 Configuring Transports for SmartSockets 93
|

filtering when EMS wildcard subscriptions collide. This section describes the
mechanisms of subscription, and the results when import subscriptions collide.

exact exact instructs tibemsd to pass subscriptions to the RTserver exactly as the EMS
subscribers specify. As a result, subject filtering occurs on the RTserver.
Consequently, the RTserver delivers each SmartSockets message with subject
/foo/bar to this client (tibemsd) twice—once for the subscription to foo.*, and
once for the subscription to foo.bar. However, tibemsd does not recognize these
duplicates as redundant, and delivers two copies to each subscriber. It is illegal to
configure exact when EMS subscriptions collide.

all all instructs tibemsd to pass the subscription /... to the RTserver. As a result, the
RTserver delivers all messages to this client (only once)—letting tibemsd filter the
messages. tibemsd delivers messages to each subscriber as appropriate, so EMS
subscribers do not receive duplicate messages. Because tibemsd requests all
messages from SmartSockets, an all connection carries more data than an exact
connection.

Destination Name—Syntax and Semantics

Slash & Dot This aspect of the mapping between EMS destination names and SmartSockets
Separators subjects is straightforward, one-to-one, and bidirectional.
EMS destination names consist of tokens separated by the dot (.) character.
SmartSockets subjects consists of tokens preceded by the slash (/) character (like
UNIX directory pathnames).
For example, the EMS name foo.bar.baz corresponds to the SmartSockets name
/foo/bar/baz. (Remember that SmartSockets names must begin with a leading
slash, but EMS names need not begin with a leading dot. A leading dot indicates
an empty element preceding it.)
The slash and dot characters have complementary roles in EMS and
SmartSockets. In EMS slash is an ordinary character, while dot is a separator. In
SmartSockets slash is a separator, while dot is an ordinary character. To translate
names between EMS and SmartSockets, substitute these characters one for
another. For example, the EMS name foo/bar.baz corresponds to the
SmartSockets name /foo.bar/baz. However, to avoid confusion, we discourage
using either slash or dot as ordinary characters.

Wildcard Star Although both EMS and SmartSockets both interpret the star (*) character as a
wildcard, they differ in its semantics. In this aspect, the mapping is not
one-to-one.

TIBCO Enterprise Message Service User’s Guide

94
| Chapter 6 Working With TIBCO SmartSockets

In EMS, star can match any whole token of a name, but not part of a token. In
SmartSockets, star can match part of an token—for example, /foo/b*/baz
matches /foo/bar/baz and /foo/box/baz.
If you are familiar with SmartSockets wildcards but not EMS wildcards, see
Wildcards on page 39.

Trailing Wildcard In EMS the greater-than (>) character is a wildcard that matches any number of
trailing tokens. In SmartSockets a string of three dots (...) signifies identical
semantics.

TIBCO Enterprise Message Service User’s Guide

 Topics 95
|

Topics

Topics can both export and import messages. Accordingly, you can configure
topic definitions (in the configuration file topics.conf) with import and export
properties that specify one or more external transports:

import • import instructs tibemsd to import messages that arrive on those transports
from SmartSockets, and deliver them to the EMS destination.

export • export instructs tibemsd to take messages that arrive on the EMS destination,
and export them to SmartSockets via those transports.

The EMS server never re-exports an imported message on the same topic.

(For general information about topics.conf syntax and semantics, see topics on
page 136. You can also configure topics using the administration tool command
addprop topic.)

Example
For example, the following tibemsadmin commands configure the topic
myTopics.news to import and export messages on three transports.

addprop topic myTopics.news import="SS01,SS02"

addprop topic myTopics.news export="SS01,SS02,SS03"

SmartSockets messages with subject /myTopics/news arrive at tibemsd over the

transports SS01 and SS02. EMS clients can receive those messages by subscribing
to myTopics.news.
EMS messages sent to myTopics.news are exported to SmartSockets over all three
transports—SS01, SS02 and SS03. SmartSockets clients of the corresponding
RTservers can receive those messages by subscribing to /myTopics/news.

Import Only when Subscribers Exist

When a topic specifies import on a connected transport, tibemsd imports
messages only when the topic has registered subscribers.

TIBCO Enterprise Message Service User’s Guide

96
| Chapter 6 Working With TIBCO SmartSockets

Wildcards
Wildcards in the import and export properties obey EMS syntax and semantics
(not SmartSockets syntax and semantics); see Destination Name—Syntax and
Semantics on page 93.

TIBCO Enterprise Message Service User’s Guide

 Queues 97
|

Queues

Queues can import messages, but cannot export them.

Configuration
You can configure queue definitions (in the configuration file queues.conf) with
the import property that specify one or more external transports.
• import instructs tibemsd to import messages that arrive on those transports
from SmartSockets, and deliver them to the EMS destination.

(For general information about queues.conf syntax and semantics, see queues on
page 136. You can also configure queues using the administration tool command
addprop queue.)

Example For example, the following tibemsadmin command configures the queue
myTopics.news to import messages on the transports SS01 and SS02.

addprop topic myQueue.in import="SS01,SS02"

SmartSockets messages with subject /myQueue/in arrive at tibemsd over the

transports SS01 and SS02. EMS clients can receive those messages by subscribing
to myQueue.in.

Import—Start and Stop

When a queue specifies import on a connected transport, tibemsd immediately
begins importing messages to the queue, even when no receivers exist for the
queue.
For static queues (configured by an administrator) tibemsd continues importing
until you explicitly delete the queue.

Wildcards
Wildcards in the import property obey EMS syntax and semantics (not
SmartSockets syntax and semantics); see Destination Name—Syntax and
Semantics on page 93.
EMS clients cannot subscribe to wildcard queues—however, you can define
wildcards queues in the EMS server for the purpose of property inheritance. That
is, you can configure a static queue named foo.* and set properties on it, so that
child queues named foo.bar and foo.baz will both inherit those properties.

TIBCO Enterprise Message Service User’s Guide

98
| Chapter 6 Working With TIBCO SmartSockets

If you define a queue that imports foo.*, tibemsd begins importing all matching
messages from SmartSockets. As messages arrive, tibemsd creates dynamic child
queues (for example, foo.bar and foo.baz) and delivers the messages to them.
Notices that tibemsd delivers messages to these dynamic child queues even
when no subscribers exist to drain them.

TIBCO Enterprise Message Service User’s Guide

 Import Issues 99
|

Import Issues

This section presents issues associated with importing messages to EMS from
SmartSockets—whether on a topic or a queue.

Import Destination Names Must be Unique

When a topic and a queue share the same name, at most one of them may set the
import property. For example, if a topic foo.bar and a queue foo.bar are both
defined, only one may specify the import property.

JMSReplyTo
When tibemsd imports and translates a SmartSockets message, it sets the
JMSReplyTo field of the EMS message to the value of the SmartSockets reply_to
header, so that EMS clients can reply to the message.
Usually this value represents a SmartSockets subject. You must explicitly
configure tibemsd to create a topic with a corresponding name, which exports
messages to SmartSockets.

Guaranteed Delivery

For full end-to-end guaranteed delivery from SmartSockets to EMS, all three of
these conditions must be true:
• SmartSockets senders must send messages with guaranteed message delivery
(GMD).
• The transport definition must set topic_import_dm or queue_import_dm (as
appropriate) to TIBEMS_PERSISTENT.
• A durable subscription for the EMS topic or queue must exist.

For export guarantees, see Guaranteed Delivery on page 100.

TIBCO Enterprise Message Service User’s Guide

100
| Chapter 6 Working With TIBCO SmartSockets

Export Issues

This section presents issues associated with exporting messages from EMS to
SmartSockets.

JMSReplyTo
Topics Consider an EMS message in which the field JMSReplyTo contains a topic. When
exporting such a message to SmartSockets, you must explicitly configure tibemsd
to import replies from SmartSockets to that reply topic.

Temporary Topics Consider an EMS message in which the field JMSReplyTo contains a temporary
topic. When tibemsd exports such a message to SmartSockets, it automatically
arranges to import replies to that temporary topic from SmartSockets; you do not
need to configure it explicitly.

Wildcard Subscriptions
Star Wildcard Both EMS and SmartSockets interpret the star character (*) as a wildcard—but
with different semantics. EMS accepts star only as a whole element, which
matches a whole element. In contrast, SmartSockets accepts star as part of an
element, matching a substring within the element.
When a SmartSockets client subscribes to foo.bar*, then configure tibemsd to
export the superset foo.*; RTserver narrows the set by delivering only messages
that match subscribers.
For a full discussion of the differences between EMS and SmartSockets wildcards,
see Destination Name—Syntax and Semantics on page 93.

Guaranteed Delivery

For full end-to-end guaranteed delivery to SmartSockets from EMS, both of these
conditions must be true:
• EMS senders must send persistent messages.
• The transport definition must set delivery_mode to gmd_some or gmd_all (as
appropriate).

For import guarantees, see Guaranteed Delivery on page 99.

TIBCO Enterprise Message Service User’s Guide

 Message Translation 101
|

Message Translation

JMS Header Fields

EMS supports the ten predefined JMS header fields; see Header Fields on page 50.

Two Special These two header fields are special cases:

Cases
• JMS header JMSDestination corresponds to SmartSockets dest.
• JMS header JMSReplyTo corresponds to SmartSockets reply_to.

Import When importing a SmartSockets message to an EMS message, tibemsd does not
set any JMS header fields, except for the special cases noted above.

Export When exporting an EMS message to a SmartSockets message, tibemsd groups all
the JMS header fields (except for the special cases noted above) into a single
submessage within the SmartSockets message. The field JMSHeaders contains
that submessage. Fields of the submessage map the names of JMS header fields to
their values.
tibemsd ignores any JMS header fields that are null or absent—it omits them
from the exported message.
You can instruct tibemsd to suppress the entire header submessage in all
exported messages by setting the transport property export_headers = false.

JMS Property Fields

Import When importing a SmartSockets message to an EMS message, tibemsd sets these
JMS properties:
• JMS_TIBCO_IMPORTED gets the value true, indicating that the message did not
originate from an EMS client.
• JMS_TIBCO_MSG_EXT gets the value true, indicating that the message might
contain submessage fields or array fields.
• JMS_TIBCO_SS_SENDER gets the value of the SmartSockets sender header
field (in SmartSockets syntax).

Export When exporting an EMS message to a SmartSockets message, tibemsd groups all
the JMS property fields into a single submessage within the SmartSockets
message. The field JMSProperties contains that submessage. Fields of the
submessage map the names of JMS property fields to their values.

TIBCO Enterprise Message Service User’s Guide

102
| Chapter 6 Working With TIBCO SmartSockets

tibemsd ignores any JMS property fields that are not set, or are set to null—it
omits them from the exported message.
You can instruct tibemsd to suppress the entire properties submessage in the
exported message by setting the transport property
export_properties = false.

Message Body
tibemsd can export messages with any JMS message body type to TIBCO
SmartSockets. Conversely, tibemsd can import messages with any message type
from TIBCO SmartSockets.
For information about JMS body types, see Message Bodies on page 51.
For information about the structure of messages, see JMS Message Structure on
page 50.

Import When importing a SmartSockets message, tibemsd translates it to one of two

EMS message body types:
• If the SmartSockets message contains only unnamed fields, then it translates
into a JMSStreamMessage. The stream contains the values of the unnamed
fields in the same order as they appear in the SmartSockets message.
• If the SmartSockets message contains one or more named fields, then it
translates into a JMSMapMessage. The map message contains the named fields;
the order of the fields is indeterminate.

Export When exporting an EMS message, tibemsd translates it to one of six SmartSockets
message types (see Table 14) with the following structure:
• The named field JMSHeaders is the first field (omitted when the transport
parameter export_headers is false). It contains a submessage; see JMS
Header Fields on page 101.
• The named field JMSProperties is the next field (omitted when the transport
parameter export_properties is false). It contains a submessage; see JMS
Property Fields on page 101.

TIBCO Enterprise Message Service User’s Guide

 Message Translation 103
|

• The data fields follow the JMS headers and properties (when present). For
details about field names and types, see the third column of Table 14.

Table 14 SmartSockets: Mapping Message Types (Export)

SmartSockets
JMS Message Type Message Type Data Fields

JMSBytesMessage T_MT_JMS_BYTES One unnamed field of type

T_MSG_FT_BINARY

JMSMapMessage T_MT_JMS_MAP Named fields; indeterminate

order

JMSObjectMessage T_MT_JMS_OBJECT One unnamed field of type

T_MSG_FT_BINARY

JMSStreamMessage T_MT_JMS_STREAM Unnamed fields in order

JMSTextMessage T_MT_JMS_TEXT One unnamed field of type

T_MSG_FT_STR

All other JMS T_MT_INFO No data fields

message types

Data Types
Table 15 presents the mapping between EMS datatypes and SmartSockets
datatypes. The mapping is bidirectional, except for a few SmartSockets types that
have no corresponding EMS type (for these types the mapping is marked as
unidirectional in the middle column of Table 15).

Table 15 SmartSockets: Mapping Data Types (Sheet 1 of 2)

EMS Map SmartSockets

Boolean T_MSG_FT_BOOL

Byte T_MSG_FT_CHAR

Character T_MSG_FT_INT2

Short T_MSG_FT_INT2

Integer T_MSG_FT_INT4

TIBCO Enterprise Message Service User’s Guide

104
| Chapter 6 Working With TIBCO SmartSockets

Table 15 SmartSockets: Mapping Data Types (Sheet 2 of 2)

EMS Map SmartSockets

Long T_MSG_FT_INT8

Float T_MSG_FT_REAL4

Double T_MSG_FT_REAL8

Double <— T_MSG_FT_TIMESTAMP

String T_MSG_FT_STR

String <— T_MSG_FT_XML

String <— T_MSG_FT_UTF8

Byte Array T_MSG_FT_BINARY

Short Array <— T_MSG_FT_BOOL_ARRAY

Short Array T_MSG_FT_INT2_ARRAY

Integer Array T_MSG_FT_INT4_ARRAY

Long Array T_MSG_FT_INT8_ARRAY

Float Array T_MSG_FT_REAL4_ARRAY

Double Array T_MSG_FT_REAL8_ARRAY

Double Array <— T_MSG_FT_TIMESTAMP_ARRAY

Stream Message T_MSG_FT_MSG

Map Message
(See Import on page 102.)

Destination Names
tibemsd automatically translates destination names when importing or exporting
a message; see Slash & Dot Separators on page 93.
When importing, it translates names in the SmartSockets subject and reply_to
fields. When exporting, it translates names in the EMS JMSDestination and
JMSReplyTo fields.

TIBCO Enterprise Message Service User’s Guide

 | 105

Chapter 7 Using the Configuration Files

This chapter describes configuring TIBCO Enterprise Message Service.

Topics

• Using the Main Configuration File, page 106

• Using Other Configuration Files, page 134

TIBCO Enterprise Message Service User’s Guide

106
| Chapter 7 Using the Configuration Files

Using the Main Configuration File

The main configuration file controls the characteristics of the TIBCO Enterprise
Message Service server. This file is usually named tibemsd.conf, but you can
specify another file name when starting the server. You can find more information
about starting the server in the section Running the Server on page 226.
An example of the tibemsd.conf file is included in the bin directory of TIBCO
Enterprise Message Service. You can edit this configuration file with a text editor.
There are a few configuration items that can be altered using the administration
tool, but most configuration parameters must be set by editing the file. See
Chapter 8, Using the Administration Tool, on page 145 for more information
about using the administration tool.
Several parameters accept boolean values. In the description of the parameter, one
specific set of values is given (for example, enable and disable), but all
parameters that accept booleans can have the following values:
• enable, enabled, true, yes, on

• disable, disabled, false, no, off

Table 16 describes the parameters in tibemsd.conf. This table is meant to give a

brief description of each parameter.

Table 16 Configuration parameters (Sheet 1 of 28)

Parameter Name Description

Server Information

server Name of server

password Password used to log in to other routed server

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 107
|
Table 16 Configuration parameters (Sheet 2 of 28)

Parameter Name Description

Initialization

startup_abort_list This comma-separated list of tokens specifies

conditions that cause the server to exit during its
initialization sequence. When omitted, the default is
the empty list—that is, the server ignores these
conditions. You may specify any subset of these tokens:
• SSL—If SSL initialization fails, then exit.
• TRANSPORTS—If any of the transports cannot be
created as specified in the configuration files, then
exit.
• CONFIG_FILES—If any configuration file listed in
tibemsd.conf does not exist, then exit.
• CONFIG_ERRORS—If the server detects any errors
while reading the config files, then exit.

Storage Files

store The directory to store TIBCO Enterprise Message

Service data.

Example
store = /usr/tmp

store_minimum Preallocates file storage space for TIBCO Enterprise

Message Service. If store_truncate is enabled, the
storage is not truncated below the minimum size
specified in this parameter.
You can specify units in this parameter in KB, MB, or
GB.

Example
store_minimum = 32MB

store_crc Specifies whether crc checksum data are checked when

reading and writing data in storage.

TIBCO Enterprise Message Service User’s Guide

108
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 3 of 28)

Parameter Name Description

store_truncate Specifies whether TIBCO Enterprise Message Service
should attempt to truncate the storage files. When set
to enabled, the storage files may be truncated, but not
below the size specified in the store_minimum
parameter.

Flow Control

flow_control Specifies whether flow control for destinations is

enabled or disabled. By default, flow control is
disabled.
When flow control is enabled, the flowControl
property on each destination specifies the target
maximum storage for pending messages on the
destination.
See Flow Control on page 46 for more information
about flow control.

Connections and Memory

max_connections Maximum number of simultaneous client connections.

Set to 0 to allow unlimited simultaneous connections.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 109
|
Table 16 Configuration parameters (Sheet 4 of 28)

Parameter Name Description

max_msg_memory Maximum memory the server can use for messages.
This parameter allows you to limit the amount of
memory used by the server for messages so that the
server memory usage does not grow beyond the
system’s memory capacity.
Messages sent to the server are stored in memory.
When the total amount of memory used by messages
reaches the limit specified by this parameter, the server
begins to swap messages to disk. This allows the server
to free up memory for incoming messages and hand a
greater total message size than allowed by this
parameter.
Each swapped message is stored on disk, but a small
footprint of the message remains in memory. If the
maximum memory specified by this parameter is
reached and all messages are swapped out to disk
(leaving no way for the server to free up memory for
new messages), the server does not accept any new
messages and any message producers receive an error
when they attempt to send new messages.
To reach the maximum memory limit when all
messages are already swapped to disk would require
an extremely low setting for this parameter and/or an
extremely high message volume. In most situations, the
server should not reach the maximum message
memory as long as this parameter is set to a reasonable
amount of memory for your system.
You can set this parameter to 0 to specify no limit. Use
KB, MB, or GB units.

Example
max_msg_memory = 512MB

msg_swapping When the maximum memory limit specified by the

max_msg_memory parameter is met, messages that
aren’t currently being handled can be temporarily
swapped out to disk. You can disable message
swapping by setting msg_swapping to disabled.

TIBCO Enterprise Message Service User’s Guide

110
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 5 of 28)

Parameter Name Description

reserve_memory size When non-zero, the daemon allocates a block of
memory for use in emergency situations. When the
daemon process exhausts storage resources, it disables
clients from producing new messages, and frees this
block of memory to allow consumers to continue
operation (which tends to free memory).
Specify size in units of MB or GB. When non-zero, the
minimum block is 16MB. When absent, the default is
zero.

msg_pool_block_size size To lessen the overhead costs associated with malloc

msg_pool_size size and free, the server pre-allocates pools of storage for
messages. These parameters determine the behavior of
these pools. Performance varies depending on
operating system platform and usage patterns.
msg_pool_block_size instructs the server to allocate
an expandable pool. Each time the server exhausts the
pool, the server increases the pool by this size, as long
as additional storage is available. The value may be in
the range 32 to 64K.
msg_pool_size instructs the server to allocate a fixed
pool. After the server exhausts this pool, the server
calls malloc each time it requires additional storage.
The value may be in the range 16K to 1024M.
When neither parameter is present, the default is
msg_pool_block_size 128 (an expandable pool).

When both parameters are present,

msg_pool_block_size supersedes msg_pool_size;
the result is an expandable pool.
The size argument determines the approximate number
of internal message structs that a block or pool can
accommodate (not the number of bytes).

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 111
|
Table 16 Configuration parameters (Sheet 6 of 28)

Parameter Name Description

Detecting Network Connection Failure
This feature lets servers and clients detect network connection failures quickly. This feature is new
in release 4.0.0; it is disabled when either entity is from an earlier release.
When these parameters are absent, or this feature is disabled, tibemsd closes a connection only
upon the operating system notification.

client_heartbeat interval In a server-to-client connection, both entities send

heartbeats at this interval (in seconds).

client_connection_timeout limit In a server-to-client connection, if either entity does not

receive a heartbeat for a period exceeding this limit (in
seconds), it closes the connection.
We recommend setting this value to approximately 3.5
times the heartbeat interval.

server_heartbeat interval In a server-to-server connection, this server sends

heartbeats at this interval (in seconds).
The two servers can be connected either by a route, or
as a fault-tolerant pair.

server_connection_timeout limit In a server-to-server connection, if this server does not

receive a heartbeat for a period exceeding this limit (in
seconds), it closes the connection.
We recommend setting this value to approximately 3.5
times the heartbeat interval of the other server. When
the other server or the network are heavily loaded, we
recommend a larger value.

TIBCO Enterprise Message Service User’s Guide

112
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 7 of 28)

Parameter Name Description

Listen Ports

listen Format is protocol://servername:port

Example
listen=tcp://localhost:7222

You can use multiple entries for listen if you have

computers with multiple interfaces

If you are enabling SSL, for example:

listen=ssl://localhost:7222

Authorization
See Chapter 9, Authentication and Permissions, on page 179 for more information about these
parameters.

authorization Authorization is disabled by default. Enable to verify

user credentials and permissions on secure
destinations.

Example
authorization= disabled

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 113
|

Table 16 Configuration parameters (Sheet 8 of 28)

Parameter Name Description

user_auth Specifies from where authentication information is
obtained when a non-administrator user attempts to
authenticate to the TIBCO Enterprise Message Service
server. This parameter can have one or more of the
following values:
• local — obtain user authentication information
from the local TIBCO Enterprise Message Service
server user configuration.
• system — obtain user authentication information
from the UNIX system password file (available
only on UNIX systems).
• ldap — obtain user authentication information
from an LDAP directory server (see the
LDAP-specific configuration parameters for
configuring authentication using an LDAP server).
You can specify one or more of these files, each value
separated by a comma. When a user attempts to
authenticate, the server attempts to obtain the
authentication information from each of the specified
locations in the order they are specified in this
parameter. If the user can authenticate successfully
using any of the specified sources, the user successfully
authenticates to the TIBCO Enterprise Message Service
server.

Routing
See Chapter 14, Working With Routes, on page 277 for more information about routing.

routing Route configuration is in the routes configuration file.

This parameter enables or disables routing
functionality for this server.

Example
routing = enabled

TIBCO Enterprise Message Service User’s Guide

114
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 9 of 28)

Parameter Name Description

Fault Tolerance Parameters
See Chapter 13, Making the Server Fault-Tolerant, on page 265 for more information about these
parameters.

ft_active Name of the active server. If this server can connect to

the active server, it will act as a backup server. If this
server cannot connect to the active server, it will
become the active server.

ft_heartbeat Heartbeat signal for the active server, in seconds.

Default is 3.

ft_activation Activation interval (maximum length of time between

heartbeat signals) which indicates that active server has
failed. Set in seconds: default is 10. This interval should
be set to at least twice the heartbeat interval.

Example
ft_activation = 60

ft_reconnect_timeout The amount of time, in seconds, a backup server (when

it becomes the primary server in a failover situation)
waits for clients to reconnect before their state is
removed from the shared state.
The default value of this parameter is 60.

ft_ssl_identity The server’s digital certificate in PEM, DER, or

PKCS#12 format. You can copy the digital certificate
into the specification for this parameter, or you can
specify the path to a file that contains the certificate in
one of the supported formats.
See File Names for Certificates and Keys on page 251
for more information on file types for digital
certificates.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 115
|
Table 16 Configuration parameters (Sheet 10 of 28)

Parameter Name Description

ft_ssl_issuer Certificate chain member for the server. The server
reads the certificates in the chain in the order they are
presented in this parameter.
The same certificate can appear in multiple places in
the certificate chain.
The certificates must be in PEM, DER, PKCS#7, or
PKCS#12 format.
See File Names for Certificates and Keys on page 251
for more information on file types for digital
certificates.

ft_ssl_private_key The server’s private key. If it is included in the digital

certificate in ft_ssl_identity, then this parameter is
not needed.
This parameter supports private keys in the following
formats: PEM, DER, PKCS#12.
You can specify the actual key in this parameter, or you
can specify a path to a file that contains the key.
See File Names for Certificates and Keys on page 251
for more information on file types for digital
certificates.

ft_ssl_password Private key or password for private keys.

You can set passwords by way of the tibemsadmin
tool. When passwords are set with this tool, the
password is obfuscated in the configuration file. See
Chapter 8, Using the Administration Tool, on page 145
for more information about using tibemsadmin to set
passwords.

TIBCO Enterprise Message Service User’s Guide

116
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 11 of 28)

Parameter Name Description

ft_ssl_trusted List of trusted certificates. This sets which Certificate
Authority certificates should be trusted as issuers of
the client certificates.
The same certificate can appear in multiple places in
the certificate chain.
The certificates must be in PEM, DER, or PKCS#7
format. You can either provide the actual certificates, or
you can specify a path to a file containing the certificate
chain.
See File Names for Certificates and Keys on page 251
for more information on file types for digital
certificates.

ft_ssl_rand_egd The path for the installed entropy gathering daemon

(EGD), if one is installed. This daemon is used to
generate random numbers for the TIBCO Enterprise
Message Service server.

ft_ssl_verify_host Specifies whether the fault-tolerant server should

verify the other server’s certificate. The values for this
parameter are enabled or disabled. By default, this
parameter is enabled, signifying the server should
verify the other server’s certificate.
When this parameter is set to disabled, the server
establishes secure communication with the other
fault-tolerant server, but does not verify the server’s
identity.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 117
|
Table 16 Configuration parameters (Sheet 12 of 28)

Parameter Name Description

ft_ssl_verify_hostname Specifies whether the fault-tolerant server should
verify the name in the CN field of the other server’s
certificate. The values for this parameter are enabled
and disabled. By default, this parameter is enabled,
signifying the fault-tolerant server should verify the
name of the connected host or the name specified in the
ft_ssl_expected_hostname parameter against the
value in the server’s certificate. If the names do not
match, the connection is rejected.
When this parameter is set to disabled, the
fault-tolerant server establishes secure communication
with the other server, but does not verify the server’s
name.

ft_ssl_expected_hostname Specifies the name the server is expected to have in the

CN field of the fault-tolerant server’s certificate. If this
parameter is not set, the expected name is the
hostname of the server.
This parameter is used when the
ft_ssl_verify_hostname parameter is set to enabled.

ft_ssl_ciphers Specifies the cipher suites used by the server; each suite
in the list is separated by a colon (:). This parameter can
use the OpenSSL name for cipher suites or the longer,
more descriptive names.
See Specifying Cipher Suites on page 258 for more
information about the cipher suites available in TIBCO
Enterprise Message Service and the OpenSSL names
and longer names for the cipher suites.

Message Tracking Information

track_message_ids Tracks messages by message ID. Default is disabled.

Enabling this parameter allows you to display
messages using the show message <messageID>
command in the administration tool.

TIBCO Enterprise Message Service User’s Guide

118
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 13 of 28)

Parameter Name Description

track_correlation_ids Tracks messages by correlation ID. Disabled by default.
Enabling this parameter allows you to display
messages using the show messages <correlationID>
command in the administration tool.

TIBCO Rendezvous
See also, Chapter 5, Working With TIBCO Rendezvous, on page 67.

tibrv_transports Specifies whether TIBCO Rendezvous transports

defined in transports.conf are enabled or disabled.
By default, all transports are disabled and will not send
messages to external systems. Setting this parameter to
enabled allows the defined transports to be used to
send messages to external systems.

tibrv_xml_import_as_string When importing messages from Rendezvous, tibemsd

translates XML fields to byte arrays. Releases earlier
than 4.0 erroneously translated them to strings. If your
client programs process XML as strings, then enable
this parameter to revert to the earlier behavior (strings).
When absent, the default value is disabled (byte
arrays).
(When importing from SmartSockets, XML fields
translate to strings. This behavior is correct for
SmartSockets, even though it differs from the correct
behavior for Rendezvous.)

TIBCO SmartSockets
See also, Chapter 6, Working With TIBCO SmartSockets, on page 87.

tibss_transports Specifies whether TIBCO SmartSockets transports

defined in transports.conf are enabled or disabled.
By default, all transports are disabled and will not send
messages to external systems. Setting this parameter to
enabled allows the defined transports to be used to
send messages to external systems.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 119
|

Table 16 Configuration parameters (Sheet 14 of 28)

Parameter Name Description

tibss_config_dir Specifies the directory for SmartSockets configuration
files and message files:
• tal_ss.cat is a required file of messages. If it is
missing, tibemsd outputs a warning message.
• tibems_ss.cm is an optional file of SmartSockets
configuration options.

When this parameter is absent, tibemsd searches for

these files in its current working directory.
For more information about these files, see TIBCO
SmartSockets documentation.

Tracing and Log File Parameters

See Chapter 10, Monitoring Server Activity, on page 207 for more information about these
parameters.

logFile Name and location of the log file.

TIBCO Enterprise Message Service User’s Guide

120
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 15 of 28)

Parameter Name Description

log_trace Sets the trace preference on the file defined by the
logFile parameter. If logFile is not set, the values are
stored but have no effect.
The value of this parameter can include names of trace
subjects, possibly prepended with '+' or '-' sign. The '+'
sign means add item to the current set of trace items,
the '-' sign means remove tracing on that item. If any
item has no '+' or '-' sign then it entirely replaces
current trace settings. List of items can include names:
INFO, WARNING, ACL, LIMITS, SSL, SSL_DEBUG,
ROUTE,ROUTE_DEBUG, CONNECT,
CONNECT_ERROR, PRODCONS, DEST, TX,
LDAP_DEBUG, MSG, AUTH, FLOW, ADMIN and
RVADV.
The special name 'DEFAULT' means the default set of
trace items which consists of:
INFO, WARNING, ACL, LIMITS, ROUTE, ADMIN,
CONNECT_ERROR, MSG, and RVADV.
See Table 28, Server tracing options, on page 209 for
more information about trace options.

Examples
log_trace=ACL

sets the trace to only show messages about rejecting

client requests because of permissions violation.
log_trace=DEFAULT,-ADMIN,+SSL

shows all default messages except ADMIN messages

and also show SSL tracing.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 121
|

Table 16 Configuration parameters (Sheet 16 of 28)

Parameter Name Description

logfile_max_size Specifies the recommended maximum log file size
before the log file is rotated. Set to 0 to specify no limit.
Use KB, MB, or GB for units (if no units are specified,
the file size is assumed to be in bytes).
The server periodically checks the size of the current
log file. If it is greater than the specified size, the file is
copied to a backup and then emptied. The server then
begins writing to the empty log file until it reaches the
specified size again.
Backup log files are named sequentially and stored in
the same directory as the current log.

console_trace Sets the trace preference on the stderr output. The

values are the same as in log_trace parameters. This
set of trace applies to the output on the console
regardless if logFile is set or not.
That is, if logFile if defined then output into the
console can be removed by specifying:
console_trace=-DEFAULT

Notice that important error messages and some others

are printed in the server console regardless of trace
settings.

trace_client_host = Trace statements related to connections can identify the

[hostname|address|both]
host by its hostname, its IP address, or both.
When absent, the default is hostname.

TIBCO Enterprise Message Service User’s Guide

122
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 17 of 28)

Parameter Name Description

Statistic Gathering Parameters
See Chapter 10, Monitoring Server Activity, on page 207 for more information about these
parameters.

server_rate_interval Sets the interval (in seconds) over which overall server
statistics are averaged. This parameter can be set to any
positive integer greater than zero.
Overall server statistics are always gathered, so this
parameter cannot be set to zero. By default, this
parameter is set to 1.
Setting this parameter allows you to average message
rates and message size over the specified interval.

statistics Enables or disables statistic gathering for producers,

consumers, destinations, and routes. By default this
parameter is set to disabled.
Disabling statistic gathering resets the total statistics
for each object to zero.

rate_interval Sets the interval (in seconds) over which statistics for
routes, destinations, producers, and consumers are
averaged. By default, this parameter is set to 3 seconds.
Setting this parameter to zero disables the average
calculation.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 123
|
Table 16 Configuration parameters (Sheet 18 of 28)

Parameter Name Description

detailed_statistics Specifies which objects should have detailed statistic
tracking. Detailed statistic tracking is only appropriate
for routes, producers that specify no destination, or
consumers that specify wildcard destinations. When
detailed tracking is enabled, statistics for each
destination are kept for the object.
Setting this parameter to NONE disabled detailed
statistic tracking. You can specify any combination of
PRODUCERS, CONSUMERS, or ROUTES to enable
tracking for each object. If you specify more than one
type of detailed tracking, separate each item with a
comma.

Examples
detailed_statistics = NONE

Turns off detailed statistic tracking.

detailed_statistics = PRODUCERS,ROUTES

Specifies detailed statistics should be gathered for

producers and routes.

statistics_cleanup_interval Specifies how long (in seconds) the server should keep
detailed statistics if the destination has no activity. This
is useful for controlling the amount of memory used by
detailed statistic tracking. When the specified interval
is reached, statistics for destinations with no activity
are deleted.

max_stat_memory Specifies the maximum amount of memory to use for

detailed statistic gathering. If no units are specified, the
amount is in bytes, otherwise you can specify the
amount using KB, MB, or GB as the units.
Once the maximum memory limit is reached, the
server stops collecting detailed statistics. If statistics are
deleted and memory becomes available, the server
resumes detailed statistic gathering.

TIBCO Enterprise Message Service User’s Guide

124
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 19 of 28)

Parameter Name Description

SSL Server Parameters
See Chapter 12, Using the SSL Protocol, on page 241 for more information about these parameters.

ssl_dh_size Size of the Diffie-Hellman key. Can be 512, 768, 1024, or

2048 bits. The default value is 1024.
This key is not used for cipher suites available for
export.

ssl_server_ciphers Specifies the cipher suites used by the server; each suite
in the list is separated by a colon (:). This parameter
must follow the OpenSSL cipher string syntax.
For example, you can enable two cipher suites with the
following setting:
ssl_server_ciphers = RC4-MD5:RC4-SHA

See Specifying Cipher Suites on page 258 for more

information about the cipher suites available in TIBCO
Enterprise Message Service and the syntax for
specifying them in this parameter.

ssl_renegotiate_size The server initiates a renegotiation when the

cumulative size, in bytes, of the data passed between
the server and the client reaches the amount specified
by this parameter.
The minimum size this parameter can be set to is 64Kb.
You can specify Kb, Mb, or Gb for the units. For
example:
ssl_renegotiate_size = 1024 Mb

By default, this parameter is set to 0, signifying

renegotiation is disabled.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 125
|
Table 16 Configuration parameters (Sheet 20 of 28)

Parameter Name Description

ssl_renegotiate_interval The server initiates a renegotiation when the number of
seconds specified by this parameter have passed. The
renegotiation occurs each time the interval occurs; the
time interval starts at the beginning of the SSL
connection.
The minimum interval is 15 seconds. For example, you
can set this parameter as follows to renegotiate every
10 minutes:
ssl_renegotiate_interval = 600

By default, this parameter is set to 0, signifying

renegotiation is disabled.

ssl_require_client_cert If this parameter is set to yes, the server only accepts

SSL connections from clients that have digital
certificates. Connections from clients without
certificates are denied.
If this parameter is set to no, then connections are
accepted from clients that do not have a digital
certificate.
Whether this parameter is set to yes or no, clients that
do have digital certificates are always authenticated
against the list of certificates in the
ssl_server_trusted parameter.

ssl_use_cert_username If this parameter is set to yes, a client’s user name is

always extracted from the CN field of the client’s
digital certificate, if the digital certificate is specified.
The CN field is either a username, an email address, or
a web address.

TIBCO Enterprise Message Service User’s Guide

126
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 21 of 28)

Parameter Name Description

ssl_cert_user_specname This parameter is useful if clients are required to
supply a username, but you wish to designate a special
username to use when the client’s username should be
taken from the client’s digital certificate.
For example, you may wish all clients to specify their
username when logging in. This means the
ssl_use_cert_username parameter would be set to
no. The username is supplied by the user, and not taken
from the digital certificate. However, you may wish
one username to signify that the client logging in with
that name should have the name taken from the
certificate. A good example of this username would be
anonymous. All clients logging in as anonymous will
have their user names taken from their digital
certificates.
The value specified by this parameter is the username
that clients will use to log in when the username
should be taken from their digital certificate. A good
example of the value of this parameter would be
anonymous.

Also, the value of this parameter is ignored if the

ssl_use_cert_username parameter is specified.
When that parameter is specified, all client usernames
are taken from their certificates. This parameter has no
effect for users that have no certificate.

ssl_server_identity The server’s digital certificate in PEM, DER, or

PKCS#12 format. You can copy the digital certificate
into the specification for this parameter, or you can
specify the path to a file that contains the certificate in
one of the supported formats.
This parameter must be specified if any SSL ports are
listed in the listen parameter, or if the ssl_enabled
parameter is set to true.
PEM and PKCS#12 formats allow the digital certificate
to include the private key. If these formats are used and
the private key is part of the digital certificate, then
setting ssl_server_key is optional.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 127
|
Table 16 Configuration parameters (Sheet 22 of 28)

Parameter Name Description

ssl_server_key The server’s private key. If it is included in the digital
certificate in ssl_server_identity, then this
parameter is not needed.
This parameter supports private keys in the following
formats: PEM, DER, PKCS#12.
You can specify the actual key in this parameter, or you
can specify a path to a file that contains the key.

ssl_password Private key or password for private keys.

This password can optionally be specified on the
command line when tibemsd is started.
If SSL is enabled, and the password is not specified
with this parameter or on the command line, tibemsd
will ask for the password upon startup.
You can set passwords by way of the tibemsadmin
tool. When passwords are set with this tool, the
password is obfuscated in the configuration file. See
Chapter 8, Using the Administration Tool, on page 145
for more information about using tibemsadmin to set
passwords.

ssl_server_issuer Certificate chain member for the server. The server

reads the certificates in the chain in the order they are
presented in this parameter.
The same certificate can appear in multiple places in
the certificate chain.
The certificates must be in PEM, DER, PKCS#7, or
PKCS#12 format.

TIBCO Enterprise Message Service User’s Guide

128
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 23 of 28)

Parameter Name Description

ssl_server_trusted List of trusted certificates. This sets which Certificate
Authority certificates should be trusted as issuers of
the client certificates.
The same certificate can appear in multiple places in
the certificate chain.
The certificates must be in PEM, DER, or PKCS#7
format. You can either provide the actual certificates, or
you can specify a path to a file containing the certificate
chain.

ssl_rand_egd The path for the installed entropy gathering daemon

(EGD), if one is installed. This daemon is used to
generate random numbers for C clients and the TIBCO
Enterprise Message Service server. Java clients do not
use this parameter.

ssl_rand_file File containing random data. This file can be used to

generate random numbers.

ssl_crl_path A non-null value for this parameter activates the

server’s certificate revocation list (CRL) feature.
The server reads CRL files from this directory.

ssl_crl_update_interval The server automatically updates its CRLs at this

interval (in hours).
When this parameter is absent, the default is 24 hours.

LDAP General Parameters

See Chapter 9, Authentication and Permissions, on page 179 for more information about these
parameters.

ldap_url URL of the external directory server. This can take the
following forms:
LDAP://<host>:<tcp_port>

or
LDAPS://<host>:<ssl_port>

For example:
LDAP://myLdapServer:1855

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 129
|
Table 16 Configuration parameters (Sheet 24 of 28)

Parameter Name Description

ldap_principal The distinguished name (DN) of the LDAP
administrator. This is the user that the TIBCO
Enterprise Message Service sever uses to bind to the
LDAP server.

ldap_credential The password associated with the user defined in the

ldap_principal property. This value must be
specified and cannot be an empty string.

ldap_cache_enabled Enables caching of LDAP data.

ldap_cache_ttl Specifies the maximum time (in seconds) that cached

LDAP data is retained before it is refreshed.

LDAP Secure Connections

ldap_conn_type Specifies they type of connection that the server uses to

to get LDAP information.
• When this parameter is absent, LDAP connections
use TCP (non-secure). For backward compatibility,
this is the default setting.
• ldaps—Use SSL on the LDAP connection (secure).
• startTLS—Use the startTLS extension to the LDAP
version 3 protocol (secure).

ldap_tls_cacert_file You must specify one of these two parameters for

secure connections.
This file contains the CA certificate that the TIBCO
EMS server trusts to sign the LDAP server’s certificate.

ldap_tls_cacert_dir When there are two or more CA certificates in the

verify chain, the server scans this directory for CA
certificates.

TIBCO Enterprise Message Service User’s Guide

130
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 25 of 28)

Parameter Name Description

ldap_tls_ciphers Optional. You can specify the cipher suite to use for
encryption on secure LDAP connections.
This parameter must follow the OpenSSL cipher string
syntax; see Specifying Cipher Suites on page 258.
In addition to the actual cipher names, you may specify
cipher quality; for example:
• HIGH

• HIGH:MEDIUM

ldap_tls_rand_file When the operating system does not include a random

data feature, this file is the source of random data for
encryption.

ldap_tls_cert_file When the LDAP server requires client authentication,

use the certificate in this file to identify the TIBCO EMS
server.

ldap_tls_key_file When the LDAP server requires client authentication,

use the private key in this file.
When you plan to start the server remotely, we
recommend that you do not password-encrypt the key
file.

LDAP User Parameters

See Chapter 9, Authentication and Permissions, on page 179 for more information about these
parameters.

ldap_user_class Name of the LDAP object class that stores users.

ldap_user_attribute Name of the attribute on the user object class that holds
the name of the user.

ldap_user_base_dn Base distinguished name (DN) of the LDAP tree that

contains the users.

ldap_user_scope Specifies how deeply under the base DN to search for

users. You can specify onelevel and subtree for this
parameter. onelevel specifies to search only one level
below the DN, subtree specifies to search all sub-trees.

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 131
|
Table 16 Configuration parameters (Sheet 26 of 28)

Parameter Name Description

ldap_user_filter Optional LDAP search filter for finding a given user
name. Use %s as the placeholder for the user name in
the filter. For example:
uid=%s

The full LDAP search grammar is specified in RFC 2254

and RFC 2251.
If unspecified, then a default search filter is generated
based on the user object class and user name attribute.

ldap_all_users_filter An optional LDAP search filter for finding all users

beneath the user base DN.
If not specified, then a default search filter is generated
based on the user object class and user name attribute.

LDAP Group parameters

See Chapter 9, Authentication and Permissions, on page 179 for more information about these
parameters.

ldap_group_base_dn Base distinguished name (DN) of the LDAP tree that

contains groups.

ldap_group_scope Specifies how deeply under the base DN to search for

groups. You can specify onelevel and subtree for this
parameter. onelevel specifies to search only one level
below the DN, subtree specifies to search all sub-trees.

ldap_group_filter Optional LDAP search filter for finding a group with a

given group name. Use %s as the placeholder for the
group name in the filter.
The full LDAP search grammar is specified in RFC 2254
2251.
If unspecified, then a default search filter is generated
based on the group object class and group attribute.

ldap_all_groups_filter Optional LDAP search filter for finding all groups

beneath the group base DN.
If unspecified, then a default search filter is generated
based on the group object class and group attribute.

TIBCO Enterprise Message Service User’s Guide

132
| Chapter 7 Using the Configuration Files

Table 16 Configuration parameters (Sheet 27 of 28)

Parameter Name Description

ldap_static_group_class Name of the LDAP object class that stores static
groups.

ldap_static_group_attribute Name of the attribute on the static group object class

that holds the name of the group.

ldap_static_member_attribute Attribute of an LDAP static group object that specifies the

distinguished names (DNs) of the members of the
group.

ldap_dynamic_group_class Name of the LDAP object class that stores dynamic

groups.

ldap_dynamic_group_attribute Name of the attribute on the dynamic group object

class that holds the name of the group.

ldap_dynamic_member_url_attribute Attribute of the dynamic LDAP group object that

specifies the URLs of the members of the dynamic
group.

TIBCO Rendezvous Parameters—Deprecated

These parameters are deprecated. Please configure TIBCO Rendezvous import/export using the
transports.conf file.

tibrv_bridge Enables the bridge between TIBCO Enterprise Message

Service and TIBCO Rendezvous. This parameter is
disabled by default.

tibrv_service TIBCO Rendezvous service number. By default, the

value is 7500.

tibrv_network TIBCO Rendezvous network number.

tibrv_daemon service:hostname:portname. By default, the local daemon is

used.

Example
tcp:hostname:7500

tibrv_topic_import_dm Sets the Delivery Mode of the topic (PERSISTENT,

NON-PERSISTENT, RELIABLE).

TIBCO Enterprise Message Service User’s Guide

 Using the Main Configuration File 133
|

Table 16 Configuration parameters (Sheet 28 of 28)

Parameter Name Description

tibrv_queue_import_dm Sets the Delivery Mode of the queue (PERSISTENT,
NON-PERSISTENT, RELIABLE).

tibrv_export_headers Set this to false if you want to disable exporting JMS

headers into TIBCO Rendezvous.

tibrv_export_properties Set this to false if you want to disable exporting JMS

properties into TIBCO Rendezvous.

tibrvcm_enable Enables a RVCM bridge. Disabled by default.

tibrvcm_name Name for the transport.

tibrvcm_ledger Name for file-based ledger.

tibrvcm_sync_ledger Set to true or false. If true, operations that update

the ledger do not return until changes are written to the
storage medium.

tibrvcm_request_old Set to true or false. Determines whether a persistent

correspondent requires delivery of previously-sent
messages of the same name.

tibrvcm_default_ttl Default time-to-live, in seconds.

TIBCO Enterprise Message Service User’s Guide

134
| Chapter 7 Using the Configuration Files

Using Other Configuration Files

In addition to the main configuration file, there are several other configuration
files used for various purposes. They control configuration for the following:
• users
• groups
• topics
• queues
• access lists
• destination bridges
• routes
• connection factories
• transports
• RVCM listeners
• durable subscribers
These configuration files can be edited by hand, but you can also use the
administration tool or the administration API to modify some of these files. See
Chapter 8, Using the Administration Tool, on page 145 for more information
about using the administration tool.
The following sections describe the configuration files.

users
This file defines all users. The format of the file is:
<username>:<password>:"<description>"

Item Description
<username> The name of the user

TIBCO Enterprise Message Service User’s Guide

 Using Other Configuration Files 135
|

Item Description
<password> Leave this item blank when creating a new user. This
is assigned by the system when the user chooses a
password. For example:
bob::"Bob Smith"

There is one predefined user, the administrator. The

administrator password is not entered in this
configuration file, and it will not be assigned by the
system. It will remain empty unless it is set in the
administration tool. See Chapter 8, Using the
Administration Tool, on page 145 for more
information on how to change the administrator
password.

<description> A string describing the user.

Example
admin: $1$urmKVgq78:"Administrator"
Bob::"Bob Smith"
Bill::"Bill Jones"

groups
This file defines all groups. The format of the file is:
<group-name1>:"<description>"
<user-name1>
<user-name2>
<group-name2>:"<description>"
<user-name1>
<user-name2>

Item Description
<group-name> The name of the group.

<description> A string describing the group.

<user-name> One or more users that belong to the group.

TIBCO Enterprise Message Service User’s Guide

136
| Chapter 7 Using the Configuration Files

Example
administrators: "TIBCO Enterprise Message Service administrators"
admin
Bob

topics
This file defines all topics. The format of the file is:
<topic-name> <property1>, <property2>, ...

For example, you might enter:

business.inventory global, import="RV01,RV02", export="RV03",
maxbytes=1MB

Only topics listed in this file or topics with names that match the topics listed in
this file can be created by the applications. For example, if topic foo.* is listed in
this file, topics foo and foo.bar can be created by the application.
Properties of the topic are inherited by all static and dynamic topics with
matching names. For example, if test.* has the property secure, then test.1
and test.foo are also secure. For information on properties that can be assigned
to topics, see Destination Properties on page 32.
For further information on the inheritance of topic properties, refer to Wildcards *
and > on page 39 and Inheritance of Properties on page 41.

queues
This file defines all queues. The format of the file is:
<queue-name> <property1>, <property2>, ...

For example, you might enter:

test failsafe,secure,prefetch=2

Only queues listed in this file or topics with names that match the topics listed in
this file can be created by the applications. For example, if queue foo.* is listed in
this file, queues foo and foo.bar can be created by the application.
Properties of the queue are inherited by all static and dynamic queues with
matching names. For example, if test.* has the property secure, then test.1
and test.foo are also secure. For information on properties that can be assigned
to queues, see Destination Properties on page 32.

TIBCO Enterprise Message Service User’s Guide

 Using Other Configuration Files 137
|

For further information on the inheritance of queue properties, refer to Wildcards

* and > on page 39 and Inheritance of Properties on page 41.

In the sample file, a > wildcard at the beginning of the file allows the applications
to create valid queues with any name. A > at the beginning of the queue (or topic)
configuration file means that name-matching is not required for creation of
queues (or topics).

acl
This file defines all permissions on topics and queues for all users and groups.
The format of the file is:
TOPIC=<topic> USER=<user> PERM=<permissions>
TOPIC=<topic> GROUP=<group> PERM=<permissions>
QUEUE=<queue> USER=<user> PERM=<permissions>
QUEUE=<queue> GROUP=<group> PERM=<permissions>
ADMIN USER=<user> PERM=<permissions>
ADMIN GROUP=<group> PERM=<permissions>

Item Description
TOPIC Name of the topic to which you wish to add
permissions.

QUEUE Name of the queue to which you wish to add

permissions.

ADMIN Specifies that you wish to add administrator

permissions.

USER Name of the user to whom you wish to add

permissions.

GROUP Name of the group to which you wish to add

permissions.

TIBCO Enterprise Message Service User’s Guide

138
| Chapter 7 Using the Configuration Files

Item Description
PERM Permissions to add.
The permissions which can be assigned to queues
are send, receive and browse. The permissions
which can be assigned to topics are publish,
subscribe and durable. For information about
these permissions, refer to When Permissions Are
Checked on page 195 and Inheritance of Permissions
on page 41.
Administration permissions are granted to users to
perform administration activities. See Administrator
Permissions on page 197 for more information about
administration permissions.

Example
ADMIN USER=sys-admins PERM=all
TOPIC=foo USER=user2 PERM=publish,subscribe
TOPIC=foo GROUP=group1 PERM=subscribe

bridges
This file defines bridges between destinations. See Destination Bridges on page 43
for more information about destination bridges.
The format of the file is:
[<destinationType>:<destination-name>]
<destinationType>=<destinationToBridgeTo1> selector="<message-selector>"
<destinationType>=<destinationToBridgeTo2> selector="<message-selector>"
...

The <destination-name> can be any specific destination or a wildcard pattern to

match multiple destinations.

Item Description
<destinationType> The type of the destination. That is, topic or
queue.

<destinationToBridgeTo> One or more names of destinations to which to

create a bridge.

TIBCO Enterprise Message Service User’s Guide

 Using Other Configuration Files 139
|

Item Description
selector This property is optional and specifies a message
selector to limit the messages received by the
bridged destination.
For detailed information about message selector
syntax, see documentation for the Message class
in TIBCO Enterprise Message Service Java API
Reference.

routes
This file defines routes between this TIBCO Enterprise Message Service server
and other TIBCO Enterprise Message Service servers.
The format of the file is:
[<route-name>]
url=<url-string>
zone_name=<zone_name>
zone_type=<zone_type>
[<selector>]*
[<ssl-prop = value>]*

(Sheet 1 of 2)

Item Description
url The URL of the server to and from which messages
are routed.

zone_name The route belongs to the routing zone with this

name. When absent, the default value is
default_mhop_zone (this default yields backward
compatibility with configurations from releases
earlier than 4.0.0).
You can set this parameter when creating a route,
but you cannot subsequently change it.
For further information, see these sections:
• Zone on page 282
• Configuring Routes and Zones on page 286

TIBCO Enterprise Message Service User’s Guide

140
| Chapter 7 Using the Configuration Files

(Sheet 2 of 2)

Item Description
zone_type The zone type is either 1hop or mhop. When omitted,
the default value is mhop.
You can set this parameter when creating a route,
but you cannot subsequently change it.

<selector> Topic selectors (for incoming_topic and

outgoing_topic parameters) control the flow of
topics along the route.
For syntax and semantics, see Selectors for Routing
Topic Messages on page 293.

<ssl-prop> SSL properties for this route.

For further information on SSL, refer to Chapter 12,
Using the SSL Protocol, page 241.

Example
[test_route_2]
url = tcp://server2:7222
ssl_verify_host = disabled

factories
This file defines the connection factories for the internal JNDI names.
The file consists of factory definitions with this format:
[<factory-name>]
type = topic | queue
url = <url-string>
metric = connections | byte_rate
clientID = <client-id>
[<prop = value>]*
[<ssl-prop = value>]*

(Sheet 1 of 3)

Item Description
type Type of the ConnectionFactory. The value can be topic, queue,
generic, xatopic, xaqueue, xageneric.

TIBCO Enterprise Message Service User’s Guide

 Using Other Configuration Files 141
|

(Sheet 2 of 3)

Item Description
url This string specifies the servers to which this factory creates
connections:
• A single URL specifies a unique server. For example:
tcp://host1:8222

• A pair of URLs separated by a comma specifies a pair of

fault-tolerant servers. For example:
tcp://host1:8222,tcp://backup1:8222

• A set of URLs separated by vertical bars specifies a load

balancing among those servers. For example:
tcp://a:8222|tcp://b:8222|tcp://c:8222

• You can combine load balancing with fault tolerance. For

example:
tcp://a1:8222,tcp://a2:8222|tcp://b1:8222,tcp://b2
:8222

metric The factory uses this metric to balance the load among a group of
servers:
• connections—Connect to the server with the fewest client
connections.
• byte_rate—Connect to the server with the lowest byte rate.
Byte rate is a statistic that includes both inbound and outbound
data.

When this parameter is absent, the default metric is connections.

clientID The factory associates this client ID string with the connections that
it creates.

Properties
Connection factory properties override corresponding properties set using API calls.

connect_attempt_count A client program iterates through its URL list until it establishes its
first connection to an EMS server. This property determines the
maximum number of iterations. When absent, the default is 2.

connect_attempt_delay When attempting a first connection, the client sleeps for this interval
(in milliseconds) between iterations through the URL list. When
absent, the default is 500 milliseconds.

TIBCO Enterprise Message Service User’s Guide

142
| Chapter 7 Using the Configuration Files

(Sheet 3 of 3)

Item Description
reconnect_attempt_count After losing its server connection, a client program iterates through
its URL list until it re-establishes a connection with an EMS server.
This property determines the maximum number of iterations. When
absent, the default is 4.

reconnect_attempt_delay When attempting to reconnect, the client sleeps for this interval (in
milliseconds) between iterations through the URL list. When absent,
the default is 500 milliseconds.

<ssl-prop> SSL properties for connections that this factory creates.

For further information on SSL, refer to Chapter 12, Using the SSL
Protocol, page 241.

Example [north_america]
type = topic
url = tcp://localhost:7222,tcp://server2:7222
clientID = "Sample Client ID"
ssl_verify_host = disabled

Configuration To configure connection factories in this file, we recommend using the

tibemsadmin tool; see create factory on page 153.

transports
This file defines transports for importing messages from or exporting messages to
external message service:
• For TIBCO Rendezvous, see Configuring Transports for Rendezvous on
page 70.
• For TIBCO SmartSockets, see Configuring Transports for SmartSockets on
page 90.

tibrvcm
This file defines the TIBCO Rendezvous certified messaging (RVCM) listeners for
use by topics that export messages to a tibrvcm transport. The server preregisters
with these listeners when the server starts up so that all messages (including the
first message published) sent by way of the tibrvcm transport are guaranteed. If
the server does not preregister with the RVCM listeners before exporting
messages, the listeners are created when the first message is published, but the
first message is not guaranteed.

TIBCO Enterprise Message Service User’s Guide

 Using Other Configuration Files 143
|

The format of this file is

<transport> <listenerName> <subjectName>

Item Description
<transport> The name of the transport for this RVCM listener.
If you are using the deprecated topic properties and
configuration settings for communicating with
TIBCO Rendezvous, then do not specify the
transport name here. For more information about the
deprecated method of exporting to RVCM, TIBCO
Rendezvous Parameters—Deprecated on page 132,
and Deprecated Properties on page 32.

<listenerName> The name of the RVCM listener to which topic

messages are to be exported.

<subjectName> The RVCM subject name that messages are

published to. This should be the same name as the
topic names that specify the export property.

Example
RVCM01 listener1 foo.bar
RVCM01 listener2 foo.bar.bar

durables
This file defines static durable subscribers.
The file consists of lines with either of these formats:
<topic-name> <durable-name>
<topic-name> <durable-name> <properties>

Item Description
<topic-name> The topic of the durable subscription.

<durable-name> The name of the durable subscriber.

<properties> A list of properties, separate by commas. Property

names and values are described below.

TIBCO Enterprise Message Service User’s Guide

144
| Chapter 7 Using the Configuration Files

Item Description
Durable Subscriber Properties

route When present, the subscriber is another server, and

the <durable-name> is the name of that server.
When this property is present, no other properties
are permitted.

clientid=<id> The client ID of the subscriber’s connection.

nolocal When present, the subscriber does not receive

messages published from its own connection.

selector="<sel>" When present, this selector narrows the set of

messages that the durable subscriber receives.

Examples topic1 dName1

topic2 dName2 clientid=myId,nonlocal
topic3 dName3 selector="urgency in (’high,’medium’)"
topic4 Paris route

Conflicting When the server detects an conflict between durable subscribers, it maintains the
Specifications earliest specification, and outputs a warning. Consider these examples:
• A static specification in this file takes precedence over a new durable
dynamically created by a client.
• An existing durable dynamically created by a client takes precedence over a
new static durable defined by an administrator.
• A static durable subscription takes precedence over a client attempting to
dynamically unsubscribe (from the same topic and durable name).

Conflict can also arise because of wildcards. For example, if a client dynamically
creates a durable subscriber for topic foo.*, and an administrator later attempts
to define a static durable for topic foo.1, then the server detects this conflict and
warns the administrator.

Configuration To configure durable subscriptions in this file, we recommend using the

tibemsadmin tool; see create durable on page 153.

If the create durable command detects an existing dynamic durable

subscription with the same topic and name, it promotes it to a static subscription,
and writes a specification to the file durables.conf.

TIBCO Enterprise Message Service User’s Guide

 | 145

Chapter 8 Using the Administration Tool

This chapter gives an overview of commands and use in the administration tool
for TIBCO Enterprise Message Service.

Topics

• Starting the Administration Tool, page 146

• Naming Conventions, page 150
• Command Listing, page 151

TIBCO Enterprise Message Service User’s Guide

146
| Chapter 8 Using the Administration Tool

Starting the Administration Tool

The administration tool is located in your <installation_path> /bin directory and is a

stand-alone executable named tibemsadmin on Unix and tibemsadmin.exe on
Windows platforms.
Type tibemsadmin -help to display information about tibemsadmin startup
parameters. All tibemsadmin parameters are optional.

TIBCO Enterprise Message Service User’s Guide

 Starting the Administration Tool 147
|

Table 17 lists options for tibemsadmin.

Table 17 tibemsadmin Options (Sheet 1 of 2)

Option Description
-help or -h Print the help screen.

-script <script-file> Execute the specified text file containing

tibemsadmin commands then quit. Any valid
tibemsadmin command described in this
chapter can be executed.
Line breaks within the file delimit each
command. That is, every command must be
contained on a single line (no line breaks
within the command), and each command is
separated by a line break.

-server <server-url> Connect to specified server.

-user <user-name> Use this user name to connect to server.

-password <password> Use this password to connect to server.

-ignore Ignore errors when executing script file. This

parameter only ignores errors in command
execution but not syntax errors in the script.

-mangle [password] Mangle the password and quit. Mangled string

in the output can be set as a value of server
password or server SSL password in the server
configuration file. If the password is not
entered it is prompted for.

-ssl_trusted <filename> File containing trusted certificate(s). This

parameter may be entered more than once if
required.

-ssl_identity <filename> File containing client certificate and

(optionally) extra issuer certificate(s), and the
private key.

-ssl_issuer <filename> File containing extra issuer certificate(s) for

client-side identity.

TIBCO Enterprise Message Service User’s Guide

148
| Chapter 8 Using the Administration Tool

Table 17 tibemsadmin Options (Sheet 2 of 2)

Option Description
-ssl_password <password> Private key or PKCS#12 password. If the
password is required, but has not been
specified, it will be prompted for.

-ssl_noverifyhostname Do not verify hostname against the name on

the certificate.

-ssl_hostname <name> Name expected in the certificate sent by the

host.

-ssl_trace Show loaded certificates and certificates sent

by the host.

-ssl_debug_trace Show additional tracing, which is useful for

debugging.

-user and -password parameters are used only when -server is specified. If
-user and -server are not specified and the server requires administrator
authentication, the command-line tool prompts the user to enter the name and
password.
Notice that user name and password provided in the command line is only used
to connect to the server specified in the same command line, otherwise they are
ignored. The user name and password entered on one command line are not used
with subsequent connect commands entered in the script file or interactively.

Examples
tibemsadmin -server "tcp://myhost:7222"
tibemsadmin -server "tcp://myhost:7222" -user admin -password
secret

Some options are needed when you choose to make a SSL connection. For more
information on SSL connections, refer to Chapter 12, Using the SSL Protocol,
page 241.

When You First Start tibemsadmin

The administration tool has a default user with the name admin. This is the
default user for logging in to the administration tool.

TIBCO Enterprise Message Service User’s Guide

 Starting the Administration Tool 149
|

To protect access to the server configuration, you should assign a password to the
user admin.

To assign a password to admin:

1. Log in and connect to the administration tool, as described directly above.
2. Change the password by entering:
set password admin <password>

When you restart the administration tool and type connect, the administration
tool now requires your password before connecting to the server.
For further information about setting and resetting passwords, refer to set
password on page 166.

TIBCO Enterprise Message Service User’s Guide

150
| Chapter 8 Using the Administration Tool

Naming Conventions

When naming users, topics, queues or groups:

• $ cannot be used at the beginning of the name.
• _ at the beginning of the name is reserved for system use.
• Spaces can be used in a description field, if the entire description field is
enclosed in double quotes as follows:
"description field"

• Both * and > are wildcards, and cannot be used in names except as wildcards
• The dot separates elements within a destination name (foo.bar.*) and can
only be used for that purpose.
For more information on the use of wildcards, see Wildcards on page 39.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 151
|

Command Listing

The command line interface of the administration tool allows you to perform a
variety of functions.

Note that SSL commands are not listed in this table. SSL commands are listed in
several tables in Chapter 12, Using the SSL Protocol, on page 241.

The following is an alphabetical listing of the commands including command

syntax and a description of each command.

add member add member <group_name> <user_name> [,<user2>,<user3>,...]

Add one or more users to the group.

addprop factory addprop factory <factory-name> <properties ...>

Adds properties to the factory. Property names are separated by spaces.

Factory properties are url= <url-string>, clientID = <client-id> and SSL
parameters.
An example is:
addprop factory MyTopicFactory ssl_trusted=cert1.pem
ssl_trusted=cert2.pem ssl_verify_host=disabled

For descriptions of factory parameters, see factories on page 140.

For SSL parameters, see Table 33 on page 255.

addprop queue addprop queue <queue-name> <properties,...>

Adds properties to the queue. Property names are separated by commas.

addprop route addprop route <route-name> prop=value[ prop-value...]

Route properties are url=<url-string> and SSL parameters.
Note that destination (topic and queue) properties must be separated by commas
but properties of routes and factories are separated with spaces.
You can set the zone_name and zone_type parameters when creating a route, but
you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones on page 286.
For the configuration file routes.conf, see routes on page 139.

addprop topic addprop topic <topic_name> <properties,...>

TIBCO Enterprise Message Service User’s Guide

152
| Chapter 8 Using the Administration Tool

Adds properties to the topic. Property names are separated by commas.

autocommit autocommit [on|off]

When autocommit is set to on, each command causes the change the command
made to the configuration files to be saved automatically. When autocommit is
set to off, you must manually use the commit command to save configuration
changes to the disk.
By default, autocommit is set to on when interactively issuing commands. If you
are running a script, the entire script must complete without errors (or the ignore
parameter can be specified to ignore errors) for the commit to occur. If there are
errors in the script, and the ignore parameter is not specified, the administration
tool immediately stops the script after the first error and does NOT perform the
implicit commit.
Entering autocommit without parameters displays the current setting of
autocommit (on or off).

commit commit

Commits all configuration changes into files on disk.

compact compact <store_type> [ <max_time> ]

Compacts the database store files.
• To compact the asynchronous file, specify either a, async, or asynchronous.
• To compact the synchronous file, specify either s, sync, or synchronous.

Since compaction can be a lengthy operation, and it blocks other database

operations, you may specify a time limit (in seconds). Zero is a special value,
which specifies no time limit. When the time limit is absent, the default is zero,
and the administration tool asks for confirmation.
We recommend compacting the database store files only when the database
Used Space usage is 30% or less (see show db on page 171).

connect connect [ <server-url> <admin user name> <password> ]

Connects the administration tool to the server. Any administrator can connect. An
administrator is either the admin user, any user in the $admin group, or any user
that has administrator permissions enabled. See Administrator Permissions on
page 197 for more information about administrator permissions.
<server-url> is usually in the form
<protocol>://<host-name>:<port-number>

for example:
tcp://myhost:7222

TIBCO Enterprise Message Service User’s Guide

 Command Listing 153
|

The protocol can be tcp or ssl.

If a user name or password are not provided, the user is prompted to enter a user
name and password, or only the password, if the user name was already specified
in the command.
You can enter connect with no other options and the administrative tool tries to
connect to the local server on the default port, which is 7222.

create durable create durable <topic-name> <durable-name> [<property>, ... ,<property>]

For descriptions of parameters and properties, and information about conflict
situations, see durables on page 143.

create factory create factory factory-name type [URL=url] [clientID=client_id]

[metric=metric] ssl-properties

Creates a new connection factory.

For descriptions of factory parameters, see factories on page 140.
For SSL parameters, see Table 33 on page 255.

create group create group <group-name> [<group-description>]

Creates a new group. See Naming Conventions on page 150.

create jndiname create jndiname <new-jndiname> <topic|queue|jndiname> <name>

Creates a JNDI name for a topic or queue, or creates an alternate JNDI name for a
topic that already has a JNDI name.
For example:
create FOO jndiname BAR

will create new JNDI name FOO referring the same object referred by JNDI name
BAR

create queue create queue <queue-name> [<properties>]

Creates a queue with the specified name and properties. See Naming
Conventions on page 150
Optional queue properties are:
• failsafe

• secure

• global

• maxRedelivery

• exclusive

TIBCO Enterprise Message Service User’s Guide

154
| Chapter 8 Using the Administration Tool

• import
• flowControl

• trace[=body]

• tibrv_import (deprecated)
• tibrvcm_import (deprecated)
• maxBytes=<number>

• preFetch=<number>

• expiration=<time>

See Destination Properties on page 32.

create route create route <name> url=<URL> [<properties ...>]

Creates a route with a name and URL for the destination server (though not
necessarily the destination client). The URL can be specified as a
comma-separated list of URLs, if you have configured fault-tolerant servers.
The name is the name of the route.
Multiple properties can be specified in a space-separated list.
You can set the zone_name and zone_type parameters when creating a route, but
you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones on page 286.
For the configuration file routes.conf, see routes on page 139.

create create rvcmlistener [<transportName>] <name> <subject>

rvcmlistener
Registers an RVCM listener with the server so that any messages forwarded
through a tibrvcm transport (including the first message sent) are guaranteed for
the specified listener. This causes the server to perform the TIBCO Rendezvous
call tibrvcmTransport_AddListener.
You can optionally specify a transport name to which this RVCM listener applies.
If no transport name is specified, the listener is assumed to be for the default
RVCM transport.
For more information, see Rendezvous Certified Messaging (RVCM) Parameters
on page 70.

create topic create topic <topic-name> [<properties>]

Creates a topic with specified name and properties. See Naming Conventions on
page 150
Optional topic properties are:

TIBCO Enterprise Message Service User’s Guide

 Command Listing 155
|

• failsafe

• secure

• global

• import

• export

• flowControl

• trace[=body]

• tibrv_import (deprecated)
• tibrvcm_import (deprecated)
• tibrv_export (deprecated)
• tibrvcm_export (deprecated)
• maxbytes=<number>

• expiration=<time>

See Destination Properties on page 32.

create user create user <user-name> [<user-description>][password=<password>]

Creates a new user. The password is optional, and can be left empty in this
command. If the password is not specified in this command, it can be added later
using the set password command.
See Naming Conventions on page 150.

delete all delete all <users|groups|topics|queues|durables>

[<topic-name-pattern>|<queue-name-pattern>]

If used as delete all <users|groups|topics|queues|durables> without the

optional parameters, the command deletes all users, groups, topics, or queues (as
chosen).
If used with a topic or queue, and the optional parameters, such as:
delete all <topics|queues> <topic-name-pattern>|<queue-name-pattern>

the command deletes all topics and queues that match the topic or queue name
pattern.

delete delete connection <connection-id>

connection
Deletes the named connection for the client. The connection ID is shown in the
first column of the connection description printed by show connection.

delete durable delete durable <durable-name>

TIBCO Enterprise Message Service User’s Guide

156
| Chapter 8 Using the Administration Tool

Deletes a durable subscriber.

See also, Conflicting Specifications on page 144.

delete factory delete factory <factory-name>

Deletes a factory.

delete group delete group <group-name>

Deletes a group.

delete jndiname delete jndiname <jndiname>

Deletes a jndiname. Notice that deleting the last JNDIname of a connection

factory object will remove the connection factory object as well.

delete message delete message <messageID>

Deletes the message with the specified message ID.

delete queue delete queue <queue-name>

Deletes a queue.

delete route delete route <route-name>

Deletes a route.

delete delete rvcmlistener [<transport>] <name> <subject>

rvcmlistener
Unregisters an RVCM listener with the server so that any messages being held for
the specified listener in the RVCM ledger are released. This causes the server to
perform the TIBCO Rendezvous call tibrvcmTransport_RemoveListener.
You can optionally specify a transport name from which this RVCM listener
should be deleted. If no transport name is specified, the listener is assumed to be
for the default RVCM transport.
For more information, see Rendezvous Certified Messaging (RVCM) Parameters
on page 70.

delete topic delete topic <topic-name>

Deletes a topic with specified name.

delete user delete user <user-name>

Deletes a user.

disconnect disconnect

TIBCO Enterprise Message Service User’s Guide

 Command Listing 157
|

Disconnects the administrative tool from the server.

echo echo [on|off]

Echo controls the reports that are printed into the standard output. When echo is
off the administrative tool only prints errors and the output of queries. When
echo is on, the administrative tool report also contains a record of successful
command execution.
Choosing the parameter on or off in this command controls echo. If echo is
entered in the command line without a parameter, it displays the current echo
setting (on or off). This command is used primarily for scripts.
The default setting for echo is on.

exit exit (aliases: quit, q, bye, end)

Exits the administration tool.

The administrator may choose the exit command when there are changes in the
configuration have which have not been committed to disk. In this case, the
system will prompt the administrator to use the commit command before exiting.

grant queue grant queue <queue> <user-name>|<group-name> <permissions>

Grants specified permissions to specified user or group on specified queue. The

name following the topic name is first checked to be a group name, then a user
name.
Specified permissions are added to any existing permissions. Multiple
permissions are separated by commas. Enter all in the <permissions> string if
you choose to grant all possible user permissions.
Optional user permissions are:
• receive

• send

• browse

Destination-level administrator permissions can also be granted with this

command. The following are administrator permissions for queues.
• view

• create

• delete

• modify

• purge

TIBCO Enterprise Message Service User’s Guide

158
| Chapter 8 Using the Administration Tool

For more information, see Chapter 9, Authentication and Permissions, on

page 179.

grant topic grant topic <topic> <user-name>|<group-name> <permissions>

Grants specified permissions to specified user or group on specified topic. The

name following the topic name is first checked to be a group name, then a user
name.
Specified permissions are added to any existing permissions. Multiple
permissions are separated by commas. Enter all in the <permissions> string if
you choose to grant all possible permissions.
Optional topic permissions are:
• subscribe

• publish

• durable

Destination-level administrator permissions can also be granted with this

command. The following are administrator permissions for topics.
• view

• create

• delete

• modify

• purge

For more information, see Chapter 9, Authentication and Permissions, on

page 179.

grant admin grant admin <group-name | user-name> <admin permissions>

Grants the specified global administrator permissions to the specified user or
group. For a complete listing of global administrator permissions, see Chapter 9,
Authentication and Permissions, on page 179.

help help (aliases: h, ?)

Usage help.
Enter help commands for a command summary.
Enter help <command> for help on a specific command.

info info (alias: i)

Shows server name and information about the connected server.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 159
|
purge all queues purge all queues [<pattern>]

When used without the optional pattern parameter, this command erases all
messages in all queues for all receivers.
When used with the pattern parameter, this command erases all messages in all
queues that fit the pattern (for example: foo.*).

purge all topics purge all topics [<pattern>]

When used without the optional pattern parameter, this command erases all
messages in all topics for all subscribers.
When used with the pattern parameter, this command erases all messages in all
topics that fit the pattern (for example: foo.*).

purge durable purge <durable-name>

Erases all messages in the topic for a specified durable subscriber

purge queue purge <queue>

Erases all messages in the queue.

purge topic purge topic <durable-name>

Erases all messages in the topic.

remove member remove member <group-name> <user-name>[,<user2>,<user3>,...]

Removes one or more users from a group.

removeprop removeprop factory <factory-name> <properties>

factory
Removes properties from a factory.

removeprop removeprop queue <queue-name> <properties>

queue
Removes properties from a queue.

removeprop removeprop route <route-name> <properties>

route
Removes properties from a route.
You cannot remove topic selectors.
You can set the zone_name and zone_type parameters when creating a route, but
you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones on page 286.
For the configuration file routes.conf, see routes on page 139.

TIBCO Enterprise Message Service User’s Guide

160
| Chapter 8 Using the Administration Tool

removeprop removeprop topic <topic-name> <properties>

topic
Removes properties from a topic.

revoke admin revoke admin <user> <permissions>

Revokes the specified global administrator permissions from the specified user.
See Chapter 9, Authentication and Permissions, on page 179 for more information
about administrator permissions.

revoke queue revoke queue <queue> <user-name>|<group-name> [<permissions>]

If used as revoke queue <queue-name> without the optional parameters, the

command revokes all permissions for the specified queue.
Revokes specified permissions from a user or group in a specified queue. The
name following the queue name is first checked to be a group name, then a user
name. If you specify an asterisk (*), all permissions on this queue are removed.
User permissions for queues are receive, send, browse, and all.
Administrator permissions for queues are view, create, delete, modify, and
purge.

For more information, see Chapter 9, Authentication and Permissions, on

page 179.

revoke topic revoke topic <topic-name> [<user-name>|<group-name> <permissions>]

If used as revoke topic <topic-name> without the optional parameters, the

command revokes all permissions for the specified topic.
When used with the optional parameters, the command revokes specified
permissions from a user or group on specified topic. The name following the topic
name is first checked to be a group name, then a user name. If you specify an
asterisk (*), all permissions on this queue are removed.
Permissions for topics are subscribe, publish, durable, and all.
Administrator permissions for topics are view, create, delete, modify, and
purge.

For more information, see Chapter 9, Authentication and Permissions, on

page 179.

rotatelog rotatelog

Forces the current log file to be backed up and truncated. All entries in the current
log file are purged, and the server then starts writing entries to the newly empty
log file.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 161
|

The backup file name is the same as the current log file name with a sequence
number appended to the filename. The server queries the current log file
directory and determines what the highest sequence number is, then chooses the
next highest sequence number for the new backup name. For example, if the log
file name is tibems.log and there is already a tibems.log.1 and tibems.log.2,
the server names the next backup tibems.log.3.

set server set server <parameter=value> [<parameter=value> ...]

The set server command can control many parameters. Multiple parameters
are separated by spaces. Table 18 describes the parameters you can set with this
command.

Table 18 Set server parameters (Sheet 1 of 6)

Parameter Description
password[=string] Sets server password used by the server to
connect to other routed servers. If the value is
omitted it is prompted for by the
administration tool. Entered value will be
stored in the main server configuration file in
mangled form (but not encrypted).
Enter empty string twice when prompted to
reset password.

authorization=<enabled|disabled> Sets authorization mode to enabled or

disabled. When enabled it does not affect
already connected EMS clients, whether they
are producers or consumers. However, when
authorization is enabled, it will immediately
apply to all new requests.

TIBCO Enterprise Message Service User’s Guide

162
| Chapter 8 Using the Administration Tool

Table 18 Set server parameters (Sheet 2 of 6)

Parameter Description
log_trace=<trace-items> Sets the trace preference on the file defined by
the logFile parameter. If logFile is not set,
the values are stored but have no effect.
The value of this parameter can include names
of trace subjects, possibly prepended with '+' or
'-' sign. The '+' sign means add item to the
current set of trace items, the '-' sign means
remove tracing on that item. If any item has no
'+' or '-' sign then it entirely replaces current
trace settings. List of items can include names:
INFO, WARNING, ACL, LIMITS, SSL,
SSL_DEBUG, ROUTE,ROUTE_DEBUG,
CONNECT, CONNECT_ERROR,
PRODCONS, DEST, TX, LDAP_DEBUG, MSG,
AUTH, FLOW, ADMIN and RVADV.
The special name 'DEFAULT' means the
default set of trace items which consists of:
INFO, WARNING, ACL, LIMITS, ROUTE,
ADMIN, CONNECT_ERROR, MSG, and
RVADV.
See Table 28, Server tracing options, on
page 209 for more information about trace
options.

Examples
log_trace=ACL

sets the trace to only show messages about

rejecting client requests because of permissions
violation.
log_trace=DEFAULT,-ADMIN,+SSL

shows all default messages except ADMIN

messages and also show SSL tracing.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 163
|
Table 18 Set server parameters (Sheet 3 of 6)

Parameter Description
console_trace=<console-trace-items> Sets the trace preference on the stderr output.
The values are the same as in log_trace
parameters. This set of trace applies to the
output on the console regardless if logFile is
set or not.
That is, if logFile if defined then output into
the console can be removed by specifying:
console_trace=-DEFAULT

Notice that important error messages and some

others are printed in the server console
regardless of trace settings.

client_trace={enabled | disabled} Administrators can trace a connection or group

[target=<location>] [<filter>=<value>] of connections. When this property is enabled,
the server generates trace output for opening
or closing a connection, message activity, and
transaction activity. This type of tracing does
not require restarting the client program.
The server sends trace output to <location>,
which may be either stderr (the default) or
stdout.

You can specify a filter to selectively trace

specific connections. The <filter> can be user,
connid or clientid. The <value> can be a user
name or ID (as appropriate to the filter).
When the filter and value clause is absent, the
default behavior is to trace all connections.

TIBCO Enterprise Message Service User’s Guide

164
| Chapter 8 Using the Administration Tool

Table 18 Set server parameters (Sheet 4 of 6)

Parameter Description
max_msg_memory=<value> Maximum memory the server can use for
messages. This parameter allows you to limit
the amount of memory used by the server for
messages so that the server memory usage
does not grow beyond the system’s memory
capacity.
See the description of the max_msg_memory
parameter in Table 16 on page 106 for a
complete description.
You can set this parameter to 0 to specify no
limit. Use KB, MB, or GB units.
Lowering this value will not immediately free
memory occupied by messages.

track_message_ids=<enabled|disabled> Enables or disables tracking messages by

MessageID.

track_correlation_ids=<enabled|disabled> Enables or disables tracking messages by

CorrelationID.

ssl_password[=string] This sets a password for SSL use only.

Sets private key or PKCS#12 file password
used by the server to decrypt the content of the
server identity file. Password stored in
mangled form.

ft_ssl_password[=string] This sets a password for SSL use with Fault

Tolerance.
Sets private key or PKCS#12 file password
used by the server to decrypt the content of the
FT identity file. Password stored in mangled
form.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 165
|
Table 18 Set server parameters (Sheet 5 of 6)

Parameter Description
server_rate_interval=<num> Sets the interval (in seconds) over which
overall server statistics are averaged. This
parameter can be set to any positive integer
greater than zero.
Overall server statistics are always gathered, so
this parameter cannot be set to zero. By default,
this parameter is set to 1.
Setting this parameter allows you to average
message rates and message size over the
specified interval.

statistics=<enabled | disabled> Enables or disables statistic gathering for

producers, consumers, destinations, and
routes. By default this parameter is set to
disabled.
Disabling statistic gathering resets the total
statistics for each object to zero.

rate_interval=<num> Sets the interval (in seconds) over which

statistics for routes, destinations, producers,
and consumers are averaged. By default, this
parameter is set to 3 seconds. Setting this
parameter to zero disables the average
calculation.

detailed_statistics = < NONE | Specifies which objects should have detailed

PRODUCERS,CONSUMERS,ROUTES>
statistic tracking. Detailed statistic tracking is
only appropriate for routes, producers that
specify no destination, or consumers that
specify wildcard destinations. When detailed
tracking is enabled, statistics for each
destination are kept for the object.
Setting this parameter to NONE disabled
detailed statistic tracking. You can specify any
combination of PRODUCERS, CONSUMERS,
or ROUTES to enable tracking for each object.
If you specify more than one type of detailed
tracking, separate each item with a comma.

TIBCO Enterprise Message Service User’s Guide

166
| Chapter 8 Using the Administration Tool

Table 18 Set server parameters (Sheet 6 of 6)

Parameter Description
statistics_cleanup_interval=<num> Specifies how long (in seconds) the server
should keep detailed statistics if the destination
has no activity. This is useful for controlling the
amount of memory used by detailed statistic
tracking. When the specified interval is
reached, statistics for destinations with no
activity are deleted.

max_stat_memory=<num> Specifies the maximum amount of memory to

use for detailed statistic gathering. If no units
are specified, the amount is in bytes, otherwise
you can specify the amount using KB, MB, or
GB as the units.
Once the maximum memory limit is reached,
the server stops collecting detailed statistics. If
statistics are deleted and memory becomes
available, the server resumes detailed statistic
gathering.

set password set password <user-name> [<password>]

Sets the password for a user. If a password is not provided in the command, the
system prompts you to enter it. It is not necessary to have a password. The
administrator can press enter when asked for a password.
To reset a password, type:
set password <user-name>

The administrative tool prompts for a password. A new password can be entered
at this time.
If the user presses enter at each password prompt, without entering any text,
then that user will not have a password.
In setting passwords, as in other commands, you must use the commit command
to save the changes to the configuration file.

setprop factory setprop factory <factory-name> <properties ...>

Sets the properties for a factory, overriding any existing properties. Multiple
properties are separated by spaces.

setprop queue setprop queue <queue-name> <properties, ...>

TIBCO Enterprise Message Service User’s Guide

 Command Listing 167
|

Sets the properties for a queue, overriding any existing properties. Multiple
properties are separated by commas.

setprop route setprop route <route-name> <properties ...>

Sets the properties for a route, overriding any existing properties. Topic and
queue names are separated by commas. Multiple properties are separated by
spaces.
You can set the zone_name and zone_type parameters when creating a route, but
you cannot subsequently change them.
For route parameters, see Configuring Routes and Zones on page 286.
For the configuration file routes.conf, see routes on page 139.

setprop topic setprop topic <topic-name> <properties>

Sets topic properties overriding any existing properties. Multiple properties are
separated by commas.

show bridge show bridge <topic | queue> <name>

Displays information about the configured bridges for the specified topic or
queue. The following is example output for this command:
Target Name Type Selector
queue.dest Q
topic.dest.1 T "urgency in ('high', 'medium')"
topic.dest.2 T

The names of the destinations to which the specified destination has configured
bridges are listed in the Target Name column. The type and the message selector
(if one is defined) for the bridge are listed in the Type and Selector column.

show bridges show bridges [type=<topic | queue>] [<pattern>]

Shows a summary of the destination bridges that are currently configured. The
type option specifies the type of destination. For example, show bridges topic
shows a summary of configured bridges for all topics. The pattern specifies a
pattern to match for destination names. For example show bridges foo.*
returns a summary of configured bridges for all destinations that match the name
foo.*. The type and pattern are optional.

The following is example output for this command:

Source Name Queue Targets Topic Targets
Q queue.source 1 1
T topic.source 1 2

TIBCO Enterprise Message Service User’s Guide

168
| Chapter 8 Using the Administration Tool

Destinations that match the specified pattern and/or type are listed in the Source
Name column. The number of bridges to queues for each destination is listed in
the Queue Targets column. The number of bridges to topics for each destination is
listed in the Topic Targets column.

show config show config

Shows the configuration parameters for the connected server.

show show connections [type=<q|t|s>] [host=<hostname>] [user=<username>]

connections [version] [address]

Shows connections between clients and server. You can optionally specify the
type of connection you would like to display: queue (q), topic (t), or system (s).
You can also optionally specify a hostname or username to display connections for
only the desired host or user. You can optionally specify the version keyword to
display the client’s version.
This command prints a table of information described in Table 19.

Table 19 Show connections table information (Sheet 1 of 3)

Heading Information Contained

L The type of client. Can be one of the following:
• J — Java client
• C — C client
• # — C# client
• - — unknown system connection

Version The TIBCO Enterprise Message Service version of the client.

ID Unique connection ID. Each connection is assigned a unique,

numeric ID that can be used to delete the connection.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 169
|
Table 19 Show connections table information (Sheet 2 of 3)

Heading Information Contained

FSXT Connection type information.
The F column displays whether the connection is fault-tolerant.
• - — not a fault-tolerant connection, that is, this connection
has no alternative URLs
• + — fault-tolerant connection, that is, this connection has
alternative URLs
The S column displays whether the connection is using the SSL
protocol.
• - — connection is not SSL
• + — connection is SSL
• / — the client uses SSL, but connects by way of an external
SSL accelerator to one of the server's TCP ports
The X column displays whether the connection is XA.
• - — connection is not XA
• + — connection is an XA connection
The T column displays the connection type.
• C — generic user connection
• T — user TopicConnection
• Q — user QueueConnection
• A — administrative connection
• R — system connection to another route server
• F — system connection to the fault-tolerant server

S Connection started status, + if started, - if stopped.

Host Connection's host name. (If the name is not available, this
column displays the host’s IP address.)

Address Connection's IP address.

If you supply the keyword address, then the table includes this
column.

TIBCO Enterprise Message Service User’s Guide

170
| Chapter 8 Using the Administration Tool

Table 19 Show connections table information (Sheet 2 of 3)

Heading Information Contained

FSXT Connection type information.
The F column displays whether the connection is fault-tolerant.
• - — not a fault-tolerant connection, that is, this connection
has no alternative URLs
• + — fault-tolerant connection, that is, this connection has
alternative URLs
The S column displays whether the connection is using the SSL
protocol.
• - — connection is not SSL
• + — connection is SSL
• / — the client uses SSL, but connects by way of an external
SSL accelerator to one of the server's TCP ports
The X column displays whether the connection is XA.
• - — connection is not XA
• + — connection is an XA connection
The T column displays the connection type.
• C — generic user connection
• T — user TopicConnection
• Q — user QueueConnection
• A — administrative connection
• R — system connection to another route server
• F — system connection to the fault-tolerant server

S Connection started status, + if started, - if stopped.

Host Connection's host name. (If the name is not available, this
column displays the host’s IP address.)

Address Connection's IP address.

If you supply the keyword address, then the table includes this
column.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 171
|

Table 19 Show connections table information (Sheet 3 of 3)

Heading Information Contained

User Connection user name. If a user name was not provided when
the connection was created, it is assigned the default user name
anonymous.

ClientID Client ID of the connection.

Sess Number of sessions on this connection.

show db show db <store_type>

Print a summary of the server’s databases.
• To summarize only the asynchronous file, specify either a, async, or
asynchronous.

• To summarize only the synchronous file, specify either s, sync, or

synchronous.

• To summarize both files, omit the <store_type> parameter.

show durable show durable <durable-name>

Displays detailed information about the durable subscriber with a particular

name.

show durables show durables [<pattern>]

If a pattern is not entered, this command shows a list of all durable subscribers on
all topics.
If a pattern is entered (for example foo.*) this command shows a list of durable
subscribers on topics that match that pattern.
This command prints a table of information described in Table 20.

Table 20 Show durables table information (Sheet 1 of 2)

Heading Information Contained

Topic Name Name of the topic.
An asterisk preceding this name indicates a dynamic durable
subscriber. Otherwise the subscriber is static (configured by
an administrator).

Durable Full name of the durable subscriber.

TIBCO Enterprise Message Service User’s Guide

172
| Chapter 8 Using the Administration Tool

Table 20 Show durables table information (Sheet 2 of 2)

Heading Information Contained

User Name of the user of this durable subscriber. If the durable
subscriber is currently offline, the value in this column is
offline.

For users defined externally, there is an asterisk in front of

the user name.

Msgs Number of pending messages

Size Total size of pending messages

For more information, see Destination Properties on page 32.

show factory show factory <factory-name>

Shows properties of specified factory.

show factories show factories

Shows all factories

show jndiname show jndiname <jndiname>

Shows the object that the specified name is bound to by the JNDI server.

show jndinames show jndinames [<type>]

The optional parameter <type> can be:

• destination
• topic
• queue
• factory
• topicConnectionFactory
• queueConnectionFactory
When type is specified only JNDI names bound to objects of the specified type are
shown. When type is not specified, all JNDI names are shown.

show group show group <group-name>

Shows group name, description, and number of members in the group.

TIBCO Enterprise Message Service User’s Guide

 Command Listing 173
|

For groups defined externally, there is an asterisk in front of the group name.
Only groups with at least one currently connected user are shown.

show groups show groups

Shows all groups.

For groups defined externally, there is an asterisk in front of the group name.
Only groups with at least one currently connected user are shown.

show members show members <group-name>

Shows all user members of specified group.

show message show message <messageID>

Shows the message for the specified message id.

This command requires that tracking by message ID be turned on using the
track_message_ids configuration parameter.

show messages show messages <correlationID>

Shows the message IDs of all messages with the specified correlation ID set as
JMSCorrelationID message header field. You can display the message for each
ID returned by this command by using the show message <messageID> command.
This command requires that tracking by correlation ID be turned on using the
track_correlation_ids configuration parameter.

show parents show parents <user-name>

Shows the user’s parent groups. This command can help you to understand the
user’s permissions.

show queue show queue <queue-name>

Shows queue properties.

An asterisk (*) appearing before the queue name indicates a temporary queue.
SeeDynamic Queues and Topics on page 30.
For more information, see Destination Properties on page 32.

show queues show queues [<pattern-name>]

If a pattern-name is not entered, this command shows a list of all queues.

If a pattern-name is entered (for example foo.*) this command shows a list of
queues that match that pattern.
A * appearing before the queue name indicates a dynamic queue.

TIBCO Enterprise Message Service User’s Guide

174
| Chapter 8 Using the Administration Tool

This command prints a table of information described in Table 21.

Table 21 Show queues table information

Heading Information Contained
Queue Name Name of the queue. If the name is prefixed with an asterisk
(*), then the queue is temporary or was created dynamically.
Properties of dynamic and temporary queues cannot be
changed.

SNFGXIBCT Prints information on the topic properties in the order

(S)ecure (N)sender_name or sender_name_enforced
(F)ailsafe (G)lobal e(X)clusive (I)mport (B)ridge
(C)flowControl (T)race
The characters in the value section show:
- Property not present
+ Property is present, and was set on the topic itself
* Property is present, and was inherited from another topic
Note that inherited properties cannot be removed.

Pre Prefetch value. if the value is prefixed with an asterisk (*),

then it is inherited from another queue or is the default
value.

Rcvrs Number of currently active receivers

Msgs Number of pending messages

Size Total size of pending messages

For more information, see Destination Properties on page 32.

show route show route <route-name>

Shows the properties (URL and SSL properties) of a route.

show routes show route

Shows the properties (URL and SSL properties) of all created routes.

show show rvcmledger [<subject or wildcard>]

rvcmledger

TIBCO Enterprise Message Service User’s Guide

 Command Listing 175
|

This command is provided for backward compatibility with previous releases and
the previous mechanism for specifying RVCM transports. Use the show
rvcmtransportledger command if you are using the current mechanism for
specifying transports.
Displays the TIBCO Rendezvous certified messaging (RVCM) ledger file entries
for the specified subject. You can specify a subject name, use wildcards to retrieve
all matching subjects, or specify no subject name to retrieve all ledger file entries.
This command performs the RVCM call tibrvcmTransport_ReviewLedger.
See the TIBCO Rendezvous documentation for more information about ledger
files and the format of ledger file entries.

show show rvcmtransportledger <transport> [<subject or wildcard>]

rvcmtransportle
Displays the TIBCO Rendezvous certified messaging (RVCM) ledger file entries
dger
for the specified transport and the specified subject. You can specify a subject
name, use wildcards to retrieve all matching subjects, or specify no subject name
to retrieve all ledger file entries. This command performs the RVCM call
tibrvcmTransport_ReviewLedger.

See the TIBCO Rendezvous documentation for more information about ledger
files and the format of ledger file entries.

show show rvcmlisteners

rvcmlisteners
Shows all RVCM listeners that have been created using the create
rvcmlistener command or by editing the tibrvcm.conf file.

show server show server (aliases: info, i)

Shows server name and information about the connected server.

show stat show stat consumers [topic=<name> | queue=<name>] [user=<name>]

[connection=<id>] [total]
show stat producers [topic=<name> | queue=<name>] [user=<name>]
[connection=<id>] [total]
show stat route [topic=<name> | queue=<name>] [total] [wide]
show stat topic <name> [total] [wide]
show stat queue <name> [total] [wide]

Displays statistics for the specified item. You can display statistics for consumers,
producers, routes, or destinations. Statistic gathering must be enabled for
statistics to be displayed. Also, detailed statistics for each item can be displayed if
detailed statistic tracking is enabled. Averages for inbound/outbound messages
and message size are available if an interval is specified in the rate_interval
configuration parameter.

TIBCO Enterprise Message Service User’s Guide

176
| Chapter 8 Using the Administration Tool

The total keyword specifies that only total number of messages and total
message size for the item should be displayed. The wide keyword displays
inbound and outbound message statistics on the same line.
See Working with Server Statistics on page 220 for a complete description of
statistics and how to enable/disable statistic gathering options.

show topic show topic <topic-name>

Shows topic properties.

An asterisk (*) appearing before the topic name indicates a dynamic topic.
For more information, see Destination Properties on page 32.

show topics show topics [<pattern-name>]

If a pattern-name is not entered, this command shows a list of all topics.

If a pattern-name is entered (for example foo.*) this command shows a list of
topics that match that pattern.
This command prints a table of information described in Table 22.

Table 22 Show topics table information (Sheet 1 of 2)

Heading Information Contained

Topic Name Name of the topic. If the name is prefixed with an asterisk
(*), then the topic is temporary or was created dynamically.
Properties of dynamic and temporary topics cannot be
changed.

SNFGEIBCT Prints information on the topic properties in the order

(S)ecure (N)sender_name or sender_name_enforced
(F)ailsafe (G)lobal (E)xport (I)mport (B)ridge (C)flowControl
(T)race
The characters in the value section show:
- Property not present
+ Property is present, and was set on the topic itself
* Property is present, and was inherited from another topic
Note that inherited properties cannot be removed.

Subs Number of current subscribers on the topic, including

durable subscribers

TIBCO Enterprise Message Service User’s Guide

 Command Listing 177
|
Table 22 Show topics table information (Sheet 2 of 2)

Heading Information Contained

Durs Number of durable subscribers on the topic

Msgs Number of pending messages, including messages to

durable receivers

Size Total size of pending messages

For more information, see Destination Properties on page 32.

show show transactions

transactions
Shows all transactions that were created using the XA interface of the C or Java
clients. Each transaction is displayed on its own line containing the transaction
state followed by the transaction identifier (XID). The transaction state can be one
of the following:
• 'A' — active
• 'E' — ended
• 'R' — rollback only
• 'P' —prepared

show transport show transport <transport>

Displays the configuration for the specified transport defined in

transports.conf.

show transports show transports

Lists all configured transport names in transports.conf.

show user show user <user-name>

Shows user name and description. If no user name is specified, this command
displays the currently logged in user.
For users defined externally, there is an asterisk in front of the user name.

show users show users

Shows all users.

For users defined externally, there is an asterisk in front of the user name. Only
currently connected external users are shown.

showacl group showacl group <group-name>

TIBCO Enterprise Message Service User’s Guide

178
| Chapter 8 Using the Administration Tool

Shows all permissions set for a given group. Shows the group and the set of
permissions.

showacl queue showacl queue <queue-name>

Shows all permissions set for a queue. Lists all entries from the acl file. Each
entry shows the “grantee” (user or group) and the set of permissions.

showacl topic showacl topic <topic-name>

Shows all permissions set for a topic. Lists all entries from the acl file. Each entry
shows the “grantee” (user or group) and the set of permissions.

showacl user showacl user <user-name>

Shows all permissions set for a given user. Shows the user and the set of
permissions.

shutdown shutdown

Shuts down currently connected server.

time time [on | off]

Specifying on places a timestamp before each command’s output. By default, the

timestamp is off.

transaction transaction commit <XID>

commit
Commits the transaction identified by the transaction ID. The transaction must be
in the ended or prepared state. To obtain a transaction ID, issue the show
transactions command, and cut and paste the XID into this command.

transaction transaction rollback <XID>

rollback
Rolls back the transaction identified by the transaction ID. The transaction must
be in the ended, rollback only, or the prepared state. To obtain a transaction ID,
issue the show transactions command, and cut and paste the XID into this
command.

updatecrl updatecrl

Immediately update the server’s certificate revocation list (CRL).

whoami whoami

Alias for the show user command to display the currently logged in user.

TIBCO Enterprise Message Service User’s Guide

 | 179

Chapter 9 Authentication and Permissions

You can create users and assign passwords to the users to control access to the
TIBCO Enterprise Message Service server. TIBCO Enterprise Message Service can
also be configured to use an external directory, such as an LDAP server or the
UNIX system password file, to control access to the server.
You can also assign permissions to users and groups to control actions that can be
performed on destinations.
This chapter describes authentication and permissions in TIBCO Enterprise
Message Service.

Topics

• Overview of Users, Groups, and Permissions, page 180

• Enabling Access Control, page 183
• Users and Groups, page 185
• Setting Permissions, page 191
• Revoking Permissions, page 194
• When Permissions Are Checked, page 195
• Administrator Permissions, page 197

TIBCO Enterprise Message Service User’s Guide

180
| Chapter 9 Authentication and Permissions

Overview of Users, Groups, and Permissions

TIBCO Enterprise Message Service allows you to control access to the server by
creating users and assigning passwords. The server can also authenticate users
defined in an external directory, such as an LDAP server or the UNIX system
password file.
Permissions apply to the activities a user can perform on each destination (topic
and queue). Using permissions you can control which users have permission to
send, receive, or browse messages for queues. You can also control who can
publish or subscribe to topics, or who can create durable subscriptions to topics.
Permissions are stored in the access control list for the server.
Groups allow you to create classes of users and control permissions on a more
global level. Rather than granting and revoking permissions on destinations to
individual users, you can control destination access at the group level. Users
inherit any permissions from each of the groups they belong to, in addition to any
permissions that are granted to them directly. Group information can also be
retrieved from an external directory, such as an LDAP server.

Permissions for all users and groups must be defined in the access control list for
the TIBCO Enterprise Message Service server. See Users and Groups on page 185
for more information about using an external directory service for authenticating
users. See Setting Permissions on page 191 for more information about
permissions.

There are also administrator permissions that allow administrators to control

which actions users can perform on the server such as create destinations, modify
users, and view routes. Administrator permissions can apply globally, or they can
be granted on specific destinations.
Figure 14 illustrates the relationships between users, groups and permissions.

TIBCO Enterprise Message Service User’s Guide

 Overview of Users, Groups, and Permissions 181
|

Figure 14 Users, groups, and permissions

TIBCO Enterprise for EMS Server Local Configuration

Access Control List

Users

chris topic=check.request
pat user=chris
ryan perm=publish, subscribe

topic=purchase.order Destinations
group=accounting
perm=publish,subscribe Topics:
Groups check.request
Accounting: topic=all.news purchase.order
chris group=employees
pat perm=subscribe
ryan

External Directory

Users Groups
Employees:
gale
gale
jean
jean
perry
perry

Externally-configured users and groups are defined and managed using the
external directory. Locally-configured users and groups, as well as the access
control list, are configured using any of the administration interfaces (editing
configuration files, using the administration tool, or the administration API).

Access control and Secure Sockets Layer (SSL) have some similar characteristics.
SSL allows for servers to require user authentication by way of the user’s digital
certificate. SSL does not, however, specify any access control at the destination
level. SSL and the access control features described in this chapter can be used
together or separately to ensure secure access to your system. See Chapter 12,
Using the SSL Protocol, on page 241 for more information about SSL.

TIBCO Enterprise Message Service User’s Guide

182
| Chapter 9 Authentication and Permissions

Setting Up Access Control

The following procedure describes the general process for configuring users,
groups, and permissions and where to find more information on performing each
step.
1. Enable access control for the system. See Enabling Access Control on
page 183.
2. Optionally enable an external directory for storing users and group
information. See Configuring an External Directory on page 186.
3. Determine the names of the authorized users of the system and create
usernames and passwords for these users. See Users and Groups on page 185.
4. Optionally, set up groups and assign users to groups. See Users and Groups
on page 185.
5. Determine which users need administration permissions, and decide whether
administrators can perform actions globally or whether their actions should
only be permitted on certain destinations. See Administrator Permissions on
page 197 for more information.
6. Determine which destinations require access control, and enable access
control for those destinations. See Destination Control on page 183.
7. Create the access control list by granting specific permissions to users (or
groups) for destinations that need to be secure. See Setting Permissions on
page 191.

TIBCO Enterprise Message Service User’s Guide

 Enabling Access Control 183
|

Enabling Access Control

Administrators can enable or disable access control for the server. Administrators
can also enable and disable permission checking for specific destinations.

Server Control
The authorization property in the main configuration file enables or disables
the checking of permissions for all destinations managed by the server. The
authorization property also enables or disables verification of user names and
passwords.
When authorization is turned off, any connection to the server is granted and no
permissions are checked when a client accesses a destination (for example,
publishing a message to a topic). When authorization is turned on, only
connections from valid users supplying the correct password for that username
are allowed. Also, any permissions defined for users on destinations are checked
when authorization is enabled (provided the destination has enabled permission
checking).
You can enable authorization by editing tibemsd.conf and setting the
authorization property to enabled and restarting the server. You can also use the
tibemsadmin tool to dynamically enable authorization with the following
command:
set server authorization=enabled

Setting the authorization parameter dynamically applies to new connections only.

Any existing connections are not reauthorized.
The authorization property does not affect administrative security. That is,
administrators must always log in with the correct administration username and
password to perform any administrative function.

Destination Control
If server authorization is enabled, you can control access to individual
destinations by enabling the secure property on the destination. The secure
property, when set on a destination, specifies user permissions should be checked
for that destination when a user attempts to perform an operation on that
destination.

The secure property does not specify SSL-level security. This property only
controls basic authentication and permission verification using unencrypted,
non-secure communication between clients and server.

TIBCO Enterprise Message Service User’s Guide

184
| Chapter 9 Authentication and Permissions

When a topic or a queue does not have the secure property set, any authenticated
user can perform any actions on that topic or queue.
See Destination Properties on page 32 for more information about destination
properties.

TIBCO Enterprise Message Service User’s Guide

 Users and Groups 185
|

Users and Groups

The following sections describe users and groups in TIBCO Enterprise Message
Service.

Users
Users are specific, named IDs that allow you to identify yourself to the server.
When a client logs in, the connect request should be accompanied by a username
and the password associated with the username.

In special cases, you may wish to allow anonymous access to the server. In this
case, a connect request does not have to supply a username or password. To
configure the server to allow anonymous logins, you must create a user named
anonymous and specify no password. Anonymous logins are not permitted unless
the anonymous user exists.
Clients logging in anonymously are only able to perform the actions that the
anonymous user has permission to perform.

There is one predefined user, admin. The administrator user is set up when TIBCO
Enterprise Message Service is installed, and this user performs administrative
tasks, such as creating other users.
You can create and remove users and change passwords by specifying the users in
the users.conf configuration file, using the tibemsadmin tool, or by using the
administration API. For more information about specifying users in the
configuration file, see users on page 134. For more information about specifying
users using the tibemsadmin tool, see Chapter 8, Using the Administration Tool,
on page 145. For more information on the administration API, see TIBCO
Enterprise Message Service Java API Reference included in the online documentation.

Groups
Groups allow you to create classes of users. Groups make access control
administration significantly simpler because you can grant and revoke
permissions to large numbers of users with a single operation on the group. Each
user can belong to as many groups as necessary. A user’s permissions are the
union of the permissions of the groups the user belongs to, in addition to any
permissions granted to the user directly.

TIBCO Enterprise Message Service User’s Guide

186
| Chapter 9 Authentication and Permissions

You can create, remove, or add users to groups by specifying the groups in
groups.conf, using the tibemsadmin tool, or by using the administration API.
For more information about specifying groups in the configuration file, see
groups on page 135. For more information about specifying groups using the
tibemsadmin tool, see Chapter 8, Using the Administration Tool, on page 145. For
more information on the administration API, see TIBCO Enterprise Message Service
Java API Reference included in the online documentation.

Configuring an External Directory

You can configure the TIBCO Enterprise Message Service server to authenticate
users defined in an external directory and/or in the local TIBCO Enterprise
Message Service user configuration file. You can also configure the server to
obtain group information from an external directory and/or from the local server
configuration.

To authenticate users based on the system directory (for example, the UNIX
password file), tibemsd must be run as a user that has authorization to access the
system directory. For example, on UNIX, tibemsd should be run as root or on
Windows, the process must have the “Act as part of the operating system” policy
enabled.
On Windows platforms, the user LocalSystem already has the policy “Act as part
of the Operating System” and is the user that Microsoft recommends whenever a
process needs “Act as part of the Operating System”. To run tibemsd as a service,
you would use the program SRVANY.EXE from the Windows Resource Kit.

External User Authentication

TIBCO Enterprise Message Service can be configured to authenticate users stored
in an external directory server, such as an LDAP server or the UNIX system
password file.

Only users that are stored in an external directory and have passwords can be
authenticated by TIBCO Enterprise Message Service. Users without passwords
cannot be authenticated.

The parameter user_auth in tibemsd.conf controls from where user

information is obtained when the user authenticates to the TIBCO Enterprise
Message Service server. The parameter can have one or more of the following
values:
• local — obtain user authentication information from the local TIBCO
Enterprise Message Service server user configuration.

TIBCO Enterprise Message Service User’s Guide

 Users and Groups 187
|

• system — obtain user authentication information from the UNIX system

password file (this option is available only on UNIX systems).
• ldap — obtain user authentication information from an LDAP directory
server
You can specify one or more of these values for user_auth, each value separated
by a comma. When a user attempts to authenticate, the server attempts to obtain
the authentication information from each of the specified locations in the order it
is specified in the user_auth parameter. If the user can authenticate successfully
using any of the specified sources, the user successfully authenticates to the
TIBCO Enterprise Message Service server.

Group Information
Group information stored in an external directory can also be retrieved by the
TIBCO Enterprise Message Service server. Static and dynamic groups are
supported and you can configure the TIBCO Enterprise Message Service server to
retrieve either or both.

Administration Commands and External Users and Groups

You can perform administrative commands on users and groups that do not exist
in the TIBCO Enterprise Message Service server’s local configuration files. This
allows you to grant and revoke permissions to externally-defined users and
groups or to add externally-defined users to locally-configured groups.

You can only perform administrative commands on users and groups that do not
exist in the local configuration when the configuration parameter user_auth
includes the values ldap or system. If user_auth only specifies the value local,
then the user or group must exist in the local configuration before you can
perform commands on the user or group.

When you attempt to view users and groups using the show user/s or show
group/s commands, any users and groups that exist in external directories have
an asterisk next to their names. Users and groups from external directories will
only appear in the output of these commands in the following situations:
• an externally-defined user successfully authenticates
• a user belonging to an externally-defined group successfully authenticates
• an externally-defined user has been added to a locally-defined group
• permissions on a topic or queue have been granted to an externally-defined
user or group

TIBCO Enterprise Message Service User’s Guide

188
| Chapter 9 Authentication and Permissions

Therefore, not all users and groups defined in the external directory may appear
when the show user/s or show group/s commands are executed. Only the users
and groups that meet the above criteria at the time the command is issued will
appear.
You can create users and groups with the same names as externally-defined users
and groups. If a user or group exists in the server’s configuration and is also
defined externally, the local definition of the user takes precedence.
Locally-defined users and groups will not have an asterisk by their names in the
show user/s or show group/s commands.

You can also issue the delete user or delete group command to delete users
and groups from the local server’s configuration. The permissions assigned to the
user or group are also deleted when the user or group is deleted. If you delete a
user or group that is defined externally, this deletes the user or group from the
server’s memory and deletes any permissions assigned in the access control list,
but it has no effect on the external directory. The externally-defined user can once
again log in, and the user is created in the server’s memory and any groups to
which the user belongs are also created. However, any permissions for the user or
group have been deleted and therefore must be re-granted.

Using LDAP Directory Servers

TIBCO Enterprise Message Service has been tested with the following external
directory servers:
• Netscape/SunOne iPlanet Directory Server version 5.1
• Microsoft Active Directory shipped as part of the Windows 2000 Server
However, you should be able to use any external directory server that is
compliant with LDAP V2.

TIBCO Enterprise Message Service User’s Guide

 Users and Groups 189
|

Table 16, Configuration parameters, on page 106 describes the complete list of
configuration parameters for configuring an external directory server. Table 23
describes parameter settings for default configurations of popular LDAP servers.

Table 23 Default configuration for popular LDAP servers (Sheet 1 of 2)

External
Directory Server Parameter Configuration

iPlanet ldap_principal = cn=Directory Manager

ldap_user_class = Person
ldap_user_attribute = uid
ldap_user_base_dn = ou=people,
o=<your_organization>
ldap_user_filter =
(&(uid=%s)(objectclass=person))

ldap_group_base_dn = "ou=groups,
o=<your_organization>
ldap_group_filter =
(|(&(cn=%s)(objectclass=groupofUniqueNames))(&
(cn=%s)(objectclass=groupOfURLs)))
ldap_static_group_class = groupofuniquenames
ldap_staic_group_attribute = cn
ldap_static_member_attribute = uniquemember
ldap_dynamic_group_class = groupofURLs
ldap_static_group_member_filter =
(&(uniquemember=%s)(objectclass=groupofuniquen
ames))
ldap_dynamic_group_class = groupofURLs
ldap_dynamic_group_attribute = cn
ldap_dynamic_member_url_attribute = memberURL

Active Directory ldap_principal = CN=Administrator, CN=Users,

DC=<your_domain>

ldap_user_class = user
ldap_user_attribute = cn
ldap_user_filter = (&(cn=%s)(objectclass=user))

ldap_group_filter =
(&(cn=%s)(objectclass=group))
ldap_static_group_class = group
ldap_static_group_attribute = cn
ldap_static_member_attribute = member
ldapt_static_group_member_filter =
(&(member=%s)(objectclass=group))

TIBCO Enterprise Message Service User’s Guide

190
| Chapter 9 Authentication and Permissions

Table 23 Default configuration for popular LDAP servers (Sheet 2 of 2)

External
Directory Server Parameter Configuration

Open LDAP ldap_user_class = person

ldap_user_attribute = cn
ldap_user_base_dn = ou=people,
dc=<your_domain_component>, dc=<your_domain_component>
ldap_user_filter = (&(cn=%s)(objectclass=user))

ldap_group_base_dn = ou=groups,
dc=<your_domain_component>, dc=<your_domain_component>
ldap_group_filter =
(&(cn=%s)(objectclass=groupofnames))
ldap_static_group_class = groupofnames
ldap_static_group_attribute = cn
ldap_static_member_attribute = member
ldap_static_group_member_filter =
(&(member=%s)(objectclass=groupofnames))

Novell ldap_user_class = person

ldap_user_attribute = cn
ldap_user_base_dn = ou=people,
o=<your_organization>
ldap_user_filter =
(&(cn=%s)(objectclass=person))
ldap_group_base_dn = ou=groups,
o=<your_organization>
ldap_group_filter =
(&(cn=%s)(objectclass=groupofnames))
ldap_static_group_class = grouponames
ldap_static_group_attribute = cn
ldap_static_member_attribute = uniquemember
ldap_static_group_member_filter =
(&(uniquemember=%s)(objectclass=groupofnames))

TIBCO Enterprise Message Service User’s Guide

 Setting Permissions 191
|

Setting Permissions

Permissions are stored in the access control list and determine the actions a user
can perform on a destination. A user’s permissions are the union of the
permissions granted explicitly to that user along with any permissions the user
receives by belonging to a group.
When granting permissions, you specify the user or group to whom you wish to
grant the permission, the name of the destination, and the permission(s) you wish
to grant. You can grant permissions regardless of whether authorization is
enabled for the server or the destination has the secure property enabled. The
currently granted permissions are stored in the access control file and are only
enforced when the properties for enforcement are enabled.

When setting permissions for users and groups defined externally, user and
group names are case-sensitive. Make sure you use the correct case for the name
when setting the permissions.

Permissions can only be granted by users that have the appropriate administrator
permissions. See Administrator Permissions on page 197 for more information.
You can specify either explicit destination names or wildcard destination names.
See Inheritance of Permissions on page 192 for more information on wildcard
destination names and permissions.
Topics and queues each have associated permissions. Table 24 describes the
permissions specific to queues. Table 25 describes the permissions specific to
queues.

Table 24 Queue Permission

Name Description
receive permission to create queue receivers

send permission to create queue senders

browse permission to create queue browsers

Table 25 Topic Permission (Sheet 1 of 2)

Name Description
subscribe permission to create non-durable subscribers on the topic

TIBCO Enterprise Message Service User’s Guide

192
| Chapter 9 Authentication and Permissions

Table 25 Topic Permission (Sheet 2 of 2)

Name Description
publish permission to publish on the topic

durable permission to create durable subscribers on the topic

You assign permissions either by specifying them in the acl.conf file, using the
tibemsadmin tool, or by using the administration interface. See for more
information about specifying the configuration file. See for more information
about using the tibemsadmin tool. See TIBCO Enterprise Message Service Java API
Reference included in the online documentation for more information on using the
administration API.

Example of Setting Permissions

The user bob has the following permission recorded in the acl.conf file:
USER=bob TOPIC=foo PERM=subscribe,publish

This set of permissions means that bob can subscribe to topic foo and publish
messages to it, but bob cannot create durable subscribers to foo.
If bob is a member of group engineering and the group has the following entry
in the acl file:
GROUP=engineering TOPIC=bar PERM=subscribe,publish

then bob can publish and subscribe to topics foo and bar.
If both the user bob and the group engineering have entries in the acl.conf file,
then bob has permissions that are a union of all permissions set for bob directly
and the permissions of the group engineering.

Inheritance of Permissions
When you grant permissions to users for topics or queues with wildcard
specifications, all created topics and queues that match the specification will have
the same granted permissions as the permissions on the parent topic. If there are
multiple parent topics, the user receives the union of all parent topic permissions
for any child topic. You can add permissions to a user for topics or queues that
match a wildcard specification, but you cannot remove permissions.
For example, you can grant user Bob the browse permission on queue foo.*. The
user Bob receives the browse permission on the foo.bar queue, and you can also
grant Bob the send permission on the foo.bar queue. However, you cannot take
away the inherited browse permission from Bob on the foo.bar queue.

TIBCO Enterprise Message Service User’s Guide

 Setting Permissions 193
|

See Wildcards on page 39 for more information about wildcards in destination

names.

TIBCO Enterprise Message Service User’s Guide

194
| Chapter 9 Authentication and Permissions

Revoking Permissions

You revoke permissions either by removing or editing entries in the acl.conf file,
using the revoke command in tibemsadmin, or by using the administration API.
See Chapter 8, Using the Administration Tool, on page 145 for more information
about tibemsadmin. See TIBCO Enterprise Message Service Java API Reference
included in the online documentation for more information about the
administration API.
Administrators can revoke permissions for users that have created topic
subscriptions or are queue consumers. Once the permission is revoked, the
destination still exists, but the user can no longer perform that operation on the
destination. For example, if the subscribe permission is revoked, the subscription
continues to exist, but the user no longer receives messages for the topic.
You can only revoke a permission that is granted directly. That is, you cannot
revoke a permission from a user that the user receives from a group. Also, you
cannot revoke a permission that is inherited from a parent topic. The revoke
command in tibemsadmin can only remove items from specific entries in the
acl.conf file. The revoke command cannot remove items that are inherited from
other entries.

TIBCO Enterprise Message Service User’s Guide

 When Permissions Are Checked 195
|

When Permissions Are Checked

If permissions are enforced (that is, the authorization configuration property is

set, and the secure property is set for the destination), they are checked when a
user attempts to perform an operation on a destination. For example, create a
subscription to a topic, send a message to a queue, and so on. Permissions can be
granted or revoked dynamically, so permissions are checked each time an
operation is performed on a destination (that is, each time a consumer or
producer is created as well as each time a message is sent or received).
For specific (non-wildcard) destination names, permissions are checked when a
user performs one of the following actions:
• creates a subscription to a topic
• attempts to become a consumer for a queue
• publishes or sends a message to a topic or queue
• receives or consumes a message from a topic or queue.
A user cannot create or send a message to a destination for which he or she has
not explicitly been granted the appropriate permission. So, before creating or
sending messages to the destination, a user must be granted permissions on the
destination.
However, for wildcard topic names (queue consumers cannot specify wildcards),
permissions are not checked when users create non-durable subscriptions.
Therefore, a user can create a subscription to topic foo.* without having explicit
permission to create subscriptions to foo.* or any child topics. This allows
administrators to grant users the desired permissions after the user’s application
creates the subscriptions. You may wish to allow users to subscribe to unspecific
topics, then grant permission to specific topics at a later time. Users are not able to
receive messages based on their wildcard subscriptions until permissions for the
wildcard topic or one or more child topics are granted.

When creating a durable subscriber, users must have the durable permission
explicitly set for the topic they are subscribing to. For example, to create a durable
subscriber to topic foo.*, the user must have been granted the durable
permission to create durable subscriptions for topic foo.*.

Example of Permission Checking

This example walks through a scenario for granting and revoking permissions to
a user, and describes what happens as various operations are performed.

TIBCO Enterprise Message Service User’s Guide

196
| Chapter 9 Authentication and Permissions

1. User bob is working with a TIBCO Enterprise Message Service application

that subscribes to topics and displays any messages sent to those topics.
2. User bob creates a subscription to user.*. This topic is the parent topic of
each user. Messages are periodically sent to each user (for example, messages
are sent to the topic user.bob). Because the same application is used by many
users, the application creates a subscription to the parent topic.
3. User bob creates a subscription to topic corp.news. This operation fails
because bob has not been granted access to that topic yet.
4. A message is sent to the topic user.bob, but the application does not receive
the message because bob has not been granted access to the topic yet.
5. The administrator, as part of the daily maintenance for the application, grants
access to topics for new users. The administrator grants the subscribe
permission to topic user.bob and corp.* to user bob. These grants occur
dynamically, and user bob is now able to receive messages sent to topic
user.bob and can subscribe to topic corp.news.

6. The administrator sends a message on the topic user.bob to notify bob that
access has been granted to all corp.* topics.
7. The application receives the new message on topic user.bob and displays the
message.
8. User bob attempts to create a subscription for topic corp.news and succeeds.
9. A message is sent to topic corp.news. User bob’s application receives this
message and displays it.
10. The administrator notices that bob is a contractor and not an employee, so the
administrator revokes the subscribe permission on topic corp.* to user bob.
The subscription to corp.news still exists for user bob’s application, but no
new messages to the corp.news topic can be received, nor can bob create any
new subscriptions to children of the corp.* topic.

TIBCO Enterprise Message Service User’s Guide

 Administrator Permissions 197
|

Administrator Permissions

Administrators are a special class of users that can manage the TIBCO Enterprise
Message Service server. Administrators create, modify, and delete users,
destinations, routes, factories, and other items. In general, administrators must be
granted permission to perform administration activities when using the
administration tool or API. Administrators can be granted global permissions (for
example, permission to create users or to view all queues), and administrators can
be granted permissions to perform operations on specific destinations (for
example, purging a queue, or viewing properties for a particular topic).

Administrator permissions control what administrators can view and change in

the server only when using the administration tool or API. Administrator
commands create entries in each of the configuration files (for example,
tibemsd.conf, acl.conf, routes.conf, and so on).

You should control access to the configuration files so that only certain system
administrators can view or modify the configuration files. If a user can view or
modify the configuration files, setting permissions to control which destination
that user can manage would not be enforced when the user manually edits the
files.
Use the facilities provided by your Operating System to control access to the
server’s configuration files.

Administrators cannot be defined in an external directory. Administrators must

be created using the administration tool, the administration API, or in the
configuration files.

Predefined Administrative User and Group

There is a special, predefined user named admin that can perform any
administrative action. You cannot grant or revoke any permissions to admin. This
user is created when the server is installed, and you should change the password
for admin shortly after installation. See When You First Start tibemsadmin on
page 148 for more information about changing the admin password.
There is also a special group named $admin for system administrator users. When
a user becomes a member of this group, that user receives the same permissions
as the admin user. You cannot grant or revoke administrator permissions from any
user that is a member of the $admin group. You should only assign the overall
system administrator(s) to the $admin group.

TIBCO Enterprise Message Service User’s Guide

198
| Chapter 9 Authentication and Permissions

Granting and Revoking Administration Permissions

You grant and revoke administrator permissions to users using the grant and
revoke commands in tibemsadmin. You can either grant global administrator
permissions or permissions on specific destinations. See Global Administrator
Permissions on page 199 for a complete list of global administrator permissions.
See Destination-Level Permissions on page 202 for a description of administrator
permissions for destinations.
Global and destination-level permissions are granted and revoked separately
using different administrator commands. See Command Listing on page 151 for
the syntax of the grant and revoke commands.
If a user has both global and destination-level administrator permissions, the
actions that user can perform are determined by combining all global and
destination-level administrator permissions granted to the user. For example, if
an administrator is granted the view-destination permission, that
administrator can view information about all destinations, even if the view
permission is not granted to the administrator for specific destinations.
The admin user or all users in the $admin group can grant or revoke any
administrator permission to any user. All other users must be granted the
change-admin-acl permission and the view-user and/or the view-group
permissions before they can grant or revoke administrator permissions to other
users.
If a user has the change-admin-acl permission, that user can only grant or
revoke permissions that have been granted to the user. For example, if user BOB is
not part of the $admin group and he has only been granted the
change-admin-acl and view-user permissions, BOB cannot grant any
administrator permissions except the view-user or change-admin-acl
permissions to other users.
Users have all administrator permissions that are granted to any group to which
they belong. You can create administrator groups, grant administrator
permissions to those groups, and then add users to each administrator group. The
users will be able to perform any administrative action that is allowed by the
permissions granted to the group to which the user belongs.
Any destination-level permission granted to a user or group for a wildcard
destination is inherited for all child destinations that match the parent
destination.
If protection permissions are set up, administrators can only grant or revoke
permissions to other users that have the same protection permission as the
administrator. See Protection Permissions on page 204 for more information about
protection permissions.

TIBCO Enterprise Message Service User’s Guide

 Administrator Permissions 199
|

Enforcement of Administrator Permissions

An administrator can only perform actions for which the administrator has been
granted permission. Any action that an administrator performs may be limited by
the set of permissions granted to that administrator.
For example, an administrator has been granted the view permission on the
foo.* destination. This administrator has not been granted the global
view-destination permission. The administrator is only able to view
destinations that match the foo.* parent destination. If this administrator is
granted the global view-acl permission, the administrator is only able to view
the access control list for destinations that match the foo.* parent. Any access
control lists for other destinations are not displayed when the administrator
performs the showacl topic or showacl queue commands.
In some cases, enforcement of permissions causes the administrator to see little or
no output for any view administrator commands. An administrator will receive
an error when attempting to view a specific item for which the administrator does
not have permission. For example, if the administrator above issues the showacl
queue command, and there are no queues named foo.*, the command executes
and returns no output. However, if the administrator issues the showacl queue
bar.foo command, the administrator receives a “Not authorized to execute
command” error because the administrator is not authorized to view any
destination except those that match foo.*.

An administrator can always change his/her own password, even if the

administrator is not granted the change-user permission.
An administrator can always view his/her own permissions by issuing the show
acl <username>command, even if the administrator is not granted the view-acl
permission.

Global Administrator Permissions

Certain permissions allow administrators to perform global actions, such as
creating users or viewing all queues.

TIBCO Enterprise Message Service User’s Guide

200
| Chapter 9 Authentication and Permissions

Table 26 describes the global administrator permissions.

Table 26 Global administrator permissions (Sheet 1 of 2)

Permission Allows Administrator To...
all Perform all administrative commands.

change-acl Grant and revoke user-level

permissions.

change-admin-acl Grant and revoke administrative

permissions.

change-connection Delete connections.

create-destination Create any destination.

modify-destination Modify any destination.

delete-destination Delete any destination.

change-durable Delete durable subscribers.

change-factory Create, delete, and modify factories.

change-group Create, delete, and modify groups.

change-message Delete messages stored in the server.

change-route Create, delete, and modify routes

change-server Modify server parameters.

change-user Create, delete, and modify users.

purge-destination Purge destinations.

purge-durable Purge durable subscribers.

shutdown Shutdown the server.

view-acl View user-level permissions.

view-admin-acl View administrative permissions.

TIBCO Enterprise Message Service User’s Guide

 Administrator Permissions 201
|
Table 26 Global administrator permissions (Sheet 2 of 2)

Permission Allows Administrator To...

view-all View any item that can be administered
(for example, users, groups, topics, and
so on).

view-connection View connections, producers and

consumers.

view-destination View destination properties and

information.

view-durable View durable subscribers.

view-factory View factories.

view-group View all groups.

view-message View messages stored in the server.

view-route View routes.

view-server View server configuration and

information.

view-user View any user.

Any type of modification to an item requires that the user can view that item.
Therefore, granting any create, modify, delete, change, or purge permission
implicitly grants the permission to view the associated item.
Granting the view permissions is useful when you want specific users to only be
able to view items. It is not necessary to grant the view permission if a user
already has a permission that allows the user to modify the item.

Global permissions are stored in the acl.conf file, along with all other
permissions. Global permissions in this file have the following syntax:
ADMIN USER=<username> PERM=<permission>

or
ADMIN GROUP=<groupname> PERM=<permission>

TIBCO Enterprise Message Service User’s Guide

202
| Chapter 9 Authentication and Permissions

For example, if a user named BOB is granted the view-user global administration
permission and the group sys-admins is granted the change-acl permission, the
following entries are added to the acl.conf file:
ADMIN USER=BOB PERM=view-user
ADMIN GROUP=sys-admins PERM=change-acl

Destination-Level Permissions
Administrators can be granted permissions on each destination. Destination-level
permissions control the administration functions a user can perform on a specific
destination. Global permissions granted to a user override any destination-level
permissions.
The typical use of destination-level administration permissions is to specify
permissions on wildcard destinations for different groups of users. This allows
you to specify particular destinations over which a group of users has
administrative control. For example, you may allow one group to control all
ACCOUNTING.* topics, and another group to control all PAYROLL.* queues.

TIBCO Enterprise Message Service User’s Guide

 Administrator Permissions 203
|

Table 27 describes the destination-level administration permissions.

Table 27 Destination-level administration permissions

Permission Allows Administrator To...
view View information this destination.

create Create the specified destination. This permission is useful

when used with wildcard destination names. This allows the
user to create any destination that matches the specified
parent.

delete Delete this destination.

modify Change the properties for this destination.

purge Either purge this queue, if the destination is a queue, or

purge the durable subscribers, if the destination is a topic
with durable subscriptions.

Any type of modification to an item requires that the user can view that item.
Therefore, granting create, modify, delete, change, or purge implicitly grants the
permission to view the associated item.
Granting the view permissions is useful when you want specific users to only be
able to view items. It is not necessary to grant the view permission if a user
already has a permission that allows the user to modify the item.

Administration permissions for a destination are stored alongside all other

permissions for the destination in the acl.conf file. For example, if user BOB has
publish and subscribe permissions on topic foo, and then BOB is granted view
permission, the acl listing would look like the following:
TOPIC=foo USER=BOB PERM=publish,subscribe,view

Both user and administrator permissions for a destination are stored in the same
entry in the acl.conf file. This is for convenience rather than for clarity. User
permissions specify the actions a client application can perform on a destination
(publish, subscribe, send, receive, and so on). Administrator permissions specify
what administrative commands the user can perform on the destination when
using the administration tool or API.

TIBCO Enterprise Message Service User’s Guide

204
| Chapter 9 Authentication and Permissions

Protection Permissions
Protection permissions allow you to group users into administrative domains so
that administrators can only perform actions within their domain. An
administrator can only perform administrative operations on a user that has the
same protection permission as the user. There are four protection permissions
(protect1, protect2, protect3, and protect4) that allow you to create four
groups of administrators. Protection permissions do not apply to the admin user
or users in the $admin group — these users can perform any action on any user
regardless of protection permissions.
To use protection permissions, grant one of the protection permissions to a set of
users (either individually, or to a defined group(s)). Then, grant the same
protection permission to the administrator that can perform actions on those
users.
For example, there are four departments in a company: sales, finance,
manufacturing, and system administrators. Each of these departments has a
defined group and a set of users assigned to the group. Within the system
administrators, there is one manager and three other administrators, each
responsible for administering the resources of the other departments. The
manager of the system administrators can perform any administrator action. Each
of the other system administrators can only perform actions on members of the
groups for which they are responsible.
The user name of the manager is mgr, the user names of the other system
administrators are admin1, admin2, and admin3. The following commands
illustrate the grants necessary for creating the example administration structure.
add member $admin mgr
grant admin sales protect1
grant admin admin1 protect1,all
grant admin manufacturing protect2
grant admin admin2 protect2,all
grant admin finance protect3
grant admin admin3 protect3,all

You can grant a protection permission, in addition to the all permission. This
signifies that the user has all administrator privileges for anyone who also has the
same protection permission. However, if you revoke the all permission from a
user, all permissions, including any protection permissions are removed from the
access control list for the user.

An administrator is able to view users that have a different protection permission

set, but the administrator can only perform actions on users with the same
protection permission.

TIBCO Enterprise Message Service User’s Guide

 Administrator Permissions 205
|

For example, admin1 can perform any action on any user in the sales group, and
can view any users in the manufacturing or finance groups. However, admin1
is not able to grant permissions, change passwords, delete users from, or perform
any other administrative action on users of the manufacturing or finance
groups. The mgr user is able to perform any action on any user, regardless of their
protection permission because mgr is a member of the $admin group.

TIBCO Enterprise Message Service User’s Guide

206
| Chapter 9 Authentication and Permissions

TIBCO Enterprise Message Service User’s Guide

 | 207

Chapter 10 Monitoring Server Activity

System administrators must monitor and manage the TIBCO Enterprise Message
Service server. The logging, monitoring, and statistics facilities provided by the
server allow system administrators to effectively view system activity and track
system performance.

Topics

• Log Files and Tracing, page 208

• Message Tracing, page 213
• Monitoring Server Events, page 215
• Working with Server Statistics, page 220

TIBCO Enterprise Message Service User’s Guide

208
| Chapter 10 Monitoring Server Activity

Log Files and Tracing

You can configure the TIBCO Enterprise Message Service server to write a variety
of information to the log. Several parameters and commands control where the
log is located as well as what information is written to the log. The log can be
written to a file, to the system console, or to both.

Configuring the Log File

The logFile configuration parameter in tibemsd.conf controls the location and
the name of the log file.
You can specify that the log file should be backed up and emptied after it reaches
a maximum size. This allows you to rotate the log file and ensure that the log file
does not grow boundlessly. The logfile_max_size configuration parameter
allows you to specify the maximum size of the current log file. Set the parameter
to 0 to specify no limit. Use KB, MB, or GB units.
Once the log file reaches its maximum size, it is copied to a file with the same
name as the current log file except a sequence number is appended to the name of
the backup file. The server queries the directory and determines the first available
sequence number. For example, if the current log file is named tibems.log, the
first copy is named tibems.log.1, the second is named tibems.log.2, and so
on. You can move the files out of the log directory, if desired, and the next log file
is determine d based on the first available numbered backup in the log file
directory.

When you remove or move log files, it is recommended that you remove or more
all log files in the log file directory. The server can then restart its log file sequence
with 1.

You can also dynamically force the log file to be backed up and truncated using
the rotatelog command in tibemsadmin. See Command Listing on page 151 for
more information about the rotatelog command.
For other configuration parameters that affect the log file, see Tracing and Log File
Parameters on page 119.

TIBCO Enterprise Message Service User’s Guide

 Log Files and Tracing 209
|

Tracing on the Server

The TIBCO Enterprise Message Service server can be configured to produce
tracing messages. These messages can describe actions performed for various
areas of functionality (for example, Access Control, Administration, or Routing).
These messages can also provide information about activities performed on or by
the server, or the messages can provide warnings in the event of failures or illegal
actions.
Trace messages can be sent to a log file, the console, or both. You configure tracing
in the following ways:
• By configuring the log_trace and/or console_trace parameters in the
tibemsd.conf file.

• By specifying the -trace option when starting the server

• By using the set server command when the server is running.
log_trace and console_trace can be configured independently or together.
You can configure different types of messages to go to the log file and to the
console, if desired.

When you want trace messages to be sent to a log file, you must also configure the
logFile configuration parameter. If you specify log_trace, and the logFile
configuration parameter is not set to a valid file, the tracing options are stored,
but they are not used until the server is started with a valid log file.

When configuring log or console tracing, you have a variety of options for the
types of trace messages that can be generated. Table 28 describes the available
tracing options.

Table 28 Server tracing options (Sheet 1 of 3)

Trace Option Description

INFO Prints messages as the server performs various internal
housekeeping functions, such as creating a configuration
file, opening the persistent database files, and purging
messages. Also prints a message when tracking by
message ID is enabled or disabled.

WARNING Prints a message when a failure of some sort occurs,

usually because the user attempts to do something illegal.
For example, a message is printed when a user attempts
to publish to a wildcard destination name.

TIBCO Enterprise Message Service User’s Guide

210
| Chapter 10 Monitoring Server Activity

Table 28 Server tracing options (Sheet 2 of 3)

Trace Option Description

ADMIN Prints a message whenever an administration function is
performed.

LIMITS Prints a message when a limit is exceeded, such as the

maximum size for a destination.

ACL Prints a message when a user attempts to perform an

unauthorized action. For example, if the user attempts
publish a message to a secure topic for which the user has
not been granted the publish permission.

SSL Prints detailed messages of the SSL process, including

certificate content.

SSL_DEBUG Prints messages that trace the establishment of SSL

connections.

ROUTE Prints a message when routes are created or when a route

connection is established.

ROUTE_DEBUG Prints a message for each message that is sent over a

route.

CONNECT Prints a message when a user attempts to connect to the

sever.

CONNECT_ERROR Prints a message when an error occurs on a connection.

PRODCONS Prints a message when a client creates or closes a

producer or consumer.

DEST Prints a message when a dynamic destination is created or

destroyed.

TX Prints a message when a client performs a transaction.

LDAP_DEBUG Prints messages when LDAP is used for authentication or

to obtain group information.

AUTH Prints a message when the server authenticates a user

(either through a local configuration or through an
external system).

TIBCO Enterprise Message Service User’s Guide

 Log Files and Tracing 211
|

Table 28 Server tracing options (Sheet 3 of 3)

Trace Option Description

MSG Specifies that message trace messages should be printed.
Message tracing is enabled/disabled on a destination or
on an individual message. If message tracing is not
enabled for any messages or destinations, no trace
messages are printed when this option is specified for log
or console tracing. See Message Tracing on page 213 for
more information about message tracing.

FLOW Prints a message when the server enforces flow control or

stops enforcing flow control on a destination.

RVADV Prints TIBCO Rendezvous advisory messages whenever

they are received.

DEFAULT Sets the trace options to the default set. This includes:
• INFO

• WARNING

• ACL

• LIMITS

• ROUTE

• ADMIN

• RVADV

• CONNET_ERROR

• CONFIG

• MSG

When tracing is specified, each of the tracing options can be prepended by a + or a

- sign. The + sign adds the item to the current set of trace items, the - sign
removes tracing on that item. If any item has no + or - sign then it replaces current
trace settings for that item.
For example, the following sets the trace log to only show messages about access
control violations.
log_trace=ACL

The following sets the trace log to show all default trace messages, in addition to
SSL messages, but ADMIN messages are not shown.

TIBCO Enterprise Message Service User’s Guide

212
| Chapter 10 Monitoring Server Activity

log_trace=DEFAULT,-ADMIN,+SSL

The following sets trace messages to be sent to the console when TIBCO
Rendezvous advisory messages are received.
console_trace=RVADV

TIBCO Enterprise Message Service User’s Guide

 Message Tracing 213
|

Message Tracing

In addition to other server activity, you can trace messages as they are processed.
Trace entries for messages are only generated for destinations or messages that
specify tracing should be performed. For destinations, you specify the trace
property to enable the generation of trace messages. For individual messages, the
JMS_TIBCO_MSG_TRACE property specifies that tracing should be performed for
this message, regardless of the destination settings. The sections below describe
the tracing properties for destinations and messages.
Message trace entries can be output to either the console or the log. The MSG trace
option specifies that message trace entries should be displayed, and the
DEFAULT trace option includes the MSG option. SeeTracing on the Server on
page 209 for more information about specifying trace options.
You must set the tracing property on either destinations or messages and also set
the MSG or DEFAULT trace option on the console or the log before you can view
trace entries for messages.

Enabling Message Tracing for a Destination

The trace property on a destination specifies that trace entries are generated for
that destination. This property can optionally be specified as trace=body. Setting
trace=body includes the message body in trace messages. Setting trace without
the body option specifies that only the message sequence and message ID are
included in the trace message.
When message tracing is enabled for a destination, a trace entry is output for each
of the following events that occur in message processing:
• messages are received into a destination
• messages are sent to consumers
• messages are imported or exported to/from an external system
• messages are acknowledged
• messages are sent across a destination bridge
• messages are routed
Also, any reply messages are traced when the request message is sent to a
destination that has the trace property. In the case of exported messages, when a
message is sent to a destination that has a trace property, the reply message
automatically generates a trace entry when JMSReplyTo is set to a temporary
destination. If the reply to an exported message is sent to a static destination, to
generate a trace entry, the reply destination must have the trace property set.

TIBCO Enterprise Message Service User’s Guide

214
| Chapter 10 Monitoring Server Activity

Enabling Message Tracing on a Message

You can enable tracing on individual messages by setting the
JMS_TIBCO_MSG_TRACE property on the message. The value of the property can be
null or body. Setting the property to null specifies only the message ID and
message sequence will be included in the trace entries for the message. Setting the
property to body specifies the message body will be included in the trace entries
for the message.
When the JMS_TIBCO_MSG_TRACE property is set for a message, trace entries are
generated for the message as it is processed, regardless of whether the trace
property is set for any destinations the message passes through. Trace messages
are generated for the message when it is sent by the producer and when it is
received by the consumer.

TIBCO Enterprise Message Service User’s Guide

 Monitoring Server Events 215
|

Monitoring Server Events

The TIBCO Enterprise Message Service server can publish topic messages for
several system events. For example, the server can publish a message when users
connect or disconnect. System event messages contain detail about the event
stored in properties of the message. This section gives an overview of the
monitoring facilities provided by the server. For a list of monitor topics and a
description of the message properties for each topic, see Appendix C, Monitor
Messages, on page 315.

System Monitor Topics

The TIBCO Enterprise Message Service server can publish messages to various
topics when certain events occur. There are several types of event classes, each
class groups a set of related events. For example, some event classes are
connection, admin, and route. Each event class is further subdivided into the
events for each class. For example, the connection class has two events: connect
and disconnect. These event classes are used to group the system events into
meaningful categories.
All system event topic names begin with $sys.monitor. The remainder of the
name is the event class followed by the event. For example, the server publishes a
message to the topic $sys.monitor.connection.disconnect whenever a client
disconnects from the server. The naming scheme for system event topics allows
you to create wildcard subscriptions for all events of a certain class. For example,
to receive messages whenever clients connect or disconnect, you would create a
topic subscriber for the topic $sys.monitor.connection.*.
Monitor topics are created and maintained by the server. There is no need to
explicitly create monitor topics in the configuration files or using the
administration tool or API.

Monitoring Messages
You can monitor messages processed by a destination as they are sent, received,
or acknowledged. The $sys.monitor topic for monitoring messages has the
following format:
$sys.monitor.<D>.<E>.<destinationName>

TIBCO Enterprise Message Service User’s Guide

216
| Chapter 10 Monitoring Server Activity

Where D is the type of destination, E is the event you wish to monitor, and
destinationName is the name of the destination whose messages you wish to
monitor. Table 29 describes the possible values of D and E in message monitoring
topics.

Table 29 Message monitoring qualifiers (Sheet 1 of 2)

Qualifier Value Description
D T Destination to monitor is a topic. Include the message
body in the monitor message as a byte array. Use the
createFromBytes() method when viewing the monitor
message to recreate the message body, if desired.

t Destination to monitor is a topic. Do not include the

message body in the monitor message.

Q Destination to monitor is a queue. Include the message

body in the monitor message as a byte array. Use the
createFromBytes() method when viewing the monitor
message to recreate the message body, if desired.

q Destination to monitor is a queue. Do not include the

message body in the monitor message.

TIBCO Enterprise Message Service User’s Guide

 Monitoring Server Events 217
|
Table 29 Message monitoring qualifiers (Sheet 2 of 2)

Qualifier Value Description

E s Monitor message is generated when a message is sent by
the server to:
• a consumer
• a route
• an external system by way of a transport

r Monitor message is generated when a message is

received by the specified destination. This occurs when
the message is:
• Sent by a producer
• Sent by a route
• Forwarded from another destination by way of a
bridge
• Imported from transport to an external system

a Monitor message is generated when a message is

acknowledged.

* Monitor message is generated when a message is sent,

received, or acknowledged for the specified destination.

For example, $sys.monitor.T.r.corp.News is the topic for monitoring any

received messages to the topic named corp.News. The message body of any
received message is included in monitor messages on this topic. The topic
$sys.monitor.q.*.corp.* monitors all message events (send, receive,
acknowledge) for all queues matching the name corp.*. The message body is not
included in this topic’s messages.
The messages sent to this type of monitor topic include a description of the event,
information about where the message came from (a producer, route, external
system, and so on), and optionally the message body, depending upon the value
of D. See Appendix C, Monitor Messages, on page 315 for a complete description
of the properties available in monitoring messages.
You must explicitly subscribe to a message monitoring topic. That is, subscribing
to $sys.monitor.> will subscribe to all topics beginning with $sys.monitor, but
it does not subscribe you to any specific message monitoring topic such as
$sys.monitor.T.*.foo.bar. You can, however, specify wildcards in the
destinationName portion of the message monitoring topic to subscribe to the

TIBCO Enterprise Message Service User’s Guide

218
| Chapter 10 Monitoring Server Activity

message monitoring topic for all matching destinations. For example, you can
subscribe to $sys.monitor.T.r.> to monitor all messages received by all topics.
For performance reasons, you may want to avoid subscribing to too many
message monitoring topics. See Performance Implications of Monitor Topics on
page 219 for more information.

Viewing Monitor Topics

Monitor topics are just like any other topic. To view these topics, create a client
application that subscribes to the desired topics.
Because monitor topics contain potentially sensitive system information,
authentication and permissions are always checked when clients access a monitor
topic. That is, even if authentication for the server is disabled, clients are not able
to access monitor topics unless they have logged in with a valid username and
password and the user has permission to view the desired topic.
The admin user and members of the $admin group have permission to perform
any server action, including subscribing to monitor topics. All other users must be
explicitly granted permission to view monitor topics before the user can
successfully create subscribers for monitor topics. For example, if user BOB is not
a member of the $admin group, and you wish to allow user BOB to monitor all
connection events, you can grant BOB the required permission with the following
command using the administration tool:
grant topic $sys.monitor.connection.* BOB subscribe

Bob’s application can then create a topic subscriber for $sys.monitor.connect.*

and view any connect or disconnect events.

Topics starting with $sys.monitor do not participate in any permission

inheritance from parent topics other than those starting with $sys.monitor (that
is, *.* or *.> is not a parent of $sys.monitor).
Therefore, granting permission to a user to subscribe to > does not allow that user
to subscribe to $sys.monitor topics. You must explicitly grant users permission
to $sys.monitor topics (or parent topics, such as $sys.monitor.admin.*) for a
user to be able to subscribe to that topic.

Monitor topics publish messages of type MapMessage. Information about the

event is stored within properties in the message. Each system event has different
properties. Appendix C, Monitor Messages, on page 315 describes each of the
monitor topics and the message properties for the messages published on that
topic. Your application can receive and display all or part of a monitor message,
just as it would handle any message sent to a topic.

TIBCO Enterprise Message Service User’s Guide

 Monitoring Server Events 219
|

Monitor messages are like any topic messages, so you can have any number of
applications that subscribe to monitor messages. You can create different
applications that subscribe to different monitor topics, or you can create one
application that subscribes to all desired monitor topics. Your topic subscribers
can also use message selectors to filter the monitor messages so your application
receives only the messages it is interested in.

Performance Implications of Monitor Topics

The TIBCO Enterprise Message Service server only generates messages for
monitor topics that currently have subscribers. So, if no applications subscribe to
monitor topics, no monitor messages are generated. Generating a monitor
message does consume system resources, and therefore you should consider what
kinds of monitoring your environment requires. System performance is affected
by the number of subscribers for monitor topics as well as the frequency of
messages for those topics.
For development and testing systems, monitoring all system events is probably
desirable. Usually, development and testing systems do not have large message
volumes, and monitoring can give you information about system problems.
For production systems, monitoring all events may have an adverse effect on
system performance. Therefore, you should not create topic subscribers for
$sys.monitor.> in your production system. Also, monitor events are likely to be
added in future releases, so the number of monitor topics may grow.
Subscriptions to monitor topics in production systems should always be limited
to specific monitor topics or wildcard subscriptions to specific classes of monitor
topics that are required.
Also, consider the frequency of messages to each monitor topic. System
administration events, such as creating topics, routes, and changing permissions,
do not occur frequently, so creating subscriptions for these types of events will
most likely not have a significant effect on performance.
Also, using message selectors to limit monitor messages can improve
performance slightly. The server does not send any messages that do not match a
subscriber’s message selector. Even though the message is not sent, the message is
still generated. Therefore there is still system overhead for subscribers to a
monitor topic, even if all messages for that topic do not match any subscriber’s
message selector filter.

TIBCO Enterprise Message Service User’s Guide

220
| Chapter 10 Monitoring Server Activity

Working with Server Statistics

The TIBCO Enterprise Message Service server allows you to track incoming and
outgoing message volume, message size, and message statistics for the server
overall as well as for each producer, consumer, or route. You can configure the
type of statistics collected, the interval for computing averages, and amount of
detail for each type.
Statistic tracking can be set in the server’s configuration file, or you can change
the configuration dynamically using commands in the administration tool or by
creating your own application with the Java administration API.
Statistics can be viewed using the administration tool, or you can create your own
application that performs more advanced analysis of statistics using the Java
administration API.
This section details how to configure and view statistics using the configuration
files and administration tool commands. For more information about the Java
administration API, see the description of com.tibco.tibjms.admin in TIBCO
Enterprise Message Service Java API Reference.

The TIBCO Enterprise Message Service server tracks the number of incoming or
outgoing messages, but only messages sent or received by a producer, consumer,
or route are tracked. The server also sends system messages, but these are not
included in the number of messages.
However, the server can add a small amount of data to a message for internal use
by the server. This overhead is counted in the total message size, and you may
notice that some messages have a greater message size than expected.

Overall Server Statistics

The server always collects certain overall server statistics. This includes the rate of
inbound and outbound messages (expressed as number of messages per second),
message memory usage, disk storage usage, and the number of destinations,
connections, and durable subscriptions. Gathering this information consumes
virtually no system resources, therefore these statistics are always available. You
can view overall server statistics by executing either the show server or show
config commands.

TIBCO Enterprise Message Service User’s Guide

 Working with Server Statistics 221
|

The default interval for collecting overall server statistics is 1 second. You may
wish to view average system usage statistics over a larger interval. The
server_rate_interval configuration parameter controls the collection interval
for server statistics. The parameter can be set in the configuration file or
dynamically using the set server command. This parameter can only be set to
positive integers greater than zero.

Enabling Statistic Gathering

Each producer, consumer, destination, and route can gather overall statistics and
statistics for each of its destinations. To enable statistic gathering, you must set the
statistics parameter to enabled. This parameter can be specified in the
configuration file, and it can be changed dynamically using the set server
command.
The statistics parameter allows you to globally enable and disable statistic
gathering. Statistics are kept in server memory for the life of each object. If you
wish to reset the total statistics for all objects to zero, disable statistic gathering,
then re-enable it. Server statistics are also reset when the server shuts down and
restarts, or in the event of a fault-tolerant failover.
For each producer, consumer, destination, and route the total number of
sent/received messages and total size of messages is maintained. Also, producers
and consumers keep these statistics for each destination that they use to send or
receive messages.
The rate of incoming/outgoing messages and message size is calculated over an
interval. By default, the average is calculated every 3 seconds. You can increase or
decrease this value by altering the rate_interval parameter. This parameter can
be set in the configuration file or dynamically using the set server command.
Setting this parameter to 0 disables the tracking of statistics over an interval—
only the total statistics for the destination, route, producer, or consumer are kept.
Gathering total statistics for producers, consumers, destinations, and routes
consumes very little system resources. Calculating the average statistics over an
interval can have an adverse effect on performance if the interval is very large
and/or there are a very large number of destinations. Under most circumstances,
enabling statistic gathering and average calculations should not affect system
performance.

Detailed Statistics
In some situations, the default statistic gathering may not be sufficient. For
example, if a topic subscriber subscribes to wildcard topics, the total statistics for
all topics that match the wildcard are kept. You may wish to get further detail in
this case and track the statistics for each actual topic the subscriber receives.

TIBCO Enterprise Message Service User’s Guide

222
| Chapter 10 Monitoring Server Activity

The following situations may require detailed statistic gathering:

• Topic subscribers that subscribe to wildcard topics
• Message producers that do not specify a destination when they are created.
These message producers can produce messages for any destination, and the
destination name is specified when a message is sent.
• Routes can have incoming and outgoing messages on many different topics.
To enable detailed statistics, set the detailed_statistics parameter to the type
of statistics you wish to receive. The parameter can have the following values:
• NONE — disables detailed statistic gathering.
• CONSUMERS — enables detailed statistics for topic subscribers with wildcard
topic names.
• PRODUCERS — enables detailed statistics for producers that do not specify a
destination when they are created.
• ROUTES — enables detailed statistics for routes
You can set the detailed_statistics parameter to NONE or any combination of
CONSUMERS, PRODUCERS, or ROUTES. To specify more than one type of detailed
statistic gathering, provide a comma-separated list of values. You can set the
detailed_statistics parameter in the configuration file or dynamically by
using the set server command. For example, the following set server
command enables detailed statistic tracking for producers and routes.
set server detailed_statistics = PRODUCERS,ROUTES

Collecting detailed statistics does consume memory, and it can have an adverse
affect on performance, if there are a large number of destinations for the type of
statistics you wish to gather. There are two parameters that allow you to control
resource consumption when collecting detailed statistics. First, you can control
the amount of time statistics are kept, and second you can set a maximum amount
of memory for detailed statistic gathering.
The statistics_cleanup_interval parameter controls how long detailed
statistics are kept. This parameter can be set either in the configuration file or
dynamically with the set server command. By default, statistics are kept for 15
seconds. For example, if there is a topic subscriber for the topic foo.*, and the
subscriber receives a message on topic foo.bar, if no new messages arrive for
topic foo.bar within 15 seconds, statistics for topic foo.bar are deleted for that
consumer. You can set this parameter to 0 to signify that all detailed statistics are
to be kept indefinitely. Of course, statistics for an object only exist as long as the
object itself exists. That is, if a message consumer terminates, all detailed statistics
for that consumer are deleted from memory.

TIBCO Enterprise Message Service User’s Guide

 Working with Server Statistics 223
|

The max_stat_memory parameter controls the amount of memory used by

detailed statistics. This parameter can be set either in the configuration file or
dynamically with the set server command. By default, this parameter is set to 0
which signifies that detailed statistics have no memory limit. If no units are
specified, the value of this parameter is in bytes. Optionally, you can specify units
as KB, MB, or GB. When the specified limit is reached, the server stops collecting
new statistics. The server will only resume collecting statistics if the amount of
memory used decreases (for example, if the statistics_cleanup_interval is
set and old statistics are removed).

Displaying Statistics
When statistic collecting is enabled, you can view statistics for producers,
consumers, routes, and destinations using the show stat command in the
administration tool.
The show stat command allows you to filter the statistics based on destination
name, user name, connection ID, or any combination of criteria. You can
optionally specify the total keyword to retrieve only the total statistics (this
suppresses the detailed output). You can also optionally specify the "wide"
keyword when displaying statistics for destinations or routes. This specifies that
inbound and outbound message statistics should be displayed on the same line
(the line can be 100 characters or more).
The following illustrates displaying statistics for a route where detailed statistic
tracking is enabled.
tcp://server1:7322> show stat route B
Inbound statistics for route 'B':
Total Count Rate/Second
Destination Msgs Size Msgs Size
<total> 189 37.9 Kb 10 2.0 Kb
Topic: dynamic.0 38 7.6 Kb 2 0.4 Kb
Topic: dynamic.1 38 7.6 Kb 2 0.4 Kb
Topic: dynamic.2 38 7.6 Kb 2 0.4 Kb
Topic: dynamic.3 38 7.6 Kb 2 0.4 Kb
Topic: dynamic.4 37 7.4 Kb 2 0.4 Kb
Outbound statistics for route 'B':
Total Count Rate/Second
Destination Msgs Size Msgs Size
<total> 9538 1.9 MB 10 2.1 Kb
Topic: dynamic.0 1909 394.9 Kb 2 0.4 Kb
Topic: dynamic.1 1908 394.7 Kb 2 0.4 Kb
Topic: dynamic.2 1907 394.5 Kb 2 0.4 Kb
Topic: dynamic.3 1907 394.5 Kb 2 0.4 Kb
Topic: dynamic.4 1907 394.5 Kb 2 0.5 Kb

See show stat on page 175 for more information and detailed syntax of the show
stat command.

TIBCO Enterprise Message Service User’s Guide

224
| Chapter 10 Monitoring Server Activity

TIBCO Enterprise Message Service User’s Guide

 | 225

Chapter 11 Deploying the Application

This chapter describes deploying the TIBCO Enterprise Message Service

application.

Topics

• Running the Server, page 226

• Security Considerations, page 228
• Running TIBCO Enterprise Message Service Client-Side Application, page 229
• Connecting Directly to TIBCO Enterprise Message Service Server, page 230
• Using JNDI with TIBCO Enterprise Message Service, page 232

TIBCO Enterprise Message Service User’s Guide

226
| Chapter 11 Deploying the Application

Running the Server

In order to use TIBCO Enterprise Message Service with your applications, the
TIBCO Enterprise Message Service Server must be running. The server and the
clients work together to implement TIBCO Enterprise Message Service. The
server implements all types of message persistence; no messages are stored on the
client side.

Starting the Server

TIBCO Enterprise Message Service Server is located in the bin subdirectory of the
TIBCO Enterprise Message Service installation directory.
1. Navigate to the bin subdirectory
2. Type tibemsd [options]

where options are described in Table 30. The command options to tibemsd are
similar to the parameters you specify in tibemsd.conf, and the command
options override any value specified in the parameters. See Table 16 on page 106
for more information about configuration parameters and more information
about each parameter.

Table 30 tibemsd Options (Sheet 1 of 2)

Option Description
-config <config file name> is the name of the main configuration file for
<config file name>
tibemsd server. Default is tibemsd.conf.

-trace <items> Specifies the trace items. These items are not stored in the
configuration file. The value has the same format as the value of
log_trace parameter specified with set server command of the
administration tool.

-ssl_password <string> Private key password.

-ssl_trace Print the certificates loaded by the server and do more detailed
tracing of SSL-related situation.

-ssl_debug_trace Turns on tracing of SSL connections.

-ft_active <active_url> URL of the active server. If this server can connect to the active
server, it will act as a backup server. If this server cannot connect to
the active server, it will become the active server.

TIBCO Enterprise Message Service User’s Guide

 Running the Server 227
|
Table 30 tibemsd Options (Sheet 2 of 2)

Option Description
-ft_heartbeat<seconds> Heartbeat signal for the active server, in seconds. Default is 3.

-ft_activation <seconds> Activation interval (maximum length of time between heartbeat

signals) which indicates that active server has failed. Set in seconds:
default is 10. This interval should be set to at least twice the
heartbeat interval.

TIBCO Enterprise Message Service User’s Guide

228
| Chapter 11 Deploying the Application

Security Considerations

When the authorization property is set to false, every user is granted access to
the system. However, even when security is disabled, the user admin must use an
appropriate password in order to connect to the server.

The default setting for the admin password is no password. If the default has not
been changed, the user admin can connect without a password.

When security for tibemsd is enabled, the server requires a name and password
in order to connect. Only users listed in the configuration files can connect to the
server.
However, the administrator (admin) may choose to allow connections for users
without a name or a password, even when security is enabled. To allow these
connections, the administrator must create a user with the name anonymous and
no password.

Creating the user anonymous does not mean that anonymous has all permissions.
Individual topics and queues can still be secure, and the ability to use these
destinations (either sending or receiving) is controlled by the acl list of
permissions for those destinations. The user anonymous will only be able to access
non-secure destinations.

For more information on setting security, refer to secure on page 33, and Adding
the secure Property to the Topic on page 302.

TIBCO Enterprise Message Service User’s Guide

 Running TIBCO Enterprise Message Service Client-Side Application 229
|

Running TIBCO Enterprise Message Service Client-Side Application

In order to run the client-side application, you must implement the items on the
programmer’s check list, and then connect the client side to the server. There are
two methods to connect the client to the server: directly and with the JNDI
interface. This section describes the programmer’s checklist, security
considerations, and both methods of connecting to the server.

Programmer’s Checklist
In order to compile and run a client-side Java application using TIBCO Enterprise
Message Service, you must be sure:
1. Your application imports the following packages:
import javax.jms.*;
import javax.naming.*;

2. The CLASSPATH includes the following jar files:

jms.jar
jndi.jar
tibjms.jar

3. If SSL is used for communication, add the following files to the CLASSPATH:
tibcrypt.jar
jnet.jar
jcert.jar
jsse.jar

All necessary jar files are located in the java subdirectory of the TIBCO Enterprise
Message Service installation directory.

TIBCO Enterprise Message Service User’s Guide

230
| Chapter 11 Deploying the Application

Connecting Directly to TIBCO Enterprise Message Service Server

Client applications must connect to a running instance of TIBCO Enterprise

Message Service server in order to perform any JMS operations.
Normally client applications use JNDI access to look up a ConnectionFactory
object in order to connect to the server. For more information on JNDI-based
access to the server, refer to Using JNDI with TIBCO Enterprise Message Service
on page 232.
However, in rare cases applications may connect to the server directly.
In order to connect to the server directly, the application must use one of the
following statements.
For the common facility interface, use:
ConnectionFactory factory = new
com.tibco.tibjms.TibjmsConnectionFactory(<server url>);
For a topic, use:
TopicConnectionFactory factory = new
com.tibco.tibjms.TibjmsTopicConnectionFactory(<server url>);
For a queue, use:
QueueConnectionFactory factory = new
com.tibco.tibjms.TibjmsQueueConnectionFactory(<server url>);
The <server url> parameter in these expressions is a Java string defining the
protocol and the address of the running instance of the TIBCO Enterprise
Message Service Server. The <server url> parameter has the form:
protocol://host:port

The supported protocols are tcp and ssl.

Examples of the server url string are:

tcp://jmshost:7255
ssl://localhost:7243

You can use short forms of the server-url, as described below:

• The protocol can be omitted: it defaults to tcp.
• The port can be omitted: it defaults to 7222.
For example, valid forms of the server url are:
• anotherhost:7333 (equivalent to tcp://anotherhost:7333)

TIBCO Enterprise Message Service User’s Guide

 Connecting Directly to TIBCO Enterprise Message Service Server 231
|

• mainhost (equivalent to tcp://mainhost:7222)

TIBCO Enterprise Message Service User’s Guide

232
| Chapter 11 Deploying the Application

Using JNDI with TIBCO Enterprise Message Service

In most cases, client applications use the JNDI interface to look up connection
factories and Topic and Queue objects.

Dynamic Topics and Queues

TIBCO Enterprise Message Service allows dynamic creation of topics and queues
using the following JMS API methods:
• session.createTopic(<topic name>);

• session.createQueue(<queue name>);
• TopicSession.createTopic(<topic name>);

• QueueSession.createQueue(<queue name>);

Since dynamic topics and queues do not appear in the configuration files, you
cannot use the JNDI interface to look up these topics and queues.
For more information about connecting to the server without the JNDI interface,
refer to Connecting Directly to TIBCO Enterprise Message Service Server on
page 230.

Static Topics and Queues

In order to use JNDI access to TIBCO Enterprise Message Service connection
factories and topics and queues, the application should use the following
parameters:
• provider context factory
com.tibco.tibjms.naming.TibjmsInitialContextFactory

• JNDI provider URL in the form

tibjmsnaming://host:port

• Topics and Queues or optional JNDI names, created using the administration
tool, the administration API, or in the configuration files.
• To obtain connection factory, topic, or queue objects, the client application
should use JNDI calls:
Topic topic =(javax.jms.Topic)jndiContext.lookup(<topic-name>);
Queue queue =(javax.jms.Queue)jndiContext.lookup(<queue-name>);
ConnectionFactory cf =
(javax.jms.ConnectionFactory)jndiContext.lookup(<connection-
factory-name>);

TIBCO Enterprise Message Service User’s Guide

 Using JNDI with TIBCO Enterprise Message Service 233
|

• If there are topics and queues with same names in the configuration files, the
client application must use context qualifiers:
Topic topic =
(javax.jms.Topic)jndiContext.lookup(“$topics:”+<topic-name>);
Queue queue =
(javax.jms.Queue)jndiContext.lookup(“$queues:”+<queue-name>);

Formerly, the syntax for topic and queue lookup was $topic. and $queue.
This syntax is supported for backward compatibility, but the new syntax is
preferred.

Using context qualifiers is not required if there are no topics and queues with
the same names in the configuration files.

The provider URL host:port value is one of the listen ports of TIBCO Enterprise
Message Service. There is no separate port defined for JNDI access.

Example
This section provides an example of accessing JMS administered objects when
using TIBCO Enterprise Message Service.
static final String providerContextFactory =
"com.tibco.tibjms.naming.TibjmsInitialContextFactory";

static final String defaultProviderURL =

"tibjmsnaming://jmshost:7222";
try
{
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,providerContextFactory);
env.put(Context.PROVIDER_URL,providerURL);
jndiContext = new InitialContext(env);
}
catch (NamingException e)
{
System.out.println("Failed to create InitialContext”);
e.printStackTrace();
}

ConnectionFactory factory =
(javax.jms.ConnectionFactory)
jndiContext.lookup("ConnectionFactory");

TopicConnectionFactory topicFactory =
(javax.jms.TopicConnectionFactory)
jndiContext.lookup("TopicConnectionFactory");

QueueConnectionFactory queueFactory =
(javax.jms.QueueConnectionFactory)

TIBCO Enterprise Message Service User’s Guide

234
| Chapter 11 Deploying the Application

jndiContext.lookup("QueueConnectionFactory");

Topic topic = (javax.jms.Topic)jndiContext.lookup("topic.sample");

Queue queue = (javax.jms.Queue)jndiContext.lookup("queue.sample");

Looking Up Objects Using Full URL Names

Administered objects can also be looked up using full URL names. In this case, the
Context.PROVIDER_URL property is not provided to the InitialContext.
Instead, the Context.URL_PKG_PREFIXES property is provided using the
statement:
env.put(Context.URL_PKG_PREFIXES, "com.tibco.tibjms.naming");

If using full URL names, you can look up topics or queues like the following
example:
Topic topic = (javax.jms.Topic)jndiContext.lookup(
"tibjmsnaming://jmshost:7222/topic.sample");
Queue queue = (javax.jms.Queue)jndiContext.lookup(
"tibjmsnaming://jmshost:7222/queue.sample");

For further information on how to use JNDI access, refer to the tibjmsJNDI.java
example included with TIBCO Enterprise Message Service.

Using SSL with JNDI Lookups

TIBCO Enterprise Message Service client programs can perform secure JNDI
lookups using the Secure Sockets Layer (SSL) protocol. To accomplish this, the
client program must set SSL properties in the environment when the
InitialContext is created. The SSL properties are similar to the SSL properties
for the TIBCO Enterprise Message Service server. See Chapter 12, Using the SSL
Protocol, on page 241 for more information about using SSL in the TIBCO
Enterprise Message Service server.
Table 31 describes the properties for configuring SSL when using JNDI. Refer to
TIBCO Enterprise Message Service Java API Reference included in the online
documentation for more information about using JNDI and configuring the
InitialContext.

Table 31 SSL properties for client applications using JNDI (Sheet 1 of 6)

Property Datatype Description
TibjmsContext.SECURITY_PROTOCOL String The security protocol for the
connection to the JNDI server.
The value of this property must
be ssl.

TIBCO Enterprise Message Service User’s Guide

 Using JNDI with TIBCO Enterprise Message Service 235
|
Table 31 SSL properties for client applications using JNDI (Sheet 2 of 6)

Property Datatype Description

TibjmsContext.SSL_CIPHER_SUITES String Specifies the cipher suites used
by the server; each suite in the
list is separated by a colon (:).
This parameter can use the
OpenSSL name for cipher suites
or the longer, more descriptive
names.
See Specifying Cipher Suites on
page 258 for more information
about the cipher suites available
in TIBCO Enterprise Message
Service and the OpenSSL names
and longer names for the cipher
suites.

TibjmsContext.SSL_DEBUG_TRACE Boolean When set to true, enables more

detailed SSL tracing. This
property is used for debugging
only; it is not for use in
production systems.

TibjmsContext.SSL_ENABLE_VERIFY_HOST Boolean Specifies whether the client

should verify the server’s
certificate. By default, this
property is set to true, signifying
the client should verify the
server’s certificate.
When this property is set to
false, the client establishes
secure communication with the
server, but does not verify the
server’s identity.

TIBCO Enterprise Message Service User’s Guide

236
| Chapter 11 Deploying the Application

Table 31 SSL properties for client applications using JNDI (Sheet 3 of 6)

Property Datatype Description

TibjmsContext.SSL_ENABLE_VERIFY_HOST_NAME Boolean Specifies whether the client
should verify the name in the CN
field of the server’s certificate. By
default, this property is set to
true, signifying the client should
verify the name of the connected
host or the name specified in the
SSL_EXPECTED_HOST_NAME
property against the value in the
server’s certificate. If the names
do not match, the connection is
rejected.
When this property is set to
false, the client establishes
secure communication with the
server, but does not verify the
server’s name.

TibjmsContext.SSL_EXPECTED_HOST_NAME String Specifies the name the server is

expected to have in the CN field
of its certificate. If this parameter
is not set, the expected name is
the hostname of the server.
This parameter is used when the
SSL_ENABLE_VERIFY_HOST_NAME
parameter is set to enabled.

TibjmsContext.SSL_HOST_NAME_VERIFIER String Constant that holds the name of

SSL property specifying the
custom host name verifier for
JNDI lookups.

TIBCO Enterprise Message Service User’s Guide

 Using JNDI with TIBCO Enterprise Message Service 237
|
Table 31 SSL properties for client applications using JNDI (Sheet 4 of 6)

Property Datatype Description

TibjmsContext.SSL_IDENTITY String The client’s digital certificate.
PEM and PSCS#12 formats allow
the digital certificate to include
the private key. If these formats
are used and the private key is
part of the digital certificate, then
setting SSL_PRIVATE_KEY is
optional.
See File Names for Certificates
and Keys on page 251 for more
information on file types for
digital certificates.

TibjmsContext.SSL_IDENTITY_ENCODING String The encoding of the client’s

certificate.

TibjmsContext.SSL_ISSUER_CERTIFICATES Vector Certificate chain member for the

client. The client reads the
certificates in the chain in the
order they are presented in this
property.
The same certificate can appear
in multiple places in the
certificate chain.
See File Names for Certificates
and Keys on page 251 for more
information on file types for
digital certificates.

TibjmsContext.SSL_PASSWORD String Password for client’s private key.

TibjmsContext.SSL_PRIVATE_KEY String The name and location of the

client’s private key file.

TibjmsContext.SSL_PRIVATE_KEY_ENCODING String The encoding of the client’s

private key file.

TIBCO Enterprise Message Service User’s Guide

238
| Chapter 11 Deploying the Application

Table 31 SSL properties for client applications using JNDI (Sheet 5 of 6)

Property Datatype Description

TibjmsContext.SSL_RENEGOTIATE_INTERVAL Integer The client initiates a
renegotiation when the number
of seconds specified by this
parameter have passed. The
renegotiation occurs each time
the interval occurs; the time
interval starts at the beginning of
the SSL connection.
The minimum interval is 15
seconds.
By default, this parameter is set
to 0, signifying renegotiation is
disabled.
See Renegotiating the Session
Key on page 250 for more
information about renegotiation
of keys during a session.

TibjmsContext.SSL_RENEGOTIATE_SIZE Integer The client initiates a

renegotiation when the
cumulative size, in bytes, of the
data passed between the server
and the client reaches the amount
specified by this parameter.
The minimum size this
parameter can be set to is 64Kb.
You can specify Kb, Mb, or Gb
for the units.
By default, this parameter is set
to 0, signifying renegotiation is
disabled.
See Renegotiating the Session
Key on page 250 for more
information about renegotiation
of keys during a session.

TIBCO Enterprise Message Service User’s Guide

 Using JNDI with TIBCO Enterprise Message Service 239
|

Table 31 SSL properties for client applications using JNDI (Sheet 6 of 6)

Property Datatype Description

TibjmsContext.SSL_TRACE Boolean When set to true, enables tracing
of loaded certificates.
This prints a message to the
console during startup of the
server that describes each loaded
certificate.

TibjmsContext.SSL_TRUSTED_CERTIFICATES Vector List of trusted certificates. This

sets which Certificate Authority
certificates should be trusted as
issuers of the JNDI server
certificates.
The same certificate can appear
in multiple places in the
certificate chain.
See File Names for Certificates
and Keys on page 251 for more
information on file types for
digital certificates.

TibjmsContext.SSL_VENDOR String The SSL provider name. The

value of this property must be
either j2se or entrust61.

Example of Using SSL for JNDI Lookups

The following is an example of how to create an InitialContext that can be
used to perform JNDI lookups using the SSL protocol.
Hashtable env = new Hashtable();
env.put(Context.INITIAL_CONTEXT_FACTORY,
"com.tibco.tibjms.naming.TibjmsInitialContextFactory");
env.put(Context.PROVIDER_URL, tibjmsnaming://jmshost:7223);
env.put(Context.URL_PKG_PREFIXES, "com.tibco.tibjms.naming")
env.put(TibjmsContext.SECURITY_PROTOCOL, "ssl");
env.put(TibjmsContext.SSL_ENABLE_VERIFY_HOST,
new Boolean("false"));
Context context = new InitialContext(env);

TIBCO Enterprise Message Service User’s Guide

240
| Chapter 11 Deploying the Application

In this example, the port number specified for the Context.PROVIDER_URL is set
to the SSL listen port that was specified in the server configuration file
tibjsmd.conf. The value for TibjmsContext.SECURITY_PROTOCOL is set to ssl.
Finally, the value of TibjmsContext.ENABLE_VERIFY_HOST is set to "false" to turn
off server authentication. Because of this, no trusted certificates need to be
provided and the client will then not verify the server it is using for the JNDI
lookup against the server’s certificate.

Performing Fault-Tolerant JNDI Lookups

TIBCO Enterprise Message Service can perform fault-tolerant JNDI lookups. If the
primary server fails and the backup server becomes the primary, the JNDI
provider automatically uses the new primary server for JNDI lookups. You
accomplish this by providing multiple URLs in the Context.PROVIDER_URL
property when creating the InitialContext. Specify more than one URL
separated by commas (,) in the property.

Example
The following illustrates setting up the Context.PROVIDER_URL property with
the URLs of a primary EMS server on the machine named emshost and a backup
EMS server on the machine named backuphost.
env.put(Context.PROVIDER_URL, "tibjmsnaming://jmshost:7222,
tibjmsnaming://backuphost:7222");

If at any time the first EMS server fails, the JNDI provider will automatically
switch to the EMS server on the host backuphost for JNDI lookups. If emshost is
repaired and restarted, it then becomes the backup EMS server.

Limitations of Fault-Tolerant JNDI Lookups

Fault-tolerant JNDI lookups do not occur in the following scenarios:
• When using full URL names in argument to the lookup method.
• When looking up an object that has been bound into a foreign
naming/directory service such as LDAP.

TIBCO Enterprise Message Service User’s Guide

 | 241

Chapter 12 Using the SSL Protocol

Secure Sockets Layer (SSL) is a protocol for transmitting encrypted data over the
Internet or an internal network. SSL works by using public and private key to
encrypt data that is transferred over the SSL connection. Most web browsers
support SSL, and many Web sites and Java applications use the protocol to obtain
confidential user information, such as credit card numbers.
The SSL protocol is fairly complex and this chapter is not intended as a complete
description of SSL. This chapter describes how to configure SSL in the TIBCO
Enterprise Message Service server and in client applications communicating with
the server. For a more complete description of SSL, refer to the SSL specification at
http://wp.netscape.com/eng/ssl3/.

Topics

• SSL Support in TIBCO Enterprise Message Service, page 242

• Digital Certificates, page 243
• Private Key Formats, page 244
• Overview of the SSL Protocol, page 245
• Renegotiating the Session Key, page 250
• File Names for Certificates and Keys, page 251
• Configuring SSL in the Server, page 252
• Configuring SSL in EMS Clients, page 253
• Specifying Cipher Suites, page 258
• Third-Party SSL Hardware Accelerators, page 262

TIBCO Enterprise Message Service User’s Guide

242
| Chapter 12 Using the SSL Protocol

SSL Support in TIBCO Enterprise Message Service

TIBCO Enterprise Message Service supports the Secure Sockets Layer (SSL)
protocol. SSL uses public and private keys to encrypt data over a network
connection in order to secure communication between client and server. SSL is
supported in all possible communication paths between components. This
includes communication between:
• a Java client and the tibemsd server
• a C or C# client and the tibemsd server
• the tibemsadmin tool and the tibemsd server
• routed servers
• fault-tolerant servers
The TIBCO Enterprise Message Service server and the C and C# client libraries
use OpenSSL for SSL support. You can find out more about OpenSSL at
www.openssl.org.
TIBCO Enterprise Message Service Java clients can use either JSSE (from Sun
JavaSoft) or the SSL implementation from Entrust. TIBCO Enterprise Message
Service includes JSSE; if you wish to use Entrust, you must purchase and install
the Entrust SSL Version 6.1 implementation separately (version 6.0 is not
supported).

TIBCO Enterprise Message Service User’s Guide

 Digital Certificates 243
|

Digital Certificates

Digital certificates are files used by SSL to verify the identities of servers and
clients. A digital certificate is issued by a trusted third-party certificate authority.
Each user and server on the network requires their own digital certificate to
ensure that a request is sent from and received by the correct party. A digital
certificate is issued for a particular public key owned by a user or server, and the
combination of the public key and the private key provides a unique identity to
the owner of the digital certificate.
A digital certificate typically includes a variety of information, such as the
following:
• The name of the subject (owner) and other information required to confirm
the unique identity of the subject. This includes the URL of the web server
using the digital certificate, or an email address.
• The subject’s public key.
• The name of the certificate authority that issued the digital certificate.
• A serial number.
• The length of time the certificate will remain valid. This is defined by a start
date and an end date.
The most widely used standard for digital certificates is ITU-T X.509. Digital
certificates can be read or written by any application complying with the X.509
standard. TIBCO Enterprise Message Service supports using digital certificates
that comply with the X.509 version 3 (X.509v3). This includes certificates from
most certificate authorities, such as Verisign or Entrust.

Digital Certificate File Formats

Digital certificate files can be in DER (Distinguished Encoding Rules), PEM
(Privacy Enhanced Mail), or other formats. TIBCO Enterprise Message Service
supports the following file formats:
• PEM
• DER
• PKCS#7
• PKCS#12
• Java KeyStore (for client digital certificates)
• Entrust Store (for client digital certificates)

TIBCO Enterprise Message Service User’s Guide

244
| Chapter 12 Using the SSL Protocol

Private Key Formats

Typically each application has a pair of different but related keys. The public key
is distributed to anyone, and the private key is kept secret by the owner of the key.
The two keys are used together to encrypt and decrypt messages sent over the
network.
TIBCO Enterprise Message Service supports the following private key formats:
• PEM
• DER
• PKCS#8
• PKCS#12
TIBCO Enterprise Message Service uses OpenSSL for generating and maintaining
keys. The server does not support Java KeyStore or Entrust Store formats.

TIBCO Enterprise Message Service User’s Guide

 Overview of the SSL Protocol 245
|

Overview of the SSL Protocol

The Secure Sockets Layer (SSL) protocol involves a handshake between the client
(the initiator) and the server (the target). SSL can be used when clients
communicate with EMS servers or when EMS servers communicate with each
other. Within this chapter, the term client is used to signify a client or server that
initiates SSL communication with a server.
SSL relies on digital certificates on the client and server for authentication and
encryption. See Digital Certificates on page 243 for more information on digital
certificates.
Figure 15 illustrates the SSL protocol between the client and server.

Figure 15 SSL Protocol

Client/Initiator Server/Target

1. Client initiates
2. Server negotiates version and cipher suite
3. Certificate (optional)
4. Certificate request (optional)
5. Server done with negotiation
6. Certificate (optional)
7. Client generates key
8. Certificate verify (optional)
9. Enter encrypted mode
10. Finished
11. Change to encrypted mode
12. Finished

Encrypted Data Encrypted Data

When an SSL connection is requested by a client, the client and the server perform
the following protocol:
1. The client sends an initiating message to the server. This message contains the
highest version of SSL and the list of cipher suites the client supports. See
Specifying Cipher Suites on page 258 for more information about cipher
suites.
2. The server chooses the highest version of SSL and the best cipher suite that
both the client and the server support. The server sends this information to the
client.

TIBCO Enterprise Message Service User’s Guide

246
| Chapter 12 Using the SSL Protocol

3. Optionally, the server sends its digital certificate or certificate chain. This is
only done if the client requires that the server authenticate itself.
4. Optionally, the server sends a request to the client for the client’s digital
certificate. This is only done if the server requires that the client authenticate
itself.
5. The server then informs the client that it has completed the initial negotiation.
6. Optionally, the client sends the server its digital certificate or certificate chain.
This is only done if the server requires that the client authenticate itself.
7. The client then generates information used to create a key to use for
symmetric encryption. This key is used to encrypt and decrypt data that is
exchanged between the client and the server. When using some cipher suites,
this key is then sent to the server.
8. Optionally, the client sends a digital signature to the server. The server
decrypts this signature using the client’s public key. If the server is successful
in decrypting the signature, the server authenticates the client. This is only
done if the server requires that the client authenticate itself.
9. The client informs the server to change to encrypted mode.
10. The client informs the server that it is ready for secure communication to
begin.
11. The server informs the client to change to encrypted mode.
12. The server informs the client that it is ready for secure communication to
begin.
When establishing an SSL connection, several of the steps described above are
optional. The client and the server can specify SSL configuration parameters to
control the connection steps. See Configuring SSL in the Server on page 252 and
Configuring SSL in EMS Clients on page 253 for more information about the SSL
configuration parameters for clients and servers.
Encryption keys can be renegotiated once the session begins, if parameters are set
to renegotiate keys after a certain amount of time or after a certain amount of data
is exchanged. See Renegotiating the Session Key on page 250 for more
information about renegotiating the encryption key for the session.

TIBCO Enterprise Message Service User’s Guide

 Overview of the SSL Protocol 247
|

Cipher Suite Negotiation

A fundamental part of the SSL handshake is the negotiation between client and
server for which encryption algorithms, key sizes, and so on to use. The
specification of a particular set of algorithms and key size is known as a cipher
suite. Both the client and the server can specify the cipher suites they support.
During the SSL handshake, the strongest cipher suite that is supported by both
the client and server is chosen.
See Specifying Cipher Suites on page 258 for more information about supported
cipher suites.

Client and Server Authentication

An optional part of the SSL handshake is for the client and server to authenticate
themselves to each other. This is to ensure that both parties guarantee they are
communicating with the expected applications.

Server Authentication to the Client

A rogue server could be set up to impersonate your EMS server. To prevent clients
connecting to the rogue server, the client can request that the server present its
digital certificate to the client.
During a handshake, the client requests the server’s digital certificate and checks
the certificate against the client’s list of trusted certificate authority certificates. If
the certificate authority of the server certificate is not in the client’s list, the client
halts further communications with that server.

Client Parameters Clients using ConnectionFactories specify the ssl_verify_host parameter to

require that the server authenticate itself to the client. Also, the ssl_trusted
parameter specifies the list of certificate authorities the client will trust. See
Configuring a ConnectionFactory on page 254 for more information about SSL
parameters in ConnectionFactories.
TIBCO Enterprise Message Service servers that act as clients in a fault-tolerant
configuration specify the ft_ssl_verify_host parameter to require that the
other server authenticate itself to the client. Also, the ft_ssl_trusted parameter
specifies the list of certificate authorities the server will trust. See Chapter 13,
Making the Server Fault-Tolerant, on page 265 for more information about fault
tolerance.

TIBCO Enterprise Message Service User’s Guide

248
| Chapter 12 Using the SSL Protocol

Server When SSL connections can be accepted by a server, any client may request server
Parameters authentication. Therefore, the server must specify the ssl_server_identity and
ssl_password (if the password is not part of the server’s digital certificate)
parameters. See Table 16 on page 106 for more information about specifying these
parameters.

Verifying the Server’s Hostname

In TIBCO Enterprise Message Service, the client can also be configured to verify
the hostname of the server. During a handshake, the client checks the CN field of
the server certificate against the name of the connected host, or if an expected
hostname is provided, against that name. If the names do not match, the
connection is rejected.

Client Parameters Clients using ConnectionFactories specify the ssl_verify_hostname and

ssl_expected_hostname parameters to require that the hostname in the server’s
digital certificate be verified. See Configuring a ConnectionFactory on page 254
for more information about SSL parameters in ConnectionFactories.
TIBCO Enterprise Message Service servers that act as clients in a fault-tolerant
configuration specify the ft_ssl_verify_hostname and
ft_ssl_expected_hostname parameters to require that the hostname in the
server’s digital certificate be verified. See Chapter 13, Making the Server
Fault-Tolerant, on page 265 for more information about fault tolerance.

Client Authentication to the Server

In many applications, the server accepts connections from any client, so server
authentication is not needed. However, client passwords can be compromised, so
you may wish to implement an additional check to verify the identity of clients.
To prevent rogue clients from logging into the server, the server can request that
the client present its digital certificate to the server.
During a handshake, the server requests the client’s digital certificate and checks
the certificate against its list of trusted certificate authority certificates. If the
certificate authority of the client certificate is not in the server’s list, the server
halts further communications with that client.

Server The TIBCO Enterprise Message Service server must specify true for the
Parameters ssl_require_client_cert parameter to require that clients authenticate
themselves. The ssl_server_trusted parameter specifies the list of certificate
authorities the server will trust. See Table 16 on page 106 for more information
about specifying configuration parameters.

TIBCO Enterprise Message Service User’s Guide

 Overview of the SSL Protocol 249
|
Client Parameters Clients using ConnectionFactories specify the ssl_identity and ssl_password
(if the password is not part of the client’s digital certificate) parameters when the
server requires that the client authenticate itself to the client. See Configuring a
ConnectionFactory on page 254 for more information about SSL parameters in
ConnectionFactories.

Retrieving the Username from the Client’s Digital Certificate

The TIBCO Enterprise Message Service server can also be configured to extract
the client's username from the client's digital certificate for authentication with
the EMS server (note that this is different from SSL authentication). If
authorization is enabled, the server authenticates the client using the username
from the client’s digital certificate. If the username is configured to also require a
password, the client must provide the password to the create connection call.

Server The TIBCO Enterprise Message Service server must specify true for the
Parameters ssl_use_cert_username parameter in tibemsd.conf to require that the
username from the client’s digital certificate is used when logging in. See Table 16
on page 106 for more information about specifying configuration parameters.

Using a Special User Name to Log In

The TIBCO Enterprise Message Service server can also be configured with a
special username that specifies clients logging in with that username are
authenticated with the server using the username taken from their digital
certificate.

Server The TIBCO Enterprise Message Service server must specify a username for the
Parameters ssl_cert_user_speccname parameter in tibemsd.conf to require that a user
logging in with that username will be authenticated using the username from the
client’s digital certificate. See Table 16 on page 106 for more information about
specifying configuration parameters.

TIBCO Enterprise Message Service User’s Guide

250
| Chapter 12 Using the SSL Protocol

Renegotiating the Session Key

Once a SSL connection is established, the client and the server agree on a
symmetric key for encrypting and decrypting data exchanged by either side. This
key normally lasts for the lifetime of the session, but the server can specify that
the key should be renegotiated (that is, changed based on certain criteria). A
server can specify that keys for sessions should be renegotiated based on elapsed
time or amount of data exchanged for the session.
When a key is renegotiated, the session is re-established, and this can have an
adverse effect on overall system performance. You should set renegotiation
parameters carefully to ensure that renegotiation only occurs when it is required.
See the description of the ssl_renegotiate_interval and
ssl_renegotiate_size parameters in Table 16 on page 106 for more information
about setting the renegotiation criteria.

TIBCO Enterprise Message Service User’s Guide

 File Names for Certificates and Keys 251
|

File Names for Certificates and Keys

For all parameters that specify the identity (digital certificate), private key, issuer
(certificate chain), or trusted list of certificate authorities, valid files must be
specified. Not all types of files are supported for clients and servers. The
description of the parameter details which formats are supported.
Table 32 lists the valid types of files.

Table 32 File types

Extension Description
.pem PEM encoded certificates and keys (allows the certificate and
private key to be stored together in the same file)

.der DER encoded certificates

.p8 PKCS#8 file

.p7b PKCS#7 file

.p12 PKCS12 file (allows the certificate and private key to be

stored together in the same file)

.jks Java KeyStore file

.epf Entrust store file

TIBCO Enterprise Message Service User’s Guide

252
| Chapter 12 Using the SSL Protocol

Configuring SSL in the Server

To use SSL, each instance of tibemsd must have a digital certificate and a private
key. The server can optionally require a certificate chain or trusted certificates.
You set the server to listen for SSL connections from clients by using the listen
parameter in tibemsd.conf. To specify that a port accept SSL connections,
specify the SSL protocol in the listen parameter as follows:
listen = ssl://localhost:7243

SSL Parameters
There are a number of SSL parameters that can be set in tibemsd.conf. However,
the only required parameter is ssl_server_identity. If the server’s certificate
does not have a private key contained in the certificate, then ssl_server_key
must also be specified.
Table 16 on page 106 provides a complete description of the SSL parameters that
can be set in tibemsd.conf.

Command Line Options

The server accepts a few command-line options for SSL.
When starting tibemsd, you can specify the following options:
• -ssl_trace — enables tracing of loaded certificates. This prints a message to
the console during startup of the server that describes each loaded certificate.
• -ssl_debug_trace — enables more detailed SSL tracing. This option is used
for debugging only; not for use in production systems.
• -ssl_password — specifies the private key password. This can also be
specified in the ssl_server_password parameter in tibemsd.conf, or if this
option is omitted, you will be prompted for the password when tibemsd
starts. See the description of the ssl_password configuration parameter for
more information.

TIBCO Enterprise Message Service User’s Guide

 Configuring SSL in EMS Clients 253
|

Configuring SSL in EMS Clients

For clients to use an SSL connection to the TIBCO Enterprise Message Service
server, the client must have the following JAR files included in the CLASSPATH:
• jsse.jar

• jnet.jar

• jcert.jar

• tibcrypt.jar

These files are included with TIBCO Enterprise Message Service, and will also be
included with JDK 1.4. If you are using JDK 1.3, JSSE is an add-on package, and
you must make sure to include the proper files in the CLASSPATH.
If you wish to use Entrust on the EMS client, you must separately purchase and
install the Entrust Version 6.1 libraries. If you use the Entrust libraries, you must
include them in the CLASSPATH before the JSSE JAR files. To use Entrust Version
6.1 with JDK 1.4.x, the unlimited strength policy JAR files have to be downloaded
form Sun's website and installed into your local installation of JDK 1.4.x. Please
refer to the Entrust Version 6.1 documentation for details on how to configure the
CLASSPATH and how to install unlimited strength policy files.

Client Digital Certificates

When client authentication with a digital certificate is required by the TIBCO
Enterprise Message Service server (see the description of the
ssl_require_client_cert parameter in tibemsd.conf), the client can present
the client certificate and private key in a single file in one of the following formats:
• PKCS#12
• Java KeyStore
• Entrust Store
The client certificate can also be stored separately from the client’s private key file.
If this is the case, the certificate and private key must be stored in one of the
following formats:
• PEM
• PKCS#8

TIBCO Enterprise Message Service User’s Guide

254
| Chapter 12 Using the SSL Protocol

The format of the client digital certificate and private key file depends greatly on
the type of SSL vendor used by the client. JSSE and Entrust support different
formats and combinations of formats. Refer to your SSL vendor’s documentation
for more information about the formats supported.

Configuring SSL
A Java client connecting to a TIBCO Enterprise Message Service server can
configure SSL characteristics in three ways:
• Using JNDI to lookup a ConnectionFactory object that specifies SSL
connectivity. That is, the server URL in the connection factory must use the
SSL protocol, and the SSL parameters must be specified.
• Setting global SSL parameters using the com.tibco.tibjms.TibjmsSSL class.
See TIBCO Enterprise Message Service Java API Reference included with TIBCO
Enterprise Message Service for more information about using that class.
• Using a direct constructor of TIBCO Enterprise Message Service connection
factory classes (TibjmsTopicConnectionFactory and/or
TibjmsQueueConnectionFactory).

The preferred mechanism is to use JNDI to lookup a configured

ConnectionFactory. However, in certain situations, direct use of the TibjmsSSL
class or the connection factory constructors may be required.
If you use a combination of these methods, there is an order of precedence.
Specifying any SSL parameters within the connection factory causes all global SSL
parameters set with the TibjmsSSL class to be ignored.

Configuring a ConnectionFactory
You can configure a ConnectionFactory using the administration tool or the Java
Administration API provided by TIBCO Enterprise Message Service. See
Chapter 8, Using the Administration Tool, on page 145 for more information
about using this tool and configuring ConnectionFactories.
When configuring a ConnectionFactory, you can specify several parameters for
SSL. These parameters are similar to the parameters that you specify when
configuring the TIBCO Enterprise Message Service server in tibemsd.conf.

When configuring a connection factory, any file names specified in the SSL
parameters are not verified. At the time the factory is retrieved using JNDI, the
TIBCO Enterprise Message Service server attempts to resolve any file references.
If the files do not match the supported types or the files are not found, the JNDI
lookup fails with a ConfigurationException.

TIBCO Enterprise Message Service User’s Guide

 Configuring SSL in EMS Clients 255
|

Table 33 describes the parameters you can set in the ConnectionFactory and gives
a pointer for more information about each parameter. See the description of the
equivalent parameter in tibemsd.conf for more information about each
parameter.

Table 33 ConnectionFactory SSL parameters (Sheet 1 of 3)

Parameter Description
ssl_vendor The SSL vendor name to be used by a Java
client.

ssl_identity The client’s digital certificate.

See File Names for Certificates and Keys
on page 251 for more information on file
types for digital certificates.

ssl_issuer Issuer’s certificate chain for the client. The

client reads the certificates in the chain in
the order they are presented in this
parameter.
See File Names for Certificates and Keys
on page 251 for more information on file
types for digital certificates.

ssl_private_key The client’s private key. If it is included in

the digital certificate in ssl_identity,
then this parameter is not needed.
See File Names for Certificates and Keys
on page 251 for more information on file
types for digital certificates.

ssl_trusted List of trusted certificates. This sets which

Certificate Authority certificates should be
trusted as issuers of the server certificates.
The same certificate can appear in multiple
places in the certificate chain.
See File Names for Certificates and Keys
on page 251 for more information on file
types for digital certificates.

TIBCO Enterprise Message Service User’s Guide

256
| Chapter 12 Using the SSL Protocol

Table 33 ConnectionFactory SSL parameters (Sheet 2 of 3)

Parameter Description
ssl_verify_host Specifies whether the client should verify
the server’s certificate. The values for this
parameter are enabled or disabled. By
default, this parameter is enabled,
signifying the client should verify the
server’s certificate.
When this parameter is set to disabled,
the client establishes secure
communication with the server, but does
not verify the server’s identity.

ssl_verify_hostname Specifies whether the client should verify

the name in the CN field of the server’s
certificate. The values for this parameter
are enabled and disabled. By default,
this parameter is enabled, signifying the
client should verify the name of the
connected host or the name specified in
the ssl_expected_hostname parameter
against the value in the server’s certificate.
If the names do not match, the connection
is rejected.
When this parameter is set to disabled,
the client establishes secure
communication with the server, but does
not verify the server’s name.

ssl_expected_hostname The name the server is expected to have in

the CN field of the server’s certificate. If
this parameter is not set, the expected
name is the hostname of the server.
This parameter is used when the
ssl_verify_hostname parameter is set to
enabled.

TIBCO Enterprise Message Service User’s Guide

 Configuring SSL in EMS Clients 257
|
Table 33 ConnectionFactory SSL parameters (Sheet 3 of 3)

Parameter Description
ssl_ciphers Specifies the cipher suites used by the
client, each suite in the list is separated by
a colon (:). This parameter can use the
OpenSSL name for cipher suites or the
longer, more descriptive names.
See Specifying Cipher Suites on page 258
for more information about the cipher
suites available in TIBCO Enterprise
Message Service and the OpenSSL names
and longer names for the cipher suites.

ssl_rand_egd The path for the installed entropy

gathering daemon (EGD), if one is
installed. This daemon is used to generate
random numbers for the client.

TIBCO Enterprise Message Service User’s Guide

258
| Chapter 12 Using the SSL Protocol

Specifying Cipher Suites

On the TIBCO Enterprise Message Service server, the cipher suite is specified by
the ssl_server_ciphers configuration parameter in tibemsd.conf. For clients
connecting with a ConnectionFactory, the cipher suite is specified by the
ssl_ciphers ConnectionFactory parameter.

See Chapter 7, Using the Configuration Files, on page 105 for more information
about server configuration files. See Configuring SSL in EMS Clients on page 253
for more information about specifying SSL parameters within a
ConnectionFactory.

Syntax for Cipher Suites

TIBCO Enterprise Message Service uses OpenSSL to provide SSL support.
Therefore, the cipher suite names can be specified as the OpenSSL name for the
cipher suite.
When specifying cipher suites, the normal way to specify more than one cipher
suite is to separate each suite name with a colon (:) character. However, you can
also use spaces and commas to separate names, but the colon is the usual
separator.

Java Client Syntax

The syntax for specifying the list of cipher suites is different for Java clients than
for any other location where cipher suites can be specified. For Java clients, you
specify a qualifier (for example, + to add the suite) followed by the cipher suite
name. Table 34 describes the qualifiers you can use when specifying cipher suite
names in a ConnectionFactory for Java clients.

Table 34 Qualifiers for cipher suites in the Java client (Sheet 1 of 2)

Qualifier Description
+ Add the cipher to the list of ciphers.

- Remove the cipher from the list of ciphers.

> Move the cipher to the end of the list.

< Move the cipher to the beginning of the list.

TIBCO Enterprise Message Service User’s Guide

 Specifying Cipher Suites 259
|
Table 34 Qualifiers for cipher suites in the Java client (Sheet 2 of 2)

Qualifier Description
all All ciphers from the list. You can use this keyword to add or
remove all ciphers.
At least one cipher suite must be present or the SSL
connection fails to initialize. So, if you use -all, you should
then add the desired ciphers to the list.

The following is an example of specifying cipher suites in the ssl_ciphers

ConnectionFactory parameter in a Java client.
-all:+RC4-MD5:+DES-CBC-SHA:<DES-CBC3-SHA

Syntax for All Other Cipher Suite Specifications

For any cipher suite list that is not specified in a ConnectionFactory of a Java
client, the OpenSSL syntax is used. For example, when specifying the
ssl_server_ciphers configuration parameter, or when specifying cipher suites
for C clients, the OpenSSL syntax is used.
In OpenSSL, specifying a cipher suite name adds that cipher suite to the list. Each
cipher suite name can be preceded by a qualifier. Table 35 describes the qualifiers
you can use when specifying cipher suite names using OpenSSL syntax.

Table 35 OpenSSL qualifiers for cipher suites

Qualifier Description
+ Moves the cipher to the end of the list.

- Remove the cipher from the list of ciphers. When this option
is used, the cipher can be added later on in the list of ciphers.

! Remove the cipher permanently from the list of ciphers. Use

this option if you wish to remove a cipher and you do not
want later items in the list to add the cipher to the list.

all All ciphers from the list. You can use this keyword to add or
remove all ciphers.
At least one cipher suite must be present or the SSL
connection fails to initialize. So, after using -all, you should
add at least one cipher to the list.

TIBCO Enterprise Message Service User’s Guide

260
| Chapter 12 Using the SSL Protocol

The following is an example of specifying cipher suites in the

ssl_server_ciphers configuration parameter.

ssl_server_ciphers = -all:RC4-MD5:DES-CBC-SHA:DES-CBC3-SHA

The following example illustrates removing RC4-MD5 from the list, then adding all
other ciphers:
ssl_server_ciphers = !RC4-MD5:all

Supported Cipher Suites

Table 36 lists the cipher suites supported in Java clients using TIBCO Enterprise
Message Service. The table lists both the standard name and the OpenSSL name
for the cipher suite.

Table 36 Supported cipher suites (Sheet 1 of 2)

Suite Name
(OpenSSL Name) Export Key Exch Auth Encrypt Key Size MAC

SSL_RSA_WITH_RC4_128_MD5
(RC4-MD5)

RSA RSA RC4 128 MD5

SSL_RSA_WITH_RC4_128_SHA
(RC4-SHA)

RSA RSA RC4 128 SHA1

SSL_RSA_WITH_DES_CBC_SHA
(DES-CBC-SHA)

RSA RSA DES 56 SHA1

SSL_RSA_WITH_3DES_EDE_CBC_SHA
(DES-CBC3-SHA)

RSA RSA 3-DES 168 SHA1

SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5
(EXP-RC2-CBC-MD5)

Yes RSA(512) RSA RC2 40 MD5

TIBCO Enterprise Message Service User’s Guide

 Specifying Cipher Suites 261
|

Table 36 Supported cipher suites (Sheet 2 of 2)

Suite Name
(OpenSSL Name) Export Key Exch Auth Encrypt Key Size MAC

SSL_RSA_EXPORT_WITH_RC4_40_MD5
(EXP-RC4-MD5)

Yes RSA(512) RSA RC4 40 MD5

SSL_RSA_EXPORT_WITH_DES_40_CBC_SHA
(EXP-DES-CBC-SHA)

Yes RSA(512) RSA DES 40 SHA1

SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
(EDH-DSS-DES-CBC3-SHA)

DH DSS 3-DES 168 SHA1

SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
(EDH-RSA-DES-CBC3-SHA)

DH RSA 3-DES 168 SHA1

SSL_DHE_DSS_WITH_DES_CBC_SHA
(EDH-DSS-DES-CBC-SHA)

DH DSS DES 56 SHA1

SSL_DHE_RSA_WITH_DES_CBC_SHA
(EDH-RSA-DES-CBC-SHA)

DH RSA DES 56 SHA1

SSL_DHE_DSS_EXPORT_WITH_DES_40_CBC_SHA
(EXP-EDH-DSS-DES-CBC-SHA)

Yes DH(512) DSS DES 40 SHA1

SSL_DHE_RSA_EXPORT_WITH_DES_40_CBC_SHA
(EXP-EDH-RSA-DES-CBC-SHA)

Yes DH(512) RSA DES 40 SHA1

TIBCO Enterprise Message Service User’s Guide

262
| Chapter 12 Using the SSL Protocol

Third-Party SSL Hardware Accelerators

While the SSL protocol provides message security and integrity, the connection
handshake and bulk message encryption can require significant machine
resources. To reduce this overhead, you can deploy a third-party SSL hardware
accelerator. The TIBCO Enterprise Message Service server supports external
(rack-mount) hardware accelerators. SSL accelerators are capable of off-loading
the main CPU from asymmetric public/private key negotiations as well as well as
secret key bulk message encryption and decryption.

Ingrian Accelerator
Ingrian provides a variety of accelerator products, such as the Ingrian i100, i140,
i210, and so on. These products are external hardware accelerators that fit into
standard rack mount space. The Ingrian Accelerator is placed on the network
between the client and the server and off loads all SSL functionality from the
server. The clients use SSL to communicate with the server by connecting to an
SSL port on the Ingrian Accelerator. The Ingrian Accelerator completely performs
the SSL handshake and passes messages to the server over TCP. Figure 16
illustrates the operation of the Ingrian Accelerator.

Figure 16 Ingrian Accelerator

SSL TCP
Client Ingrian Accelerator Server

Because the Ingrian Accelerator performs all SSL functionality, it must be

separately configured for listen ports, certificates, and so on. See
www.ingrian.com for more information about Ingrian Accelerator products, and
refer to the documentation for the specific accelerator for information about how
to configure the accelerator for your application.

Configuring the Ingrian Accelerator for Communication with the TIBCO

Enterprise Message Service Server
The Ingrian Accelerator is configured to pass data from a client to a server
through forwarding rules. A forwarding rule specifies, among other things, the
listen port that clients connect to, the target port on the back-end server, the
protocol that clients use to communicate with the Ingrian Accelerator, and the
protocol that the accelerator uses to communicate with the back end server.

TIBCO Enterprise Message Service User’s Guide

 Third-Party SSL Hardware Accelerators 263
|

The Ingrian Accelerator supports several protocols. To be used with the TIBCO
Enterprise Message Service server however, the accelerator must be configured to
use the “SSL Any” protocol to communicate with clients and the “Any” protocol
to communicate with the server. See the documentation for the specific Ingrian
Accelerator you are using for information about how to configure forwarding
rules.
The Ingrian Accelerator can also be configured to extract the user name from the
client certificate and pass it to the server for user authentication. If you require
this functionality, please contact TIBCO for instructions about how to enable this
feature in the Ingrian Accelerator and the TIBCO Enterprise Message Service
server.
Because the Ingrian Accelerator off loads the server of all SSL functionality, none
of the parameters in tibemsd.conf for configuring SSL in the server are used.
When the Ingrian Accelerator is deployed, the TIBCO Enterprise Message Service
server should be configured to use standard TCP communication.

TIBCO Enterprise Message Service User’s Guide

264
| Chapter 12 Using the SSL Protocol

TIBCO Enterprise Message Service User’s Guide

 | 265

Chapter 13 Making the Server Fault-Tolerant

This chapter describes the fault-tolerant features of TIBCO Enterprise Message

Service.

Topics

• Fault Tolerance Overview, page 266

• Shared State, page 267
• Setting Up Fault-Tolerant Servers, page 269
• Setting Up Clients for Fault-Tolerant Connections, page 271
• Failover, page 273

TIBCO Enterprise Message Service User’s Guide

266
| Chapter 13 Making the Server Fault-Tolerant

Fault Tolerance Overview

You can configure TIBCO Enterprise Message Service servers as primary and
backup servers to provide fault tolerance for your environment. The primary and
backup servers act as a pair, with the primary server accepting client connections
and performing the work of handling messages, and the secondary server acting
as a backup in case of failure. The primary and backup servers must both have
access to a shared state. This shared state can be implemented as shared storage
devices or through other mechanisms, such as replication. This shared state
allows the backup server to take over any active connections and properly handle
persistent messages.
Figure 17 illustrates a fault-tolerant configuration of TIBCO Enterprise Message
Service.

Figure 17 Primary Server and Backup Server

Shared
State

Primary Backup
Server Server

When the primary server fails, the backup server resumes operation and becomes
the primary server. Before becoming the new primary server, the backup server
re-reads all of its configuration files. If the two servers share configuration files,
then administrative changes to the old primary carry over to the new primary.

When fault-tolerant servers share configuration files, we strongly recommend

that you limit configuration changes to the current primary server only.
Separately reconfiguring the backup server can cause it to overwrite the shared
configuration files; unintended misconfiguration can result.

TIBCO Enterprise Message Service User’s Guide

 Shared State 267
|

Shared State

The primary server and backup server must share the same state. The state of the
servers includes:
• persisted messages for queues and topics
• information on the primary server’s client connections
• metadata regarding data delivery
During normal operation of the primary server, all persisted messages are stored
then delivered. During a failover, all shared state information that exists is
retrieved by the backup server.

Implementing Shared State

Shared state can be implemented by shared storage or through other means such
as replication. The shared state must be accessible to both the primary and backup
servers.
Some common ways to implement shared storage are Network Attached Storage
(NAS) or Storage Area Network (SAN) devices. Replication schemes from
popular vendors such as Veritas or EMC can also be used for replicating the
shared state.
To prevent the backup server from assuming the role of the primary server
unnecessarily, the primary server locks the shared state during normal operation.
If the primary server fails, the lock is released, and the backup server can obtain a
lock on the shared state.

Caution: When replication is used, however, the backup server may read the state
from a separate location, ignoring the primary server’s lock on the state.

Which Messages Are Stored

Messages delivered using PERSISTENT delivery mode are stored and are
available in the event of primary server failure. Messages delivered with
NON_PERSISTENT delivery mode will not be stored in persistent storage, and
will not be available if the primary server fails.
See Message Redelivery on page 274 for more information about recovery of
messages in PERSISTENT and NON_PERSISTENT delivery mode during
failover.

TIBCO Enterprise Message Service User’s Guide

268
| Chapter 13 Making the Server Fault-Tolerant

Storage Files
The location of the storage files is defined by the store parameter in the main
configuration file:
store = <storage-directory>

The tibemsd server creates three files:

• meta.db

• sync-msgs.db

• async-msgs.db

The meta-information file stores information required by the server, but stores no
messages.
The two message-storage files are used for persistent storage of messages for
queues and topics, depending on whether the queue or topic is defined as
failsafe and requires synchronous I/O.

• If a queue or a topic is defined as failsafe in the corresponding

configuration file, messages for that topic or queue are stored in the
sync-msgs.db file.

• If the queue or topic is not defined as failsafe, messages for the queue or topic
are stored in async-msgs.db file.
For more information on the failsafe property, refer to failsafe on page 33. See
Chapter 7, Using the Configuration Files, on page 105 for more information about
editing the main configuration file.

Controlling Storage
There are three other parameters for controlling storage:
• store_minimum — Preallocates storage space for TIBCO Enterprise Message
Service. If store_truncate is enabled, the storage is not truncated below the
minimum size specified in this parameter. You can specify units in this
parameter in MB, KB, or GB. Specifying 0 for this parameter signifies that
there should be no minimum amount of storage space.
• store_crc — Specifies whether crc checksum data are checked when reading
data from storage.
• store_truncate — Specifies whether TIBCO Enterprise Message Service
should periodically attempt to truncate the storage files. When set to enabled,
the storage files may be truncated, but not below the size specified in the
store_minimum parameter.

TIBCO Enterprise Message Service User’s Guide

 Setting Up Fault-Tolerant Servers 269
|

Setting Up Fault-Tolerant Servers

A backup fault-tolerant server is specified by having the following configuration

parameters set:
• the server parameter must be set to the same name as the primary server
• the ft_active parameter must be set to the URL of the primary server
When the backup server starts, it attempts to connect to the primary server. If the
connection can be established, the backup server enters standby mode for the
primary. If the connection cannot be established, the backup server becomes the
primary server.
If the backup server is in standby mode, it does not accept connections from
clients, but the admin user can connect to the backup server by way of the
administration tool to administer the server.
For example, you may have a primary server whose server name is set to
EMSserver. You would set the following parameters to configure the backup
server:
server = "EMSserver"
ft_active = ssl://activehost:7522

The primary server should set the ft_active parameter to the URL of the backup
server. This allows the primary and backup servers to exchange roles in the event
of a failure.
You can set the configuration parameters in the main configuration file or on the
command line when starting the servers.

Using SSL for Connections Between Primary and Backup Servers

Communication between the primary and backup servers can be secured by
using SSL. You configure the communication between servers in the same way
that you configure the primary server’s SSL characteristics. This configuration is
done by way of parameters in tibemsd.conf configuration file.
The parameters for configuring SSL communication between fault-tolerant
servers start with ft_ssl. When configuring the ft_ssl parameters, these
parameters specify the communication characteristics for the server on which
they are configured. For example, if you are configuring your backup server, the
ft_ssl parameters specify the SSL characteristics that the backup server uses to
communicate with the primary server.

TIBCO Enterprise Message Service User’s Guide

270
| Chapter 13 Making the Server Fault-Tolerant

See Table 16 on page 106 for a description of configuration parameters for SSL
communication between fault-tolerant servers. See Chapter 12, Using the SSL
Protocol, on page 241 for more information on SSL.

Reconnect Timeout
When a backup server assumes the role of the primary server during failover,
client connections can reconnect to the backup server and continue with
processing their current message state. The backup server reads the clients’ state
from the shared state, and the server can be configured to clean up any state
information for clients that have not reconnected after a certain period of time.
The ft_reconnect_timeout configuration parameter specifies the amount of
time, in seconds, a backup server waits for clients to reconnect before their state is
removed from the shared state.
The default value of this parameter is 60.

TIBCO Enterprise Message Service User’s Guide

 Setting Up Clients for Fault-Tolerant Connections 271
|

Setting Up Clients for Fault-Tolerant Connections

To connect to a backup server in the event of a failure of a primary server, a client

application must specify multiple server URLs as part of the connection to the
EMS server. This can be done in various ways, depending upon how the client
connects to the server. In any method, however, the server URLs for the primary
and backup server are specified as a comma-separated list of URLs, and the same
protocol (that is, tcp or ssl) must be used for both the primary and backup server
connections.

The URLs in the list are tried in order. If a connection to the first URL fails, the
next URL is used to attempt a reconnection. The connections in the list are
attempted in sequence (wrapping to the start of the list, if the first connection was
not the failed connection) until all URLs have been tried. If no connection is
established after all URLs have been tried, the connection fails.

In the following examples tcp://server0:7222 is the first choice server, and

tcp://server1:7344 is the second choice server (if first choice is unavailable).

Using TibjmsConnectionFactory in Java

Java clients can list the primary and backup server URLs in the serverURL
argument to a TibjmsConnectionFactory constructor. For example:
TibjmsTopicConnectionFactory factory = new
TibjmsTopicConnectionFactory("tcp://server0:7222,
tcp://server1:7344");

ConnectionFactoryInfo Constructor in Java

Java clients can use the Java Administrator API to specify the primary and backup
server URLs in the url argument to a ConnectionFactoryInfo constructor. For
example:
ConnectionFactoryInfo cfi = new
ConnectionFactoryInfo("ssl://server0:7222,tcp://server1:7344,
ssl://server2:7222",QUEUE_TYPE,params);

Connection Constructor in C
C clients list the primary and backup server URLs in the brokerURL argument to
a connection constructor. For example:
tibjmsQueueConnection_Create(&qc,"tcp://server0:7222,
tcp://server1:7344",NULL,"admin",NULL);

TIBCO Enterprise Message Service User’s Guide

272
| Chapter 13 Making the Server Fault-Tolerant

JNDI Look-up Using Command Line Tool

The client can use the tibemsadmin command-line tool to specify multiple server
URLs in the url argument to the create factory command. For example:
create factory myFactory topic
url=tcp://server0:7545,tcp://server1:7344,tcp://server2:7433

Specifying More Than Two URLs

Even though there are only two servers (the primary and backup servers), clients
can specify more than two URLs for the connection. This can be useful if there is
more than one listen address on each server. The client can reconnect to the same
server during a failover using a different address. Also, this can be useful if there
are parallel systems available for catastrophe recovery (for example, duplicate
systems in different geographic locations for earthquake recovery).

TIBCO Enterprise Message Service User’s Guide

 Failover 273
|

Failover

Detection
A backup server detects a failure of the primary in either of two ways:
• Heartbeat Failure—The primary server sends heartbeat messages to the backup
server to indicate that it is still operating. When a network failure stops the
servers from communicating with each other, the backup server detects the
interruption in the steady stream of heartbeats. For details, see Heartbeat
Parameters on page 275.
• Connection Failure—The backup server can detect the failure of its TCP
connection with the primary server. When the primary process or its host
computer terminates unexpectedly, the backup server detects the broken
connection.

Response
When a backup server (B) detects the failure of the primary server (A), then B
attempts to assume the role of primary server. First, B obtains the lock on the
current shared state. When B can access this information, it becomes the new
primary server.

Role Reversal When B becomes the new primary server, A can restart as a backup server, so that
the two servers exchange roles.

Client Transfer Clients of A that are configured to failover to backup server B automatically
transfer B when it becomes the new primary server. B reads the client’s current
state from the shared storage to deliver any persistent messages to the client.

Client Notification Client applications can receive notification when failover occurs. To receive
notification, the client must set the system property
tibco.tibjms.ft.switch.exception to any value. When this system property
is defined, the application’s ExceptionListener receives a callback on failover.
For more information, see the description of the class com.tibco.tibjms.Tibjms
in TIBCO Enterprise Message Service Java API Reference.

Lock Unavailable If B cannot obtain the lock immediately, it repeatedly attempts to obtain the lock.
The resolution of the situation depends on the status of the TCP connection
between the servers:

TIBCO Enterprise Message Service User’s Guide

274
| Chapter 13 Making the Server Fault-Tolerant

• While the connection remains intact, these resolutions are possible:

— B eventually does obtain the lock, and becomes the new primary.
— Restored network communications allow heartbeats to reach B. B detects
that A is still functioning as the primary, so B reverts to its previous role as
a backup server.
— B attempts to obtain the lock indefinitely.
• When the connection is broken, these resolutions are possible:
— B eventually does obtain the lock, and becomes the new primary.
— A continues as primary. However, B can never restore the connection, and
attempts to obtain the lock indefinitely. You must terminate B and restart it
(as a backup server); the new process establishes a new connection to A.

Message Redelivery
When a failure occurs, messages that have the delivery mode set to PERSISTENT
that were not successfully acknowledged before the failure are redelivered.
Messages whose delivery mode is not set to PERSISTENT may be recovered, but
they are not guaranteed to be recovered.
Any messages that have been successfully acknowledged or committed are not
redelivered, in compliance with the JMS 1.1 specification. Also, messages that
have PERSISTENT delivery modes and have a failsafe destination are guaranteed
to not be lost during a failure.
All topic subscribers continue normal operation after a failover.

Queues
For queue receivers, any messages that have been sent to multiple receivers, but
have not been acknowledged before the failover, may be sent to other receivers
immediately after the failover.
A receiver trying to acknowledge a message after a failover may receive the
javax.jms.IllegalStateException. This exception signifies that the attempted
acknowledgement is for a message that has already been sent to another queue
receiver. This exception only occurs in this scenario or if the Session or
Connection have been closed. This exception cannot occur if there is only one
receiver at the time of a failover, but it may occur for exclusive queues if more
than one receiver was started for that queue.

TIBCO Enterprise Message Service User’s Guide

 Failover 275
|

When the queue receiver encounters the javax.jms.IllegalStateException,

the best course of action is to call the Session.recover() method. Your
application should also be prepared to handle redelivery of messages in this
event. All queue messages that can be redelivered to another queue receiver after
a failover always have JMSRedelivered header field set to true. Applications can
check that field to avoid duplicate processing of the same message in the case of
redelivery.

Acknowledged messages are never redelivered (in compliance with the JMS
specification). The case described above occurs when the application cannot
acknowledge a message because of a failover.

Transacted Sessions
Sessions with active transactions cannot commit the transaction after a failover to
a backup server. Transactions are active when at least one message has been sent
or received by a transacted session and the session has not issued a call to
Session.commit().

After a failover, when a client attempts to call the Session.commit() method, the
application will throw a javax.jms.TransactionRolledBackException. Clients
that use transactions should account for this possibility and handle the exception
in the event of a failover.
Once the transaction is rolled back, the client should resend any messages sent
during a transaction. All messages delivered to the session that rolled back the
transaction are automatically redelivered.

Heartbeat Parameters
When the primary server heartbeat fails, there is an activation interval (time
elapsed after the last heartbeat received) and then the backup server retrieves
information and takes over.
The heartbeat interval default is set at three seconds, and the activation interval
default is set at ten seconds. The activation interval must be set to at least twice
the heartbeat interval. The heartbeat and activation intervals are specified in
seconds and represent how often the servers will send heartbeats and the interval
for which activation will occur in the absence of any heartbeat. These intervals are
set in the administration tool or in the configuration file.
See Table 16 on page 106 for more information about the heartbeat activation and
interval configuration parameters.

TIBCO Enterprise Message Service User’s Guide

276
| Chapter 13 Making the Server Fault-Tolerant

TIBCO Enterprise Message Service User’s Guide

 | 277

Chapter 14 Working With Routes

This chapter describes routing of messages among TIBCO Enterprise Message

Service servers.

Topics

• Overview of Routing, page 278

• Zone, page 282
• Active and Passive Routes, page 285
• Configuring Routes and Zones, page 286
• Routed Topic Messages, page 291
• Routed Queues, page 296
• Routing and Authorization, page 298

TIBCO Enterprise Message Service User’s Guide

278
| Chapter 14 Working With Routes

Overview of Routing

TIBCO Enterprise Message Service servers can route messages to other servers.
• Topic messages can travel one hop or multiple hops (from the first server).
• Queue messages can travel only one hop to the home queue, and one hop from
the home queue.

You can define routes using an administrative interface (that is, configuration
files, tibemsadmin, or administration API).

TIBCO Enterprise Message Service User’s Guide

 Route 279
|

Route

Basic Operation
• Each route connects two TIBCO Enterprise Message Service servers.
• Each route forwards messages between corresponding destinations (that is,
destinations of the same type, with the same name) on its two servers.
• Routes are bidirectional; that is, each server in the pair forwards messages
along the route to the other server.

For example, the compact view at the top of Figure 18 denotes a route between
two servers, A and B. The exploded view beneath it illustrates the behavior of the
route. Each server has a global queue named Q1 and a global topic named T1;
these destinations correspond, so the route forwards messages between them. In
addition, server A has a global topic T2, which does not correspond to any topic
on server B. The route does not forward messages from T2.

Figure 18 Routes: bidirectionality and corresponding destinations

Route
Server: A Server: B

Server: A Server: B

Queue: Q1 Queue: Q1

Topic: T1 Topic: T1

Topic: T2

TIBCO Enterprise Message Service User’s Guide

280
| Chapter 14 Working With Routes

Global Destinations
Routes forward messages only between global destinations—that is, topics and
queues for which the global property is true (on both servers). This rule
overrides the inherent bidirectionality of routes. (For more information about
destination properties, See Destination Properties on page 32.)
Figure 19 illustrates a route between two servers, C and D, with corresponding
destinations Q1 and Q2. Notice that Q1 is global on both C and D, so both servers
forward messages across the route to the corresponding destination. However, Q2
is not global on C, neither C nor D forward Q2 messages to one another.

Figure 19 Routes: global destinations

Server: C Server: D

Q1 Q1
global=true global=true

Q2
Q2
global=true

Unique Routing Path

It is illegal to define a set of routes that permit a message to reach a server by more
than one path. TIBCO Enterprise Message Service servers detect illegal duplicate
routes and report them as configuration errors.
Figure 20 on page 281 depicts two sets of routes. On the left, the routes connecting
servers A, B, C, D and E form an acyclic graph, with only one route connecting
any pair of servers; this configuration is legal (in any zone).
In contrast, the routing configuration on the right is illegal in a multi-hop zone.
The graph contains redundant routing paths between servers Q and S (one direct,
and one through R and T).

Note that the configuration on the right is illegal only in a multi-hop zone; it is
legal in a one-hop zone. For further information, see Zone on page 282.

TIBCO Enterprise Message Service User’s Guide

 Route 281
|

Figure 20 Routes: Unique Path

Legal Illegal (in a multi-hop zone)

A B C P Q R

D E S T

TIBCO Enterprise Message Service User’s Guide

282
| Chapter 14 Working With Routes

Zone

Zones restrict the behavior of routes, so you can configure complex routing paths.
Zones affect topic messages, but not queue messages.

Basic Operation
A zone is a named set of routes. Every route belongs to a zone. A zone affects the
forwarding behavior of its routes:
• In a multi-hop (mhop) zone, topic messages travel along all applicable routes
to all servers connected by routes within the zone.
• In a one-hop (1hop) zone, topic messages travel only one hop (from the first
server).
• Queue messages travel only one hop, even within multi-hop zones.

For example, Figure 21 depicts a set of servers connected by routes within a

multi-hop zone, Z1. If a client sends a message to a global topic on server B, the
servers forward the message to A, C, D and E. In contrast, if Z1 were a one-hop
zone, B would forward the message to A, C and D—but D would not forward it E.

Figure 21 Zones: multi-hop

A B C

Zone: Z1
mhop

D E

Eliminating Redundant Paths with a One-Hop Zone

Figure 22 illustrates an enterprise with four servers:
• B1 and B2 serve producers at branch offices of an enterprise.
• M serves consumers at the main office, which process the messages from the
branches.
• R serves consumers that record messages for archiving, auditing, and backup.

TIBCO Enterprise Message Service User’s Guide

 Zone 283
|

The goal is to forward messages from B1 and B2 to both M and R. The routing
graph seems to contain a cycle—the path from B1 to M to B2 to R duplicates the
route from B1 to R. However, since these routes belong to the one-hop zone Z2, it
is impossible for messages to travel the longer path. Instead, this limitation results
in the desired result—forwarding from B1 to M and R, and from B2 to M and R.

Figure 22 Zones: one-hop

B1 B2

Zone: Z2
1hop

M R

Overlapping Zones
A server can have routes that belong to several zones. When zones overlap at a
server, the routing behavior within each zone does not limit routing in other
zones. That is, when a forwarded message reaches a server with routes in several
zones, the message crosses zone boundaries, and its hop count is reset to zero.
Figure 23 on page 284 illustrates an enterprise with one-hop zones connecting all
the servers in each of several cities in a fully-connected graph. Zone TK connects
all the servers in Tokyo; zone NY connects all the servers in New York; zone PA
connects all the servers in Paris. In addition, the multi-hop zone WO connects one
server in each city.
When a client of server TK3 produces a message, it travels one hop to each of the
other Tokyo servers. When the message reaches TK1, it crosses into zone WO. TK1
forwards the message to NY1, which in turn forwards it to PA1. When the
message reaches NY1, it crosses into zone NY (with hop count reset to zero); NY1
forwards it one hop to each of the other New York servers. Similarly, when the
message reaches PA1, it crosses into zone PA (with hop count reset to zero); PA1
forwards it one hop to each of the other Paris servers.

TIBCO Enterprise Message Service User’s Guide

284
| Chapter 14 Working With Routes

Figure 23 Zones: overlap

TK3 TK2 PA2 PA3

Zone: TK Zone: WO Zone: PA

TK4 1hop TK1 PA1 1hop PA4
mhop

NY1 NY2

Zone: NY
NY4 1hop NY3

TIBCO Enterprise Message Service User’s Guide

 Active and Passive Routes 285
|

Active and Passive Routes

A route connects two servers. You may configure a route at either or both of the
servers. When you configure a route at only one server, this asymmetry results in
two perspectives on the route:
• A route is active from the perspective of the server where it is configured. This
server actively initiates the connection to the other server, so we refer to it as
the active server, or initiating server.
• A route is passive from the perspective of the other server. This server
passively accepts connection requests from the active server, so we refer to it
as the passive server.

A server can have both active and passive routes. That is, you can configure
server S to initiate routes, and also configure other servers to initiate routes to S.
Both of two servers can configure an active route one to the other. This
arrangement is called an active-active configuration. For example, server A specifies
a route to server B, and B specifies a route to A. Either server can attempt to
initiate the connection. This configuration results in only one connection; it does
not result in redundant routes.
You can specify and modify the properties of an active route, but not those of a
passive route. That is, properties of routes are associated with the server where
the route is configured, and which initiates the connection.

Note that defining a route specifies a zone as well (either implicitly or explicitly).
The first route in the zone defines the type of the route; subsequent routes in the
same zone must have the same zone type (otherwise, the server reports an error).

TIBCO Enterprise Message Service User’s Guide

286
| Chapter 14 Working With Routes

Configuring Routes and Zones

You can create routes using the administration tool (see Chapter 8 on page 145), or
the administration API (see com.tibco.tibjms.admin.RouteInfo in TIBCO
Enterprise Message Service Java API Reference).

Syntax To create a route using the administration tool, first connect to one of the servers,
then use the create route command with the following syntax:
create route <name> url=<URL> zone_name=<zone_name> zone_type=1hop|mhop <properties>

• <name> is the name of the passive server; it also becomes the name of the route.
• <URL> specifies the passive server by its URL—including protocol and port.
If your environment is configured for fault tolerance, the URL can be a
comma-separated list of URLs denoting fault-tolerant servers. For more
information about fault tolerance, see Chapter 13, Making the Server
Fault-Tolerant, on page 265.
• <zone_name> specifies that the route belongs to the routing zone with this
name. When absent, the default value is default_mhop_zone (this default
yields backward compatibility with configurations from releases earlier than
4.0.0).
• The zone type is either 1hop or mhop. When omitted, the default value is mhop.
• <properties> is a space-separated list of properties for the route. Each property
has the syntax <prop_name>=<value>.
For gating properties that control the flow of topics along the route, see
Selectors for Routing Topic Messages on page 293.
For properties that configure the Secure Sockets Layer (SSL) protocol for the
route, see Routing and SSL on page 287.

Example For example, these commands on server A would create routes to servers B and C.
The route to B belongs to the one-hop zone Z1. The route to C belongs to the
multi-hop zone ZM.
create route B url=tcp://B:7454 zone_name=Z1 zone_type=1hop
create route C url=tcp://C:7455 zone_name=ZM zone_type=mhop

Show Routes You can display these routes using the show routes command in the
administration tool:
show routes
Route T ConnID URL Zone T
B A 3 tcp://B:7454 Z1 1
C A - tcp://C:7455 ZM m

TIBCO Enterprise Message Service User’s Guide

 Configuring Routes and Zones 287
|

• The Route column lists the name of the passive server.

• The T column indicates whether the route is active (A) or passive (P), from the
perspective of server A.
• The ConnID column contains either an integer connection ID (if the route is
currently connected, or a dash (-) if the route is not connected.

Routes to Fault-Tolerant Servers

You can configure servers for fault tolerance. Client applications can specify the
primary and backup servers; if the client’s connection to the primary server fails,
the client can connect to the backup server and resume operation. Similarly, a
route specification can specify primary and secondary passive servers, so that if
the route to the primary server fails, the active server can connect to the backup
server and resume routing.
Failover behavior for route connections is similar to that for client connections;
see Setting Up Clients for Fault-Tolerant Connections on page 271.

Example

create route B url=tcp://B:7454,tcp://BBackup:7454 zone_name=Z1 zone_type=1hop

Routing and SSL

When configuring a route, you can specify SSL parameters for the connection.
Although both participants in an SSL connection must specify a similar set of
parameters, each server specifies this information in a different place:
• The passive server must specify SSL parameters in its main configuration file,
tibemsd.conf.

• When a server initiates an SSL connection, it sends the route’s SSL parameters
to identify and authenticate itself to the passive server. You can specify these
parameters when creating the route, or you can specify them in the route
configuration file, routes.conf.

TIBCO Enterprise Message Service User’s Guide

288
| Chapter 14 Working With Routes

Table 37 lists the parameters that you can specify in the routes.conf
configuration file, or on the command line when creating a route. The parameters
for configuring SSL between routed servers are similar to the parameters used to
configure SSL between server and clients; see Chapter 12, Using the SSL Protocol,
on page 241.

Table 37 SSL Parameters for Routes (Sheet 1 of 3)

Parameter Description
ssl_identity The server’s digital certificate in PEM, DER, or
PKCS#12 format. You can copy the digital
certificate into the specification for this parameter,
or you can specify the path to a file that contains
the certificate in one of the supported formats.
For more information, see File Names for
Certificates and Keys on page 251.

ssl_issuer Certificate chain member for the server. The

server reads the certificates in the chain in the
order they are presented in this parameter.
The same certificate can appear in multiple places
in the certificate chain.
The certificates must be in PEM, DER, PKCS#7 or
PKCS#12 format.
For more information, see File Names for
Certificates and Keys on page 251.

ssl_private_key The local server’s private key. If the digital

certificate in ssl_identity already includes this
information, then you may omit this parameter.
This parameter accepts private keys in PEM, DER
and PKCS#12 formats.
You can specify the actual key in this parameter,
or you can specify a path to a file that contains the
key.
For more information, see File Names for
Certificates and Keys on page 251.

TIBCO Enterprise Message Service User’s Guide

 Configuring Routes and Zones 289
|

Table 37 SSL Parameters for Routes (Sheet 2 of 3)

Parameter Description
ssl_password Private key or password for private keys.
You can set passwords using the tibemsadmin
tool. When passwords are set with this tool, the
password is obfuscated in the configuration file.
For more information, see Chapter 8, Using the
Administration Tool, on page 145.

ssl_trusted List of certificates that identify trusted certificate

authorities.
The same certificate can appear in multiple places
in the certificate chain.
The certificates must be in PEM, DER or PKCS#7
format. You can either provide the actual
certificates, or you can specify a path to a file
containing the certificate chain.
For more information, see File Names for
Certificates and Keys on page 251.

ssl_verify_host Specifies whether the server must verify the other

server’s certificate. The values for this parameter
are enabled and disabled.
When omitted, the default is enabled, signifying
the server must verify the other server’s
certificate.
When this parameter is disabled, the server
establishes secure communication with the other
server, but does not verify the server’s identity.

TIBCO Enterprise Message Service User’s Guide

290
| Chapter 14 Working With Routes

Table 37 SSL Parameters for Routes (Sheet 3 of 3)

Parameter Description
ssl_verify_hostname Specifies whether the server must verify the name
in the CN field of the other server’s certificate.
The values for this parameter are enabled and
disabled.

When omitted, the default is enabled, signifying

the server must verify the name of the connected
host or the name specified in the
ssl_expected_hostname parameter against the
value in the server’s certificate. If the names do
not match, the connection is rejected.
When this parameter is disabled, the server
establishes secure communication with the other
server, but does not verify the server’s name.

ssl_expected_hostname Specifies the name expected in the CN field of the

other server’s certificate. If this parameter is not
set, the default is the hostname of the other server.
This parameter is relevant only when the
ssl_verify_hostname parameter is enabled.

ssl_ciphers Specifies a list of cipher suites, separated by

colons (:).
This parameter accepts both the OpenSSL name
for cipher suites, or the longer descriptive names.
For information about available cipher suites and
their names, see Specifying Cipher Suites on
page 258.

ssl_rand_egd The path for the installed entropy gathering

daemon (EGD), if one is installed. This daemon
generates random numbers.

TIBCO Enterprise Message Service User’s Guide

 Routed Topic Messages 291
|

Routed Topic Messages

A server forwards topic messages along routes only when the global property is
defined for the topic; see addprop topic on page 151 and create topic on
page 154.
Topic messages can traverse multiple hops.
When a route becomes disconnected (for example, because of network problems),
the forwarding server stores topic messages. When the route reconnects, the
server forwards the stored messages.

Propagating Registered Interest

To ensure forwarding of messages along routes, servers propagate their topic
subscriptions to other servers. For example, the top of Figure 24 depicts an
enterprise with three servers—A, M and B—connected by routes in a multi-hop
zone. The bottom of Figure 24 illustrates the mechanism at work within the
servers to route messages from a producer client of server A, through server M, to
server B and its subscriber client. Consider this sequence of events.

Figure 24 Routing: Propagating Subscribers

Zone: Z
A mhop M B

Server: A Server: M Server: B

Topic: T1 Topic: T1 Topic: T1

global global global

Subscriber Subscriber Subscriber

T1 T1 T1

Client Client
Producer Subscriber
T1 T1

1. All three servers configure a global topic T1.

TIBCO Enterprise Message Service User’s Guide

292
| Chapter 14 Working With Routes

2. At bottom right of Figure 24, a client of server B creates a subscriber to T1.

3. Server B, registers interest in T1 on behalf of the client by creating an internal
subscriber object.
4. Because a route connects servers M and B, server B propagates its interest in
T1 to server M. In response, M creates an internal subscriber to T1 on behalf of
server B. This subscriber ensures that M forwards (that is, delivers) messages
from topic T1 to B. Server B behaves as a client of server M.
5. Similarly, because a route connects servers A and M, server M propagates its
interest in T1 to server A. In response, A creates an internal subscriber to T1 on
behalf of server M. This subscriber ensures that A forwards messages from
topic T1 to M. Server M behaves as a client of server A.
6. When a producer client of server A sends a message to topic T1, A forwards it
to M. M accepts the message on its topic T1, and forwards it to B. B accepts the
message on its topic T1, and passes it to the client.

Subscriber Client If the client of server B creates a non-durable subscriber to T1, then if the client
Exit process exits, the servers delete the entire sequence of internal subscribers. When
the client restarts, it generates a new sequence of subscribers; meanwhile, the
client might have missed messages.
If the client of server B creates a durable subscriber to T1, then if the client process
exits, the entire sequence of internal subscribers remains intact; messages
continue to flow through the servers in store-and-forward fashion. When the
client restarts, it can consume all the messages that B has been storing in the
interim.

Server Failure In an active-active route between servers B and M, if B fails, then M retains its
internal subscriber and continues to store messages for clients of B. When B
reconnects, M forwards the stored messages.
In an active-passive route configured on B, if B fails, then M removes its internal
subscriber and does not store messages for clients of B—potentially resulting in a
gap in the message stream. When B reconnects, M creates a new internal
subscriber and resumes forwarding messages.

maxbytes Combining durable subscribers with routes creates a potential demand for
storage—especially in failure situations. For example, if server B fails, then server
M stores messages until B resumes. We recommend that you set the maxbytes
property of the topic (T1) on each server, to prevent unlimited storage growth
(which could further disrupt operation).

TIBCO Enterprise Message Service User’s Guide

 Routed Topic Messages 293
|

Selectors for Routing Topic Messages

Motivation A server forwards a global topic message along routes to all servers with
subscribers for that topic. When each of those other servers requires only a small
subset of the messages, this policy could potentially result in a high volume of
unwanted network traffic. You can specify message selectors on routes, to narrow
the subset of topic messages that traverse each route.

Message selectors on routes are different from message selectors on individual

subscribers, which narrow the subset of messages that the server delivers to the
subscriber client.

Example Figure 25 illustrates an enterprise with a central server for processing customer
orders, and separate regional servers for billing those orders. For optimal use of
network capacity, we configure topic selectors so that each regional server gets
only those orders related to customers within its region.

Figure 25 Routing: Topic Selectors, example

Incoming Orders

Central Order Server

USA Orders Canada Orders Mexico Orders

USA Canada Mexico
Order Processing Order Processing Order Processing

Specifying Specify message selectors for global topics as properties of routes. You can define
Selectors these properties in two ways:
• Define selectors when creating the route (either in routes.conf, or with the
administrator command create route).

TIBCO Enterprise Message Service User’s Guide

294
| Chapter 14 Working With Routes

• Manipulate selectors on an existing route (using the addprop, setprop, or

removeprop administrator commands).

Syntax The message selector properties have the same syntax whether they appear in a
command or in a configuration file:
incoming_topic=topicName selector="messageSelector"
outgoing_topic=topicName selector="messageSelector"

The terms incoming and outgoing refer to the perspective of the active server—
where the route is defined.
topicName is the name of a global topic.
messageSelector is a message selector string. For detailed information about message
selector syntax, see the documentation for class Message in TIBCO Enterprise
Message Service Java API Reference.

Example Syntax In the example of Figure 25, an administrator might configure these routes on the
central order server:
setprop route Canada outgoing_topic="orders" selector="country=’Canada’"
setprop route Mexico outgoing_topic="orders" selector "country=’Mexico’"
setprop route USA outgoing_topic="orders" selector="country=’USA’"

Those commands would create these entries in routes.conf:

[Canada]
url=ssl://canada:7222
outgoing_topic=orders selector="country=’Canada’"
...
[Mexico]
url=ssl://mexico:7222
outgoing_topic=orders selector="country=’Mexico’"
...
[USA]
url=ssl://usa:7222
outgoing_topic=orders selector="country=’USA’"
...

Symmetry outgoing_topic and incoming_topic are symmetric. Whether A specifies a

route to B with incoming_topic selectors, or B specifies a route to A with
outgoing_topic selectors, the effect is the same.

Active-Active In an active-active configuration, you may specify selectors on either or both

Configuration servers. If you specify outgoing_topic selector S1 for topic T on server A, and
incoming_topic selector S2 for T on server B, then the effective selector for T on
the route from A to B is (S1 AND S2).
See also Active and Passive Routes on page 285.

TIBCO Enterprise Message Service User’s Guide

 Routed Topic Messages 295
|
Wildcards You can specify wildcards in topic names. For each actual topic, the server uses
logical AND to combine all the selectors that match the topic.

TIBCO Enterprise Message Service User’s Guide

296
| Chapter 14 Working With Routes

Routed Queues

With respect to routing, queues differ from topics in several respects:

• Servers route queue messages between the queue owner and adjacent servers.
• The concept of zones and hops does not apply to queue messages (only to
topic messages).

The left side of Figure 26 depicts an enterprise with three servers—P, R and S—
connected by routes. The remainder of Figure 24 illustrates the mechanisms that
routes queue messages among servers (center) and their clients (right side).

Figure 26 Routing: Queues

Server: P J Producer
Q1
P Q1@R global
- store and fwd to R
- proxy rcvr K Consumer
Q1

Server: R L Producer
Q1
R Q1 global
- home queue M Consumer
Q1

Server: S

S
Q1@R global
- proxy rcvr N Consumer
Q1

Owner & Home Server R defines a global queue named Q1. R is the owner of Q1.
Servers P and S define routed queues Q1@R. This designation indicates that these
queues depend upon and reflect their home queue (that is, Q1 on server R). Notice
that the designation Q1@P is only for the purpose of configuration; clients of P
refer to the routed queue as Q1.

TIBCO Enterprise Message Service User’s Guide

 Routed Queues 297
|
Example When J sends a message to Q1, server P forwards the message to the home
queue—Q1 on server R.
Now the message is available to receivers on all three servers, P, R and S—
although only one client can consume the message. Either Q1 on P receives it on
behalf of K; or Q1 on S receives it on behalf of N; or M receives it directly from the
home queue.

Producers From the perspective of producer clients, a routed queue stores messages and
forwards them to the home queue. For example, when J sends a message to Q1 on
server P, P forwards it to the queue owner, R, which delivers it to Q1 (the home
queue).
The message is not available for consumers until it reaches the home queue. That
is, client K cannot consume the message directly from server P.
If server R fails, or the route connection from P to R fails, P continues to store
messages from K in its queue. When P and R resume communication, P delivers
the stored messages to Q1 on R.

Consumers From the perspective of consumer clients, a routed queue acts as a proxy receiver.
For example, when L sends a message to Q1 on server R, Q1 on P can receive it
from R on behalf of K, and immediately gives it to K.
If server P fails, or the route connection from P to R fails, K cannot receive
messages from Q1 until the servers resume communication. Meanwhile, M and N
continue to receive messages from Q1. When P and R resume communication, K
can again receive messages through Q1 on P.

Configuration You must explicitly configure each routed queue in queues.conf—clients cannot
create routed queues dynamically.
You may use the administration tool or API to configure routed queues; see
addprop queue on page 151 and create queue on page 153.

To configure a routed queue, specify the queue name and the server name of the
queue owner; for example, on server P, configure:
Q1@R global

It is legal to use this notation even for the home queue. The queue owner
recognizes its own name, and ignores the location designation (@R).

Browsing Queue browsers cannot examine routed queues. That is, you can create a browser
only on the server that owns the home queue.

TIBCO Enterprise Message Service User’s Guide

298
| Chapter 14 Working With Routes

Routing and Authorization

User & Password

When a server enables authorization, servers that actively connect to it must
authenticate themselves by name and password.

Figure 27 Routing: Authorization

A B

authorization=enabled authorization=disabled

Q2@B Q2

In Figure 27, servers A and B both configure active routes to one another.
• Because A enables authorization, A must configure a user named B, and B
must configure a matching username and password to identify itself to A.
• However, because B disables authorization, A need not identify itself to B, and
B need not configure a user named A.

ACL
When routing a secure topic or queue, servers consult the ACL specification
before forwarding each message. The servers must grant one another appropriate
permissions to send, receive, publish or subscribe.
For example, in Figure 27, Q2 messages flow from A to B if and only if server A
grants receive permission to user B for Q2, and server B grants send permission to
user A on Q2.

See Also Chapter 9, Authentication and Permissions, on page 179

TIBCO Enterprise Message Service User’s Guide

 | 299

Appendix A Using the Samples

This chapter describes working with the client sample files.

Topics

• Starting Work with the Client Sample Files, page 300

• Publish and Subscribe Example, page 301

TIBCO Enterprise Message Service User’s Guide

300
| Appendix A Using the Samples

Starting Work with the Client Sample Files

The sample files were designed to allow you to run TIBCO Enterprise Message
Service with minimum start-up time and coding. The directory contains three sets
of files:
• Client samples for TIBCO Enterprise Message Service implementation.
(jms/samples/java)
• Examples created by Sun Microsystems as basic examples for JMS.
(jms/samples/java/sun)
• Samples of interoperation of TIBCO Enterprise Message Service with TIBCO
Rendezvous applications. (jms/samples/java/tibrv)
This section describes compiling and beginning to use the client samples.

Compiling the Sample Files

In order to compile and run the client samples you need to execute setup.bat
(Windows) or setup.sh (UNIX) scripts, which are located in the sample files
directory.
To run the client sample files:
1. Verify the setting of the TIBEMS_ROOT environment variable inside the
setup.bat or setup.sh script file.

2. Open a command line or console window, and change directory to the

samples>client subdirectory in the JMS folder.

3. Run the setup script.

4. Compile the samples by typing javac -d.*.java on the command line.
This will compile all the samples in the directory, except for those samples
within the sun and tibrv subdirectories.
If the files compile successfully, the class files will appear in the
samples>client subdirectory. If they do not compile correctly, an error
message appears.

TIBCO Enterprise Message Service User’s Guide

 Publish and Subscribe Example 301
|

Publish and Subscribe Example

This section describes an example of publishing and subscribing, using the

administration tool and the client samples.

Overview of the Example

In general, to run a client sample, you enter appropriate commands in the sample
console window and the EMS administration tool. For more information on the
sample clients, see the Readme in the sample folder. For further information on
the administration tool, see Starting the Administration Tool on page 146 and
Command Listing on page 151.
In this chapter, you will use the client samples. You will create a topic and then
create two users for that topic. You will give one user permission to subscribe on
that topic, and the other user permission to publish on that topic. Then you will
publish two messages, and observe as they are received.
This example is simple and limited. For example, in a real application, the users
would be connections to working applications, while in this example, users only
send and receive messages. This example also does not attempt to include
examples of all permissions, properties or commands, and it does not describe
any of the queue commands. Nevertheless, the example can give a partial
overview of the process.

Creating a Topic
In this section, you will create a topic. Several topics are included with the client
samples. For this sample, however, you will create a new topic. You create topics
in the EMS administration tool.

You must start the server and the administration tool before creating a topic. For
information on running the server, refer to Running the Server on page 226. For
information on starting the administration tool, refer to Starting the
Administration Tool on page 146.

TIBCO Enterprise Message Service User’s Guide

302
| Appendix A Using the Samples

Using the Administration Tool

To begin using the administration tool, see Starting the Administration Tool on
page 146.

On a computer running Windows, you can also start the administration tool from
the Start menu, following the path Programs>TIBCO Enterprise Message
Service 4.0.0>Start EMS administration tool.

When you have started the administration tool, you need to connect it to the EMS
server.
To connect the EMS administration tool to the EMS server, execute one of the
following commands:
• If you are using TIBCO Enterprise Message Service on a single computer, type
connect in the command line of the Administration tool.
The screen will display: connected to tcp://localhost:7222.

It will then display the following prompt: tcp://localhost:7222>

• If you are using TIBCO Enterprise Message Service in a network, use the
connect server command as follows:
connect [<server URL>] [<user-name>] [<password>]

For more information on this command, see connect on page 152.

Creating the Topic

Once you have connected the administration tool to the server, you can create a
new topic.
To create a new topic:
1. Startup the administration tool, then enter the following command:
create topic foo

2. Enter the commit command to save the topic as a permanent topic.

For more information on the create topic command, refer to create topic on
page 154. For more information on the commit command, see commit on
page 152 and autocommit on page 152.

Adding the secure Property to the Topic

You will add the secure property to the topic. With the secure property added,
only users who have been assigned a certain permission can perform the actions
allowed by that permission. For example, only users with publish permission on
the topic can publish, while other users cannot publish.

TIBCO Enterprise Message Service User’s Guide

 Publish and Subscribe Example 303
|

If the secure property is not added to a topic, all authenticated users have all
permissions (publish, subscribe, create durable subscribers) on that topic.
For more information on the secure property, see the section about secure on
page 33. For more information on topic permissions, see Chapter 9,
Authentication and Permissions, on page 179.
To enable server authorization and add the secure property to a topic, perform
the following:
1. Start the server. For more information on starting the server, refer to Starting
the Server on page 226.
2. Startup the administration tool.
3. Enable the authorization property by entering the following command:
set server authorization=on

The authorization property enables checking of permissions set on

destinations.
4. Enter the following command to add the secure property to a topic named
foo:

addprop topic foo secure

For more information on the addprop topic command, refer to addprop

topic on page 151.

Creating Users
Using the client samples, you will create several users and give them various
permissions to publish and subscribe to the topic foo.
The first step is creating the users.

Creating the Users

This section illustrates creating users with the administration tool.
To create two users:
1. Startup the administration tool, then enter the following command:
create user user1

The tool will display the message: user user1 has been created.

2. Enter the command:

create user user2

3. Enter the commit command.

TIBCO Enterprise Message Service User’s Guide

304
| Appendix A Using the Samples

You have now created two users.

For more information on the create user command, refer to create user on
page 155.

Granting Permissions
In order to see how permissions affect the ability to publish and receive messages,
you will give the two users various permissions on the topic foo. You will give
publish permission to one user, subscribe permission to the second user, and both
publish and subscribe to the third user.
To grant permissions to users on the topic foo:
1. Startup the administration tool, then enter the following commands:
grant topic foo user1 publish
grant topic foo user2 subscribe

2. Enter the commit command to save the permissions.

For more information on the grant topic command, refer to grant topic on
page 158.
Next, you will use the client samples to publish and receive on topic foo.

Publishing and Subscribing

In previous sections, you have created the topic foo, assigned the property
secure to that topic. You also made two users, and assigned permissions to
publish and subscribe on foo to these users. In this section, you will use the client
samples to publish and subscribe on foo.
To publish and subscribe on foo, you will use the client samples.

Running Client Samples

In order to run the client samples, you must give them commands from within the
sample directory. The sample directory contains the compiled samples.
For more information on the samples, refer to the readme within the sample
directory. For more information on compiling the samples, refer to Compiling the
Sample Files on page 300.

TIBCO Enterprise Message Service User’s Guide

 Publish and Subscribe Example 305
|

Starting Subscribers
First, you will attempt to start both of your users as subscribers on foo. Because
only one user has permission to subscribe on foo, only one of the users will
actually start as a subscriber.
You will start the subscribers first, because the subscribers enable you to observe
the messages being received when you start the publisher.
To start a subscriber:
1. Set a command line window and navigate to the folder containing the client
samples.
2. At the prompt, enter: setup

Entering setup sets the environment and classpath, and returns you to the
prompt.
3. After the prompt, enter:
java tibjmsTopicSubscriber -topic foo -user user1

However, in this example, foo is a secure topic, and user1 has permission to
publish, but not to subscribe. Therefore, you will receive an exception
message including the statement:
Operation not permitted.

The window will then return to the prompt.

4. After the prompt, enter:
java tibjmsTopicSubscriber -topic foo -user user2

The screen will display a message showing that user2 is subscribed to foo.

In this example, foo is a secure topic, and user2 has permission to subscribe
to foo.
The window does not return to the prompt, because the subscription is
running, and no further action needs to be taken.

Starting the Publisher and Sending Messages

Setting up the publisher is very similar to setting up the subscriber. However,
while the subscriber requires the name of the topic and the user, the publisher also
requires messages.
To start the publisher:
1. Set a command line window and navigate to the folder containing the client
samples.
2. At the prompt, enter: setup

TIBCO Enterprise Message Service User’s Guide

306
| Appendix A Using the Samples

Entering setup sets the environment and classpath, and returns you to the
prompt.
3. After the prompt, enter:
java tibjmsTopicPublisher -topic foo -user user1 m1 m2

where m1 and m2 are messages.

The command line window containing the publisher will display a message
stating that both messages have been published. The command line windows
containing the subscriber will show the two messages being received.
After the messages are published, this window returns to the prompt for further
message publishing.

Note that if you attempt to use the form:

java tibjmsTopicPublisher -topic foo -user user1

without adding the messages, you will see an error message, reminding you that
you must have at least one message text.

TIBCO Enterprise Message Service User’s Guide

 | 307

Appendix B Using TIBCO Hawk

This appendix describes how to configure TIBCO Hawk so that it can be used to
administer and monitor the TIBCO Enterprise Message Service server.
For more information about TIBCO Hawk, see the TIBCO Hawk documentation.

Topics

• Overview of Server Management With TIBCO Hawk, page 308

• Installing the Classes, page 309
• Method Description, page 312

TIBCO Enterprise Message Service User’s Guide

308
| Appendix B Using TIBCO Hawk

Overview of Server Management With TIBCO Hawk

TIBCO Hawk is a tool for monitoring and managing applications and operating
systems. TIBCO Enterprise Message Service provides classes for administering
the EMS server. Table 38 describes the provided classes.

Table 38 TIBCO Enterprise Message Service classes in TIBCO Hawk

Class Description
com.tibco.tibjms.admin.hawk.HawkListener Monitoring methods that allow you to
view the status of topics, queues, routes,
and other items on the TIBCO Enterprise
Message Service server.

com.tibco.tibjms.admin.hawk.HawkController Management methods for shutting down

the TIBCO Enterprise Message Service
server and performing other
administrative functions.
This class contains all HawkListener
monitoring methods as well.

If you wish to monitor and manage the server, you only need the
HawkController class. If you wish to only monitor the server, you can use the
HawkListener class.

To use TIBCO Hawk to manage the TIBCO Enterprise Message Service server,
you must load the classes provided into the TIBCO Hawk agent. Once the classes
are loaded, methods for managing the EMS server are available in the TIBCO
Hawk display.
This appendix details how to install the provided classes into the TIBCO Hawk
agent and the methods available for monitoring and managing the TIBCO
Enterprise Message Service server.

TIBCO Enterprise Message Service User’s Guide

 Installing the Classes 309
|

Installing the Classes

Installing the provided classes is different for UNIX and Windows platforms. The
following sections detail how to install the TIBCO Enterprise Message Service
management classes into the TIBCO Hawk agent for each platform.

These instructions are specific to TIBCO Hawk Release 4.1.0 or later. Earlier
versions of TIBCO Hawk have a different mechanism for adding plugins. Refer to
your TIBCO Hawk documentation for details on installing plugins, if you are
using an earlier version of TIBCO Hawk.

Windows Installation
To install the provided classes for use in a TIBCO Hawk agent running on a
Windows platform, perform the following:
1. Locate the tibemsadmin.hma file in the TIBCO Enterprise Message Service
installation directory under the samples/admin/hawk subdirectory and copy
it into your TIBCO Hawk plugins directory. Also, locate tibjmsadmin.jar,
jms.jar, and tibjms.jar in the clients/java subdirectory and copy these
files into the TIBCO Hawk plugins directory.
Usually, a TIBCO Hawk plugins directory is located in
c:\tibco\hawk\plugins.

2. Open the TIBCO Hawk Configuration Utility and make certain the plugins
directory is set to the location where you have installed TIBCO Hawk plugins.
To set the plugins directory, click the Agent tab, then set the Plugins Directory
field to the location where the plugins are located.
For more information about using the TIBCO Hawk Configuration Utility, see
TIBCO Hawk Installation and Configuration.
3. Navigate to your plugins directory and open the tibemsadmin.hma file in a
text editor.
4. Specify the TIBCO Hawk microagent class you wish to use in the
<classname> element. You can use either the HawkListener class if you only
want to monitor the server, or you can specify the HawkController class if
you want to monitor and manage the server.
5. Specify the username and password and server URL to use to connect to the
TIBCO Enterprise Message Service server in the appropriate <arg> elements.
For example:
<arguments>
<arg>-user</arg>

TIBCO Enterprise Message Service User’s Guide

310
| Appendix B Using TIBCO Hawk

<arg>admin</arg>
<arg>-password</arg>
<arg>admin_pass</arg>
<arg>-server</arg>
<arg>tcp://server1.yourcompany.com:7222</arg>
</arguments>

You should use specify the predefined admin user or a user that is a member
of the $admin group.
6. Restart the TIBCO Hawk agent service. See the TIBCO Hawk documentation
for more information about restarting the service.

UNIX Installation
To install these classes for use in a TIBCO Hawk Agent running on a UNIX
platform, perform the following procedure:
1. Locate the tibemsadmin.hma file in the TIBCO Enterprise Message Service
installation directory under the samples/hawk subdirectory and copy it into
your TIBCO Hawk plugins directory. Also, locate tibjmsadmin.jar, jms.jar,
and tibjms.jar in the clients/java subdirectory and copy these files into
the TIBCO Hawk plugins directory.
Usually, a TIBCO Hawk plugins directory is located in
/usr/tibco/hawk/plugins.

2. Edit the TIBCO Hawk hawkagent.cfg file and specify the -hma_plugin_dir
option to include the directory where your TIBCO Hawk plugins are located.
For more information about editing TIBCO Hawk configuration files on
UNIX, see TIBCO Hawk Installation and Configuration.
3. Navigate to your plugins directory and open the tibemsadmin.hma file in a
text editor.
4. Specify the TIBCO Hawk microagent class you wish to use in the
<classname> element. You can use either the HawkListener class if you only
want to monitor the server, or you can specify the HawkController class if
you want to monitor and manage the server.
5. Specify the username and password and server URL to use to connect to the
TIBCO Enterprise Message Service server in the appropriate <arg> elements.
For example:
<arguments>
<arg>-user</arg>
<arg>admin</arg>
<arg>-password</arg>
<arg>admin_pass</arg>
<arg>-server</arg>

TIBCO Enterprise Message Service User’s Guide

 Installing the Classes 311
|
<arg>tcp://server1.yourcompany.com:7222</arg>
</arguments>

You should use specify the predefined admin user or a user that is a member
of the $admin group.

TIBCO Enterprise Message Service User’s Guide

312
| Appendix B Using TIBCO Hawk

Method Description

The TIBCO Hawk classes have several methods for managing and monitoring a
TIBCO Enterprise Message Service server. These methods correspond to
commands you can issue in the administration tool.
Table 39 lists the methods of each class and the corresponding tibemsadmin
command for the method. The table also lists the page where you can find more
information about each command in Chapter 8, Using the Administration Tool,
on page 145.

Table 39 TIBCO Hawk method names (Sheet 1 of 3)

TIBCO Hawk Agent

tibemsadmin Command Page
Method Name
com.tibco.tibjms.admin.hawk.HawkListener Methods

getMethods() This method returns the list of methods —

that this TIBCO Hawk class can
perform.

getServerInfo() show server 175

getNumConnections() Returns the number of connections. —

getConnections show connections 168

getUsers() show users 177

getQueues( show queue 173

String regexp)
show queues

(shows information from both

commands for each queue)
You can specify a queue name or a
pattern to return all matching queue
names.

getRoutes() show route 174

show routes

(shows information from both

commands for each route)

TIBCO Enterprise Message Service User’s Guide

 Method Description 313
|

Table 39 TIBCO Hawk method names (Sheet 2 of 3)

TIBCO Hawk Agent

Method Name tibemsadmin Command Page

getTopics( show topic 176

String regexp)
show topics

(shows information from both

commands for each topic)
You can specify a topic name or a
pattern to return all matching topic
names.

getDurables( show durables 171

String regexp)
You can specify a topic name or a
pattern to return all matching durable
subscriptions.

getConsumers() show stat consumers 175

getProducers() show stat producers 175

getListenPorts() This method returns the list of ports the —

TIBCO Enterprise Message Service
server is configured to listen on.

getCMLedgerInfo() show rvcmledger 174

getTransports() show rvcmlistener 175

getTransport() show rvcmlistener 175

Shows the name and subject of the
specified RVCM listener.

isRunning() Check whether the server is reachable —

by attempting to connect to it.
(Afterward, this method breaks the test
connection.)

com.tibco.tibjms.admin.hawk.HawkController Methods (also contains all

HawkListener methods)

getMethods() This method returns the list of methods —

that this TIBCO Hawk class can
perform.

TIBCO Enterprise Message Service User’s Guide

314
| Appendix B Using TIBCO Hawk

Table 39 TIBCO Hawk method names (Sheet 3 of 3)

TIBCO Hawk Agent

Method Name tibemsadmin Command Page

shutdown() shutdown 178

purgeDurable( purge durable 159

String name,
String clientID) Specify the name of the durable
subscription and the client ID
associated with the durable
subscription (client ID can be null).

purgeQueue( purge queue 159

String name)
Specify the name of the queue to purge.

purgeTopic( purge topic 159

String name)
Specify the name of the topic to purge.

rotateLog() rotatelog 160

TIBCO Enterprise Message Service User’s Guide

 | 315

Appendix C Monitor Messages

This appendix lists all topics on which the server publishes messages for system
events. The message properties for messages published on each topic are also
described. See Monitoring Server Events on page 215 for more information about
monitor topics and messages.

Topics

• Description of Monitor Topics, page 316

• Description of Topic Message Properties, page 318

TIBCO Enterprise Message Service User’s Guide

316
| Appendix C Monitor Messages

Description of Monitor Topics

Table 40 describes each monitor topic.

Table 40 Monitor topics (Sheet 1 of 2)

Topic Message Is Published When...
$sys.monitor.admin.change The administrator has made a change to the
configuration.

$sys.monitor.connection.connect A user attempts to connect to the server.

$sys.monitor.connection.disconnect A user connection is disconnected.

$sys.monitor.connection.error An error occurs on a user connection.

$sys.monitor.consumer.create A consumer is created.

$sys.monitor.consumer.destroy A consumer is destroyed.

$sys.monitor.limits.connection Maximum number of hosts or connections is reached.

$sys.monitor.limits.queue Maximum bytes for queue storage is reached.

$sys.monitor.limits.server Server memory limit is reached.

$sys.monitor.limits.topic Maximum bytes for durable subscriptions is reached.

$sys.monitor.producer.create A producer is created.

$sys.monitor.producer.destroy A producer is destroyed.

$sys.monitor.queue.create A dynamic queue is created.

$sys.monitor.route.connect A route connection is attempted.

$sys.monitor.route.disconnect A route connection is disconnected.

$sys.monitor.route.error An error occurs on a route connection.

$sys.monitor.route.interest A change in registered interest occurs on the route.

$sys.monitor.server.info The server sends information about an event, for

example, a log file is rotated.

$sys.monitor.server.state The server state changes.

TIBCO Enterprise Message Service User’s Guide

 Description of Monitor Topics 317
|
Table 40 Monitor topics (Sheet 2 of 2)

Topic Message Is Published When...

$sys.monitor.server.warning The server sends a warning message.

$sys.monitor.topic.create A dynamic topic is created.

$sys.monitor.<D>.<E>.<destination> A message is handled by a destination. The name of

this monitor topic includes two qualifiers (D and E)
and the name of the destination you wish to monitor.
D signifies the type of destination and whether to
include the entire message.
• T — topic, include full message (as a byte array)
into each event
• t — topic, do not incude full message into each
event
• Q — queue, include full message (as a byte array)
into each event
• q — queue, do not incude full message into each
event
E signifies the type of event that occurs, r for receive, s
for send, a for acknowlege, or * for all event types.
For example, $sys.monitor.T.r.corp.News is the
topic for monitoring any received messages to the topic
named corp.News. The message body of any received
messages is included in monitor messages on this
topic. The topic $sys.monitor.q.*.corp.* monitors
all message events (send, receive, acknowledge) for all
queues matching the name corp.*. The message body
is not included in this topic’s messages.
The messages sent to this type of monitor topic include
a description of the event, information about where the
message came from (a producer, route, external
system, and so on), and optionally the message body,
depending upon the value of D.
See Monitoring Messages on page 215 for more
information about message monitoring.

TIBCO Enterprise Message Service User’s Guide

318
| Appendix C Monitor Messages

Description of Topic Message Properties

Table 41 describes the properties that monitor topic messages can contain. Each
monitor message can have a different set of these properties.

Table 41 Message properties (Sheet 1 of 6)

Property Contents
conn_connid Connection ID of the connection that generated the event.

conn_ft Whether the client connection is a connection to a fault-tolerant

server.

conn_hostname Hostname of the connection that generated the event.

conn_ssl Whether the server connection uses the SSL protocol.

conn_ssl2 Whether the client connection uses the SSL protocol.

conn_type Type of connection that generated the event. This property can
have the following values:
• Admin

• Topic

• Queue

• Generic

• Route

• FT (connection to fault-tolerant server)

• Unknown

conn_username User name of the connection that generated the event.

conn_xa Whether the client connection is an XA connection.

TIBCO Enterprise Message Service User’s Guide

 Description of Topic Message Properties 319
|

Table 41 Message properties (Sheet 2 of 6)

Property Contents
event_action The action that caused the event. This property can have the
following values:
• connect (connection attempted)
• accept (connection accepted)
• disconnect (connection disconnected)
• interest (registered interest for a route)
• create (something created)
• delete (something deleted)
• modify (something changed)
• add (user added to a group)
• remove (user removed from a group)
• grant (permission granted)
• revoke (permission revoked)
• purge (topic, queue, or durable subscriber purged)
• commit (transaction committed)
• rollback (transaction rolled back)
• roteatelog (log file rotated)
• receive (message posted into destination)
• send (message sent by server to another party)
• acknowledge (message is acknowledged)

event_class The type of monitoring event (that is, the last part of the topic
name without the $sys.monitor).
For message monitoring, the value of this property is always set to
message.

event_reason The reason the event occurred (usually an error). The values this
property can have are described in Table 42.

event_route For routing, the route that the event occurred on.

TIBCO Enterprise Message Service User’s Guide

320
| Appendix C Monitor Messages

Table 41 Message properties (Sheet 3 of 6)

Property Contents
message_bytes When the full message is to be included for message monitoring,
this field contains the message as a byte array. You can use the
createFromBytes method (in the various client APIs) to recover
the message.

mode Message delivery mode. This values of this property can be the
following:
• persistent

• non_persistent

• reliable

msg_seq Message sequence number.

msg_id Message ID.

msg_timestamp Message timestamp.

msg_expiration Message expiration.

replyTo Message JMSReplyTo.

rv_reply Message RV reply subject.

source_id ID of the source object.

source_name Name of the source object involved with the event. This property
can have the following values:
• XID (global transaction ID)
• message_id

• connections (number of connections)

• unknown (unknown name)
• Any server property name
• the name of the user, or anonymous

TIBCO Enterprise Message Service User’s Guide

 Description of Topic Message Properties 321
|
Table 41 Message properties (Sheet 4 of 6)

Property Contents
source_object Source object that was involved with the event. This property can
have the following values:
• producer

• consumer

• topic

• queue

• permissions

• durable

• server

• transaction

• user

• group

• connection

• message

• jndiname

• factory

• file

• limits (a limit, such as a memory limit)

• route

• transport

source_value Value of source object.

stat_msgs Message count statistic for producer or consumer.

stat_size Message size statistic for producer or consumer.

target_admin Whether the target object is the admin connection.

target_created Time that the consumer was created (in milliseconds since the
epoch).

target_dest_name Name of the target destination

TIBCO Enterprise Message Service User’s Guide

322
| Appendix C Monitor Messages

Table 41 Message properties (Sheet 5 of 6)

Property Contents
target_dest_type Type of the target destination.

target_durable Name of durable subscriber when target is durable subscriber.

target_group Group name that was target of the event

target_hostname Hostname of the target object.

target_id ID of the target object.

target_name Name of the object that was the target of the event. This property
can have the following values:
• XID (global transaction ID)
• message_id

• connections (number of connections)

• unknown (unknown name)
• Any server property name
• the name of the user, or anonymous

target_nolocal NoLocal flag when target is durable subscriber.

TIBCO Enterprise Message Service User’s Guide

 Description of Topic Message Properties 323
|
Table 41 Message properties (Sheet 6 of 6)

Property Contents
target_object The general object that was the target of the event. This property
can have the following values:
• producer

• consumer

• topic

• queue

• permissions

• durable

• server

• transaction

• user

• group

• connection

• message

• jndiname

• factory

• file

• limits (a limit, such as a memory limit)

• route

• transport

target_selector Selector when the target is a consumer.

target_subscription Subscription of the target object when target is durable subscriber.

target_url URL of the target object.

target_username Username of the target object.

target_value Value of the object that was the target of the event, such as the
name of a topic, queue, permission, and so on.

TIBCO Enterprise Message Service User’s Guide

324
| Appendix C Monitor Messages

Table 42 Event Reason Property Values (Sheet 1 of 2)

Event Reason Value Description

backup_connected The fault-tolerant backup server has connected.

backup_disconnected The fault-tolerant backup server has disconnected.

bridge Message posted to destination as result of

bridging.

closed Connection was closed.

consumer For message monitoring, this value signifies a

message was sent or acknowledged by a
consumer. For all other cases, this value signifies a
dynamic topic or queue created for a consumer.

cycle Cyclic route created.

disabled Feature not enabled.

duplicate Duplicate, such as route, global queue or topic.

error Connection disconnected due to error.

exceeded Limit exceeded.

export Message exported to a transport.

import Message imported from a transport.

invalid_name Name not valid, such as route name.

invalid_password Invalid password provided.

not_authorized Not authorized to perform action.

not_connected Could not establish connection.

not_found Something was expected, but not found.

producer For message monitoring, this value signifies a

message was posted by a producer. For all other
cases, this value signifies a dynamic topic or queue
created for a producer.

TIBCO Enterprise Message Service User’s Guide

 Description of Topic Message Properties 325
|

Table 42 Event Reason Property Values (Sheet 2 of 2)

Event Reason Value Description

reconnect_active Connection active.

reconnect_unknown Connection unknown.

rotatelog Log file rotated.

route For message monitoring, this value signifies a

message was sent or received from a route. For all
other cases, this value signifies a dynamic topic or
queue created for a route.

shutdown Server was shut down.

standby Server in standby mode.

terminated Connection was terminated.

TIBCO Enterprise Message Service User’s Guide

326
| Appendix C Monitor Messages

TIBCO Enterprise Message Service User’s Guide

 | 327

Appendix D Error Messages

This appendix lists all possible error messages that the server can output,
alphabetized by category.

Key to this Appendix

Category This string appears as the first part of any error output. It indicates the general
class of error.
This appendix is alphabetized by category.

Description This string describes the error category in more detail.

Remedy This string indicates possible recovery actions that administrators should
consider.

Errors These strings represent all instances of the error, as they appear in our code. Some
categories have many error instances; others have only one. These strings can
include formatting characters.

TIBCO Enterprise Message Service User’s Guide

328
| Appendix D Error Messages

Errors

Category Admin command failed

Description An admin tool or program using the admin API attempted an operation that
failed for the given reason.

Remedy The admin tool or admin API provides the failure reason. The user of the tool or
API should examine the error and correct the syntax, parameter or configuration
that is causing the failure.

Errors %s: create %s failed: conflicting zone: existing consumer has a different zone
%s: create %s failed: detected duplicate durable subscription [%s] for topic [%s].
%s: create %s failed: illegal to use wildcard %s [%s].
%s: create %s failed: invalid %s [%s].
%s: create %s failed: invalid session id=%d.
%s: create %s failed: invalid syntax of %s [%s].
%s: create %s failed: invalid temporary %s [%s].
%s: create %s failed: not allowed to create dynamic %s [%s].

Category Backup server '%s' disconnected

Description Lost connection with the backup fault-tolerant server.

Remedy Determine if the backup server is running. If it is running, check for a network
partition.

Errors WARNING: Backup server '%s' disconnected.

Category Bad or missing value for command line parameter

Description An invalid value was supplied for a command line parameter.

Remedy Change the value supplied for the named argument for one that is acceptable, see
EMS documentation for intructions on starting tibemsd.

Errors '%s' requires a positive integer argument.

'%s' requires a string argument.

TIBCO Enterprise Message Service User’s Guide

 Errors 329
|

'%s' requires an integer argument.

Category Basic initialization failed

Description tibemsd was unable to start up.

Remedy Correct the configuration or startup parameters and restart.

Errors %s.
Fault Tolerant configuration error, can't create loop.
Fault tolerant activation has to be greater than 2x heartbeat
Fault tolerant connection failed, fault tolerant mode not supported on '%s'.
Fault tolerant heartbeat has to be greater than 0
Initialization failed due to errors in SSL.
Initialization failed due to errors in configuration.
Initialization failed due to errors with transports.
Initialization failed. Exiting.
Initialization has failed. Exiting.
Initialization of thread pool failed (%s). Exiting.
Startup aborted.

Category Commit failed due to prior failure or after fault-tolerant switch

Description A warning message indicating that the commit of a client application's transaction
failed either because there were earlier errors when processing this transaction or
because the transaction was started on the primary server prior to a fault-tolerant
failover.

Remedy The client application should retry the transaction.

Errors Commit failed due to prior failure or after fault-tolerant switch.

Category Compaction failed

Description Compaction of the store file failed.

TIBCO Enterprise Message Service User’s Guide

330
| Appendix D Error Messages

Remedy The most likely cause of this error is running out of memory. Shut down tibemsd
and see remedies for out of memory.

Errors Compaction failed. Please shutdown and restart tibemsd

Category Configured durable differs from stored one

Description The durables configuration file specifies a durable with a given name and client
identifier with attributes that are different from the identically named durable
found in the meta.db file.

Remedy Correct the durables configuration file to match the durable defined in the
meta.db file or administratively delete the durable and re-define it.

Errors Configured durable '%s' differs from durable in storage, storage version used.

Category Create of global routed topic failed: not allowed to create dynamic topic

Description A server received an interest notification from another server that does not match
the allowed topics in its configuration.

Remedy This only is printed when the trace includes ROUTE_DEBUG. If the server's topic
definitions are as expected, this statement can be ignored or remove the
ROUTE_DEBUG trace specification to prevent printing.

Errors Create of global routed topic failed: not allowed to create dynamic topic [%s].

Category Create of routed queue failed: not allowed to create dynamic queue

Description A warning indicating that a tibemsd with a route to this daemon has a queue
configured to be global but this daemon does not permit the creation of that
queue dynamically.

Remedy Add the specified queue or a pattern that includes it to this daemon if you want
the queue to be assessible from this daemon, otherwise the warning can be
ignored.

Errors Create of routed queue failed: not allowed to create dynamic queue [%s].

Category Database record damaged

TIBCO Enterprise Message Service User’s Guide

 Errors 331
|
Description An error occurred reading one of the tibemsd's store files.

Remedy Send details of the error and the situation in which it occurred to TIBCO Support.

Errors Invalid destination for message.

No destination information for consumer.
Persisted message possibly corrupt.
Server failed to recover state.

Category Duplicate message detected

Description Warning generated when tibemsd receives a message with a message id that
matches another message's message id.

Remedy Only seen when message id tracking is enabled.

Errors Detected duplicate %s message, messageID='%s'

Category Error in configuration file

Description The server encountered an invalid configuration statement in the specified

configuration file on the specified line.

Remedy Examine the appropriate configuration file and correct the syntax error.

Errors Configuration error: file=%s, line=%d: %s

Configuration error: file=%s, line=%d: %s '%s' not found
Configuration error: file=%s, line=%d: Ignoring durable, duplicate of earlier ntry.
Configuration error: file=%s, line=%d: Ignoring durable, name cannot start with
$sys.route, use route property instead.
Configuration error: file=%s, line=%d: Ignoring durable, name is invalid.
Configuration error: file=%s, line=%d: Ignoring durable, name is missing or
invalid.
Configuration error: file=%s, line=%d: Ignoring durable, route does not allow
clientid, selector or nolocal.
Configuration error: file=%s, line=%d: Ignoring durable, route must exist to
create durable for it.

TIBCO Enterprise Message Service User’s Guide

332
| Appendix D Error Messages

Configuration error: file=%s, line=%d: Ignoring durable, topic is invalid.

Configuration error: file=%s, line=%d: Ignoring durable, topic is missing or
invalid.
Configuration error: file=%s, line=%d: Illegal to specify routed queue as a bridge
source
Configuration error: file=%s, line=%d: Invalid clientid value
Configuration error: file=%s, line=%d: Invalid selector value
Configuration error: file=%s, line=%d: Rendezvous transport not specified for
Rendezvous CM transport '%s'
Configuration error: file=%s, line=%d: Unable to create destination defined by the
bridge source
Configuration error: file=%s, line=%d: Unrecognized attribute
Configuration error: file=%s, line=%d: both tibrv_export and tibrvcm_export are
specified, ignoring tibrv_export
Configuration error: file=%s, line=%d: both tibrv_import and tibrvcm_import are
specified, ignoring tibrv_import
Configuration error: file=%s, line=%d: bridge has no targets, unable to process
Configuration error: file=%s, line=%d: duplicate specification of transport type
Configuration error: file=%s, line=%d: duplicate value
Configuration error: file=%s, line=%d: error in permissions
Configuration error: file=%s, line=%d: error in the bridge description, unable to
proceed.
Configuration error: file=%s, line=%d: error in the transport description, unable
to proceed.
Configuration error: file=%s, line=%d: errors in line, some options may have been
ignored
Configuration error: file=%s, line=%d: failed to create ACL entry, reason=%s
Configuration error: file=%s, line=%d: ignored alias '%s' for %s '%s' because such
alias already exists
Configuration error: file=%s, line=%d: ignored alias '%s' for factory because such
alias already exists
Configuration error: file=%s, line=%d: ignored route '%s' because route has
invalid zone information.
Configuration error: file=%s, line=%d: ignored route '%s' because route represents

TIBCO Enterprise Message Service User’s Guide

 Errors 333
|

route to this server.

Configuration error: file=%s, line=%d: ignored route '%s' because route with such
name or URL already exists.
Configuration error: file=%s, line=%d: ignored unknown permission '%s'
Configuration error: file=%s, line=%d: ignoring duplicate %s '%s' specified earlier
Configuration error: file=%s, line=%d: ignoring duplicate transport name '%s' in
%s list
Configuration error: file=%s, line=%d: ignoring duplicate user
Configuration error: file=%s, line=%d: ignoring errors in permission line
Configuration error: file=%s, line=%d: ignoring invalid entry syntax
Configuration error: file=%s, line=%d: ignoring invalid factory load balancing
metric
Configuration error: file=%s, line=%d: ignoring invalid line
Configuration error: file=%s, line=%d: ignoring invalid line in factory parameters
Configuration error: file=%s, line=%d: ignoring invalid line in route parameters
Configuration error: file=%s, line=%d: ignoring invalid line: invalid syntax in the
line
Configuration error: file=%s, line=%d: ignoring invalid selector specifications in
route parameters
Configuration error: file=%s, line=%d: ignoring invalid topic selector
specifications in route parameters
Configuration error: file=%s, line=%d: ignoring invalid value in the line
Configuration error: file=%s, line=%d: ignoring invalid value of %s
Configuration error: file=%s, line=%d: ignoring rvcmlistener, first token is invalid
Configuration error: file=%s, line=%d: ignoring rvcmlistener, invalid destination
Configuration error: file=%s, line=%d: ignoring rvcmlistener, second token is
invalid
Configuration error: file=%s, line=%d: ignoring rvcmlistener, third token is
invalid
Configuration error: file=%s, line=%d: ignoring rvcmlistener, wildcards are not
permitted
Configuration error: file=%s, line=%d: ignoring transport '%s' in %s list, transport
not found

TIBCO Enterprise Message Service User’s Guide

334
| Appendix D Error Messages

Configuration error: file=%s, line=%d: ignoring unknown property '%s'

Configuration error: file=%s, line=%d: ignoring unrecognized property '%s'
Configuration error: file=%s, line=%d: ignoring user out of group context
Configuration error: file=%s, line=%d: illegal to use predefined name %s
Configuration error: file=%s, line=%d: invalid certificate file name, unknown
extension or invalid encoding specification
Configuration error: file=%s, line=%d: invalid entry syntax -- ignoring
Configuration error: file=%s, line=%d: invalid line syntax or line out of order
Configuration error: file=%s, line=%d: invalid password
Configuration error: file=%s, line=%d: invalid property value
Configuration error: file=%s, line=%d: invalid syntax of %s, unable to continue.
Configuration error: file=%s, line=%d: invalid trace_client_host value
Configuration error: file=%s, line=%d: invalid transport parameter '%s'
Configuration error: file=%s, line=%d: invalid transport type '%s'
Configuration error: file=%s, line=%d: invalid value '%s'
Configuration error: file=%s, line=%d: invalid value of %s
Configuration error: file=%s, line=%d: invalid value of %s, reset to 256MB
Configuration error: file=%s, line=%d: invalid value of %s, reset to default
Configuration error: file=%s, line=%d: invalid value of %s, reset to unlimited
Configuration error: file=%s, line=%d: invalid value of '%s'
Configuration error: file=%s, line=%d: invalid value of db_pool_size, reset to
default of %d bytes
Configuration error: file=%s, line=%d: invalid value of max memory, reset to
unlimited
Configuration error: file=%s, line=%d: invalid value of max_msg_memory, reset
to unlimited
Configuration error: file=%s, line=%d: invalid value of reserve_memory, reset to
zero
Configuration error: file=%s, line=%d: invalid value, reset to no minimum.
Configuration error: file=%s, line=%d: line too long, ignoring it
Configuration error: file=%s, line=%d: maximum number of listen interfaces
reached.

TIBCO Enterprise Message Service User’s Guide

 Errors 335
|

Configuration error: file=%s, line=%d: multiple bridge entries for the same
destination'%s' are not allowed.
Configuration error: file=%s, line=%d: multiple principals specified, line ignored
Configuration error: file=%s, line=%d: multiple targets specified, line ignored
Configuration error: file=%s, line=%d: no permissions found in acl entry
Configuration error: file=%s, line=%d: no target found in acl entry
Configuration error: file=%s, line=%d: no valid user or group found in acl entry
Configuration error: file=%s, line=%d: out of memory, unable to create
Rendezvous transport
Configuration error: file=%s, line=%d: syntax error in the line, ignoring
Configuration error: file=%s, line=%d: syntax errors in line, line ignored
Configuration error: file=%s, line=%d: unable to create %s '%s': invalid topic
name, invalid parameters or out of memory
Configuration error: file=%s, line=%d: unable to process selector in route
parameters, error=%s
Configuration error: file=%s, line=%d: user '%s' not found, ignoring
Configuration error: file=%s, line=%d: value less than allowed minimum, reset to
0
Configuration error: file=%s, line=%d: value of %s less than allowed minimum of
%dKB, reset to unlimited
Configuration error: file=%s, line=%d: value of %s out of range, reset to default
Configuration error: file=%s, line=%d: value of db_pool_size too big or less than
allowed minimum, reset to default value of %d bytes
Configuration error: file=%s, line=%d: value of max_msg_memory less than
allowed, reset to %dMB
Configuration error: file=%s, line=%d: value of msg_pool_size too big or less than
allowed minimum of %d, reset to default value of %d
Configuration warning: file=%s, line=%d: ignoring rvcmlistener, duplicate
Configuration warning: file=%s, line=%d: parameter '%s' is deprecated
Configuration warning: file=%s, line=%d: route '%s' does not have a user
configured for authorization.
Fault tolerant reconnect timeout is set to a negative or 0 value of %d seconds, reset
to %d seconds.
Fault tolerant reread error: file=%s, line=%d: invalid property value

TIBCO Enterprise Message Service User’s Guide

336
| Appendix D Error Messages

No topic exists for configured durable '%s%s%s'.

Topic '%s' not valid in configured durable '%s'.
Unable to create Rendezvous Certified transport '%s' because it references
undefined Rendezvous transport '%s'
Unable to create SmartSockets subscriber on transport %s: failed to convert %s
'%s', error=%d
Use fsync error: file=%s, line=%d: invalid property value

Category Error writing commit request, errors already occurred in this transaction

Description A client application's attempt to commit a transaction failed because the server
encountered an error during an operation associated with the transaction.

Remedy Examine previous error statements to determine the cause of the operation failure
and correct that before attempting the transaction again.

Errors Error writing commit request, errors already occurred in this transaction.

Category Fault tolerant reconnect timeout is set to a large value of %d seconds

Description Warning that fault tolerant reconnect timeout is set to a large number of seconds.

Remedy Consider reducing the timeout unless it is important that the newly active server
maintains state for clients that do not reconnect following a failover.

Errors Fault tolerant reconnect timeout is set to a large value of %d seconds.

Category Error writing configuation file

Description tibemsd was unable to update one of its configuration files following a
configuration change.

Remedy Check that the user that started the tibemsd has permission to change the
configuration files and that there is sufficient disk space on the device.

Errors Error occured saving %s information

Error occured saving acl information
Error occured saving durables information

TIBCO Enterprise Message Service User’s Guide

 Errors 337
|

Error occured saving factories information

Error occured saving file '%s'
Error occured saving group information
Error occured saving main configuration file '%s'
Error occured saving routes information
Error occured saving tibrvcm information
Error occured writing destination '%s' into file
Error occured writing factory into file.
Error occured writing group '%s' into file
Error occured writing route into file.
Error occurred saving durables information
Error occurred while updating main configuration file '%s'. Configuration has not
been saved.
Error occurred writing into the file '%s'.
I/O error occured saving group information
I/O error occured saving route information
I/O error occured writing into file '%s'

Category Error writing to store file

Description tibemsd was unable to write data to one of its store files.

Remedy Ensure that the directory containing the store files is mounted and accessible to
the tibemsd, and that there is free space available on the device

Errors Error writing xa prepare request, %s.

Exception trying to create ack record, %s.
Exception trying to create confirm record, %s.
Exception trying to create message from store: %s
Exception trying to create transaction record.
Exception trying to create valid messages record, %s.
Exception trying to export message to RV.
Failed writing block data to '%s': %s

TIBCO Enterprise Message Service User’s Guide

338
| Appendix D Error Messages

Failed writing message to '%s': I/O error or out of disk space.

Failed writing purge state for queue '%s': I/O error or out of disk space.
Failed writing purge state for topic consumer: I/O error or out of disk space.

Category Failed to open TCP port

Description tibemsd was unable to open the tcp port.

Remedy Shutdown process that is using the port or change the value of the 'listen'
parameter in the server's tibemsd.conf file to a port that is not in use .

Errors Binding connection to TCP port %d failed:%d (%s).

Category File access error

Description tibemsd was unable to open the specified file.

Remedy Check that the path name is correct and the directory exists, the user that started
tibemsd has permission to read the specified directory and path, the file exists if it
isn't one that the tibemsd can create, the file is not being used by another tibemsd
or some other process.

Errors Configuration file '%s' not found.

Exception trying to read message from store.
Failed to create file '%s'
Failed to create file '%s'
Failed to open file '%s'
Failed to read message from store.
Failed to rename file %s into %s: %s
I/O error occurred reading from the file '%s'.
Unable to open metadata file '%s', file may be locked.
Unable to open metadata file '%s'.
Unable to open store file '%s', file may be locked.
Unable to open store file '%s'.
Unable to preallocate async storage file '%s'.

TIBCO Enterprise Message Service User’s Guide

 Errors 339
|

Unable to preallocate sync storage file '%s'.

failed to open file '%s'.
failed to open log file '%s'.

Category Internal error

Description The server detected an internal consistency.

Remedy Send the error statement and a description of the environment to TIBCO Support.

Errors Error processing xa commit request, %s.

Error processing xa end - transaction marked ROLLBACKONLY, %s.
Error processing xa prepare request, %s.
Error processing xa rollback request, %s.
Error: unable to add bridge specified in file=%s, line=%d.
Exception creating connection.
Exception creating purge record.
Exception creating session.
Exception creating zone.
Exception creating zone: adding zone to state.
Exception in startup, exiting.
Exception preparing message for client send.
Exception restoring persisted message, %s.
Exception sending flow recover acknowledge
Exception sending routing information to %s.
Exception sending session init response
Exception trying to initialize connection, can't send response.
Exception trying to initialize connection.
Exception trying to initialize route.
Exception trying to process message from store.
Exception trying to process message, '%s'.
Failed to handle connection init: %s.

TIBCO Enterprise Message Service User’s Guide

340
| Appendix D Error Messages

Unable to handle transacted data message.

Unable to handoff connection init message: %s.
Unable to initialize fault tolerant connection, remote server returned '%s'
Unable to process producer message.
Unable to process sequence for message.

Category Invalid connection

Description Warning indicating that tibemsd was attempting to restablish delivery of

messages across a route to another tibemsd but was unable to find the connection
for that route.

Remedy Check the other tibemsd is still running and if it is verify the network connection
from this tibemsd to the other tibemsd.

Errors Recovery flow stall failed: invalid route connection

Category Invalid listen specification

Description The server could not parse the listen parameter in the tibemsd.conf file

Remedy Correct the listen parameter to match the form <protocol>://<url> as specified in
the manual.

Errors Invalid listen specification: '%s'.

Invalid request to create temporary destination.

Category Invalid session

Description tibemsd received a request that referred to a session that doesn't currently exist.

Remedy Send details of the error and the situation in which it occurred to TIBCO Support.

Errors %s: destroy %s failed: invalid session id=%d.

Cannot find session for ack
Cannot find session for ack range
Invalid session in commit request.

TIBCO Enterprise Message Service User’s Guide

 Errors 341
|

Invalid session in commit transaction record.

Invalid session in recover request.
Invalid session in rollback request.
Invalid session in xa end request.
Invalid session in xa start request.
Unable to destroy session, invalid session.

Category LDAP error - should always display LDAP error

Description An attempt to authenticate a client's userid and password using the external
LDAP server failed.

Remedy Examine the error code printed by the messaging server and consult the manual
for the external LDAP server.

Errors LDAP is not present

could not start tls in ldap initialization.
filter '%s' contains an illegal type substitution character, only %%s is allowed
filter '%s' contains too many occurrances of %%s, max allowed is: %d
filter '%s' too long, max length is %d characters
invalid search scope: %s
ldap_parse_result failed: %s
ldap_search_s failed: %s
ldap_set_option failed: %s
ldap_unbind failed: %s
ldap_url_parse failed, returned: %d
lookup of group '%s' produced incorrect or no results
missing %s parameter
missing LDAP URL
unable to bind to LDAP server as: '%s', %s
zero entries returned from getting attributes for group '%s':

TIBCO Enterprise Message Service User’s Guide

342
| Appendix D Error Messages

Category LICENSE WARNING

Description The server detected a violation of its license.

Remedy This error only occurs with the evaluation version of the server or in an
embedded form. To correct this error either replace your evaluation version with
a production version or contact the vendor who supplied the embedded version.

Errors [%s@%s]: LICENSE WARNING: %s

Category Missing configuration

Description An essential attribute has not been configured.

Remedy Change the tibemsd.conf file so that a value for the attribute is provided.

Errors Configuration error with metadata database.

Configuration error with storage databases.

Category Missing transaction

Description A client application attempted to change the state of a transaction that the
tibemsd does not have in its list of current transactions.

Remedy Check tibemsd trace logs to see if the transaction had been committed or rolled
back by an administrator, if not then check the client code to see if it or its
transaction manager are calling the transaction operations in the correct order.

Errors Cannot find transaction referred to in commit request.

Cannot find transaction referred to in commit transaction record.
Cannot find transaction referred to in prepare request.
Cannot find transaction referred to in rollback request.
Cannot find transaction referred to in rollback transaction record.
Cannot find transaction referred to in xa commit request.
Cannot find transaction referred to in xa prepare request.
Cannot find transaction referred to in xa rollback request.
Cannot find transaction referred to in xa start request.
Cannot process xa end for non-existent transaction.

TIBCO Enterprise Message Service User’s Guide

 Errors 343
|

Category Out of memory

Description The server failed to allocate memory as it was attempting to perform an

operation.

Remedy Check how much memory the server process is using according to the operating
system. Compare this with how much memory and swap space the host actually
has. If there are sufficient memory and swap space, check the operating system
limits on the server process to determine if this is the cause. If the limits are set to
their maximum and this error occurs, reduce the load on this server by moving
some topics and queues to another server.

Errors Could not initialize monitor

Error during route configuration, can not create routed queue consumer
Error during routed queue configuration, can not create routed queue consumer
Error: out of memory processing admin request
Error: unable to create %s '%s': no memory
Error: unable to create alias for %s '%s': no memory
Error: unable to create alias: out of memory
Error: unable to create route while parsing file=%s, line=%d.
Exception trying to create ack record, no memory.
Failed writing message to '%s': No memory for operation.
Fault Tolerant configuration, no memory!
Fault Tolerant error, no memory.
LDAP initialization failed.
No memory authenticating user '%s'
No memory authenticating via LDAP
No memory creating stalled flow record in destination
No memory creating stalled flow record in route
No memory creating stalled flows in destination
No memory creating stalled flows in route
No memory creating the stalled destination %s on route %s
No memory creating the stalled destination %s:%s on route %s

TIBCO Enterprise Message Service User’s Guide

344
| Appendix D Error Messages

No memory for creating connection.

No memory generating dynamic route durable.
No memory in IO thread to create pool.
No memory performing routing operation.
No memory processing purge record.
No memory sending topic routing information.
No memory to create ack record.
No memory to create client connection
No memory to create configured durable '%s%s%s'.
No memory to create configured durables
No memory to create confirm record.
No memory to create connection.
No memory to create consumer.
No memory to create destination for consumer.
No memory to create destination for message.
No memory to create destination for producer.
No memory to create message from store.
No memory to create producer.
No memory to create routed consumer
No memory to create routed queue consumers
No memory to create session.
No memory to create transaction record.
No memory to create valid messages record.
No memory to create zone.
No memory to process SSL renegotiation request.
No memory to process route interest
No memory to restore messages.
No memory to restore prepared transactions.
No memory to set clientID for connection.
No memory trying to send recover/rollback response.

TIBCO Enterprise Message Service User’s Guide

 Errors 345
|

No memory trying to add message to dead queue.

No memory trying to add message to system.
No memory trying to cleanup route.
No memory trying to create client connection.
No memory trying to create consumer.
No memory trying to create destination for consumer.
No memory trying to create destination.
No memory trying to create global topic destination.
No memory trying to create message producer.
No memory trying to create producer.
No memory trying to create queue browser.
No memory trying to create response message.
No memory trying to create routed queue destination.
No memory trying to create routed tmp queue destination.
No memory trying to create session.
No memory trying to create tmp destination for consumer.
No memory trying to create txn.
No memory trying to export message to RV.
No memory trying to export message to SS.
No memory trying to import message from RV%s.
No memory trying to import message from RVCM.
No memory trying to import message from SS.
No memory trying to initialize connection.
No memory trying to initialize route connection.
No memory trying to parse configured durable.
No memory trying to process data message.
No memory trying to process queue message.
No memory trying to process system request.
No memory trying to process topic consumer.
No memory trying to process topic message.

TIBCO Enterprise Message Service User’s Guide

346
| Appendix D Error Messages

No memory trying to process xa end.

No memory trying to read message from store.
No memory trying to recover routed consumer.
No memory trying to recreate persistent message.
No memory trying to retrieve for queue browser.
No memory trying to retrieve for queue browser.
No memory trying to setup queue route configuration
No memory trying to setup route configuration
No memory trying to setup topic route configuration
No memory while processing route interest
No memory.
Out of memory
Out of memory creating import event for %s '%s' on transport '%s'
Out of memory processing %s on %s '%s'
Out of memory processing administrative request
Out of memory processing message tracing
Out of memory processing transports configuration
Out of memory reading configuration.
Out of memory restoring routed consumer
Out of memory sending monitor message.
Out of memory while building JNDI response message
Out of memory while building admin response message
Out of memory while parsing bridges file
Out of memory while parsing factories file
Out of memory while parsing routes file
Unable to create import event for %s '%s' on transport '%s'
Failed to create reserve memory. Exiting.
Failed to initialize OpenSSL environment: out of memory
Fault Tolerant error, can't create connection to '%s'.

TIBCO Enterprise Message Service User’s Guide

 Errors 347
|
Category Protocol error, incorrect XID in XA request

Description The tibemsd received an XA End instruction from the third party Transaction
Manager which referred to a different transaction from the one currently in use by
the session.

Remedy Report this to the your Transaction Manager vendor.

Errors Incorrect xid in xa end request.

Category Protocol error, transaction in incorrect state

Description A client application's attempt to start an XA transaction failed because the

transaction already exists and is not in the correct state.

Remedy This error is most likely caused by an external transaction manager that allowed
two separate client applications to use the same XA transaction identifier (XID).
Consult the manual for the transaction manager or report this to the transaction
manager vendor.

Errors Cannot process xa start for a session when another transaction is already active on
that session.
Cannot process xa start with TMNOFLAGS when the transaction is already
active.

Category Protocol message format error

Description tibemsd received a message with either missing or incomplete data.

Remedy Send details of the error and the situation in which it occurred to TIBCO Support.

Errors Invalid flag in xa end request.

Invalid flag in xa start request.
Invalid request to delete temporary destination.
Invalid request to delete temporary destination: not owner connection.
Invalid xid in commit request.
Invalid xid in commit transaction record.
Invalid xid in prepare request.
Invalid xid in rollback request.

TIBCO Enterprise Message Service User’s Guide

348
| Appendix D Error Messages

Invalid xid in rollback transaction record.

Invalid xid in xa commit request.
Invalid xid in xa end request.
Invalid xid in xa prepare request.
Invalid xid in xa rollback request.
Invalid xid in xa start request.
Malformed routed message
Problem decoding sequence data in confirm.
Problem decoding sequence data in xa end.
Received JNDI request with replyTo not set.
Received admin request with replyTo not set
Received unexpected message type %d
Unable to confirm session, invalid request.
Unable to create consumer, invalid destination.
Unable to init session, invalid request.
Unable to process msg for export.
Unable to recover consumer, invalid request.
Unable to recover consumer, invalid session.
Unable to recover flow stall, invalid consumer.
Unable to recover flow stall, invalid request.
Unable to start consumer, invalid consumer
Unable to unsubscribe consumer, invalid client request.

Category Protocol sequence error

Description A non-embedded java client is attempting to connect to a tibemsd that is part of

an embedded JMS environment.

Remedy Reconfigure the client to connect to a fully licensed tibemsd.

Errors Invalid client connect detected.

No closure.

TIBCO Enterprise Message Service User’s Guide

 Errors 349
|

Category Rejected attempt to connect via SSL to TCP port

Description A client application attempted to connect to the server's TCP port using the SSL
protocol.

Remedy Change the client application's URL from ssl to tcp or change the server's listen
parameter from tcp to ssl. To activate a change of the server listen parameter
requires a restart of the server.

Errors Rejected attempt to connect via SSL to TCP port

Category Rejected attempt to connect via TCP to SSL port

Description A client application attempted to connect to the server's SSL port using the TCP
protocol.

Remedy Change the client application's URL from tcp to ssl or change the server's listen
parameter from ssl to tcp. To activate a change of the server listen parameter
requires a restart of the server.

Errors Rejected attempt to connect via TCP to SSL port

Category rejected connect from route: invalid cycle in route

Description The multi-hop route support of the server does not support configuring a cycle.
However, it detected a configuration that would create a cycle.

Remedy Remove one of the routes that creates the cycle.

Errors Illegal, route to '%s' creates a cycle.

Illegal, route to '%s' creates a cycle. Terminate the connection
[%s@%s]: rejected connect from route: invalid cycle in route: %s

Category Rendezvous transport error

Description tibemsd encountered a Rendezvous error.

Remedy See Rendezvous documentation for details of what the error means and how to
remedy it.

TIBCO Enterprise Message Service User’s Guide

350
| Appendix D Error Messages

Errors Failed to confirm RVCM message: %s.

Failed to disallow Rendezvous Certified Message listener '%s': %s
Rendezvous send failed on transport '%s', error='%s'
Unable to confirm RVCM message. %s
Unable to create Rendezvous Certified transport '%s' because unable to create
Rendezvous transport '%s'
Unable to create Rendezvous Certified transport '%s': %s
Unable to create Rendezvous transport '%s': %s
Unable to create TIBCO Rendezvous Certified Listener for %s '%s' on transport
'%s': %s
Unable to create inbox for import event for %s '%s' on transport '%s'
Unable to export topic message, error=%s.
Unable to handoff confirm RVCM message: %s.
Unable to pre-register certified listener '%s' on transport '%s': %s
Unable to process imported RVCM message.

Category Restoring consumer failed

Description Seen when tibemsd starts up and detects that the zone for a route as specified in
routes.conf has been changed.

Remedy Either delete the route or change its zone back and restart the tibemsd.

Errors Restoring consumer failed:

Conflicting zone for route to [%s]:
The route was initially zone \"%s\" type %s, but now \"%s\" type %s.
Zone change not allowed while there are durable subscribers.
Please delete the route first and create new one.

Category Running on reserve memory

Description Warnings indicating that the tibemsd has run out of memory and is now using its
reserve memory

Remedy Either reduce the tibemsd's memory requirement by consuming messages or

removing messages from its queues, or increase the amount of memory available
to the tibemsd by shutting down other processes on the machine or increasing the

TIBCO Enterprise Message Service User’s Guide

 Errors 351
|

machine's memory.

Errors Running on reserve memory, ignoring new message.

Running on reserve memory, no more send requests accepted.

Category SmartSocket transport error

Description tibemsd encountered a SmartSockets error.

Remedy See SmartSockets documentation for details of what the error means and how to
remedy it.

Errors Exception trying to export message to SS.

Failed to create SmartSockets transport %s
SS Subject CB destroy Failed: for '%s' on transport '%s' SS error: %s
SS Subject CB lookup Failed: for '%s' on transport '%s' SS error: %s
SS Unsubscribe failed: for '%s' on transport '%s' SS error: %s
SmartSockets TipcMsgSetDeliveryMode failed, '%s'
SmartSockets TipcMsgSetLbMode failed, '%s'
SmartSockets TipcSrvConnFlush failed, '%s'
SmartSockets TipcSrvConnMsgSend failed, '%s'
Unable to connect to SmartSockets RTserver via transport: '%s': %d - %s
Unable to create SS callback for %s '%s' on transport '%s' SS error: %s
Unable to create SmartSockets subscriber for %s '%s' on transport '%s', error: %s
Unable to create SmartSockets transport '%s': %d - %s
Unable to destroy SmartSockets subscriber on transport %s: failed to convert
subject '%s', error=%d
Unable to export JMS message into SmartSockets on transport '%s'. Failed to
convert subject '%s', error=%d
Unable to export topic message to SmartSockets.
Unable to import SmartSockets message on transport %s: failed to convert subject
'%s', error=%d
Unable to set SmartSockets Dispatcher for transport: '%s': %d - %s
Unable to set Username/Password for SmartSockets transport '%s': %d - %s

TIBCO Enterprise Message Service User’s Guide

352
| Appendix D Error Messages

Category SSL initialization failed

Description The server failed attempting to initialize the OpenSSL library.

Remedy Examine the OpenSSL error and the EMS User's Guide chapter describing the use
of SSL.

Errors Failed to initialize OpenSSL environment: error=%d, message=%s.

Failed to initialize SSL. Error=%s
Failed to initialize SSL: can not load certificates and/or private key and/or CRL
file(s)
Failed to initialize SSL: server certificate not specified.
Failed to initialize SSL: server private key not specified.
Failed to initialize SSL: unable to obtain password
Failed to process ft ssl password
Failed to process ssl password
Ignoring SSL listen port %s

Category System call error, should be errno-driven

Description A low-level system function has failed.

Remedy Report the error to your system administrator and ask them to remedy the
problem.

Errors Accept() failed: too many open files.

Please check per-process and system-wide limits on the number of open files.
Accept() failed: %d (%s)
Cannot retrieve user name of the current process.
Client connection not created, socket failed.
Could not obtain hostname
Could not resolve hostname '%s'. Possibly default hostname is not configured
properly while multiple network interfaces are present.
Unable to listen for connections: %d (%s).
Unable to open socket for listening: %d (%s).

TIBCO Enterprise Message Service User’s Guide

 Errors 353
|

Category Unrecognized option

Description The server's command line contains an unrecognized option.

Remedy Run the server with the -help option and compare it with the command line
containing the unrecognized option.

Errors Unrecognized option: '%s'.

TIBCO Enterprise Message Service User’s Guide

354
| Appendix D Error Messages

TIBCO Enterprise Message Service User’s Guide

 | 355

Index

A E
admin export
connect 152 topic property 36
password 228 export property 36
user 148 topic 155
admin user 228 export topic property 155
anonymous
user and security 228

C failover and heartbeat 275

files, sample 300
compiling samples 300
compression
messages 59
configuring G
external directory for authentication 186
LDAP 186 group 185
connect
admin 152
customer support xviii
H
heartbeat
D failover and 275

definitions of properties 33
delete subscriber 156
disabled security 228 I
durable subscriber 5, 34, 64, 159
dynamic queues 30 import
dynamic topics 30 queue property 36
topic property 36
import property 36
inheritance
property 41
inheritance of property 31

TIBCO Enterprise Message Service User’s Guide

356
| Index

J property 63
definitions 33
JNDI connections 232 export 36
static queues 232 import 36
static topics 232 inheritance 31, 41
maxbytes 41

L
Q
LDAP 186
queue import property 36
queue properties 32
queue property list 32
M queues
dynamic 30
MapMessage 51 static 30
definition 51 temporary 30
extension 63
maxbytes property 41
message compression 59
S
sample files 300
N samples
compiling 300
no-acknowledge receipt 65 secure property and permission 33
No-Acknowledgement Receipt Mode 65 security
and anonymous user 228
disabled 228
main configuration file 183
P shared storage 267
static queues 30
password JNDI connections 232
admin 228 static topics 30, 232
permission subscriber 5, 192
secure property and 33 delete 156
properties durable 5, 34, 64, 159
queue 32 support, contacting xviii
topic 32

T
tcp 152, 230, 302

TIBCO Enterprise Message Service User’s Guide

 Index 357
|
technical support xviii
temporary queues 30
temporary topics 30
topic export property 36
topic import property 36
topic property list 32
topics
dynamic 30
static 30
temporary 30

U
UNIX system
using for user authentication 186
user 185
admin 228
externally authenticated 186
user admin 148

TIBCO Enterprise Message Service User’s Guide

358
| Index

TIBCO Enterprise Message Service User’s Guide

 TIBCO Software Inc. End User License Agreement 359
|

TIBCO Software Inc. End User License Agreement

READ THIS END USER LICENSE AGREEMENT CAREFULLY. BY resolution during TIBCO's published support hours corresponding to
DOWNLOADING OR INSTALLING THE SOFTWARE, YOU AGREE the level of Support fees paid.
TO BE BOUND BY THIS AGREEMENT. IF YOU DO NOT AGREE TO
THESE TERMS, DO NOT DOWNLOAD OR INSTALL THE Upon notice from a contact of a Software problem which can be
SOFTWARE AND RETURN IT TO THE VENDOR FROM WHICH IT reproduced at a TIBCO support facility or via remote access to
WAS PURCHASED. RETURNS BY THE ORIGINAL PURCHASER Customer's facility, TIBCO shall use reasonable efforts to correct or
WITHIN THIRTY (30) DAYS OF THE PURCHASE DATE WILL circumvent the problem according to its published support objectives.
RECEIVE A FULL REFUND. TIBCO reserves the right to make changes only to the most currently
available version. TIBCO will use reasonable efforts to support the
Upon your acceptance as indicated above, the following shall govern previously released version of the Software for a maximum of six
your use of the Software except to the extent all or any portion of the months.
Software (a) is subject to a separate written agreement, (b) includes a
separate "click-on" license agreement as part of the download or TIBCO shall have no obligation to support the Software (i) for use on
installation process, or (c) is provided by a third party under the terms any computer system running other than the operating system
set forth in an Addenda at the end of this Agreement, in which case software for which the Software is approved (as set forth in the
the terms of such addenda shall control over inconsistent terms with Software documentation) and licensed hereunder, or (ii) if Customer
regard to such portion(s). has modified or authorized a third party to modify the Software.
TIBCO shall have no obligation to modify any version of the Software
License Grant. The Software is the property of TIBCO or its licensors to run with any new versions of any operating system, or any other
and is protected by copyright and other laws. While TIBCO continues third party software or hardware. If Customer purchases Support for
to own the Software, TIBCO hereby grants to Customer a limited, any Software, Customer must purchase the same level of Support for
non-transferable, non-exclusive, license to use the number of all copies of the Software for which it is licensed.
Permitted Instances set forth in the Ordering Document, in
machine-readable, object code form and solely for Customer's internal Support may be extended for one-year periods on the anniversary of
business use. each Purchase Date at the standard amounts set forth in its price list,
for as long as TIBCO offers Support. Customer may reinstate lapsed
Restrictions. Customer agrees not to (a) make more copies than the support for any then currently supported Software by paying all
number of Permitted Instances plus a reasonable number of backups; Support fees in arrears and any applicable reinstatement fee.
(b) provide access to the Software to anyone other than employees, Upgrades, patches, enhancements, bug fixes, new versions and/or
contractors, or consultants of Customer; (c) sublicense, transfer, new releases of the Software provided from time to time under
assign, distribute to any third party, pledge, lease, rent, or Support shall be used only as replacements to existing Permitted
commercially share the Software or any of Customer's rights under Instances, and shall not be deemed to increase that number, and use
this Agreement (for the purposes of the foregoing a change in control thereof shall be governed by the terms of this Agreement, except for
of Licensee is deemed to be an assignment); (d) use the Software for the first paragraph of the Limited Warranty and any right of return or
purposes of providing a service bureau, including, without limitation, refund.
providing third-party hosting, or third-party application integration or
application service provider-type services, or any similar services; (e) Consulting Services. Customer may request additional services
use the Software in connection with ultrahazardous activities, or any ("Services") either in an Ordering Document, or by a separate
activity for which failure of the Software might result in death or serious mutually executed work order, statement of work or other
bodily injury to Customer or a third party; or (f) directly or indirectly, in work-request document incorporating this Agreement (each, a "Work
whole or in part, modify, translate, reverse engineer, decrypt, Order"). Unless otherwise expressly agreed to in a Work Order, all
decompile, disassemble, make error corrections to, create derivative Services and any work product therefrom shall be (a) performed on a
works based on, or otherwise attempt to discover the source code or time and materials basis, plus meals, lodging, travel, and other
underlying ideas or algorithms of the Software. expenses reasonably incurred in connection therewith, (b) deemed
accepted upon delivery, and (c) exclusively owned by TIBCO (except
Beta and Evaluation Licenses. Notwithstanding the foregoing, if the for confidential information of Customer identified to TIBCO in the
Software is being provided for demonstration, beta testing, or Ordering Document), including all right, title and intellectual property
evaluation purposes, then Customer agrees (a) to use the Software or other right or interest therein. Each Work Order is intended to
solely for such purposes, (b) that the Software will not be used or constitute an independent and distinct agreement of the parties,
deployed in a production environment, and (c) that such use shall notwithstanding that each shall be construed to incorporate all
automatically terminate upon the earlier of thirty days from the date applicable provisions of this Agreement. Specific to TIBCO training
Customer receives the right to install the Software, or Customer's services, additional information regarding courses, registration,
receipt of notice of termination from TIBCO. restrictions or limitation can be found at TIBCO's website at
http://www.tibco.com/services/education under Education Programs.
Technical Support. Provided Customer has paid applicable support Fees for Services shall be due and payable in United States dollars
fees (not included with Software fees unless separately listed), TIBCO net 30 from the date of TIBCO's invoice.
shall provide support for generally available TIBCO Software on an
annual basis commencing on the Purchase Date, as follows Limited Warranty. If Customer obtained the Software directly from
("Support"): Customer shall designate at TIBCO's support website TIBCO, then TIBCO warrants that for a period of thirty (30) days from
https://support.tibco.com/eSupport/newuser.html, the number of the Purchase Date: (i) the media on which the Software is furnished
technical support contacts permitted under the level of Support will be free of defects in materials and workmanship under normal
purchased (contacts are changeable upon 48-hours prior written use; and (ii) the Software will substantially conform to its published
notice to TIBCO). Each contact may contact TIBCO for problem specifications. This limited warranty extends only to the original
Customer hereunder. Customer's sole and exclusive remedy and the

TIBCO Enterprise Message Service User’s Guide

360
| TIBCO Software Inc. End User License Agreement
entire liability of TIBCO and its suppliers under this limited warranty Limitation of Liability. EXCEPT AS PROVIDED UNDER
will be, at TIBCO's option, repair, replacement, or refund of the INDEMNITY OR RESULTING FROM A BREACH OF
Software and applicable Support fees, in which event this Agreement CONFIDENTIALITY (THE "EXCLUDED MATTERS"), IN NO EVENT
shall terminate upon payment thereof. WILL EITHER PARTY BE LIABLE FOR ANY LOST DATA, LOST
REVENUE, LOST PROFITS, DAMAGE TO REPUTATION,
This warranty does not apply to any Software which (a) is licensed for BUSINESS INTERRUPTION, OR ANY OTHER INDIRECT,
beta, evaluation, testing or demonstration purposes for which TIBCO INCIDENTAL, CONSEQUENTIAL, SPECIAL, PUNITIVE,
does not receive a license fee, (b) has been altered or modified, EXEMPLARY OR ANY SIMILAR TYPE DAMAGES ARISING OUT OF
except by TIBCO, (c) has not been installed, operated, repaired, or THIS AGREEMENT, THE USE OR THE INABILITY TO USE THE
maintained in accordance with instructions supplied by TIBCO, (d) has SOFTWARE, OR THE PROVISION OF ANY SUPPORT OR
been subjected to abnormal physical or electrical stress, misuse, SERVICES, EVEN IF A PARTY HAS BEEN ADVISED OF THE
negligence, or accident, or (e) is used in violation of any other term of POSSIBILITY OF SUCH DAMAGES. EXCEPT FOR THE EXCLUDED
this Agreement. Customer agrees to pay TIBCO for any Support or MATTERS, IN NO EVENT SHALL A PARTY BE LIABLE TO THE
Services provided by TIBCO related to a breach of the foregoing on a OTHER, WHETHER IN CONTRACT, TORT (INCLUDING ACTIVE OR
time, materials, travel, lodging and other reasonable expenses basis. If PASSIVE NEGLIGENCE), BREACH OF WARRANTY, CLAIMS BY
Customer obtained the Software from a TIBCO reseller or distributor, THIRD PARTIES OR OTHERWISE, EXCEED THE PRICE PAID BY
the terms of any warranty shall be as provided by such reseller or CUSTOMER UNDER THE APPLICABLE ORDERING DOCUMENT.
distributor, and TIBCO provides Customer no warranty with respect to
such Software. THE FOREGOING LIMITATIONS SHALL APPLY EVEN IF THE
ABOVE-STATED REMEDY OR LIMITED WARRANTY FAILS OF ITS
EXCEPT AS SPECIFIED IN THIS LIMITED WARRANTY, THE ESSENTIAL PURPOSE. BECAUSE SOME STATES OR
SOFTWARE, SUPPORT AND SERVICES ARE PROVIDED "AS IS", JURISDICTIONS DO NOT ALLOW LIMITATION OR EXCLUSION OF
ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS, CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE
AND WARRANTIES INCLUDING, WITHOUT LIMITATION, ANY LIMITATION MAY NOT APPLY TO CUSTOMER.
IMPLIED WARRANTY OR CONDITION OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, Confidentiality. "Confidential Information" means the terms of this
SATISFACTORY QUALITY OR ARISING FROM A COURSE OF Agreement; all information marked by the disclosing party as
DEALING, USAGE, OR TRADE PRACTICE, ARE HEREBY proprietary or confidential; any provided software, related
EXCLUDED TO THE EXTENT ALLOWED BY APPLICABLE LAW. NO documentation or related performance test results derived by
WARRANTY IS MADE REGARDING THE RESULTS OF ANY Licensee; and any methods, concepts or processes utilized in
SOFTWARE, SUPPORT OR SERVICES OR THAT THE SOFTWARE provided software or related documentation. Confidential Information
WILL OPERATE WITHOUT ERRORS, PROBLEMS OR shall remain the sole property of the disclosing party and shall not be
INTERRUPTIONS, OR THAT ERRORS OR BUGS IN THE disclosed to any non-Authorized User without the prior written consent
SOFTWARE WILL BE CORRECTED, OR THAT THE SOFTWARE'S of the disclosing party. If Confidential Information is communicated
FUNCTIONALITY OR SERVICES WILL MEET CUSTOMER'S orally, such communication shall be confirmed as "Confidential" in
REQUIREMENTS. NO TIBCO DEALER, DISTRIBUTOR, AGENT OR writing within thirty days of such disclosure. The parties agree to
EMPLOYEE IS AUTHORIZED TO MAKE ANY MODIFICATIONS, protect the Confidential Information of the other in the same manner it
EXTENSIONS OR ADDITIONS TO THIS WARRANTY. protects the confidentiality of similar information and data of its own
(and at all times exercising at least a reasonable degree of care).
Indemnity. If Customer obtained the Software from TIBCO directly, Except with respect to the Software, items will not be deemed
then TIBCO shall indemnify Licensee from and against any final Confidential Information if (i) available to the public other than by a
judgment by a court of competent jurisdiction, including reasonable breach of an agreement with TIBCO, (ii) rightfully received from a third
attorneys' fees, that the unmodified TIBCO Software infringes any party not in breach of any obligation of confidentiality, (iii)
patent issued by the United States, Canada, Australia, Japan, or any independently developed by one party without use of the Confidential
member of the European Union, or any copyright, or any trade secret Information of the other; (iv) known to the recipient at the time of
of a third party; provided that TIBCO is promptly notified in writing of disclosure (other than under a separate confidentiality obligation); or
such claim, TIBCO has the exclusive right to control such defense (v) produced in compliance with applicable law or court order,
and/or settlement, and Licensee shall provide reasonable assistance provided the other party is given reasonable notice of the same. Both
(at TIBCO's expense) in the defense thereof. In no event shall parties agree to indemnify the other for any damages the other may
Licensee settle any claim, action or proceeding without TIBCO's prior sustain resulting from their unauthorized use and/or disclosure of the
written approval. In the event of any such claim, litigation or threat other's Confidential Information. Such damages shall include
thereof, TIBCO, at its sole option and expense, shall (a) procure for reasonable expenses incurred in seeking both legal and equitable
Licensee the right to continue to use the TIBCO Software or (b) remedies. To the extent required by law, at Customer's request,
replace or modify the TIBCO Software with functionally equivalent TIBCO shall provide Customer with the interface information needed
software. If such settlement or modification is not commercially to achieve interoperability between the Software and another
reasonable (in the reasonable opinion of TIBCO), TIBCO may cancel independently created program, on payment of TIBCO's applicable
this Agreement upon sixty days prior written notice to Licensee, and fee. Customer agrees to observe obligations of confidentiality with
refund to Licensee the unamortized portion of the license fees paid to respect to such information.
TIBCO by Licensee based on a five-year straight-line depreciation.
This Section states the entire liability of TIBCO with respect to the Export. Software, including technical data, is subject to U.S. export
infringement of any Intellectual Property rights, and Licensee hereby control laws, including the U.S. Export Administration Act and its
expressly waives any other liabilities or obligations of TIBCO with associated regulations, and may be subject to export or import
respect thereto. The foregoing indemnity shall not apply to the extent regulations in other countries. Customer agrees to comply strictly with
any infringement could have been avoided by use of the then-current all such regulations and agrees to obtain all necessary licenses to
release. export, re-export, or import Software.

TIBCO Enterprise Message Service User’s Guide

 TIBCO Software Inc. End User License Agreement 361
|
Government Use. If the Customer is an agency, department, or other "Limited Warranty" all fees paid under or in connection with this
entity of the United States Government ("Government"), the use, Agreement are non-refundable and no right of set-off exists. All
duplication, reproduction, release, modification, disclosure or transfer payments of fees due shall be made in U.S. dollars, net 30 from
of the Software, or any related documentation of any kind, including Purchase Date, or, for any other amounts coming due hereafter, net
technical data or manuals, is restricted in accordance with Federal 30 from TIBCO's invoice. A service charge of one and one-half
Acquisition Regulation ("FAR") 12.212 for civilian agencies and percent per month will be applied to all invoices that are not paid on
Defense Federal Acquisition Regulation Supplement ("DFARS") time. Licensee agrees to pay all sales, use, value-added, withholding,
227.7202 for military agencies. The Software is commercial computer excise and any other similar taxes or government charges, exclusive
software and commercial computer software documentation. Use of of TIBCO's income taxes. No delay in the performance of any
the Software and related documentation by the Government is further obligation by either party, excepting all obligations to make payment,
restricted in accordance with the terms of this Agreement, and any shall constitute a breach of this Agreement to the extent caused by
modification thereto. force majeure. Customer hereby grants TIBCO and its independent
auditors the right to audit Customer's compliance with this Agreement.
Orders. An Ordering Document shall be deemed accepted only by If any portion of this Agreement is found to be void or unenforceable,
issuance of a TIBCO invoice and solely for purposes of administrative the remaining provisions shall remain in full force and effect. This
convenience. None of the terms of the Ordering Document (other than Agreement shall be governed by and construed in accordance with
the Software product name, number of Permitted Instances, level of the laws of the State of California, United States of America, as if
Support, description of Services, and fees due in connection performed wholly within the state and without giving effect to the
therewith) shall apply for any reason or purpose whatsoever, principles of conflict of law. The state and/or federal courts in San
regardless of any statement on any Ordering Document to the Francisco, California, USA, shall have exclusive jurisdiction of any
contrary, unless countersigned by an officer of TIBCO. This action arising out of or relating to this Agreement. The United Nations
Agreement constitutes the entire agreement between the parties with Convention on Contracts for the International Sale of Goods is
respect to the use of the Software, Support and Services, and excluded from application hereto. If any portion hereof is found to be
supersedes all proposals, oral or written, and all other representations, void or unenforceable, the remaining provisions of this Agreement
statements, negotiations and undertakings relating to the subject shall remain in full force and effect.
matter hereof. All orders of Software, Support or Services by
Customer from TIBCO shall be deemed to occur under the terms of Definitions. In connection with this Agreement, the following
this Agreement (with or without reference to this Agreement), unless capitalized terms shall have the following meaning: "Agreement"
expressly superseded by a signed written Agreement between the means this End User License Agreement; "Connection" for the TIBCO
parties. Software shall be delivered electronically (unless physical Software product TIBCO Enterprise Message Service - Full Edition
shipment is specifically set forth in an Ordering Document), and such means a TIBCO Enterprise Message Service client connection to the
delivery shall occur upon e-mail of download information to Licensee TIBCO Enterprise Message Service server for the purpose of sending
at the email address set forth in the Ordering Document or as or receiving messages and for the purposes of the TIBCO Software
otherwise provided by Customer to TIBCO. Physical deliveries (if products TIBCO SmartSockets and TIBCO SmartMQ software
applicable) of Software and documentation which typically products, a Connection means any network protocol link established
accompanies the Software on delivery shall be on CD-ROM, FOB with such TIBCO Software (directly or indirectly) to any other entity,
TIBCO, and delivery shall occur by depositing the CD-ROM with including but not limited to software, firmware or hardware;
TIBCO's overnight carrier (at no charge to Customer). "Customer" means the original purchaser or licensee of the Software
and any permitted successors and assigns; "Developer" means one
Term and Termination. Support or Services may be terminated: (a) user/developer of a TIBCO Software product for use in Development;
by either party upon a default of the other, such default remaining "Development" means used for software development purposes only;
uncured for fifteen days from written notice from the non-defaulting "Enterprise" means an unlimited number of Permitted Instances for a
party; (b) upon the filing for bankruptcy or insolvency of the other period of one year from the Purchase Date (unless otherwise set forth
party, (c) by either party upon prior written notice at least sixty days in the Ordering Document), at which time existing licenses convert to
prior to the end of any annual Maintenance period; or (d) by Licensee perpetual and Customer may not thereafter deploy additional
(for Services), upon ten days prior written notice. Termination of Permitted Instances, and in any event, shall (during the one-year
Support or Services shall not terminate this Agreement. Customer unlimited deployment period) exclude any entity which acquires, is
may terminate this Agreement in its entirety at any time by destroying acquired by, merged into, or otherwise combined with Customer.
all copies of the Software. Upon termination of this Agreement in its Customer hereby agrees to provide TIBCO with notice of the number
entirety, for any reason, Customer must cease using and return or of Permitted Instances deployed at the end of such one-year period
destroy all copies of the Software. Customer's obligation to pay within thirty days thereafter; "Fab" means unlimited use for shop-floor
accrued charges and any fees due as of the date of termination, as manufacturing applications at a Site; "Workstation" shall mean a
well as the sections entitled "Confidentiality", "Limited Warranty" and single end-user computer that is generally intended to be accessed by
"Limitation of Liability" shall survive any such termination. one person at a time; "Ordering Document" means any purchase
order or similar document or agreement requesting Software, Support
Authority. You hereby represent and warrant that you have full power or Services; "Permitted Instance(s)" means the number of copies of
and authority to accept the terms of this Agreement on behalf of Software running on a Server Instance, Workstation, User, or
Customer, and that Customer agrees to be bound by this Agreement. Development basis, on a designated Platform, as set forth in an
Ordering Document, including, without limitation, Enterprise, Site and
General. Fees on the Ordering Document (all to be paid on the latter Fab licensing; "Platform" means the operating system set forth in an
of thirty days from Invoice by TIBCO or the date set forth in the Ordering Document; "Purchase Date" means the date the Ordering
Ordering Document) do not include sales, use, withholding, Document is accepted by TIBCO; "Server Instance" means a
value-added or similar taxes, and Customer agrees to pay the same, computer with 1 CPU (unless otherwise set forth in the Ordering
excluding therefrom taxes related to TIBCO's income and corporate Document) performing common services for multiple machines; "Site"
franchise tax. Customer agrees to pay all reasonable costs incurred means an unlimited number of Permitted Instances at a specific
(including reasonable attorneys' fees) in collecting past due amounts physical address set forth in the Ordering Document (or, in the
under this Agreement. Except as set forth in the Section entitled absence of any address, at Customer's corporate headquarters);

TIBCO Enterprise Message Service User’s Guide

362
| TIBCO Software Inc. End User License Agreement
"Software" means the software products listed in an Ordering
Document (except as provided in the second paragraph hereof), in
whole and in part, along with their associated documentation; "TIBCO"
means TIBCO Software Inc.; and "Named User" means the number of
named users with access to the Software.

Special Product Provisions. TIBCO BusinessPartner: Customer

may sublicense to third parties ("Partners") up to the total Number of
Copies of TIBCO BusinessPartner, provided that for every such
sublicense, the Number of Copies Customer is licensed to use shall
be reduced by the same number, and provided further that prior to
delivery of TIBCO BusinessPartner to a Partner, such Partner agrees
in writing (a) to be bound by terms and conditions at least as
protective of TIBCO as the terms of this Agreement, (b) that TIBCO
BusinessPartner be used solely to communicate with Customer's
implementation of TIBCO BusinessConnect, and (c) for such Partner
to direct all technical support and Maintenance questions directly to
Customer. Customer agrees to keep records of the Partners to which it
distributes TIBCO BusinessPartner, and to provide TIBCO the names
thereof (with an address and contact name) within sixty days of the
end of each quarter. Third Party Software: Use of any other third-party
software identified by its company and/or product name or otherwise
designated in Licensee's Ordering Document (collectively "Third Party
Software") is subject solely to the terms and conditions of the
click-wrap or shrink-wrap license agreement included with the Third
Party Software products, and for which TIBCO shall be an intended
third-party beneficiary of same. TIBCO shall have no obligation
whatsoever in connection with the Third Party Software (including,
without limitation, any obligation to provide maintenance or support)
and the provision of Third Party Software is accomplished solely as an
accommodation and in lieu of Customer purchasing a license to Third
Party Software directly from the third party vendor.
Embedded/Bundled Products: Some TIBCO Software embeds or
bundles other TIBCO Software (e.g., TIBCO InConcert bundles
TIBCO Rendezvous). Use of such embedded or bundled TIBCO
Software is solely to enable the functionality of the TIBCO Software
licensed on the Cover Page, and may not be used or accessed by any
other TIBCO Software, or for any other purpose. Open Source
Software: If Licensee uses Open Source software in conjunction with
the TIBCO Software, Licensee must ensure that its use does not (i)
create, or purport to create, obligations of use with respect to the
TIBCO Software, or (ii) grant, or purport to grant, to any third party any
rights to or immunities under TIBCO's intellectual property or
proprietary rights in the TIBCO Software. You also may not combine
the TIBCO Software with programs licensed under the GNU General
Public License ("GPL") in any manner that could cause, or could be
interpreted or asserted to cause, the TIBCO Software or any
modifications thereto to become subject to the terms of the GPL.

Third Party Software Notices

Java Secure Socket Extension (JSSE) 1.0.3

This product includes code licensed from RSA Security, Inc.

ADDENDA: Third Party License Agreements

TIBCO Enterprise Message Service User’s Guide

 Third Party Software License Agreements 363
|

Third Party Software License Agreements

The following are the software licenses for the Third Party Software This product includes cryptographic software written by Eric Young
provided in connection with the software. ([email protected]). This product includes software written by Tim
Hudson ([email protected]).

Open SSL v2/v3 0.9.7c

Original SSLeay License
The OpenSSL toolkit stays under a dual license, i.e. both the
conditions of the OpenSSL License and the original SSLeay license Copyright (C) 1995-1998 Eric Young ([email protected])
apply to the toolkit. See below for the actual license texts. Actually
both licenses are BSD-style Open Source licenses. In case of any All rights reserved.
license issues related to OpenSSL please contact
[email protected]. This package is an SSL implementation written by Eric Young
([email protected]).

OpenSSL License The implementation was written so as to conform with Netscape’s

SSL.
Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved.
This library is free for commercial and non-commercial use as long as
Redistribution and use in source and binary forms, with or without the following conditions are adhered to. The following conditions apply
modification, are permitted provided that the following conditions are to all code found in this distribution, be it the RC4, RSA, lhash, DES,
met: etc., code; not just the SSL code. The SSL documentation included
with this distribution is covered by the same copyright terms except
1. Redistributions of source code must retain the above copyright that the holder is Tim Hudson ([email protected]).
notice, this list of conditions and the following disclaimer.
Copyright remains Eric Young's, and as such any Copyright notices in
2. Redistributions in binary form must reproduce the above copyright the code are not to be removed.
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution. If this package is used in a product, Eric Young should be given
attribution as the author of the parts of the library used.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgment: “This product includes This can be in the form of a textual message at program startup or in
software developed by the OpenSSL Project for use in the OpenSSL documentation (online or textual) provided with the package.
Toolkit. (http://www.openssl.org/)”
Redistribution and use in source and binary forms, with or without
4. The names “OpenSSL Toolkit” and “OpenSSL Project” must not be modification, are permitted provided that the following conditions are
used to endorse or promote products derived from this software met:
without prior written permission. For written permission, please
contact [email protected]. 1. Redistributions of source code must retain the copyright notice, this
list of conditions and the following disclaimer.
5. Products derived from this software may not be called “OpenSSL”
nor may “OpenSSL” appear in their names without prior written 2. Redistributions in binary form must reproduce the above copyright
permission of the OpenSSL Project. notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
6. Redistributions of any form whatsoever must retain the following
acknowledgment: 3. All advertising materials mentioning features or use of this software
must display the following acknowledgement: “This product includes
“This product includes software developed by the OpenSSL Project cryptographic software written by Eric Young ([email protected])”
for use in the OpenSSL Toolkit (http://www.openssl.org/)” The word 'cryptographic' can be left out if the routines from the library
being used are not cryptographic related :-).
THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS
IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, 4. If you include any Windows specific code (or a derivative thereof)
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES from the apps directory (application code) you must include an
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR acknowledgement:
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL
PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, “This product includes software written by Tim Hudson
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR ([email protected])”
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
OF THE POSSIBILITY OF SUCH DAMAGE. EXEMPLARY, OR CONSEQUENTIAL

TIBCO Enterprise Message Service User’s Guide

364
| Third Party Software License Agreements
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT X Open ICU 1.4.1.2 Source License
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER COPYRIGHT AND PERMISSION NOTICE
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN Copyright (c) 1999,2000,2001 Compaq Computer Corporation
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING Copyright (c) 1999,2000,2001 Hewlett-Packard Company
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF Copyright (c) 1999,2000,2001 IBM Corporation
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE Copyright (c) 1999,2000,2001 Hummingbird Communications Ltd.
POSSIBILITY OF SUCH DAMAGE. Copyright (c) 1999,2000,2001 Silicon Graphics, Inc.
Copyright (c) 1999,2000,2001 Sun Microsystems, Inc.
The licence and distribution terms for any publicly available version or Copyright (c) 1999,2000,2001 The Open Group
derivative of this code cannot be changed. i.e. this code cannot simply All rights reserved.
be copied and put under another distribution licence [including the
GNU Public Licence.] Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
OpenLDAP 2.1.25 without limitation the rights to use, copy, modify, merge, publish,
distribute, and/or sell copies of the Software, and to permit persons to
The OpenLDAP Public License Version 2.8, 17 August 2003 whom the Software is furnished to do so, provided that the above
copyright notice(s) and this permission notice appear in all copies of
Redistribution and use of this software and associated documentation the Software and that both the above copyright notice(s) and this
("Software"), with or without modification, are permitted provided that permission notice appear in supporting documentation.
the following conditions are met:
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
1. Redistributions in source form must retain copyright statements and ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
notices, TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD
2. Redistributions in binary form must reproduce applicable copyright PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER
statements and notices, this list of conditions, and the following OR HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY
disclaimer in the documentation and/or other materials provided with CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
the distribution, and DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
3. Redistributions must contain a verbatim copy of this document. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
The OpenLDAP Foundation may revise this license from time to time. OR PERFORMANCE OF THIS SOFTWARE.
Each revision is distinguished by a version number. You may use this
Software under terms of this license revision or under the terms of any Except as contained in this notice, the name of a copyright holder shall
subsequent revision of the license. not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization of the
THIS SOFTWARE IS PROVIDED BY THE OPENLDAP copyright holder.
FOUNDATION AND ITS CONTRIBUTORS ``AS IS'' AND ANY
EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT X Window System is a trademark of The Open Group.
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. OSF/1, OSF/Motif and Motif are registered trademarks, and OSF, the
IN NO EVENT SHALL THE OPENLDAP FOUNDATION, ITS OSF logo, LBX, X Window System, and Xinerama are trademarks of
CONTRIBUTORS, OR THE AUTHOR(S) OR OWNER(S) OF THE the Open Group. All other trademarks and registered trademarks
SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, mentioned herein are the property of their respective owners.
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, zlib 1.2.1
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN This product includes zlib software, copyright 1995–2003
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING Jean-loup Gailly and Mark Adler
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

The names of the authors and copyright holders must not be used in
advertising or otherwise to promote the sale, use or other dealing in
this Software without specific, written prior permission. Title to
copyright in this Software shall at all times remain with copyright
holders.

OpenLDAP is a registered trademark of the OpenLDAP Foundation.

Copyright 1999-2003 The OpenLDAP Foundation, Redwood City,

California, USA. All Rights Reserved. Permission to copy and
distribute verbatim copies of this document is granted.

TIBCO Enterprise Message Service User’s Guide