TIBCO Rendezvous®

Configuration Tools
Software Release 8.4
February 2012
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 LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE
LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED
IN THE “LICENSE” FILE(S) OF THE SOFTWARE. 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.
TIBCO, The Power of Now, TIB, Information Bus, Rendezvous, TIBCO Rendezvous and Messaging Appliance
are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other
countries.
EJB, Java EE, J2EE, 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. SEE THE README 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.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING
BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 1997–2012 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
 | iii

Contents

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

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv
Manual Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
TIBCO Rendezvous Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xix
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii

Chapter 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Scope of the Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuration API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Command Line Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
API Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Data Accessors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Immediate Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Read-Only Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Program Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2 Daemon Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

DaemonManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
DaemonManager() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
DaemonManager.getDaemonType(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
DaemonManager.getDaemonProxy() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
DaemonProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
DaemonProxy.getComponentName(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
DaemonProxy.getComponentInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
XmlSerializable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
XmlSerializable.printXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
XmlSerializable.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

TIBCO Rendezvous Configuration Tools

iv
| Contents

Chapter 3 Communications Daemon—rvd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

RvdProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
RvdProxy.getClientTransports() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RvdProxy.getPortMap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
RvdProxy.getServices() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
RvdProxy.getSubectMaps() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
ClientTransport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ClientTransport.getDescription() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
ClientTransport.getDetails() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ClientTransport.getIdentifier() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ClientTransport.getService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
ClientTransport.getSubscriptions(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ClientTransport.getUsername() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
ClientTransport.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Host.getHostname(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Host.getHttpAddress() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Host.getIpAddress() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Host.getSerial() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Host.getUptime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Host.getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Host.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Service.getClientCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Service.getClientTransports() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Service.getDetails() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Service.getHostCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Service.getHosts() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Service.getInboundRates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Service.getInboundTotals() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Service.getNetwork() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Service.getOutboundRates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Service.getOutboundTotals() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Service.getPortNumber() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Service.getSubscriptions(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Service.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
PortMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
PortMap.isEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
PortMap.getLastUpdate(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
PortMap.getPortMapEntries() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
PortMapEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
PortMapEntry.getClientCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
PortMapEntry.getEffectivePort(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

TIBCO Rendezvous Configuration Tools

 Contents v
|
PortMapEntry.getOriginalPort(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
SubjectMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
SubjectMap.getClientCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
SubjectMap.getLastUpdate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
SubjectMap.getSubjectMapEntries() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
SubjectMap.getSubscriptionCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
SubjectMapEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
SubjectMapEntry.getGroup() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
SubjectMapEntry.getRank() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
SubjectMapEntry.getSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
SubjectMapEntry.getSubscriberCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Chapter 4 Routing Daemon—rvrd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77

RvrdProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
RvrdProxy.addBorderRouter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
RvrdProxy.addRouter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
RvrdProxy.addRouters() 81
RvrdProxy.getLoggingParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
RvrdProxy.getRouter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
RvrdProxy.getRouters() 83
RvrdProxy.removeRouter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
RvrdProxy.removeRouters() 84
RvrdProxy.setLoggingParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ImportSubject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ImportSubject.getSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ImportSubject.getWeight() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
LocalNetworkInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
LocalNetworkInterface.addExportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
LocalNetworkInterface.addImportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
LocalNetworkInterface.addSubject(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
LocalNetworkInterface.getCost() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
LocalNetworkInterface.getExportSubjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
LocalNetworkInterface.getImportSubjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
LocalNetworkInterface.getName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
LocalNetworkInterface.getNetwork() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
LocalNetworkInterface.getService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
LocalNetworkInterface.removeExportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
LocalNetworkInterface.removeExportSubjects() 101
LocalNetworkInterface.removeImportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
LocalNetworkInterface.removeImportSubjects() 102
LocalNetworkInterface.removeSubject(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
LocalNetworkInterface.removeSubjects() 103
LocalNetworkInterface.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

TIBCO Rendezvous Configuration Tools

vi
| Contents
LoggingParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
LoggingParams.connections() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
LoggingParams.getAsMap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
LoggingParams.subjectData() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
LoggingParams.subjectInterest() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
NeighborInterface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
NeighborInterface.getBacklog() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
NeighborInterface.getCost(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
NeighborInterface.getId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
NeighborInterface.getLocalPort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
NeighborInterface.getNeighborHost() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
NeighborInterface.getNeighborName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
NeighborInterface.getNeighborPort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
NeighborInterface.getType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
NeighborInterface.isCompressed() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
NeighborInterface.isEncrypted() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
NeighborInterface.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Router.addAcceptAnyInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Router.addActiveInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Router.addLocalNetworkInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Router.addPassiveInterface(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Router.addSeekAnyInterface(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Router.clearMaxBacklog() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Router.getLocalNetworkInterfaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Router.getMaxBacklog() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Router.getName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Router.getNeighborInterfaces() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Router.removeLocalNetworkInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Router.removeLocalNetworkInterfaces() 142
Router.removeNeighborInterface(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Router.removeNeighborInterfaces() 143
Router.setMaxBacklog(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Router.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
BorderRouter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
BorderRouter.addPolicyRule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
BorderRouter.getPolicyRule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
BorderRouter.getPolicyRules() 150
BorderRouter.removePolicyRule() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
BorderRouter.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
PolicyRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
PolicyRule.addAllowedSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
PolicyRule.addAllowedSubjects() 154
PolicyRule.getAllowedSubjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

TIBCO Rendezvous Configuration Tools

 Contents vii
|
PolicyRule.getBorderRouterName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
PolicyRule.getFromInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
PolicyRule.getToInterface() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
PolicyRule.removeAllowedSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
PolicyRule.removeAllowedSubjects() 160
PolicyRule.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Chapter 5 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163

SecurityProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
SecurityProxy.getAdministratorName(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
SecurityProxy.getCertificateSlot() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
SecurityProxy.getCertificateSlots() 167
SecurityProxy.getValidUses() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
SecurityProxy.setCertificateUses() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
SecurityProxy.setCredentials() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
SecurityProxy.useCredentials(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
CertificateSlot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
CertificateSlot.getIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
CertificateSlot.getPathname(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
CertificateSlot.getText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
CertificateSlot.getUses(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
CertificateSlot.setFromFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
CertificateSlot.setFromText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
CertificateSlot.toXml(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Chapter 6 Secure Daemons—rvsd & rvsrd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181

SecureDaemonProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
SecureDaemonProxy.addUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
SecureDaemonProxy.addUsers() 185
SecureDaemonProxy.authorizeListen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
SecureDaemonProxy.authorizeListenAndSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
SecureDaemonProxy.authorizeNetworkAndService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
SecureDaemonProxy.authorizeNetworksAndServices() 188
SecureDaemonProxy.authorizeSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
SecureDaemonProxy.getDefaultNetworkAndService(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
SecureDaemonProxy.getListen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
SecureDaemonProxy.getNetworksAndServices() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
SecureDaemonProxy.getSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
SecureDaemonProxy.getUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
SecureDaemonProxy.getUsers() 195
SecureDaemonProxy.removeListen() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
SecureDaemonProxy.removeListenAndSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
SecureDaemonProxy.removeNetworkAndService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

TIBCO Rendezvous Configuration Tools

viii
| Contents
SecureDaemonProxy.removeNetworksAndServices() 198
SecureDaemonProxy.removeSend() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
SecureDaemonProxy.removeUser() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
SecureDaemonProxy.removeUsers() 201
SecureDaemonProxy.setDefaultNetworkAndService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
NetworkServicePair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
NetworkServicePair.getNetwork() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
NetworkServicePair.getService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
NetworkServicePair.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
User.addCertificateFromFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
User.addCertificateFromText() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
User.addCertificateFromPKCS12File() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
User.clearPassword(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
User.getCertificates() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
User.getUsername() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
User.removeCertificate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
User.removeCertificates() 214
User.setPassword() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
User.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
UserCertificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
UserCertificate.getAssignmentDate() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
UserCertificate.getId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
UserCertificate.getIndex() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
UserCertificate.getIssuer(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
UserCertificate.getFileName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
UserCertificate.getPublicKeyEngine() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
UserCertificate.getSerialNumber(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
UserCertificate.getSubject(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
UserCertificate.getValidNotAfter() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
UserCertificate.getValidNotBefore(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
UserCertificate.getVersion(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
UserCertificate.toXml() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Chapter 7 Rendezvous Agent—rva. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

RvaProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
RvaProxy.addExportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
RvaProxy.addImportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
RvaProxy.addSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
RvaProxy.changeState() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
RvaProxy.getExportSubjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
RvaProxy.getHttpTunnelParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
RvaProxy.getImportSubjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

TIBCO Rendezvous Configuration Tools

 Contents ix
|
RvaProxy.getNetworkParams(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
RvaProxy.isRunning() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
RvaProxy.removeExportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
RvaProxy.removeExportSubjects() 244
RvaProxy.removeImportSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
RvaProxy.removeImportSubjects() 245
RvaProxy.removeSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
RvaProxy.removeSubjects() 246
RvaProxy.setHttpTunnelParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
RvaProxy.setNetworkParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
HttpTunnelParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
HttpTunnelParams.getActiveFlush() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
HttpTunnelParams.getAsMap(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
HttpTunnelParams.getClientTimeout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
HttpTunnelParams.getInactiveFlush() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
HttpTunnelParams.getMaxClientQueue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
HttpTunnelParams.getMaxProxyBuffer(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
HttpTunnelParams.getMaxQueueSize() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
HttpTunnelParams.getPingInterval() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
HttpTunnelParams.getPort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
HttpTunnelParams.getRequestFlush() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
HttpTunnelParams.isEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
RvaNetworkParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264
RvaNetworkParams.getAsMap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
RvaNetworkParams.getDaemon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
RvaNetworkParams.getListenPort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
RvaNetworkParams.getNetwork() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
RvaNetworkParams.getService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

Chapter 8 Current Value Cache—rvcache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .271

RvcacheProxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
RvcacheProxy.addSubjectMerge() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
RvcacheProxy.addSubjectsMerge() 274
RvcacheProxy.addSubjectReplace() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
RvcacheProxy.addSubjectsReplace() 275
RvcacheProxy.changeState() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
RvcacheProxy.disableFaultTolerance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
RvcacheProxy.getCachedSubjects() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
RvcacheProxy.getFaultToleranceParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
RvcacheProxy.getNetworkParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
RvcacheProxy.isRunning() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
RvcacheProxy.removeSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
RvcacheProxy.removeSubjects() 282
RvcacheProxy.setFaultToleranceParams() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

TIBCO Rendezvous Configuration Tools

x
| Contents
RvcacheProxy.setNetworkParams(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
CachedField . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
CachedField.getDataType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
CachedField.getFieldName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
CachedField.getValue() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
CachedSubject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
CachedSubject.getFields(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
CachedSubject.getInitialValuesServed() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
CachedSubject.getMessageSize(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
CachedSubject.getStorageMethod() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
CachedSubject.getSubject() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
CachedSubject.getUpdatesApplied(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
FaultToleranceParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
FaultToleranceParams.getActivation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
FaultToleranceParams.getAsMap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
FaultToleranceParams.getGroup() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
FaultToleranceParams.getHeartbeat() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
FaultToleranceParams.getNetwork() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
FaultToleranceParams.getService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
FaultToleranceParams.getWeight() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
FaultToleranceParams.isEnabled() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
RvcacheNetworkParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
RvcacheNetworkParams.getAsMap() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
RvcacheNetworkParams.getDaemon() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
RvcacheNetworkParams.getNetwork() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
RvcacheNetworkParams.getService() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Chapter 9 Component Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

ComponentInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
ComponentInformation.getAsMap(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
ComponentInformation.getHostname() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
ComponentInformation.getIpAddress() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
ComponentInformation.getLicenseTicket() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
ComponentInformation.getName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
ComponentInformation.getProcessID() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
ComponentInformation.getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
RvaInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
RvaInformation.getClientPort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
RvaInformation.getState() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
RvaInformation.getTotalClients() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
RvaInformation.getTunnelClients(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
RvaInformation.httpTunnelIsEnabled(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
RvcacheInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

TIBCO Rendezvous Configuration Tools

 Contents xi
|
RvcacheInformation.getFaultToleranceState() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
RvcacheInformation.getMergeMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
RvcacheInformation.getCacheMode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
RvcacheInformation.getState() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
RvdInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
RvdInformation.getClientPort() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
RvdInformation.getNetworkServicesCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
RvdInformation.getUsername() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
RvrdInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
RvrdInformation.getRoutingNamesCount() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
RvrdInformation.getStoreFilePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
RvsdInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
RvsdInformation.getStoreFilePath() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
RvsrdInformation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Chapter 10 Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .343

ConfigurationException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
FatalConfigurationException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

Chapter 11 Command Line Tool—tibrvcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .347

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
tibrvcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

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

TIBCO Rendezvous Configuration Tools

xii
| Contents

TIBCO Rendezvous Configuration Tools

 | xiii

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Table 2 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
Table 3 Overview of Configuration Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

TIBCO Rendezvous Configuration Tools

xiv
| Tables

TIBCO Rendezvous Configuration Tools

 | xv

Preface

TIBCO Rendezvous® is a messaging infrastructure product.

TIBCO is proud to announce the latest release of TIBCO Rendezvous®. This
release is the latest in a long history of TIBCO products that leverage the power of
the Information Bus® to enable truly event-driven IT environments. To find out
more about how TIBCO Rendezvous and other TIBCO products are powered by
TIB® technology, please visit us at www.tibco.com.
This manual describes tools for configuring daemons and other component
processes of TIBCO Rendezvous software. It is part of the documentation set for
Rendezvous Software Release 8.4.0.
Parts of the book TIBCO Rendezvous Administration describe the configuration of
Rendezvous components using a graphical browser administration interface. This
book describes a programmer interface and an XML tool for configuring the same
parameters.

Topics

• Manual Organization, page xvi

• Related Documentation, page xvii
• Typographical Conventions, page xix
• Connecting with TIBCO Resources, page xxii

TIBCO Rendezvous Configuration Tools

xvi
| Manual Organization

Manual Organization

This book begins with an introduction to the tools and the configuration API:
• Chapter 1, Overview, on page 1

Most of the book details the objects and methods of the API:
• Chapter 2, Daemon Manager, on page 9
• Chapter 3, Communications Daemon—rvd, on page 21
• Chapter 4, Routing Daemon—rvrd, on page 77
• Chapter 5, Security, on page 163
• Chapter 6, Secure Daemons—rvsd & rvsrd, on page 181
• Chapter 7, Rendezvous Agent—rva, on page 231
• Chapter 8, Current Value Cache—rvcache, on page 271
• Chapter 9, Component Information, on page 311
• Chapter 10, Exceptions, on page 343

One chapter describes a tool that you can use to quickly configure Rendezvous
components from a command line. This tool can also apply a configuration stored
in an XML file.
• Chapter 11, Command Line Tool—tibrvcfg, on page 347

TIBCO Rendezvous Configuration Tools

 Preface xvii
|

Related Documentation

This section lists documentation resources you may find useful.

TIBCO Rendezvous Documentation

The documentation road map shows the relationships between the books and
online references in this product’s documentation set.

z/OS Only

z/OS Installation
Installation Concepts and Configuration

COBOL
Administration C Reference
Reference

C++ Reference

Configuration
COM Reference
Tools

Java Reference
RVDM JMX
MBean API
.NET Reference
Reference Pages

Legend PDF HTML

The following documents form the Rendezvous documentation set:

• TIBCO Rendezvous Concepts
Read this book first. It contains basic information about Rendezvous
components, principles of operation, programming constructs and
techniques, advisory messages, and a glossary. All other books in the
documentation set refer to concepts explained in this book.
• TIBCO Rendezvous C Reference
Detailed descriptions of each datatype and function in the Rendezvous C API.
Readers should already be familiar with the C programming language, as well
as the material in TIBCO Rendezvous Concepts.

TIBCO Rendezvous Configuration Tools

xviii Related Documentation
|

• TIBCO Rendezvous C++ Reference

Detailed descriptions of each class and method in the Rendezvous C++ API.
The C++ API uses some datatypes and functions from the C API, so we
recommend the TIBCO Rendezvous C Reference as an additional resource.
Readers should already be familiar with the C++ programming language, as
well as the material in TIBCO Rendezvous Concepts.
• TIBCO Rendezvous Java Reference
Detailed descriptions of each class and method in the Rendezvous Java
language interface. Readers should already be familiar with the Java
programming language, as well as the material in TIBCO Rendezvous Concepts.
• TIBCO Rendezvous .NET Reference
Detailed descriptions of each class and method in the Rendezvous .NET
interface. Readers should already be familiar with either C# or Visual Basic
.NET, as well as the material in TIBCO Rendezvous Concepts.
• TIBCO Rendezvous COM Reference
Detailed descriptions of each class and method in the Rendezvous COM
component. Readers should already be familiar with the programming
environment that uses COM and OLE automation interfaces, as well as the
material in TIBCO Rendezvous Concepts.
• TIBCO Rendezvous Administration
Begins with a checklist of action items for system and network administrators.
This book describes the mechanics of Rendezvous licensing, network details,
plus a chapter for each component of the Rendezvous software suite. Readers
should have TIBCO Rendezvous Concepts at hand for reference.
• TIBCO Rendezvous Configuration Tools
Detailed descriptions of each Java class and method in the Rendezvous
configuration API, plus a command line tool that can generate and apply
XML documents representing component configurations. Readers should
already be familiar with the Java programming language, as well as the
material in TIBCO Rendezvous Administration.
• TIBCO Rendezvous Installation
Includes step-by-step instructions for installing Rendezvous software on
various operating system platforms.
• TIBCO Rendezvous Release Notes
Lists new features, changes in functionality, deprecated features, migration
and compatibility information, closed issues and known issues.

TIBCO Rendezvous Configuration Tools

 Preface xix
|

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use
TIBCO_HOME Many TIBCO products must be installed within the same home directory. This
directory is referenced in documentation as TIBCO_HOME. The value of
ENV_HOME
TIBCO_HOME depends on the operating system. For example, on Windows
TIBRV_HOME systems, the default value is C:\tibco.
Other TIBCO products are installed into an installation environment. Incompatible
products and multiple instances of the same product are installed into different
installation environments. An environment home directory is referenced in
documentation as ENV_HOME. The default value of ENV_HOME depends on the
operating system. For example, on Windows systems the default value is
C:\tibco.

TIBCO Rendezvous installs into a version-specific directory inside TIBCO_HOME.

This directory is referenced in documentation as TIBRV_HOME. The value of
TIBRV_HOME depends on the operating system. For example on Windows
systems, the default value is C:\tibco\rv\8.4.

code font Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example:
Use MyCommand to start the foo process.

bold code Bold code font is used in the following ways:

font
• In procedures, to indicate what a user types. For example: Type admin.
• In large code samples, to indicate the parts of the sample that are of
particular interest.
• In command syntax, to indicate the default parameter for a command. For
example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]

TIBCO Rendezvous Configuration Tools

xx
| Typographical Conventions

Table 1 General Typographical Conventions (Cont’d)

Convention Use
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO FTL Concepts.
• To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must replace.
For example: MyCommand PathName

Key Key name separated by a plus sign indicate keys pressed simultaneously. For
combinations example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the
other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for
example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply
the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example,
data loss or corruption if certain steps are taken or not taken.

Table 2 Syntax Typographical Conventions

Convention Use
[ ] An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter

| A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3

TIBCO Rendezvous Configuration Tools

 Preface xxi
|

Table 2 Syntax Typographical Conventions

Convention Use
{ } A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}

In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}

In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}

TIBCO Rendezvous Configuration Tools

xxii
| Connecting with TIBCO Resources

Connecting with TIBCO Resources

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts. It is a place to share and access the collective experience of the
TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety
of resources. To register, go to http://www.tibcommunity.com.

How to Access All TIBCO Documentation

You can access TIBCO documentation here:
http://docs.tibco.com

How to Contact TIBCO Support

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

TIBCO Rendezvous Configuration Tools

 |1

Chapter 1 Overview

This chapter introduces the TIBCO Rendezvous® configuration tools, and

presents important information for programmers who use this configuration API.

Topics

• Scope of the Tools, page 2

• API Architecture, page 3
• Data Accessors, page 6
• Program Structure, page 7
• Requirements, page 8

TIBCO Rendezvous Configuration Tools

2
| Chapter 1 Overview

Scope of the Tools

The Rendezvous configuration tools set consists of three parts:

• An API for coding configuration programs.
• A general configuration tool.
• An XML syntax for configuration data.

Configuration API
The Rendezvous configuration API consists of a set of Java classes. You can use
these classes and their methods to write programs that configure or examine
Rendezvous daemons (and other component processes). This book presents the
API in depth.
The methods can get parameters, set parameters, and get state information—the
same set of operations that you do using the daemon’s browser administration
interface.
Using Java programs for these operations can speed the distribution of
administrative changes to a large number of daemon processes.

Interacting with a daemon too frequently can degrade the daemon’s performance
(for example, repeatedly polling for statistical information). Use immediate-access
methods conservatively.

Command Line Tool

Using the configuration API, we have implemented a command line tool for
general use. tibrvcfg interacts with a component to execute one configuration
command, and outputs the results to stdio.
You can use tibrvcfg to dump an XML configuration document reflecting the
configuration of a Rendezvous component process. Other commands can load an
XML document, so a component conforms to the configuration it specifies.
For details, see Command Line Tool—tibrvcfg on page 347.

XML
DTD files define the syntax of XML configuration documents for Rendezvous
components. These definitions guide the command line tools to produce and
parse correct XML documents.

TIBCO Rendezvous Configuration Tools

 API Architecture 3
|

API Architecture

Table 3 describes the Java classes that compose the configuration API. These
classes belong to five categories:
• Manager
• Proxies
• Immediate-Access Objects
• Read-Only Objects
• Exceptions

Table 3 Overview of Configuration Classes (Sheet 1 of 3)

Class Description
DaemonManager Establish and manage a connection to the browser
administration interface of a daemon process.

Proxy interfaces represent daemon component processes within a configuration program.

DaemonProxy This interface defines methods common to all

Rendezvous components.
The DaemonManager automatically creates a proxy
instance, which the program uses as its main interface to
the daemon process.

RvdProxy These interfaces define methods specific to each

RvrdProxy Rendezvous component. For example, RvaProxy defines
SecurityProxy methods for interacting with rva.
SecureDaemonProxy
Each proxy interface represents one aspect of the
RvaProxy
behavior of the component. Some components
RvcacheProxy
incorporate several aspects, and they support the
corresponding proxy interfaces. For example, rvrd has
aspects of communications daemon (rvd) behavior, and
aspects of routing daemon behavior (rvrd)—so it
supports both RvdProxy and RvrdProxy.
Programs cast the proxy instance to the appropriate
proxy interfaces in order to call methods specific to the
corresponding aspects.

TIBCO Rendezvous Configuration Tools

4
| Chapter 1 Overview

Table 3 Overview of Configuration Classes (Sheet 2 of 3)

Class Description
Immediate-access data structure classes represent data structures within component
processes. Methods interact with the corresponding process.

ClientTransport These classes represent data structures within a

Service communications daemon process (including rvd, rvsd,
Host rvrd and rvsrd).

Router These classes represent data structures within a routing

LocalNetworkInterface daemon process (including rvrd and rvsrd).
NeighborInterface
ImportSubject

CertificateSlot This class represents a data structure that can contain an

X.509 certificate. These slots occur in processes that
permit secure HTTPS connections (including rvd, rvsd,
rvrd, rvsrd, rva and rvcache).

NetworkServicePair These classes represent data structures within a secure

User daemon process (including rvsd and rvsrd).
UserCertificate

CachedField These classes represent data structures within an

CachedSubject rvcache process.

Read-only data structure classes contain information retrieved from component processes.
Methods do not interact with component processes.

ComponentInformation These classes structure general information from the

RvdInformation various components.
RvrdInformation
RvsdInformation
RvsrdInformation
RvaInformation
RvcacheInformation

LoggingParams These classes structure parameter information from the

HttpTunnelParams various components.
RvaNetworkParams
FaultToleranceParams
RvcacheNetworkParams

TIBCO Rendezvous Configuration Tools

 API Architecture 5
|

Table 3 Overview of Configuration Classes (Sheet 3 of 3)

Class Description
Exception classes

ConfigurationException Methods of the configuration API throw these exception

FatalConfigurationException classes.

TIBCO Rendezvous Configuration Tools

6
| Chapter 1 Overview

Data Accessors

Immediate Access
Proxy interfaces and immediate-access data structure classes define methods that
access data within component processes. These methods access data immediately
(though indirectly):
• Methods that get data from the component always fetch new data with each
call (they do not return stored data from earlier calls).
• Methods that set values in the component immediately store the new values
(they do not hold values while waiting for another call). If the component
rejects a value, the method throws an exception.

This immediate-access paradigm ensures that configuration programs and

daemon components always remain synchronized throughout their interactions.

Program Credentials

An important exception to this rule is SecurityProxy.useCredentials(),

which is not a data access method. Instead, this method records an administrator
name and password within the program (not within the daemon). A private
method of SecurityProxy automatically supplies these credentials whenever the
daemon requests them. For details see, SecurityProxy.useCredentials() on
page 171.

Read-Only Objects
Each proxy interface defines a method that gets general information from the
component. These methods return an instance of a subclass of
ComponentInformation. All of these instances are read-only:

• Methods that get data from these objects do not interact with the component.
• Programs cannot construct these objects; they exist only because
getComponentInformation() methods return them.
• Programs cannot modify these objects.

TIBCO Rendezvous Configuration Tools

 Program Structure 7
|

Program Structure

Examples Programming examples are included on the installation media. When you install
Rendezvous software, these examples appear in the directory
src/examples/configapi.

We encourage you to examine these programs before writing your own programs.

Structure The basic structure of programs follows these steps:

1. Define subclasses of javax.net.ssl.HostnameVerifier and
javax.net.ssl.X509TrustManager to specify the security behavior of your
program.
2. Create an instance of DaemonManager.
The constructor automatically creates an instance of DaemonProxy, and stores
it in the new manager instance.
3. Get the daemon proxy instance from the daemon manager.
4. Cast the daemon proxy instance to one of the specific aspect proxy interfaces,
and call methods of that aspect to access and configure the daemon.
You may subsequently cast the daemon proxy to different aspect proxy
interfaces, and call their methods.

TIBCO Rendezvous Configuration Tools

8
| Chapter 1 Overview

Requirements

Java SDK
The Rendezvous configuration API requires that you first install Java SDK
runtime environment 1.4 (or later). You can download this software from
java.sun.com.

Environment Variables

Variable Description
CLASSPATH Rendezvous installation places the Java archive file
rvconfig.jar in the lib directory under TIBRV_HOME. If you
have placed this file in any other location, the CLASSPATH
variable must include the complete pathname.
The CLASSPATH variable must also include the complete
pathname to the SDK file jsse.jar, which implements SSL.

TIBCO Rendezvous Configuration Tools

 |9

Chapter 2 Daemon Manager

This chapter describes the top-level objects in Rendezvous configuration

programs.

Topics

• DaemonManager, page 10
• DaemonProxy, page 14
• XmlSerializable, page 17

TIBCO Rendezvous Configuration Tools

10
| Chapter 2 Daemon Manager

DaemonManager
Class

Declaration class com.tibco.tibrv.config.DaemonManager

extends java.lang.Object

Purpose Establish and manage a connection to the browser administration interface of a

daemon process.

Although it has a similar name, this class is not related to the Daemon Manager
(RVDM) feature.

Remarks Each instance connects to one process instance of a daemon.

Constant Description
DaemonManager.UNKNOWN DaemonManager.getDaemonType() returns these integer constants
to indicate the type of daemon to which it has connected.
DaemonManager.RVD

DaemonManager.RVRD

DaemonManager.RVSD

DaemonManager.RVSRD

DaemonManager.RVA

DaemonManager.RVCACHE

Method Description Page

DaemonManager() Create a daemon manager and initialize its 11
connection to a daemon process.

DaemonManager.getDaemonType() Return an integer indicating the type of daemon 12

to which the daemon manager has connected.

DaemonManager.getDaemonProxy() Return the proxy instance representing the 13

daemon process.

TIBCO Rendezvous Configuration Tools

 DaemonManager() 11
|

DaemonManager()
Constructor

Declaration DaemonManager(java.lang.String url)

throws ConfigurationException

Purpose Create a daemon manager and initialize its connection to a daemon process.

Remarks Each instance connects to one process instance of a daemon. The URL parameter
specifies the location of the browser administration interface for that process.
This constructor automatically creates a proxy instance
(java.lang.reflect.Proxy) within the DaemonManager object. The proxy serves
as the program’s command interface to the daemon component. Programs extract
the proxy instance using DaemonManager.getDaemonProxy(), and cast it to the
appropriate proxy interfaces to access the corresponding daemon or component.

Parameter Description
url Connect to a daemon at this URL.
For example:
• http://localhost:7580
• http://rvaHostName:7680

TIBCO Rendezvous Configuration Tools

12
| Chapter 2 Daemon Manager

DaemonManager.getDaemonType()
Method

Declaration int getDaemonType()

throws ConfigurationException

Purpose Return an integer indicating the type of daemon to which the daemon manager
has connected.

Remarks For a list of values that this method can return, see the constants defined at
DaemonManager on page 10.

TIBCO Rendezvous Configuration Tools

 DaemonManager.getDaemonProxy() 13
|

DaemonManager.getDaemonProxy()
Method

Declaration DaemonProxy getDaemonProxy()

throws ConfigurationException

Purpose Return the proxy instance representing the daemon process.

Remarks The constructor DaemonManager() automatically creates an appropriate proxy

instance for the daemon component. Programs use this proxy instance to
configure the daemon. A variety of proxy interfaces allow programs to access
parameter values of the daemon. Each proxy interface defines a set of methods
related to a specific aspect of daemon behavior.

Programs cast the proxy instance to an appropriate proxy interface, then call
methods of the interface.

See Also DaemonProxy on page 14

RvdProxy on page 22
RvrdProxy on page 78
SecurityProxy on page 164
SecureDaemonProxy on page 182
RvaProxy on page 232
RvcacheProxy on page 272

TIBCO Rendezvous Configuration Tools

14
| Chapter 2 Daemon Manager

DaemonProxy
Interface

Declaration interface com.tibco.tibrv.config.DaemonProxy

extends XmlSerializable

Purpose Define methods common to all Rendezvous components.

Method Description Page

DaemonProxy.getComponentName() Get the name of the daemon. 15

DaemonProxy.getComponentInformation() Get basic component information from 16

the daemon.

Inherited Methods
XmlSerializable.printXml()
XmlSerializable.toXml()

Components These components support this interface:

rvd
rvrd
rvsd
rvsrd
rva
rvcache

For information about these components, see TIBCO Rendezvous Administration

Subinterfaces RvdProxy on page 22

RvrdProxy on page 78
SecurityProxy on page 164
SecureDaemonProxy on page 182
RvaProxy on page 232
RvcacheProxy on page 272

TIBCO Rendezvous Configuration Tools

 DaemonProxy.getComponentName() 15
|

DaemonProxy.getComponentName()
Method

Declaration java.lang.String getComponentName()

throws ConfigurationException

Purpose Get the name of the daemon.

Remarks This method gets the name from the daemon component and returns it as a
printable string.

TIBCO Rendezvous Configuration Tools

16
| Chapter 2 Daemon Manager

DaemonProxy.getComponentInformation()
Method

Declaration ComponentInformation getComponentInformation()

throws ConfigurationException

Purpose Get basic component information from the daemon.

Remarks This method returns the contents of the General Information or Component
Information page from the component’s browser administration interface. The
information content varies depending on the type of the component, and its
release. For details, see TIBCO Rendezvous Administration.
This method returns an object from which you can extract the information
content. That object is an instance of one of these classes:
ComponentInformation on page 312
RvdInformation on page 333
RvrdInformation on page 337
RvsdInformation on page 340
RvsrdInformation on page 342
RvaInformation on page 320
RvcacheInformation on page 327

TIBCO Rendezvous Configuration Tools

 XmlSerializable 17
|

XmlSerializable
Interface

Declaration interface com.tibco.tibrv.config.XmlSerializable

Purpose Define methods for producing XML that describes Rendezvous components.

Method Description Page

XmlSerializable.printXml() Print the object as an XML document. 18

XmlSerializable.toXml() Format the object as an XML document. 19

TIBCO Rendezvous Configuration Tools

18
| Chapter 2 Daemon Manager

XmlSerializable.printXml()
Method

Declaration void printXml(

java.io.OutputStream outputStream)

void printXml(
java.io.Writer writer)

Purpose Print the object as an XML document.

Parameter Description
outputStream Print to this output stream.

writer Print to this character stream.

TIBCO Rendezvous Configuration Tools

 XmlSerializable.toXml() 19
|

XmlSerializable.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the object as an XML document.

TIBCO Rendezvous Configuration Tools

20
| Chapter 2 Daemon Manager

TIBCO Rendezvous Configuration Tools

 | 21

Chapter 3 Communications Daemon—rvd

This chapter describes the proxy interface for the Rendezvous communications
daemon (rvd), and the immediate-access data objects that support it.

Topics

• RvdProxy, page 22
• ClientTransport, page 27
• Host, page 35
• Service, page 43
• PortMap, page 58
• PortMapEntry, page 62
• SubjectMap, page 66
• SubjectMapEntry, page 71

See Also • RvdInformation, page 333

TIBCO Rendezvous Configuration Tools

22
| Chapter 3 Communications Daemon—rvd

RvdProxy
Interface

Declaration interface com.tibco.tibrv.config.RvdProxy

extends DaemonProxy

Purpose Define methods for Rendezvous communications daemons.

Method Description Page

RvdProxy.getClientTransports() Get the client transports of the daemon. 23

RvdProxy.getPortMap() Get the port map from a managed daemon. 24

RvdProxy.getServices() Get the network services on which the daemon 25

communicates.

RvdProxy.getSubectMaps() Get the subject maps from a managed daemon. 26

Inherited Methods
DaemonProxy.getComponentName()
DaemonProxy.getComponentInformation()

XmlSerializable.printXml()
XmlSerializable.toXml()

Components These components support this interface:

rvd
rvrd
rvsd
rvsrd

See Also For information about the parameters that this interface can access, see these
sections:
• Rendezvous Daemon (rvd) on page 41 in TIBCO Rendezvous Administration
• Browser Administration Interface—rvd on page 57 in TIBCO Rendezvous
Administration
• General Information on page 60 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 RvdProxy.getClientTransports() 23
|

RvdProxy.getClientTransports()
Method

Declaration ClientTransport[] getClientTransports()

throws ConfigurationException

Purpose Get the client transports of the daemon.

See Also ClientTransport on page 27

Clients on page 62 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

24
| Chapter 3 Communications Daemon—rvd

RvdProxy.getPortMap()
Method

Declaration PortMap getPortMap()

throws ConfigurationException

Purpose Get the port map from a managed daemon.

Remarks If the daemon is not a managed daemon, this method throws a

ConfigurationException.

See Also PortMap on page 58

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 RvdProxy.getServices() 25
|

RvdProxy.getServices()
Method

Declaration Service[] getServices()

throws ConfigurationException

Purpose Get the network services on which the daemon communicates.

See Also Service on page 43

Services on page 65 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

26
| Chapter 3 Communications Daemon—rvd

RvdProxy.getSubectMaps()
Method

Declaration SubjectMap[] getSubectMaps()

throws ConfigurationException

Purpose Get the subject maps from a managed daemon.

Remarks If the daemon is not a managed daemon, this method throws a

ConfigurationException.

See Also SubjectMap on page 66

For the corresponding browser page, see Subject Map Summary on page 72 in
TIBCO Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 ClientTransport 27
|

ClientTransport
Class

Declaration class com.tibco.tibrv.config.ClientTransport

extends java.lang.Object

Purpose Represent a client transport of a Rendezvous communications daemon.

Remarks The method RvdProxy.getClientTransports() returns an array of objects of

this class.

Method Description Page

ClientTransport.getDescription() Get the description string of the transport. 28

ClientTransport.getDetails() Get detailed information about the client 29

transport.

ClientTransport.getIdentifier() Get the globally unique identifier for the 30

transport object.

ClientTransport.getService() Get the UDP or PGM service on which the 31

transport communicates.

ClientTransport.getSubscriptions() Get the subscriptions that this transport has 32

registered with the daemon.

ClientTransport.getUsername() Get the user name of the transport’s program. 33

ClientTransport.toXml() Format the client transport information as an 34

XML document.

See Also RvdProxy.getClientTransports() on page 23

For the corresponding browser page, see Clients on page 62 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

28
| Chapter 3 Communications Daemon—rvd

ClientTransport.getDescription()
Method

Declaration java.lang.String getDescription()

Purpose Get the description string of the transport.

Remarks The client program supplies this string to identify the program and transport.

See Also ClientTransport on page 27

For the corresponding browser page, see Clients on page 62 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 ClientTransport.getDetails() 29
|

ClientTransport.getDetails()
Method

Declaration java.util.Map getDetails()

Purpose Get detailed information about the client transport.

See Also ClientTransport on page 27

For the corresponding browser page, see Client Information on page 62 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

30
| Chapter 3 Communications Daemon—rvd

ClientTransport.getIdentifier()
Method

Declaration java.lang.String getIdentifier()

Purpose Get the globally unique identifier for the transport object.

See Also ClientTransport on page 27

For the corresponding browser page, see Clients on page 62 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 ClientTransport.getService() 31
|

ClientTransport.getService()
Method

Declaration int getService()

Purpose Get the UDP or PGM service on which the transport communicates.

See Also ClientTransport on page 27

For the corresponding browser page, see Clients on page 62 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

32
| Chapter 3 Communications Daemon—rvd

ClientTransport.getSubscriptions()
Method

Declaration java.lang.String[] getSubscriptions()

Purpose Get the subscriptions that this transport has registered with the daemon.

Remarks Each string in the table is the subject name of one subscription.
The daemon limits this list to the first page of subscriptions; if the list would span
more than one page, the subscriptions on the remaining pages are not available.

See Also ClientTransport on page 27

For the corresponding browser page, see Client Information on page 62 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 ClientTransport.getUsername() 33
|

ClientTransport.getUsername()
Method

Declaration java.lang.String getUsername()

Purpose Get the user name of the transport’s program.

See Also ClientTransport on page 27

For the corresponding browser page, see Clients on page 62 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

34
| Chapter 3 Communications Daemon—rvd

ClientTransport.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the client transport information as an XML document.

See Also ClientTransport on page 27

For the corresponding browser page, see Clients on page 62 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 Host 35
|

Host
Class

Declaration class com.tibco.tibrv.config.Host

extends java.lang.Object

Purpose Represent the host computer of a Rendezvous communications daemon.

Remarks Objects of this class always represent a host computer other than the host
computer of the daemon. That is, they represent computers with which this
daemon communicates.
The method Service.getHosts() return objects of this class.

Method Description Page

Host.getHostname() Get the hostname of the computer that this 36
object represents.

Host.getHttpAddress() Get the address where the host computer 37

listens for HTTP (browser interface)
connections.

Host.getIpAddress() Get the IP address of the computer. 38

Host.getSerial() Get the serial number of the Rendezvous 39

license ticket.

Host.getUptime() Get the elapsed time that the daemon has 40

been using the UDP or PGM service.

Host.getVersion() Get the version of the Rendezvous daemon 41

running on a host.

Host.toXml() Format the host computer information as an 42

XML document.

See Also Service.getHosts() on page 49

For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

36
| Chapter 3 Communications Daemon—rvd

Host.getHostname()
Method

Declaration java.lang.String gethostname()

Purpose Get the hostname of the computer that this object represents.

See Also Host on page 35

For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Host.getHttpAddress() 37
|

Host.getHttpAddress()
Method

Declaration java.lang.String getHttpAddress()

Purpose Get the address where the host computer listens for HTTP (browser interface)
connections.

Remarks The address follows the template http://host:port

• host is the hostname of the computer.
• port is the port where the daemon accepts HTTP clients.

See Also Host on page 35

TIBCO Rendezvous Configuration Tools

38
| Chapter 3 Communications Daemon—rvd

Host.getIpAddress()
Method

Declaration java.lang.String getIpAddress()

Purpose Get the IP address of the computer.

See Also Host on page 35

For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Host.getSerial() 39
|

Host.getSerial()
Method

Declaration java.lang.String getSerial()

Purpose Get the serial number of the Rendezvous license ticket.

Remarks Most Rendezvous components require a valid license ticket for operation. This
method returns the ticket that validates the component on this host computer.

See Also Host on page 35

For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

40
| Chapter 3 Communications Daemon—rvd

Host.getUptime()
Method

Declaration java.lang.String getUptime()

Purpose Get the elapsed time that the daemon has been using the UDP or PGM service.

Remarks The uptime of a remote host on a service represents the cumulative time that the
host (that is, the daemon on that host) has been using that service on behalf of one
or more client transports.
When a daemon first begins using a service on behalf of a client transport, it starts
counting the uptime for that service from zero. The daemon counts uptime
separately for each service it uses.
As long as the daemon still has one or more client transports on the particular
service, its uptime continues to increase. When no more client transports remain
on that service, the daemon stops using the service (after a short delay). If a new
transport subsequently begins using the service again, the daemon begins
counting uptime for that service at zero.

See Also Host on page 35

Service.getHosts() on page 49
For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Host.getVersion() 41
|

Host.getVersion()
Method

Declaration java.lang.String getVersion()

Purpose Get the version of the Rendezvous daemon running on a host.

See Also Host on page 35

For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

42
| Chapter 3 Communications Daemon—rvd

Host.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the host computer information as an XML document.

See Also Host on page 35

For the corresponding browser page, see Host List on page 70 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Service 43
|

Service
Class

Declaration class com.tibco.tibrv.config.Service

extends java.lang.Object

Purpose Represent a UDP or PGM service of a Rendezvous communications daemon.

Remarks This object represents a communications daemon’s activity on a specific network

service—that is, a physical network combined with a UDP or PGM service.
The method RvdProxy.getServices() returns objects of this class.

(Sheet 1 of 2)

Method Description Page

Service.getClientCount() Get the number of client transports that use 45
this service.

Service.getClientTransports() Get the client transports that use this service. 46

Service.getDetails() Get detailed information about the network 47

service.

Service.getHostCount() Get the number of other host computers with 48

daemons that communicate on this network
and service.

Service.getHosts() Get the other host computers with daemons 49

that communicate on this network and
service.

Service.getInboundRates() Get recent statistics about inbound data on 50

this service.

Service.getInboundTotals() Get cumulative statistics about inbound data. 51

Service.getNetwork() Get the network number. 52

Service.getOutboundRates() Get recent statistics about outbound data on 53

this service.

Service.getOutboundTotals() Get cumulative statistics about outbound 54

data.

Service.getPortNumber() Get the UDP or PGM service number. 55

TIBCO Rendezvous Configuration Tools

44
| Chapter 3 Communications Daemon—rvd

(Sheet 2 of 2)

Method Description Page

Service.getSubscriptions() Get the client subscriptions registered with 56
this daemon on the network service.

Service.toXml() Format the service information as an XML 57

document.

See Also RvdProxy.getServices() on page 25

For the corresponding browser page, see Services on page 65 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 Service.getClientCount() 45
|

Service.getClientCount()
Method

Declaration int getClientCount()

Purpose Get the number of client transports that use this service.

See Also ClientTransport on page 27

Service on page 43
Service.getClientTransports() on page 46
For the corresponding browser page, see Services on page 65 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

46
| Chapter 3 Communications Daemon—rvd

Service.getClientTransports()
Method

Declaration ClientTransport[] getClientTransports()

Purpose Get the client transports that use this service.

Remarks This method is similar to RvdProxy.getClientTransports(), except that it gets

only the transports that use this service.
Service.getClientCount() on page 45 returns the size of this client array.

See Also RvdProxy.getClientTransports() on page 23

ClientTransport on page 27
Service on page 43
Service.getClientCount() on page 45
For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Service.getDetails() 47
|

Service.getDetails()
Method

Declaration java.util.Map getDetails()

Purpose Get detailed information about the network service.

See Also Service on page 43

For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

48
| Chapter 3 Communications Daemon—rvd

Service.getHostCount()
Method

Declaration int getHostCount()

Purpose Get the number of other host computers with daemons that communicate on this
network and service.

See Also Host on page 35

Service on page 43
Service.getHosts() on page 49
For the Services browser page, see Services on page 65 in TIBCO Rendezvous
Administration
For the Hosts browser page, see Host List on page 70 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 Service.getHosts() 49
|

Service.getHosts()
Method

Declaration Host[] getHosts()

Purpose Get the other host computers with daemons that communicate on this network
and service.

Remarks Service.getHostCount() on page 48 returns the size of this host array.

See Also Host on page 35

Service on page 43
Service.getHostCount() on page 48
For the Services browser page, see Service Information on page 66 in TIBCO
Rendezvous Administration
For the Hosts browser page, see Host List on page 70 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

50
| Chapter 3 Communications Daemon—rvd

Service.getInboundRates()
Method

Declaration java.util.Map getInboundRates()

Purpose Get recent statistics about inbound data on this service.

Remarks This method returns a set of statistics about inbound data on this network service
during the most recent sampling period:
• msgs—the rate (per second) at which the daemon received inbound messages
• bytes—the rate (per second) at which the daemon received inbound bytes
• pkts—the rate (per second) at which the daemon received inbound packets

See Also Service on page 43

Service.getOutboundRates() on page 53
For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Service.getInboundTotals() 51
|

Service.getInboundTotals()
Method

Declaration java.util.Map getInboundTotals()

Purpose Get cumulative statistics about inbound data.

Remarks The return value contains a set of running totals for inbound data on this network
service, accumulated since the start of the daemon process:
• msgs—number of messages
• bytes—number of bytes
• pkts—number of packets
• missed—number of missed packets (detected as a packet sequence gap)
• lostMc—number of multicast packets lost because the sending daemon could
not retransmit them
• lostPtp—number of point-to-point packets lost because the sending daemon
could not retransmit them

See Also Service on page 43

Service.getOutboundTotals() on page 54
For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

52
| Chapter 3 Communications Daemon—rvd

Service.getNetwork()
Method

Declaration java.util.String getNetwork()

Purpose Get the network number.

See Also Service on page 43

For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Service.getOutboundRates() 53
|

Service.getOutboundRates()
Method

Declaration java.util.Map getOutboundRates()

Purpose Get recent statistics about outbound data on this service.

Remarks This method returns a set of statistics about outbound data on this network
service during the most recent sampling period:
• msgs—the rate (per second) at which the daemon sent outbound messages
• bytes—the rate (per second) at which the daemon sent outbound bytes
• pkts—the rate (per second) at which the daemon sent outbound packets

See Also Service on page 43

Service.getInboundRates() on page 50
For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

54
| Chapter 3 Communications Daemon—rvd

Service.getOutboundTotals()
Method

Declaration java.util.Map getOutboundTotals()

Purpose Get cumulative statistics about outbound data.

Remarks The return value contains a set of running totals for outbound data on this
network service, accumulated since the start of the daemon process:
• msgs—number of messages
• bytes—number of bytes
• pkts—number of packets
• retrans—number of packets retransmitted (multicast and point-to-point)
• lostMc—number of multicast packets the daemon could not retransmit (too
old)
• lostPtp—number of point-to-point packets the daemon could not retransmit
(too old)

See Also Service on page 43

Service.getInboundTotals() on page 51
For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Service.getPortNumber() 55
|

Service.getPortNumber()
Method

Declaration int getPortNumber()

Purpose Get the UDP or PGM service number.

See Also Service on page 43

For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

56
| Chapter 3 Communications Daemon—rvd

Service.getSubscriptions()
Method

Declaration java.lang.String[] getSubscriptions()

Purpose Get the client subscriptions registered with this daemon on the network service.

Remarks Each string in the table is the subject name of one subscription.
The daemon limits this list to 50 subscriptions; if the list would have more than 50
subscriptions, the daemon replaces them with only one item, which describes the
approximate number of subscriptions.

See Also Service on page 43

For the corresponding browser page, see Service Information on page 66 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Service.toXml() 57
|

Service.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the service information as an XML document.

See Also Service on page 43

For the corresponding browser page, see Services on page 65 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

58
| Chapter 3 Communications Daemon—rvd

PortMap
Class

Declaration class com.tibco.tibrv.config.PortMap

extends java.lang.Object

Purpose Represent an RVDM port map page.

Remarks This object represents the RVDM port map page of a managed daemon.
The method RvdProxy.getPortMap() returns objects of this class.

Method Description Page

PortMap.isEnabled() Determine whether the port map feature is 59
enabled.

PortMap.getLastUpdate() Get the timestamp indicating when RVDM 60

last updated the port map on the managed
daemon.

PortMap.getPortMapEntries() Get the rows of the port map page. 61

See Also RvdProxy.getPortMap() on page 24

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 PortMap.isEnabled() 59
|

PortMap.isEnabled()
Method

Declaration boolean isEnabled()

Purpose Determine whether the port map feature is enabled.

See Also PortMap on page 58

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

60
| Chapter 3 Communications Daemon—rvd

PortMap.getLastUpdate()
Method

Declaration java.util.Date getLastUpdate()

Purpose Get the timestamp indicating when RVDM last updated the port map on the
managed daemon.

See Also PortMap on page 58

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 PortMap.getPortMapEntries() 61
|

PortMap.getPortMapEntries()
Method

Declaration PortMapEntry[] getPortMapEntries()

Purpose Get the rows of the port map page.

See Also PortMap on page 58

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

62
| Chapter 3 Communications Daemon—rvd

PortMapEntry
Class

Declaration class com.tibco.tibrv.config.PortMapEntry

extends java.lang.Object

Purpose Represent a row within a port map table.

Remarks This object represents one table row of the RVDM port map page of a managed
daemon.
The method PortMap.getPortMapEntries() returns an array of objects of this
class.

Method Description Page

PortMapEntry.getClientCount() Get the number of clients affected by a port 63
mapping.

PortMapEntry.getEffectivePort() Get the effective port (of a service pair) from a 64

port map row.

PortMapEntry.getOriginalPort() Get the original port (of a service pair) from a 65

port map row.

See Also PortMap.getPortMapEntries() on page 61

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 PortMapEntry.getClientCount() 63
|

PortMapEntry.getClientCount()
Method

Declaration short getClientCount()

Purpose Get the number of clients affected by a port mapping.

See Also PortMapEntry on page 62

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

64
| Chapter 3 Communications Daemon—rvd

PortMapEntry.getEffectivePort()
Method

Declaration short getEffectivePort()

Purpose Get the effective port (of a service pair) from a port map row.

See Also PortMapEntry on page 62

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 PortMapEntry.getOriginalPort() 65
|

PortMapEntry.getOriginalPort()
Method

Declaration short getOriginalPort()

Purpose Get the original port (of a service pair) from a port map row.

See Also PortMapEntry on page 62

For the corresponding browser page, see Port Map on page 75 in TIBCO
Rendezvous Administration
For concept information, see Port Map on page 225 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

66
| Chapter 3 Communications Daemon—rvd

SubjectMap
Class

Declaration class com.tibco.tibrv.config.SubjectMap

extends java.lang.Object

Purpose Represent a row of the subject map summary page of a managed daemon.

Remarks This object represents one subject map (that is, one row of the summary table)
corresponding to a specific service.
The method RvdProxy.getSubectMaps() returns an array of objects of this class.

Method Description Page

SubjectMap.getClientCount() Get the number of clients affected by a subject 67
map.

SubjectMap.getLastUpdate() Get the timestamp indicating when RVDM 68

last updated the subject map on the managed
daemon.

SubjectMap.getSubjectMapEntries() Get the details for each subject map. 69

SubjectMap.getSubscriptionCount() Get the number of subscriptions using the 70

service of a subject map.

See Also RvdProxy.getSubectMaps() on page 26

For the corresponding browser page, see Subject Map Summary on page 72 in
TIBCO Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 SubjectMap.getClientCount() 67
|

SubjectMap.getClientCount()
Method

Declaration int getClientCount()

Purpose Get the number of clients affected by a subject map.

See Also SubjectMap on page 66

For the corresponding browser page, see Subject Map Summary on page 72 in
TIBCO Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

68
| Chapter 3 Communications Daemon—rvd

SubjectMap.getLastUpdate()
Method

Declaration java.util.Date getLastUpdate()

Purpose Get the timestamp indicating when RVDM last updated the subject map on the
managed daemon.

See Also SubjectMap on page 66

For the corresponding browser page, see Subject Map Summary on page 72 in
TIBCO Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 SubjectMap.getSubjectMapEntries() 69
|

SubjectMap.getSubjectMapEntries()
Method

Declaration SubjectMapEntry[] getSubjectMapEntries()

Purpose Get the details for each subject map.

See Also SubjectMapEntry on page 71

For the corresponding browser page, see Subject Map Detail on page 72 in TIBCO
Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

70
| Chapter 3 Communications Daemon—rvd

SubjectMap.getSubscriptionCount()
Method

Declaration int getSubscriptionCount()

Purpose Get the number of subscriptions using the service of a subject map.

See Also SubjectMap on page 66

For the corresponding browser page, see Subject Map Summary on page 72 in
TIBCO Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 SubjectMapEntry 71
|

SubjectMapEntry
Class

Declaration class com.tibco.tibrv.config.SubjectMapEntry

extends java.lang.Object

Purpose Represent a row on a subject map detail page.

Remarks The method SubjectMap.getSubjectMapEntries() returns objects of this class.

Method Description Page

SubjectMapEntry.getGroup() Get the multicast group of a mapping row. 72

SubjectMapEntry.getRank() Get the rank of a mapping row. 73

SubjectMapEntry.getSubject() Get the subject of a mapping row. 74

SubjectMapEntry.getSubscriberCount() Get the number of client transports that 75

have at least one matching listener.

See Also SubjectMap.getSubjectMapEntries() on page 69

For the corresponding browser page, see Subject Map Detail on page 72 in TIBCO
Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

72
| Chapter 3 Communications Daemon—rvd

SubjectMapEntry.getGroup()
Method

Declaration java.lang.String getGroup()

Purpose Get the multicast group of a mapping row.

See Also SubjectMapEntry on page 71

For the corresponding browser page, see Subject Map Detail on page 72 in TIBCO
Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 SubjectMapEntry.getRank() 73
|

SubjectMapEntry.getRank()
Method

Declaration int getRank()

Purpose Get the rank of a mapping row.

Remarks For default system groups and default user groups, this method returns -1 as the
rank.

See Also SubjectMapEntry on page 71

For the corresponding browser page, see Subject Map Detail on page 72 in TIBCO
Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

74
| Chapter 3 Communications Daemon—rvd

SubjectMapEntry.getSubject()
Method

Declaration java.lang.String getSubject()

Purpose Get the subject of a mapping row.

Remarks For the default system groups row, this method returns the string
Default System Groups instead of a Rendezvous subject.

For the default user groups row, this method returns the string
Default User Groups instead of a Rendezvous subject.

See Also SubjectMapEntry on page 71

For the corresponding browser page, see Subject Map Detail on page 72 in TIBCO
Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 SubjectMapEntry.getSubscriberCount() 75
|

SubjectMapEntry.getSubscriberCount()
Method

Declaration int getSubscriberCount()

Purpose Get the number of client transports that have at least one matching listener.

Remarks A matching listener is a listener with a subscription subject that matches the
subject of this subject mapping row.

See Also SubjectMapEntry on page 71

For the corresponding browser page, see Subject Map Detail on page 72 in TIBCO
Rendezvous Administration
For concept information, see Subject Map on page 216 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

76
| Chapter 3 Communications Daemon—rvd

TIBCO Rendezvous Configuration Tools

 | 77

Chapter 4 Routing Daemon—rvrd

This chapter describes the proxy interface for the Rendezvous routing daemon
(rvrd), and the immediate-access data objects that support it.

Topics

• RvrdProxy, page 78
• ImportSubject, page 86
• LocalNetworkInterface, page 89
• LoggingParams, page 105
• NeighborInterface, page 110
• Router, page 123

See Also • RvrdInformation, page 337

TIBCO Rendezvous Configuration Tools

78
| Chapter 4 Routing Daemon—rvrd

RvrdProxy
Interface

Declaration interface com.tibco.tibrv.config.RvrdProxy

extends DaemonProxy

Purpose Define methods for Rendezvous routing daemons.

Method Description Page

RvrdProxy.addBorderRouter() Add a border router to the routing daemon. 80

RvrdProxy.addRouter() Add router names to the routing daemon. 81

RvrdProxy.addRouters()

RvrdProxy.getLoggingParams() Get the flags that guide the routing 82

daemon’s log output.

RvrdProxy.getRouter() Get routers from the routing daemon. 83

RvrdProxy.getRouters()

RvrdProxy.removeRouter() Remove router names from the routing 84

daemon.
RvrdProxy.removeRouters()

RvrdProxy.setLoggingParams() Set the flags that guide the routing 85

daemon’s log output.

Inherited Methods
DaemonProxy.getComponentName()
DaemonProxy.getComponentInformation()

XmlSerializable.printXml()
XmlSerializable.toXml()

Components These components support this interface:

rvrd
rvsrd

See Also For information about the parameters that this interface can access, see these
sections:
• Routing Daemon (rvrd) on page 77 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 RvrdProxy 79
|

• Browser Administration Interface—rvrd on page 134 in TIBCO Rendezvous

Administration
• General Information on page 138 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

80
| Chapter 4 Routing Daemon—rvrd

RvrdProxy.addBorderRouter()
Method

Declaration BorderRouter addBorderRouter(

java.lang.String routerName)
throws ConfigurationException

Purpose Add a border router to the routing daemon.

Remarks Border routing restricts permissible configurations. When an rvrd process is

configured as a border router, that border router must be the only routing table
entry for the process.
As a result, you can configure an rvrd process either as a collection of one or more
first-tier routers, or as exactly one border router. You cannot configure more than
one border router in a process, nor mix first-tier and border routers in the same
process.
Once a border router is configured, you cannot remove it, rename it, nor convert it
to a first-tier router. Nor can you convert a first-tier router to a border router.

Parameter Description
routerName Add this router name.

See Also RvrdProxy.getRouter() on page 83

BorderRouter on page 146
For the corresponding browser pages, see Border Routing on page 151 in TIBCO
Rendezvous Administration, and the sections that follow it
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 RvrdProxy.addRouter() 81
|

RvrdProxy.addRouter()
Method

Related Forms RvrdProxy.addRouters()

Declaration Router addRouter(

java.lang.String routerName)
throws ConfigurationException

Router[] addRouters(
java.lang.String[] routerNames)
throws ConfigurationException

Purpose Add router names to the routing daemon.

Remarks When adding more than one router name, the second method is faster than
repeatedly calling the first method.

Parameter Description
routerName Add this router name.

routerNames Add all the router names in this array.

See Also RvrdProxy.getRouter() on page 83

RvrdProxy.removeRouter() on page 84
Router on page 123
For background information, see Routing Table Entry on page 85 in TIBCO
Rendezvous Administration
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

82
| Chapter 4 Routing Daemon—rvrd

RvrdProxy.getLoggingParams()
Method

Declaration LoggingParams getLoggingParams()

throws ConfigurationException

Purpose Get the flags that guide the routing daemon’s log output.

Remarks This method returns an object encapsulating the logging parameters. To examine
the individual values, use the methods of the class LoggingParams on page 105.

See Also RvrdProxy on page 78

RvrdProxy.setLoggingParams() on page 85
LoggingParams on page 105
For background information, see Interpreting Log Output on page 124 in TIBCO
Rendezvous Administration
For the corresponding browser page, see Daemon Parameters on page 147 in
TIBCO Rendezvous Administration, and Logging on page 149 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 RvrdProxy.getRouter() 83
|

RvrdProxy.getRouter()
Method

Related Forms RvrdProxy.getRouters()

Declaration Router getRouter(

java.lang.String routerName)
throws ConfigurationException

Router[] getRouters()
throws ConfigurationException

Purpose Get routers from the routing daemon.

Remarks getRouters() returns an array containing all the routers configured for the
routing daemon.
getRouter() queries the routing daemon for a router with a specific router name,
and returns that router (if it exists). If it does not exist, the method throws an
exception.

Parameter Description
routerName Return the router with this router name, if it exists.

See Also RvrdProxy.addRouter() on page 81

Router on page 123
For background information, see Routing Table Entry on page 85 in TIBCO
Rendezvous Administration
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

84
| Chapter 4 Routing Daemon—rvrd

RvrdProxy.removeRouter()
Method

Related Forms RvrdProxy.removeRouters()

Declaration RvrdProxy removeRouter(

java.lang.String routerName)
throws ConfigurationException

RvrdProxy removeRouters(
java.lang.String[] routerNames)
throws ConfigurationException

Purpose Remove router names from the routing daemon.

Remarks When removing more than one router name, the second method is faster than
repeatedly calling the first method.
These methods return the RvrdProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
routerName Remove this router name.

routerNames Remove all the router names in this array.

See Also RvrdProxy.addRouter() on page 81

RvrdProxy.getRouter() on page 83
Router on page 123
For background information, see Routing Table Entry on page 85 in TIBCO
Rendezvous Administration
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 RvrdProxy.setLoggingParams() 85
|

RvrdProxy.setLoggingParams()
Method

Declaration RvrdProxy setLoggingParams(

boolean connections,
boolean subjectInterest,
boolean subjectData)
throws ConfigurationException

Purpose Set the flags that guide the routing daemon’s log output.

Remarks This method sets three boolean flags in the routing daemon. The program must
supply all three values.
This method returns the RvrdProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
connections When true, log connection activity whenever this routing daemon
establishes or closes a connection to a neighbor.

subjectInterest When true, log all subscription requests (notification of listening) that this
routing daemon sends to its neighbors or receives from its neighbors.

subjectData When true, log all messages that this routing daemon forwards to its
neighbors or receives from its neighbors.

See Also RvrdProxy on page 78

RvrdProxy.getLoggingParams() on page 82
For background information, see Interpreting Log Output on page 124 in TIBCO
Rendezvous Administration
For the corresponding browser page, see Daemon Parameters on page 147 in
TIBCO Rendezvous Administration, and Logging on page 149 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

86
| Chapter 4 Routing Daemon—rvrd

ImportSubject
Class

Declaration class com.tibco.tibrv.config.ImportSubject

extends java.lang.Object

Purpose Represent an import subject.

Remarks Import subjects pair a subject name with an optional import weight value.
The method LocalNetworkInterface.getImportSubjects() returns an array
of objects of this class.

Constant Description
DEFAULT_WEIGHT This constant specifies the default import weight of an import subject (10).

Method Description Page

ImportSubject.getSubject() Get the import subject name. 87

ImportSubject.getWeight() Get the import weight. 88

See Also LocalNetworkInterface.getImportSubjects() on page 97

For the corresponding browser pages, see Subject Gating on page 155 in TIBCO
Rendezvous Administration, and the sections that follow it
For background information, see these sections:
• Subject Gating on page 87 in TIBCO Rendezvous Administration
• Load Balancing on page 97 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 ImportSubject.getSubject() 87
|

ImportSubject.getSubject()
Method

Declaration java.lang.String getSubject()

Purpose Get the import subject name.

See Also ImportSubject on page 86

For the corresponding browser pages, see Subject Gating on page 155 in TIBCO
Rendezvous Administration, and the sections that follow it
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

88
| Chapter 4 Routing Daemon—rvrd

ImportSubject.getWeight()
Method

Declaration int getWeight()

Purpose Get the import weight.

See Also ImportSubject on page 86

For the corresponding browser pages, see Subject Gating on page 155 in TIBCO
Rendezvous Administration, and the sections that follow it
For background information, see these sections:
• Subject Gating on page 87 in TIBCO Rendezvous Administration
• Load Balancing on page 97 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface 89
|

LocalNetworkInterface
Class

Declaration class com.tibco.tibrv.config.LocalNetworkInterface

extends java.lang.Object

Purpose Represent a local network interface of a router.

Remarks The method Router.getLocalNetworkInterfaces() returns an array of objects

of this class.

Constant Description
LocalNetworkInterface.DEFAULT_COST Default path cost (1) between a local network and a
router. To use the default cost, supply this constant to
Router.addLocalNetworkInterface() on page 130.

LocalNetworkInterface.UNSPECIFIED To use default values for the service parameter of a

local network interface, supply this constant to
Router.addLocalNetworkInterface() on page 130.

(Sheet 1 of 2)

Method Description Page

LocalNetworkInterface.addExportSubject() Permit the router to 92
export a subject from
this local network.

LocalNetworkInterface.addImportSubject() Permit the router to 93

import a subject into
this local network.

LocalNetworkInterface.addSubject() Permit the router to 94

import and export a
subject.

LocalNetworkInterface.getCost() Get the path cost for 95

routing between the
local network and its
router.

TIBCO Rendezvous Configuration Tools

90
| Chapter 4 Routing Daemon—rvrd

(Sheet 2 of 2)

Method Description Page

LocalNetworkInterface.getExportSubjects() Get the subjects that 96
the router may export
from this local
network.

LocalNetworkInterface.getImportSubjects() Get the subjects that 97

the router may
import into this local
network.

LocalNetworkInterface.getName() Get the unique name 98

of the local network.

LocalNetworkInterface.getNetwork() Get the network 99

specification of the
local network.

LocalNetworkInterface.getService() Get the UDP or PGM 100

service of the local
network.

LocalNetworkInterface.removeExportSubject() Stop exporting a 101

subject from this local
LocalNetworkInterface.removeExportSubjects()
network.

LocalNetworkInterface.removeImportSubject() Stop importing a 102

subject from this local
LocalNetworkInterface.removeImportSubjects()
network.

LocalNetworkInterface.removeSubject() Stop importing and 103

exporting a subject.
LocalNetworkInterface.removeSubjects()

LocalNetworkInterface.toXml() Format the local 104

network information
as an XML
document.

See Also Router.addLocalNetworkInterface() on page 130

Router.getLocalNetworkInterfaces() on page 138

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface 91
|

For the corresponding browser pages, see Local Network Interfaces

Configuration on page 153 in TIBCO Rendezvous Administration, and the sections
that follow it
For background information, see Local Network on page 86 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

92
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.addExportSubject()
Method

Declaration void AddExportSubject(

java.lang.String subject)
throws ConfigurationException

Purpose Permit the router to export a subject from this local network.

Parameter Description
subject Add this subject for export.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.getExportSubjects() on page 96
LocalNetworkInterface.removeExportSubject() on page 101
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface.addImportSubject() 93
|

LocalNetworkInterface.addImportSubject()
Method

Declaration void addImportSubject(

java.lang.String subject)
throws ConfigurationException

void addImportSubject(
java.lang.String subject,
int weight)
throws ConfigurationException

Purpose Permit the router to import a subject into this local network.

Parameter Description
subject Add this subject for import.

weight When present, add the subject with this weight.

When absent, add the subject with the default import weight (10).
For background information, see Load Balancing on page 97 in TIBCO
Rendezvous Administration.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.getImportSubjects() on page 97
LocalNetworkInterface.removeImportSubject() on page 102
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

94
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.addSubject()
Method

Declaration void addSubject(

java.lang.String subject)
throws ConfigurationException

void addSubject(
java.lang.String subject,
int weight)
throws ConfigurationException

Purpose Permit the router to import and export a subject.

Parameter Description
subject Add this subject for import and export.

weight When present, add the subject with this weight for import.
When absent, add the subject with the default import weight (10).
For background information, see Load Balancing on page 97 in TIBCO
Rendezvous Administration.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.getExportSubjects() on page 96
LocalNetworkInterface.getImportSubjects() on page 97
LocalNetworkInterface.removeSubject() on page 103
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface.getCost() 95
|

LocalNetworkInterface.getCost()
Method

Declaration int getCost()

Purpose Get the path cost for routing between the local network and its router.

See Also LocalNetworkInterface on page 89

Router.addLocalNetworkInterface() on page 130
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see Load Balancing on page 97 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

96
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.getExportSubjects()
Method

Declaration java.lang.String[] getExportSubjects()

throws ConfigurationException

Purpose Get the subjects that the router may export from this local network.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.addExportSubject() on page 92
LocalNetworkInterface.removeExportSubject() on page 101
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface.getImportSubjects() 97
|

LocalNetworkInterface.getImportSubjects()
Method

Declaration ImportSubject[] getImportSubjects()

throws ConfigurationException

Purpose Get the subjects that the router may import into this local network.

See Also ImportSubject on page 86

LocalNetworkInterface on page 89
LocalNetworkInterface.addImportSubject() on page 93
LocalNetworkInterface.removeImportSubject() on page 102
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

98
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.getName()
Method

Declaration java.lang.String getName()

Purpose Get the unique name of the local network.

See Also LocalNetworkInterface on page 89

Router.addLocalNetworkInterface() on page 130
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see Local Network Name on page 86 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface.getNetwork() 99
|

LocalNetworkInterface.getNetwork()
Method

Declaration java.lang.String getNetwork()

Purpose Get the network specification of the local network.

See Also LocalNetworkInterface on page 89

Router.addLocalNetworkInterface() on page 130
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see Network and Service on page 86 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

100
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.getService()
Method

Declaration int getService()

Purpose Get the UDP or PGM service of the local network.

See Also LocalNetworkInterface on page 89

Router.addLocalNetworkInterface() on page 130
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see Network and Service on page 86 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface.removeExportSubject() 101
|

LocalNetworkInterface.removeExportSubject()
Method

Related Forms LocalNetworkInterface.removeExportSubjects()

Declaration void removeExportSubject(

java.lang.String subject)
throws ConfigurationException

void removeExportSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Stop exporting a subject from this local network.

Parameter Description
subject Remove this export subject.

subjects Remove these export subjects.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.addExportSubject() on page 92
LocalNetworkInterface.getExportSubjects() on page 96
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

102
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.removeImportSubject()
Method

Related Forms LocalNetworkInterface.removeImportSubjects()

Declaration void removeImportSubject(

java.lang.String subject)
throws ConfigurationException

void removeImportSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Stop importing a subject from this local network.

Remarks This method removes the subject from the import list. If the subject is not on the
list, the method returns without exception.

Parameter Description
subject Remove this import subject.

subjects Remove these import subjects.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.addImportSubject() on page 93
LocalNetworkInterface.getImportSubjects() on page 97
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 LocalNetworkInterface.removeSubject() 103
|

LocalNetworkInterface.removeSubject()
Method

Related Forms LocalNetworkInterface.removeSubjects()

Declaration void removeSubject(

java.lang.String subject)
throws ConfigurationException

void removeSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Stop importing and exporting a subject.

Parameter Description
subject Remove this subject.

subjects Remove these subjects.

See Also LocalNetworkInterface on page 89

LocalNetworkInterface.addSubject() on page 94
LocalNetworkInterface.getExportSubjects() on page 96
LocalNetworkInterface.getImportSubjects() on page 97
For the corresponding browser page, see Subject Gating on page 155 in TIBCO
Rendezvous Administration
For background information, see Subject Gating on page 87 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

104
| Chapter 4 Routing Daemon—rvrd

LocalNetworkInterface.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the local network information as an XML document.

See Also LocalNetworkInterface on page 89

For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 LoggingParams 105
|

LoggingParams
Class

Declaration class com.tibco.tibrv.config.LoggingParams

extends java.lang.Object

Purpose Encapsulate logging parameters from Rendezvous routing daemons.

Method Description Page

LoggingParams.connections() Extract a flag that reflects logging 106
for neighbor connections.

LoggingParams.getAsMap() Format the logging parameters as 107

a map.

LoggingParams.subjectData() Extract a flag that reflects logging 108

for subject data (forwarded
messages).

LoggingParams.subjectInterest() Extract a flag that reflects logging 109

for subject interest (subscription
requests).

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
RvrdProxy.getLoggingParams() returns instances of this class.

See Also Read-Only Objects on page 6

RvrdProxy.getLoggingParams() on page 82

TIBCO Rendezvous Configuration Tools

106
| Chapter 4 Routing Daemon—rvrd

LoggingParams.connections()
Method

Declaration boolean connections()

Purpose Extract a flag that reflects logging for neighbor connections.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 LoggingParams.getAsMap() 107
|

LoggingParams.getAsMap()
Method

Declaration java.util.Map getAsMap()

Purpose Format the logging parameters as a map.

Remarks The resulting map is useful for iterative methods, such as printing.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

108
| Chapter 4 Routing Daemon—rvrd

LoggingParams.subjectData()
Method

Declaration boolean subjectData()

Purpose Extract a flag that reflects logging for subject data (forwarded messages).

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 LoggingParams.subjectInterest() 109
|

LoggingParams.subjectInterest()
Method

Declaration boolean subjectInterest()

Purpose Extract a flag that reflects logging for subject interest (subscription requests).

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

110
| Chapter 4 Routing Daemon—rvrd

NeighborInterface
Class

Declaration class com.tibco.tibrv.config.NeighborInterface

extends java.lang.Object

Purpose Represent a neighbor interface of a router.

Remarks The method Router.getNeighborInterfaces() returns an array of objects of

this class.

Constant Description
NeighborInterface.ACCEPT_ANY NeighborInterface.getType() returns these integer
NeighborInterface.ACTIVE constants, which denote the four types of neighbor
NeighborInterface.PASSIVE interfaces.
NeighborInterface.SEEK_ANY

NeighborInterface.DEFAULT_COST Default path cost between two routers. To use the default
cost, supply this constant to
Router.addLocalNetworkInterface() on page 130.

NeighborInterface.DEFAULT_PORT Default TCP port (7501). To use the default port, supply
this constant to any of the four methods of Router that
add neighbor interfaces.

(Sheet 1 of 2)

Method Description Page

NeighborInterface.getBacklog() Get the size of the current backlog on the 112
neighbor link.

NeighborInterface.getCost() Get the path cost of the neighbor link. 113

NeighborInterface.getId() Get the interface ID of the neighbor 114

interface.

NeighborInterface.getLocalPort() Get the TCP connect port of the local 115

endpoint.

NeighborInterface.getNeighborHost() Get the host of the remote endpoint. 116

NeighborInterface.getNeighborName() Get the router name of the remote endpoint. 117

TIBCO Rendezvous Configuration Tools

 NeighborInterface 111
|

(Sheet 2 of 2)

Method Description Page

NeighborInterface.getNeighborPort() Get the TCP connect port of the remote 118
endpoint.

NeighborInterface.getType() Get the type of the neighbor interface. 119

NeighborInterface.isEncrypted() Get the SSL requirement flag of the 121

neighbor interface.

NeighborInterface.toXml() Format the neighbor interface information 122

as an XML document.

See Also Router.addAcceptAnyInterface() on page 125

Router.addActiveInterface() on page 127
Router.addPassiveInterface() on page 132
Router.addSeekAnyInterface() on page 135
Router.getNeighborInterfaces() on page 141
For the corresponding browser pages, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration, and the sections that follow it
For background information, see these sections:
• Neighbors on page 91 in TIBCO Rendezvous Administration
• Adding Neighbor Interfaces on page 93 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

112
| Chapter 4 Routing Daemon—rvrd

NeighborInterface.getBacklog()
Method

Declaration long getBacklog()

Purpose Get the size of the current backlog on the neighbor link.

Remarks Backlog is the set of messages waiting for transfer from one router to a
neighboring router. This call returns a snapshot size (in bytes) of the backlog—
that is, the sum of the sizes of all waiting messages.

See Also NeighborInterface on page 110

For the corresponding browser page, see Router Connection Statistics on page 143
in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 NeighborInterface.getCost() 113
|

NeighborInterface.getCost()
Method

Declaration int getCost()

Purpose Get the path cost of the neighbor link.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Load Balancing on page 97 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

114
| Chapter 4 Routing Daemon—rvrd

NeighborInterface.getId()
Method

Declaration java.lang.String getId()

Purpose Get the interface ID of the neighbor interface.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 NeighborInterface.getLocalPort() 115
|

NeighborInterface.getLocalPort()
Method

Declaration int getLocalPort()

Purpose Get the TCP connect port of the local endpoint.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Local Connect Port on page 91 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

116
| Chapter 4 Routing Daemon—rvrd

NeighborInterface.getNeighborHost()
Method

Declaration java.lang.String getNeighborHost()

Purpose Get the host of the remote endpoint.

Remarks This method can return either the hostname or the IP address of the remote
neighbor.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Remote Host on page 92 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 NeighborInterface.getNeighborName() 117
|

NeighborInterface.getNeighborName()
Method

Declaration java.lang.String getNeighborName()

Purpose Get the router name of the remote endpoint.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Remote Router Name on page 91 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

118
| Chapter 4 Routing Daemon—rvrd

NeighborInterface.getNeighborPort()
Method

Declaration int getNeighborPort()

Purpose Get the TCP connect port of the remote endpoint.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Remote Connect Port on page 92 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 NeighborInterface.getType() 119
|

NeighborInterface.getType()
Method

Declaration int getType()

Purpose Get the type of the neighbor interface.

Remarks This method returns an integer constant denoting the type of the neighbor
interface. For a table of constant values, see NeighborInterface on page 110.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Adding Neighbor Interfaces on page 93 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

120
| Chapter 4 Routing Daemon—rvrd

NeighborInterface.isCompressed()
Method

Declaration boolean isCompressed()

throws java.lang.UnsupportedOperationException

Purpose Get the data compression flag of the neighbor interface.

Remarks This method returns a value that reflects communications between the local
router and its neighbor (which the NeighborInterface object describes):
• true indicates that this neighbor interface compresses outbound data and
uncompresses inbound data.
• false indicates that this neighbor interface does not compress data.

Notice that it is inconsistent for one neighbor to compress data while the other
does not. Neighbors must agree concerning compression, otherwise they cannot
establish a connection.
Rendezvous routing daemons support data compression in release 7.1 and later;
earlier releases do not. When the routing daemon does not support data
compression (as with rvrd from release 7.0), this method throws
java.lang.UnsupportedOperationException.

See Also NeighborInterface on page 110

Router.addAcceptAnyInterface() on page 125
Router.addActiveInterface() on page 127
Router.addPassiveInterface() on page 132
Router.addSeekAnyInterface() on page 135
For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Data Compression on page 92 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 NeighborInterface.isEncrypted() 121
|

NeighborInterface.isEncrypted()
Method

Declaration boolean isEncrypted()

Purpose Get the SSL requirement flag of the neighbor interface.

Remarks This method returns a value that reflects communications between the local
router and its neighbor (which the NeighborInterface object describes):
• true specifies that the two neighbors communicate using SSL protocols.
• false specifies that the two neighbors communicate using non-secure
protocols.

See Also NeighborInterface on page 110

Router.addActiveInterface() on page 127
Router.addPassiveInterface() on page 132
For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Adding Neighbor Interfaces on page 93 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

122
| Chapter 4 Routing Daemon—rvrd

NeighborInterface.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the neighbor interface information as an XML document.

See Also NeighborInterface on page 110

For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router 123
|

Router
Class

Declaration class com.tibco.tibrv.config.Router

extends java.lang.Object

Purpose Represent a router interface.

Remarks The method RvrdProxy.getRouter() returns an object of this class (or its
subclass, BorderRouter).

(Sheet 1 of 2)

Method Description Page

Router.addAcceptAnyInterface() Specify a neighbor interface that accepts 125
any neighbor.

Router.addActiveInterface() Specify a neighbor interface that actively 127

connects with its neighbor.

Router.addLocalNetworkInterface() Specify a local network interface. 130

Router.addPassiveInterface() Specify a neighbor interface that passively 132

accepts connections from its neighbor.

Router.addSeekAnyInterface() Specify a neighbor interface that seeks 135

any neighbor.

Router.clearMaxBacklog() Disable protection against large backlog. 137

Router.getLocalNetworkInterfaces() Get the local network interfaces of the 138

router.

Router.getMaxBacklog() Get the maximum backlog (in kilobytes). 139

Router.getName() Get the name of the router. 140

Router.getNeighborInterfaces() Get the neighbor interfaces of the router. 141

Router.removeLocalNetworkInterface() Remove local network interfaces from the 142

router.
Router.removeLocalNetworkInterfaces()

Router.removeNeighborInterface() Remove neighbor interfaces from the 143

router.
Router.removeNeighborInterfaces()

TIBCO Rendezvous Configuration Tools

124
| Chapter 4 Routing Daemon—rvrd

(Sheet 2 of 2)

Method Description Page

Router.setMaxBacklog() Set the maximum backlog, and enable 144
protection against large backlog.

Router.toXml() Format the router information as an XML 145

document.

See Also RvrdProxy.addRouter() on page 81

RvrdProxy.getRouter() on page 83
For the corresponding browser pages, see Routers on page 150 in TIBCO
Rendezvous Administration, and the sections that follow it
For background information, see Routing Table Entry on page 85 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router.addAcceptAnyInterface() 125
|

Router.addAcceptAnyInterface()
Method

Declaration NeighborInterface addAcceptAnyInterface(

java.lang.String localHost,
int localPort,
int cost,
boolean compressed)
throws ConfigurationException

NeighborInterface addAcceptAnyInterface(
int localPort,
int cost,
boolean compressed)
throws ConfigurationException

NeighborInterface addAcceptAnyInterface(
int localPort,
int cost)
throws ConfigurationException

Use the first form when the router is release 7.2 or later.
Use the second form when the router is release 7.1 (it is deprecated for later
releases).
Use the third form when the router is release 7.0.

Purpose Specify a neighbor interface that accepts any neighbor.

Remarks Use this method to specify a neighbor interface in which this routing daemon
accepts neighbor connections from any other routing daemon.
It is not possible to configure a router name with more than one accept any
neighbor interface.
Accept any interfaces cannot use SSL neighbor connections.

(Sheet 1 of 2)

Parameter Description
localHost The local router will listen on this network interface for neighbor connection
requests from remote routers. Supply an IP address or hostname denoting a
local network interface. For more information, see Local Host on page 91 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

126
| Chapter 4 Routing Daemon—rvrd

(Sheet 2 of 2)

Parameter Description
localPort The local router will listen on this local TCP port for neighbor connection
requests from remote routers. For more information, see Local Connect Port on
page 91 in TIBCO Rendezvous Administration.

cost The path cost of this neighbor link; see Load Balancing on page 97 in TIBCO
Rendezvous Administration.
You may supply the default cost, NeighborInterface.DEFAULT_COST.

compressed When true, the new neighbor interface compresses outbound data and
uncompresses inbound data.
When false, the new neighbor interface does not compress data.
Notice that it is inconsistent for one neighbor to compress data while the other
does not. Neighbors must agree concerning compression, otherwise they
cannot establish a connection.
Rendezvous routing daemons support data compression in release 7.1 and
later; earlier releases do not. When the routing daemon does not support data
compression, use the form of this method that omits this parameter.

See Also NeighborInterface on page 110

Router on page 123
Router.getNeighborInterfaces() on page 141
Router.removeNeighborInterface() on page 143
For the corresponding browser pages, see Add New Neighbor Interface on
page 161 in TIBCO Rendezvous Administration
For background information, see these sections:
• Neighbors on page 91 in TIBCO Rendezvous Administration
• Accept Any as Neighbor on page 94 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router.addActiveInterface() 127
|

Router.addActiveInterface()
Method

Declaration NeighborInterface addActiveInterface(

java.lang.String localHost,
int localPort
java.lang.String remoteHost,
int remotePort,
java.lang.String neighborName,
int cost,
boolean compressed,
boolean encrypted,
java.lang.String peerCertificate)
throws ConfigurationException

NeighborInterface addActiveInterface(
int localPort
java.lang.String remoteHost,
int remotePort,
java.lang.String neighborName,
int cost,
boolean compressed,
boolean encrypted,
java.lang.String peerCertificate)
throws ConfigurationException

NeighborInterface addActiveInterface(
int localPort
java.lang.String remoteHost,
int remotePort,
java.lang.String neighborName,
int cost,
boolean encrypted,
java.lang.String peerCertificate)
throws ConfigurationException

Use the first form when the router is release 7.2 or later.
Use the second form when the router is release 7.1 (it is deprecated for later
releases).
Use the third form when the router is release 7.0.

Purpose Specify a neighbor interface that actively connects with its neighbor.

Remarks Use this method to specify a neighbor interface in which the local router actively
attempts to connect to the remote neighbor.

TIBCO Rendezvous Configuration Tools

128
| Chapter 4 Routing Daemon—rvrd

On a BorderRouter, this method automatically configures the default policy for

all pairings of the new interface with every other existing interface. The default
policy forwards _INBOX.> (all inbox subjects); for additional details, see Policy on
page 113 in TIBCO Rendezvous Administration.

(Sheet 1 of 2)

Parameter Description
localHost The local router will listen on this network interface for neighbor connection
requests from remote routers. Supply an IP address or hostname denoting a
local network interface. For more information, see Local Host on page 91 in
TIBCO Rendezvous Administration.

localPort The local router will listen on this local TCP port for neighbor connection
requests from its remote neighbor. For more information, see Local Connect
Port on page 91 in TIBCO Rendezvous Administration.

remoteHost The local router will seek its neighbor running on this host computer. Supply
either a resolvable hostname, or the IP address of the computer in a remote
network where the neighboring daemon is running. For more information,
see Remote Connection Information on page 91 in TIBCO Rendezvous
Administration.

remotePort The local router will use this TCP port to request a neighbor connection with
the remote router. The remote router must listen for neighbor requests on this
port. For more information, see Remote Connection Information on page 91
in TIBCO Rendezvous Administration.

neighborName The local router will connect only with this remote router.

cost The path cost of this neighbor link; see Load Balancing on page 97 in TIBCO
Rendezvous Administration.
You may supply the default cost, NeighborInterface.DEFAULT_COST.

compressed When true, the new neighbor interface compresses outbound data and
uncompresses inbound data.
When false, the new neighbor interface does not compress data.
Notice that it is inconsistent for one neighbor to compress data while the
other does not. Neighbors must agree concerning compression, otherwise
they cannot establish a connection.
Rendezvous routing daemons support data compression in release 7.1 and
later; earlier releases do not. When the routing daemon does not support
data compression, use the form of this method that omits this parameter.

TIBCO Rendezvous Configuration Tools

 Router.addActiveInterface() 129
|

(Sheet 2 of 2)

Parameter Description
encrypted When true, the two neighbors must communicate using SSL protocols.
When false, the two neighbors must communicate using non-secure
protocols.
Notice that both neighbors must use the same protocols, otherwise they
cannot establish a connection.

peerCertificate In SSL protocols, the local router expects the remote router to present this
certificate as evidence of its identity. Supply the text of the public certificate
(in PEM encoding).

See Also NeighborInterface on page 110

Router on page 123
Router.getNeighborInterfaces() on page 141
Router.removeNeighborInterface() on page 143
For the corresponding browser pages, see Add New Neighbor Interface on
page 161 in TIBCO Rendezvous Administration
For background information, see these sections:
• Neighbors on page 91 in TIBCO Rendezvous Administration
• Active Neighbor on page 93 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

130
| Chapter 4 Routing Daemon—rvrd

Router.addLocalNetworkInterface()
Method

Declaration LocalNetworkInterface addLocalNetworkInterface(

java.lang.String localNetworkName,
int service,
java.lang.String networkSpecification,
int cost)
throws ConfigurationException

Purpose Specify a local network interface.

Remarks On a BorderRouter, this method automatically configures the default policy for
all pairings of the new interface with every other existing interface. The default
policy forwards _INBOX.> (all inbox subjects); for additional details, see Policy on
page 113 in TIBCO Rendezvous Administration.

Item Description
localNetworkName Supply the name of the local network. Local network names must be
globally unique. For more information, see Local Network on page 86
in TIBCO Rendezvous Administration.

service Supply the UDP or PGM service for communication on the local
network. Programs within the local network communicate using this
service. For more information, see Specifying the UDP or PGM Service
on page 21 in TIBCO Rendezvous Administration.
You may supply the default value
LocalNetworkInterface.UNSPECIFIED.

networkSpecification Supply the network specification. For more information, see

Constructing the Network Parameter on page 23 in TIBCO Rendezvous
Administration.
You may supply the default value, the empty string.

cost Supply the path cost for routing between the local network and the
router. For more information, see Load Balancing on page 97 in TIBCO
Rendezvous Administration.
You may supply the default cost
LocalNetworkInterface.DEFAULT_COST.

See Also LocalNetworkInterface on page 89

TIBCO Rendezvous Configuration Tools

 Router.addLocalNetworkInterface() 131
|

Router on page 123

Router.getLocalNetworkInterfaces() on page 138
Router.removeLocalNetworkInterface() on page 142
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see these sections:
• Routing Table Entry on page 85 in TIBCO Rendezvous Administration
• Local Network on page 86 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

132
| Chapter 4 Routing Daemon—rvrd

Router.addPassiveInterface()
Method

Declaration NeighborInterface addPassiveInterface(

java.lang.String localHost,
int localPort
java.lang.String neighborName,
int cost,
boolean compressed,
boolean encrypted,
java.lang.String peerCertificate)
throws ConfigurationException

NeighborInterface addPassiveInterface(
int localPort
java.lang.String neighborName,
int cost,
boolean compressed,
boolean encrypted,
java.lang.String peerCertificate)
throws ConfigurationException

NeighborInterface addPassiveInterface(
int localPort
java.lang.String neighborName,
int cost,
boolean encrypted,
java.lang.String peerCertificate)
throws ConfigurationException

Use the first form when the router is release 7.2 or later.
Use the second form when the router is release 7.1 (it is deprecated for later
releases).
Use the third form when the router is release 7.0.

Purpose Specify a neighbor interface that passively accepts connections from its neighbor.

Remarks Use this method to specify a neighbor interface in which the local router does not
actively attempt to connect to the remote neighbor. Instead, it passively waits for
the remote neighbor to request a connection.

TIBCO Rendezvous Configuration Tools

 Router.addPassiveInterface() 133
|

On a BorderRouter, this method automatically configures the default policy for

all pairings of the new interface with every other existing interface. The default
policy forwards _INBOX.> (all inbox subjects); for additional details, see Policy on
page 113 in TIBCO Rendezvous Administration.

Parameter Description
localHost The local router will listen on this network interface for neighbor connection
requests from remote routers. Supply an IP address or hostname denoting a
local network interface. For more information, see Local Host on page 91 in
TIBCO Rendezvous Administration.

localPort The local router will listen on this local TCP port for neighbor connection
requests from its remote neighbor. For more information, see Local Connect
Port on page 91 in TIBCO Rendezvous Administration.

neighborName The local router will passively accept neighbor connections only from this
remote router.

cost The path cost of this neighbor link; see Load Balancing on page 97 in TIBCO
Rendezvous Administration.
You may supply the default cost, NeighborInterface.DEFAULT_COST.

compressed When true, the new neighbor interface compresses outbound data and
uncompresses inbound data.
When false, the new neighbor interface does not compress data.
Notice that it is inconsistent for one neighbor to compress data while the
other does not. Neighbors must agree concerning compression, otherwise
they cannot establish a connection.
Rendezvous routing daemons support data compression in release 7.1 and
later; earlier releases do not. When the routing daemon does not support
data compression, use the form of this method that omits this parameter.

encrypted When true, the two neighbors must communicate using SSL protocols.
When false, the two neighbors must communicate using non-secure
protocols.
Notice that both neighbors must use the same protocols, otherwise they
cannot establish a connection.

peerCertificate In SSL protocols, the local router expects the remote router to present this
certificate as evidence of its identity. Supply the text of the public certificate
(in PEM encoding).

TIBCO Rendezvous Configuration Tools

134
| Chapter 4 Routing Daemon—rvrd

See Also NeighborInterface on page 110

Router on page 123
Router.getNeighborInterfaces() on page 141
Router.removeNeighborInterface() on page 143
For the corresponding browser pages, see Add New Neighbor Interface on
page 161 in TIBCO Rendezvous Administration
For background information, see these sections:
• Neighbors on page 91 in TIBCO Rendezvous Administration
• Passive Neighbor on page 93 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router.addSeekAnyInterface() 135
|

Router.addSeekAnyInterface()
Method

Declaration NeighborInterface addSeekAnyInterface(

java.lang.String remoteHost,
int remotePort,
int cost,
boolean compressed)
throws ConfigurationException

NeighborInterface addSeekAnyInterface(
java.lang.String remoteHost,
int remotePort,
int cost)
throws ConfigurationException

Use the first form when the router is release 7.1 or later.
Use the second form when the router is release 7.0.

Purpose Specify a neighbor interface that seeks any neighbor.

Remarks Use this method to specify a neighbor interface in which this routing daemon
attempts to connect to any remote routing daemon that matches the specification.
It is illegal to configure a router name with two or more seek any neighbor
interfaces with the same remote host.
Seek any interfaces cannot use SSL neighbor connections.

Parameter Description
remoteHost The local router will seek a neighbor running on this host computer. Supply
either a DNS hostname that can resolve to more than one IP address, or a
virtual IP address.

remotePort The local router will use this TCP port to request a neighbor connection with
remote routers. All potential neighbors must listen for neighbor requests on
this port. For more information, see Remote Connection Information on
page 91 in TIBCO Rendezvous Administration.

cost The path cost of this neighbor link; see Load Balancing on page 97 in TIBCO
Rendezvous Administration.
You may supply the default cost, NeighborInterface.DEFAULT_COST.

TIBCO Rendezvous Configuration Tools

136
| Chapter 4 Routing Daemon—rvrd

Parameter Description
compressed When true, the new neighbor interface compresses outbound data and
uncompresses inbound data.
When false, the new neighbor interface does not compress data.
Notice that it is inconsistent for one neighbor to compress data while the other
does not. Neighbors must agree concerning compression, otherwise they
cannot establish a connection.
Rendezvous routing daemons support data compression in release 7.1 and
later; earlier releases do not. When the routing daemon does not support data
compression, use the form of this method that omits this parameter.

See Also NeighborInterface on page 110

Router on page 123
Router.getNeighborInterfaces() on page 141
Router.removeNeighborInterface() on page 143
For the corresponding browser pages, see Add New Neighbor Interface on
page 161 in TIBCO Rendezvous Administration
For background information, see these sections:
• Neighbors on page 91 in TIBCO Rendezvous Administration
• Seek Neighbor with Any Name on page 94 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 Router.clearMaxBacklog() 137
|

Router.clearMaxBacklog()
Method

Declaration Router clearMaxBacklog()

throws ConfigurationException

Purpose Disable protection against large backlog.

Remarks This method returns the Router object, so programs can conveniently chain
additional method calls to the return value.

See Also Router on page 123

Router.getMaxBacklog() on page 139
Router.setMaxBacklog() on page 144
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration
For background information, see Backlog Protection on page 122 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

138
| Chapter 4 Routing Daemon—rvrd

Router.getLocalNetworkInterfaces()
Method

Declaration LocalNetworkInterface[] getLocalNetworkInterfaces()

throws ConfigurationException

Purpose Get the local network interfaces of the router.

See Also LocalNetworkInterface on page 89

Router on page 123
Router.addLocalNetworkInterface() on page 130
Router.removeLocalNetworkInterface() on page 142
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see these sections:
• Routing Table Entry on page 85 in TIBCO Rendezvous Administration
• Local Network on page 86 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router.getMaxBacklog() 139
|

Router.getMaxBacklog()
Method

Declaration int getMaxBacklog()

throws ConfigurationException

Purpose Get the maximum backlog (in kilobytes).

Remarks Zero indicates that the backlog protection feature is disabled (see
Router.clearMaxBacklog() on page 137).

See Also Router on page 123

Router.clearMaxBacklog() on page 137
Router.setMaxBacklog() on page 144
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration
For background information, see Backlog Protection on page 122 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

140
| Chapter 4 Routing Daemon—rvrd

Router.getName()
Method

Declaration java.lang.String getName()

Purpose Get the name of the router.

See Also Router on page 123

Router.clearMaxBacklog() on page 137
Router.setMaxBacklog() on page 144
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration
For background information, see Router Name on page 85 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 Router.getNeighborInterfaces() 141
|

Router.getNeighborInterfaces()
Method

Declaration NeighborInterface[] getNeighborInterfaces()

throws ConfigurationException

Purpose Get the neighbor interfaces of the router.

See Also LocalNetworkInterface on page 89

Router on page 123
Router.addAcceptAnyInterface() on page 125
Router.addActiveInterface() on page 127
Router.addPassiveInterface() on page 132
Router.addSeekAnyInterface() on page 135
Router.removeNeighborInterface() on page 143
For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Neighbors on page 91 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

142
| Chapter 4 Routing Daemon—rvrd

Router.removeLocalNetworkInterface()
Method

Related Forms Router.removeLocalNetworkInterfaces()

Declaration Router removeLocalNetworkInterface(

java.lang.String localNetworkName)
throws ConfigurationException

Router removeLocalNetworkInterfaces(
java.lang.String[] localNetworkNames)
throws ConfigurationException

Purpose Remove local network interfaces from the router.

Remarks When removing more than network interface, the second method is faster than
repeatedly calling the first method.
These methods return the Router object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
localNetworkName Remove the network interface with this name.

localNetworkNames Remove all the network interfaces named in this array.

See Also LocalNetworkInterface on page 89

Router on page 123
Router.addLocalNetworkInterface() on page 130
Router.getLocalNetworkInterfaces() on page 138
For the corresponding browser page, see Local Network Interfaces Configuration
on page 153 in TIBCO Rendezvous Administration
For background information, see these sections:
• Routing Table Entry on page 85 in TIBCO Rendezvous Administration
• Local Network on page 86 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router.removeNeighborInterface() 143
|

Router.removeNeighborInterface()
Method

Related Forms Router.removeNeighborInterfaces()

Declaration Router removeNeighborInterface(

java.lang.String interfaceId)
throws ConfigurationException

Router removeNeighborInterfaces(
java.lang.String[] interfaceIds)
throws ConfigurationException

Purpose Remove neighbor interfaces from the router.

Remarks When removing more than neighbor interface, the second method is faster than
repeatedly calling the first method.
These methods return the Router object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
interfaceId Remove the neighbor interface with this ID.

interfaceIds Remove all the neighbor interfaces specified in this array.

See Also LocalNetworkInterface on page 89

Router on page 123
Router.addAcceptAnyInterface() on page 125
Router.addActiveInterface() on page 127
Router.addPassiveInterface() on page 132
Router.addSeekAnyInterface() on page 135
Router.getNeighborInterfaces() on page 141
For the corresponding browser page, see Neighbor Interfaces on page 159 in
TIBCO Rendezvous Administration
For background information, see Neighbors on page 91 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

144
| Chapter 4 Routing Daemon—rvrd

Router.setMaxBacklog()
Method

Declaration Router setMaxBacklog(

int maxBacklog)
throws ConfigurationException

Purpose Set the maximum backlog, and enable protection against large backlog.

Remarks This method returns the Router object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
maxBacklog Use this maximum (in kilobytes) to limit router backlog.

See Also Router on page 123

Router.clearMaxBacklog() on page 137
Router.getMaxBacklog() on page 139
For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration
For background information, see Backlog Protection on page 122 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 Router.toXml() 145
|

Router.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the router information as an XML document.

See Also Router on page 123

For the corresponding browser page, see Routers on page 150 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

146
| Chapter 4 Routing Daemon—rvrd

BorderRouter
Class

Declaration class com.tibco.tibrv.config.BorderRouter

extends Router

Purpose Represent a border router interface.

Remarks The method RvrdProxy.getRouter() can return an object of this class.

Once a border router is configured, you cannot remove it, rename it, nor convert it
to a first-tier router. Nor can you convert a first-tier router to a border router.

Method Description Page

BorderRouter.addPolicyRule() Add a policy rule for a pair of interfaces. 148

BorderRouter.getPolicyRule() Get policy rules of a border router. 150

BorderRouter.getPolicyRules()

BorderRouter.removePolicyRule() Remove a policy rule from the border 151

router.

BorderRouter.toXml() Format the border router information as 152

an XML document.

TIBCO Rendezvous Configuration Tools

 BorderRouter 147
|

Inherited Methods
Router.addAcceptAnyInterface()
Router.addActiveInterface()
Router.addLocalNetworkInterface()
Router.addPassiveInterface()
Router.addSeekAnyInterface()
Router.clearMaxBacklog()
Router.getLocalNetworkInterfaces()
Router.getMaxBacklog()
Router.getName()
Router.getNeighborInterfaces()
Router.removeLocalNetworkInterface()
Router.removeLocalNetworkInterfaces()
Router.removeNeighborInterface()
Router.removeNeighborInterfaces()
Router.setMaxBacklog()
Router.toXml() override

See Also RvrdProxy.addBorderRouter() on page 80

RvrdProxy.getRouter() on page 83
PolicyRule on page 153
For the corresponding browser pages, see Border Routing on page 151 in TIBCO
Rendezvous Administration, and the sections that follow it
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

148
| Chapter 4 Routing Daemon—rvrd

BorderRouter.addPolicyRule()
Method

Declaration PolicyRule addPolicyRule(

java.lang.String fromInterface,
java.lang.String toInterface,
java.lang.String subject,
boolean firstBorder)
throws ConfigurationException

PolicyRule addPolicyRule(
java.lang.String fromInterface,
java.lang.String toInterface,
java.lang.String[] subjects,
boolean firstBorder)
throws ConfigurationException

Purpose Add a policy rule for a pair of interfaces.

Remarks Use the first form to add only one subject. Use the second form to add several
subjects with one method call. (The first form calls the second form with an array
of one element.)
If a policy rule already exists for the From/To pair, then this method (first form)
behaves like PolicyRule.addAllowedSubject() on page 154—it attempts to add the
new subject to the existing rule.
• If the subject does not already exist in the rule, then the method adds it.
• If the subject already exists in the rule, then the method throws a
ConfigurationException; the rule and subject remain unchanged.

(Sheet 1 of 2)

Parameter Description
fromInterface Supply the From-Interface for the new policy rule.

toInterface Supply the To-Interface for the new policy rule.

subject Specify a subject for which this rule permits forwarding across the two
interfaces.

subjects Specify an array of subjects for which this rule permits forwarding across the
two interfaces.

TIBCO Rendezvous Configuration Tools

 BorderRouter.addPolicyRule() 149
|

(Sheet 2 of 2)

Parameter Description
firstBorder When true, the rule instructs the border router to forward the subjects only
when a message has not yet crossed another border.
When false, the border router always forwards the subjects.
This property applies to all the subjects that this method adds. It does not affect
pre-existing subjects.

See Also BorderRouter on page 146

BorderRouter.getPolicyRule() on page 150
BorderRouter.removePolicyRule() on page 151
PolicyRule on page 153
For the corresponding browser pages, see Border Routing on page 151 in TIBCO
Rendezvous Administration
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

150
| Chapter 4 Routing Daemon—rvrd

BorderRouter.getPolicyRule()
Method

Related Forms BorderRouter.getPolicyRules()

Declaration PolicyRule getPolicyRule(

java.lang.String fromInterface,
java.lang.String toInterface)
throws ConfigurationException

PolicyRule[] getPolicyRules()
throws ConfigurationException

Purpose Get policy rules of a border router.

Remarks Use the first form to get the rule for a specific pairing of From- and To-Interfaces.
Use the second form to get all policy rules of the border router.
Even if you have not configured a policy rule for a From/To pair, a default rule
might still exist. Default rules allow the subject _INBOX.> (with firstBorder
false).

After a rule has been removed, getting the rule for that pair returns an empty
rule—that is, a rule without any allowed subjects.

Parameter Description
fromInterface Supply the From-Interface of the rule to get.

toInterface Supply the To-Interface of the rule to get.

See Also BorderRouter on page 146

BorderRouter.addPolicyRule() on page 148
BorderRouter.removePolicyRule() on page 151
PolicyRule on page 153
For the corresponding browser pages, see Border Routing on page 151 in TIBCO
Rendezvous Administration
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 BorderRouter.removePolicyRule() 151
|

BorderRouter.removePolicyRule()
Method

Declaration Router removePolicyRule(

java.lang.String fromInterface,
java.lang.String toInterface)
throws ConfigurationException

Purpose Remove a policy rule from the border router.

Remarks This method removes a policy rule. As a result, the border router no longer
forwards any of the subjects that the rule had specified.
Without explicit configuration, border routers forward _INBOX.> (all inbox
subjects). Whenever you add an interface, rvrd automatically configures this
default policy for every pairing of that interface with every other existing
interface. Removing a policy rule explicitly removes this subject, which disables
forwarding of inbox messages for the From/To pair.
If no rule exists for the From/To pair—that is, even the default rule has been
removed—then this method returns normally (it does not throw an exception).

Parameter Description
fromInterface Supply the From-Interface of the rule to remove.

toInterface Supply the To-Interface of the rule to remove.

See Also LocalNetworkInterface on page 89

Router on page 123
Router.addLocalNetworkInterface() on page 130
Router.getLocalNetworkInterfaces() on page 138
For the corresponding browser pages, see Border Routing on page 151 in TIBCO
Rendezvous Administration
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

152
| Chapter 4 Routing Daemon—rvrd

BorderRouter.toXml()
Method

Declaration java.lang.String toXml()

throws ConfigurationException

Purpose Format the border router information as an XML document.

See Also BorderRouter on page 146

For the corresponding browser pages, see Border Routing on page 151 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 PolicyRule 153
|

PolicyRule
Class

Declaration class com.tibco.tibrv.config.PolicyRule

extends java.lang.Object

Purpose Represent a policy rule of a border router.

Remarks The method BorderRouter.getPolicyRule() returns objects of this class.

Method Description Page

PolicyRule.addAllowedSubject() Update an existing policy rule by adding 154
one or more subjects.
PolicyRule.addAllowedSubjects()

PolicyRule.getAllowedSubjects() Get subjects from an existing policy rule. 156

PolicyRule.getBorderRouterName() Get the name of the border router to which 157

the policy rule pertains.

PolicyRule.getFromInterface() Get the From-Interface of a policy rule. 158

PolicyRule.getToInterface() Get the To-Interface of a policy rule. 159

PolicyRule.removeAllowedSubject() Update an existing policy rule by removing 160

one or more subjects.
PolicyRule.removeAllowedSubjects()

PolicyRule.toXml() Format the policy rule information as an 161

XML document.

See Also BorderRouter on page 146

BorderRouter.getPolicyRule() on page 150
PolicyRule on page 153
For the corresponding browser pages, see Border Policy on page 157 in TIBCO
Rendezvous Administration
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

154
| Chapter 4 Routing Daemon—rvrd

PolicyRule.addAllowedSubject()
Method

Related Forms PolicyRule.addAllowedSubjects()

Declaration PolicyRule addAllowedSubject(

java.lang.String subject,
boolean firstBorder)
throws ConfigurationException

PolicyRule addAllowedSubjects(
java.lang.String[] subjects,
boolean firstBorder)
throws ConfigurationException

Purpose Update an existing policy rule by adding one or more subjects.

Remarks This method returns the updated policy rule.

The first form adds only one subject. The second form adds several subjects. (The
first form calls the second form with an array of one element.)

If the subject does not already exist in the rule, then the method adds it.
If the subject already exists in the rule, then the method throws a
ConfigurationException; the rule and subject remain unchanged.

Parameter Description
subject Append a subject to the rule, so the border router forwards that subject.

subjects Append an array of subjects to the rule, so the border router forwards those
subjects.

firstBorder When true, the rule instructs the border router to forward the new subjects
only when a message has not yet crossed another border.
When false, the border router always forwards the new subjects.
This property applies to all the new subjects that this method adds. It does not
affect pre-existing subjects.

See Also BorderRouter.getPolicyRule() on page 150

PolicyRule on page 153
For the corresponding browser pages, see Border Policy on page 157 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 PolicyRule.addAllowedSubject() 155
|

For background information, see Border Routing on page 112 in TIBCO

Rendezvous Administration

TIBCO Rendezvous Configuration Tools

156
| Chapter 4 Routing Daemon—rvrd

PolicyRule.getAllowedSubjects()
Method

Declaration java.lang.String[] getAllowedSubjects(

boolean firstBorder)
throws ConfigurationException

Purpose Get subjects from an existing policy rule.

Parameter Description
firstBorder This method returns an array of all the subjects in the rule for which the
first-border property matches this argument. To get all the rule’s subjects, you
must call this method twice—once with true, and once with false.

See Also BorderRouter.getPolicyRule() on page 150

PolicyRule on page 153
For the corresponding browser pages, see Border Policy on page 157 in TIBCO
Rendezvous Administration
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 PolicyRule.getBorderRouterName() 157
|

PolicyRule.getBorderRouterName()
Method

Declaration java.lang.String getBorderRouterName()

Purpose Get the name of the border router to which the policy rule pertains.

See Also BorderRouter on page 146

PolicyRule on page 153
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

158
| Chapter 4 Routing Daemon—rvrd

PolicyRule.getFromInterface()
Method

Declaration java.lang.String getFromInterface()

Purpose Get the From-Interface of a policy rule.

See Also PolicyRule on page 153

For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 PolicyRule.getToInterface() 159
|

PolicyRule.getToInterface()
Method

Declaration java.lang.String getToInterface()

Purpose Get the To-Interface of a policy rule.

See Also PolicyRule on page 153

For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

160
| Chapter 4 Routing Daemon—rvrd

PolicyRule.removeAllowedSubject()
Method

Related Forms PolicyRule.removeAllowedSubjects()

Declaration PolicyRule removeAllowedSubject(

java.lang.String subject)
throws ConfigurationException

PolicyRule removeAllowedSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Update an existing policy rule by removing one or more subjects.

Remarks This method returns the updated policy rule.

The first form removes only one subject. The second form removes several
subjects.
Removing a subject that is not in the rule results in a ConfigurationException.
Without explicit configuration, border routers forward _INBOX.> (all inbox
subjects). Whenever you add an interface, rvrd automatically configures this
default policy for every pairing of that interface with every other existing
interface. You may explicitly remove this subject to disable forwarding of inbox
messages.

Parameter Description
subject Remove a subject from the rule, so the border router no longer forwards that
subject.

subjects Remove an array of subjects from the rule, so the border router no longer
forwards those subjects.

See Also BorderRouter.getPolicyRule() on page 150

PolicyRule on page 153
For the corresponding browser pages, see Border Policy on page 157 in TIBCO
Rendezvous Administration
For background information, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 PolicyRule.toXml() 161
|

PolicyRule.toXml()
Method

Declaration java.lang.String toXml()

throws ConfigurationException

Purpose Format the policy rule information as an XML document.

See Also PolicyRule on page 153

For the corresponding browser pages, see Border Routing on page 112 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

162
| Chapter 4 Routing Daemon—rvrd

TIBCO Rendezvous Configuration Tools

 | 163

Chapter 5 Security

This chapter describes the proxy interface for the Rendezvous components that
require either passwords or certificates for security.

Topics

• SecurityProxy, page 164

• CertificateSlot, page 172

TIBCO Rendezvous Configuration Tools

164
| Chapter 5 Security

SecurityProxy
Interface

Declaration interface com.tibco.tibrv.config.SecurityProxy

extends DaemonProxy

Purpose Define methods for components that require passwords or certificates for security.

Constant Description
These constants correspond to positions in the certificate usage bit vector; see
SecurityProxy.getValidUses() on page 168.

SecurityProxy.HTTPS Represents usage of certificates in HTTPS protocols.

SecurityProxy.ROUTERS_TO_ROUTERS Represents usage of certificates in SSL protocols among

routing daemons.

SecurityProxy.DAEMON_TO_CLIENTS Represents usage of certificates in SSL protocols with

client transports of the daemon.

Method Description Page

SecurityProxy.getAdministratorName() Get the administrator name. 166

SecurityProxy.getCertificateSlot() Get daemon certificate slots. 167

SecurityProxy.getCertificateSlots()

SecurityProxy.getValidUses() Get the valid uses of certificates for 168

this daemon.

SecurityProxy.setCertificateUses() Assign certificates to each valid use 169

for this daemon.

SecurityProxy.setCredentials() Set administrator identification for 170

the component.

SecurityProxy.useCredentials() Record administrator identification 171

for the configuration program.

TIBCO Rendezvous Configuration Tools

 SecurityProxy 165
|

Inherited Methods
DaemonProxy.getComponentName()
DaemonProxy.getComponentInformation()

XmlSerializable.printXml()
XmlSerializable.toXml()

Components These components support this interface:

rvrd
rvsd
rvsrd
rva
rvcache

See Also For information about the parameters that this interface can access, see these
sections:
• Secure Daemons (rvsd and rvsrd) on page 169 in TIBCO Rendezvous
Administration
• Browser Administration Interface—rvrd on page 134 in TIBCO Rendezvous
Administration
• Browser Administration Interface—rvsd and rvsrd on page 190 in TIBCO
Rendezvous Administration
• Rendezvous Agent (rva) on page 267 in TIBCO Rendezvous Administration
• Current Value Cache on page 281 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

166
| Chapter 5 Security

SecurityProxy.getAdministratorName()
Method

Declaration java.lang.String getAdministratorName()

throws ConfigurationException

Purpose Get the administrator name.

See Also SecurityProxy on page 164

SecurityProxy.setCredentials() on page 170
SecurityProxy.useCredentials() on page 171
For the corresponding browser page, see Administrator and Password on
page 147 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecurityProxy.getCertificateSlot() 167
|

SecurityProxy.getCertificateSlot()
Method

Related Forms SecurityProxy.getCertificateSlots()

Declaration CertificateSlot getCertificateSlot(

int certificateIndex)
throws ConfigurationException

CertificateSlot[] getCertificateSlots()
throws ConfigurationException

Purpose Get daemon certificate slots.

Remarks Component daemons have four slots in which they can store certificates. The first
method gets a specific slot. The second method gets an array of all four slots.

Parameter Description
certificateIndex Get the certificate slot corresponding to this index.
In Java, indexing is zero-based; in Rendezvous browser administration
interfaces, certificate indexing is one-based. So to specify certificate slot #1,
supply zero; to specify certificate slot #4, supply 3.

See Also SecurityProxy on page 164

CertificateSlot on page 172

For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

168
| Chapter 5 Security

SecurityProxy.getValidUses()
Method

Declaration int getValidUses()

throws ConfigurationException

Purpose Get the valid uses of certificates for this daemon.

Remarks Each daemon component that supports the SecurityProxy interface uses
certificates in up to three ways. This method returns a bit vector that describes the
legitimate uses of certificates for the actual component.
The three constants defined for SecurityProxy on page 164 correspond to
positions in the bit vector. To determine whether a specific use applies to the
component, probe the corresponding bit with Java’s bitwise AND (&) operator; for
example:
if ( (SecurityProxy) myDmnProxy.getValidUses() & SecurityProxy.HTTPS
!= 0 {
// My daemon supports certificates for HTTPS.
... }

See Also SecurityProxy on page 164

SecurityProxy.setCertificateUses() on page 169
For the corresponding browser pages, see Certificate Uses on page 165 in TIBCO
Rendezvous Administration, or Certificate Uses on page 206 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 SecurityProxy.setCertificateUses() 169
|

SecurityProxy.setCertificateUses()
Method

Declaration SecurityProxy setCertificateUses(

int httpsCertificateIndex,
int routersToRoutersCertificateIndex,
int daemonToClientsCertificateIndex)
throws ConfigurationException

Purpose Assign certificates to each valid use for this daemon.

Remarks Each daemon component that supports the SecurityProxy interface uses
certificates in up to three ways. This method assigns one of the component’s four
possible certificates to each use that the component supports.
Supply a certificate index in each parameter position. This method ignores
parameters that correspond to invalid uses for the daemon.
Component daemons can store up to four certificates. In Java, indexing is
zero-based; in Rendezvous browser administration interfaces, certificate indexing
is one-based. So to specify certificate #1, supply zero; to specify certificate #4,
supply 3.
This method returns the SecurityProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
httpsCertificateIndex Supply the index of the certificate to use for HTTPS
communication (for example, with browsers or with Java
configuration programs).

routersToRoutersCertificateIndex Supply the index of the certificate to use for SSL

communication with other routing daemons.

daemonToClientsCertificateIndex Supply the index of the certificate to use for SSL

communications with client transports.

See Also SecurityProxy on page 164

SecurityProxy.getValidUses() on page 168
For the corresponding browser pages, see Certificate Uses on page 165 in TIBCO
Rendezvous Administration, or Certificate Uses on page 206 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

170
| Chapter 5 Security

SecurityProxy.setCredentials()
Method

Declaration SecurityProxy setCredentials(

java.lang.String name,
java.lang.String password)
throws ConfigurationException

Purpose Set administrator identification for the component.

Remarks This method returns the SecurityProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
name Set the daemon to expect this administrator name.

password Set the daemon to expect this administrator password.

See Also SecurityProxy on page 164

SecurityProxy.getAdministratorName() on page 166
SecurityProxy.useCredentials() on page 171
For the corresponding browser page, see Administrator and Password on
page 147 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecurityProxy.useCredentials() 171
|

SecurityProxy.useCredentials()
Method

Declaration void useCredentials(

java.lang.String name,
java.lang.String password)
throws ConfigurationException

Purpose Record administrator identification for the configuration program.

Remarks This method records administrator identification credentials within your Java
program. When the daemon component requests identification, the program
automatically transmits these credentials to the daemon.
Of course, these credentials must match the credentials stored at the daemon,
otherwise the daemon rejects them and closes the connection.

Parameter Description
name Set the program to offer this administrator name.

password Set the program to offer this administrator password.

See Also SecurityProxy on page 164

SecurityProxy.getAdministratorName() on page 166
SecurityProxy.setCredentials() on page 170

TIBCO Rendezvous Configuration Tools

172
| Chapter 5 Security

CertificateSlot
Class

Declaration class com.tibco.tibrv.config.CertificateSlot

extends java.lang.Object

Purpose Represent a slot in a daemon component that can store an X.509 certificate.

Remarks The method SecurityProxy.getCertificateSlot() and related methods

return objects of this class.

Method Description Page

CertificateSlot.getIndex() Get the index of this certificate slot. 173

CertificateSlot.getPathname() Get the file name from which the 174

component read the certificate in this slot.

CertificateSlot.getText() Get the certificate data as a text string. 175

CertificateSlot.getUses() Get the uses of this certificate within the 176

component.

CertificateSlot.setFromText() Interpret a text string as certificate data, and 178

put the certificate in this slot.

CertificateSlot.setFromFile() Read certificate data from a file, and put the 177
certificate in this slot.

CertificateSlot.toXml() Format the certificate slot information as an 179

XML document.

See Also SecurityProxy.getCertificateSlot() on page 167

For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration
For background information, see Certificates and Security on page 52 in TIBCO
Rendezvous Concepts.

TIBCO Rendezvous Configuration Tools

 CertificateSlot.getIndex() 173
|

CertificateSlot.getIndex()
Method

Declaration int getIndex()

Purpose Get the index of this certificate slot.

Remarks Component daemons have four slots in which they can store certificates (some
slots might be empty). In Java, indexing is zero-based; in Rendezvous browser
administration interfaces, certificate indexing is one-based. So zero indicates
certificate slot #1, and 3 indicates certificate slot #4.

See Also CertificateSlot on page 172

For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

174
| Chapter 5 Security

CertificateSlot.getPathname()
Method

Declaration java.lang.String getPathname()

Purpose Get the file name from which the component read the certificate in this slot.

Remarks Components can obtain certificate data either from a file, or directly as a text
string.
• When the certificate data came from a file, this method returns the file name.
• When the certificate data came directly as a text string, this method returns
the string N/A (not applicable).

See Also SecurityProxy on page 164

CertificateSlot.setFromFile() on page 177
For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 CertificateSlot.getText() 175
|

CertificateSlot.getText()
Method

Declaration java.lang.String getText()

Purpose Get the certificate data as a text string.

Remarks When the certificate slot is empty, this method returns null.

See Also SecurityProxy on page 164

CertificateSlot.setFromFile() on page 177
CertificateSlot.setFromText() on page 178
For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

176
| Chapter 5 Security

CertificateSlot.getUses()
Method

Declaration int getUses()

Purpose Get the uses of this certificate within the component.

Remarks Each daemon component that supports the SecurityProxy interface uses
certificates in up to three ways. This method returns a bit vector that describes the
set of ways that the component actually uses the certificate in this slot.
The three constants defined for SecurityProxy on page 164 correspond to
positions in the bit vector. To determine whether a specific use applies to the
certificate, probe the corresponding bit with Java’s bitwise AND (&) operator; for
example:
if ( myCert.getUses() & SecurityProxy.HTTPS
!= 0 {
// My daemon uses this certificate for HTTPS.
... }

See Also SecurityProxy on page 164

SecurityProxy.setCertificateUses() on page 169
For the corresponding browser pages, see Certificate Uses on page 165 in TIBCO
Rendezvous Administration, or Certificate Uses on page 206 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 CertificateSlot.setFromFile() 177
|

CertificateSlot.setFromFile()
Method

Declaration CertificateSlot setFromFile(

java.lang.String pathname,
java.lang.String password)
throws ConfigurationException

Purpose Read certificate data from a file, and put the certificate in this slot.

Remarks This method returns the CertificateSlot object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
pathname Read encrypted certificate data from this file.

password Decrypt the certificate data with this password.

See Also SecurityProxy on page 164

For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

178
| Chapter 5 Security

CertificateSlot.setFromText()
Method

Declaration CertificateSlot setFromText(

java.lang.String text,
java.lang.String password)
throws ConfigurationException

Purpose Interpret a text string as certificate data, and put the certificate in this slot.

Remarks This method returns the CertificateSlot object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
text Use this text as encrypted certificate data.

password Decrypt the certificate data with this password.

See Also SecurityProxy on page 164

For the corresponding browser pages, see Certificate List on page 167 in TIBCO
Rendezvous Administration, or Certificate List on page 208 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 CertificateSlot.toXml() 179
|

CertificateSlot.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the certificate slot information as an XML document.

See Also CertificateSlot on page 172

TIBCO Rendezvous Configuration Tools

180
| Chapter 5 Security

TIBCO Rendezvous Configuration Tools

 | 181

Chapter 6 Secure Daemons—rvsd & rvsrd

This chapter describes the proxy interface for the Rendezvous secure daemons
(rvsd and rvsrd), and the immediate-access data objects that support it.

Topics

• SecureDaemonProxy, page 182

• NetworkServicePair, page 203
• User, page 207
• UserCertificate, page 217

See Also • RvsdInformation, page 340

• RvsrdInformation, page 342

TIBCO Rendezvous Configuration Tools

182
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy
Interface

Declaration interface com.tibco.tibrv.config.SecureDaemonProxy

extends DaemonProxy

Purpose Define methods for Rendezvous secure daemons.

(Sheet 1 of 2)

Method Description Page

SecureDaemonProxy.addUser() Authorize a user to connect 185
to the secure daemon.
SecureDaemonProxy.addUsers()

SecureDaemonProxy.authorizeListen() Authorize all users to listen 186

to a subject.

SecureDaemonProxy.authorizeListenAndSend() Authorize all users to listen 187

and to send to a subject.

SecureDaemonProxy.authorizeNetworkAndService() Authorize all users to 188

communicate on a network
SecureDaemonProxy.authorizeNetworksAndServices()
and service pair.

SecureDaemonProxy.authorizeSend() Authorize all users to send 190

to a subject.

SecureDaemonProxy.getDefaultNetworkAndService() Get the default network 191

and service pair of the
secure daemon.

SecureDaemonProxy.getListen() Get the subjects authorized 192

for listening.

SecureDaemonProxy.getNetworksAndServices() Get the authorized network 193

and service pairs of the
secure daemon.

SecureDaemonProxy.getSend() Get the subjects authorized 194

for sending.

SecureDaemonProxy.getUser() Get the authorized users of 195

the secure daemon.
SecureDaemonProxy.getUsers()

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy 183
|

(Sheet 2 of 2)

Method Description Page

SecureDaemonProxy.removeListen() Remove authorization to 196
listen to a subject.

SecureDaemonProxy.removeListenAndSend() Remove authorization to 197

listen and send to a subject.

SecureDaemonProxy.removeNetworkAndService() Remove authorization to 198

communicate on a network
SecureDaemonProxy.removeNetworksAndServices()
and service pair.

SecureDaemonProxy.removeSend() Remove authorization to 200

send to a subject.

SecureDaemonProxy.removeUser() Remove a user of the secure 201

daemon.
SecureDaemonProxy.removeUsers()

SecureDaemonProxy.setDefaultNetworkAndService() Set the default network and 202

service pair of the secure
daemon.

Inherited Methods
DaemonProxy.getComponentName()
DaemonProxy.getComponentInformation()

XmlSerializable.printXml()
XmlSerializable.toXml()

Components These components support this interface:

rvsd
rvsrd

See Also For information about the parameters that this interface can access, see these
sections:
• Secure Daemons (rvsd and rvsrd) on page 169 in TIBCO Rendezvous
Administration
• Browser Administration Interface—rvrd on page 134 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

184
| Chapter 6 Secure Daemons—rvsd & rvsrd

• Browser Administration Interface—rvsd and rvsrd on page 190 in TIBCO

Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.addUser() 185
|

SecureDaemonProxy.addUser()
Method

Related Form SecureDaemonProxy.addUsers()

Declaration User addUser(

java.lang.String username)
throws ConfigurationException

User[] addUsers(
java.lang.String[] usernames)
throws ConfigurationException

Purpose Authorize a user to connect to the secure daemon.

Remarks After this method returns, you must configure the security credentials of the
resulting User object.
When adding more than one user, the second method is faster than repeatedly
calling the first method.

Parameter Description
username Add a new user with this name.

usernames Add a new user for each name in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.getUser() on page 195
SecureDaemonProxy.removeUser() on page 201
User on page 207
For the corresponding browser pages, see Users on page 201 in TIBCO Rendezvous
Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

186
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.authorizeListen()
Method

Declaration SecureDaemonProxy authorizeListen(

java.lang.String subject)
throws ConfigurationException

SecureDaemonProxy authorizeListen(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Authorize all users to listen to a subject.

Remarks When authorizing more than one subject, the second method is faster than
repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
subject Authorize subscriptions to this subject.

subjects Authorize subscriptions to all the subjects in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeListenAndSend() on page 187
SecureDaemonProxy.authorizeSend() on page 190
SecureDaemonProxy.getListen() on page 192
SecureDaemonProxy.removeListen() on page 196
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.authorizeListenAndSend() 187
|

SecureDaemonProxy.authorizeListenAndSend()
Method

Declaration SecureDaemonProxy authorizeListenAndSend(

java.lang.String subject)
throws ConfigurationException

SecureDaemonProxy authorizeListenAndSend(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Authorize all users to listen and to send to a subject.

Remarks When authorizing more than one subject, the second method is faster than
repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
subject Authorize subscriptions and sending to this subject.

subjects Authorize subscriptions and sending to all the subjects in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeListen() on page 186
SecureDaemonProxy.authorizeSend() on page 190
SecureDaemonProxy.removeListenAndSend() on page 197
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

188
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.authorizeNetworkAndService()
Method

Related Form SecureDaemonProxy.authorizeNetworksAndServices()

Declaration SecureDaemonProxy authorizeNetworkAndService(

java.lang.String networkSpecification,
int servicePort)
throws ConfigurationException

SecureDaemonProxy authorizeNetworksAndServices(
java.lang.String[] networksServices)
throws ConfigurationException

Purpose Authorize all users to communicate on a network and service pair.

Remarks When authorizing more than one pairing of network and service, the second
method is faster than repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
networkSpecification Authorize communication on this network.

servicePort Authorize communication on this UDP or PGM service.

networksServices Authorize communication on each pairing of network and service in

this array. Each element in the array is a string that combines the
network parameter with a UDP or PGM service, separated by a colon;
for example: ";225.1.1.1:5238"
To construct the two parts of these strings, see:
• Constructing the Network Parameter on page 23 in TIBCO
Rendezvous Administration
• Specifying the UDP or PGM Service on page 21 in TIBCO
Rendezvous Administration.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.getNetworksAndServices() on page 193
SecureDaemonProxy.removeNetworkAndService() on page 198
NetworkServicePair on page 203

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.authorizeNetworkAndService() 189
|

For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Network and Service Authorization on page 175
in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

190
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.authorizeSend()
Method

Declaration SecureDaemonProxy authorizeSend(

java.lang.String subject)
throws ConfigurationException

SecureDaemonProxy authorizeSend(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Authorize all users to send to a subject.

Remarks When authorizing more than one subject, the second method is faster than
repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
subject Authorize sending to this subject.

subjects Authorize sending to all the subjects in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeListen() on page 186
SecureDaemonProxy.authorizeListenAndSend() on page 187
SecureDaemonProxy.getSend() on page 194
SecureDaemonProxy.removeSend() on page 200
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.getDefaultNetworkAndService() 191
|

SecureDaemonProxy.getDefaultNetworkAndService()
Method

Declaration NetworkServicePair getDefaultNetworkAndService()

throws ConfigurationException

Purpose Get the default network and service pair of the secure daemon.

Remarks When a client transport does not specify particular network and service
parameters, it automatically communicates over this default network and service.
For example, when the client program supplies null values for either of these
parameters, the secure daemon supplies this pair as a default.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.setDefaultNetworkAndService() on page 202
NetworkServicePair on page 203
For the corresponding browser pages, see Default Network and Service on
page 180 in TIBCO Rendezvous Administration
For background information, see Network and Service Authorization on page 175
in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

192
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.getListen()
Method

Declaration java.lang.String[] getListen()

throws ConfigurationException

Purpose Get the subjects authorized for listening.

Remarks This method returns an array of subject names. All authenticated users can
subscribe to any of the subjects in the array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeListen() on page 186
SecureDaemonProxy.getSend() on page 194
SecureDaemonProxy.removeListen() on page 196
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.getNetworksAndServices() 193
|

SecureDaemonProxy.getNetworksAndServices()
Method

Declaration NetworkServicePair[] getNetworksAndServices()

throws ConfigurationException

Purpose Get the authorized network and service pairs of the secure daemon.

Remarks To convert the resulting array of NetworkServicePair objects to an array of

strings (suitable as an argument to
SecureDaemonProxy.removeNetworkAndService() on page 198), iterate through
the array, applying NetworkServicePair.toString() to each element.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeNetworkAndService() on page 188
SecureDaemonProxy.removeNetworkAndService() on page 198
NetworkServicePair on page 203
For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Network and Service Authorization on page 175
in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

194
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.getSend()
Method

Declaration java.lang.String[] getSend()

throws ConfigurationException

Purpose Get the subjects authorized for sending.

Remarks This method returns an array of subject names. All authenticated users can send
to any of the subjects in the array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeSend() on page 190
SecureDaemonProxy.getListen() on page 192
SecureDaemonProxy.removeSend() on page 200
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.getUser() 195
|

SecureDaemonProxy.getUser()
Method

Related Form SecureDaemonProxy.getUsers()

Declaration User getUser(

java.lang.String username)
throws ConfigurationException

User[] getUsers()
throws ConfigurationException

Purpose Get the authorized users of the secure daemon.

Remarks The first method finds a user by name. The second method gets a list of all users.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.addUser() on page 185
SecureDaemonProxy.removeUser() on page 201
User on page 207
For the corresponding browser pages, see Users on page 201 in TIBCO Rendezvous
Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

196
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.removeListen()
Method

Declaration SecureDaemonProxy removeListen(

java.lang.String subject)
throws ConfigurationException

SecureDaemonProxy removeListen(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove authorization to listen to a subject.

Remarks When removing more than one subject, the second method is faster than
repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
subject Remove authorization to listen to this subject.

subjects Remove authorization to listen to the subjects in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeListen() on page 186
SecureDaemonProxy.getListen() on page 192
SecureDaemonProxy.removeListenAndSend() on page 197
SecureDaemonProxy.removeSend() on page 200
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.removeListenAndSend() 197
|

SecureDaemonProxy.removeListenAndSend()
Method

Declaration SecureDaemonProxy removeListenAndSend(

java.lang.String subject)
throws ConfigurationException

SecureDaemonProxy removeListenAndSend(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove authorization to listen and send to a subject.

Remarks When removing more than one subject, the second method is faster than
repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
subject Remove authorization to listen and send to this subject.

subjects Remove authorization to listen and send to the subjects in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeListenAndSend() on page 187
SecureDaemonProxy.removeListen() on page 196
SecureDaemonProxy.removeSend() on page 200
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

198
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.removeNetworkAndService()
Method

Related Form SecureDaemonProxy.removeNetworksAndServices()

Declaration SecureDaemonProxy removeNetworkAndService(

java.lang.String networkSpecification,
int servicePort)
throws ConfigurationException

SecureDaemonProxy removeNetworksAndServices(
java.lang.String[] networksServices)
throws ConfigurationException

Purpose Remove authorization to communicate on a network and service pair.

Remarks When removing more than one pairing of network and service, the second
method is faster than repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
networkSpecification Remove authorization for this network.

servicePort Remove authorization for this UDP or PGM service.

networksServices Remove authorization for each pairing of network and service in this
array. Each element in the array is a string that combines the network
parameter with a UDP or PGM service; for example:
";225.1.1.1:5238"

To construct the two parts of these strings, see:

• Constructing the Network Parameter on page 23 in TIBCO
Rendezvous Administration
• Specifying the UDP or PGM Service on page 21 in TIBCO
Rendezvous Administration.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeNetworkAndService() on page 188
SecureDaemonProxy.getNetworksAndServices() on page 193
NetworkServicePair on page 203

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.removeNetworkAndService() 199
|

For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Network and Service Authorization on page 175
in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

200
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.removeSend()
Method

Declaration SecureDaemonProxy removeSend(

java.lang.String subject)
throws ConfigurationException

SecureDaemonProxy removeSend(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove authorization to send to a subject.

Remarks When removing more than one subject, the second method is faster than
repeatedly calling the first method.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
subject Remove authorization to send to this subject.

subjects Remove authorization to send to the subjects in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.authorizeSend() on page 190
SecureDaemonProxy.getSend() on page 194
SecureDaemonProxy.removeListen() on page 196
SecureDaemonProxy.removeListenAndSend() on page 197
For the corresponding browser pages, see Authorize Subjects on page 204 in
TIBCO Rendezvous Administration
For background information, see Subject Authorization on page 175 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 SecureDaemonProxy.removeUser() 201
|

SecureDaemonProxy.removeUser()
Method

Related Form SecureDaemonProxy.removeUsers()

Declaration SecureDaemonProxy removeUser(

java.lang.String username)
throws ConfigurationException

SecureDaemonProxy[] removeUsers(
java.lang.String[] usernames)
throws ConfigurationException

Purpose Remove a user of the secure daemon.

Remarks Removing a user prevents the user from connecting to the secure daemon.
When removing more than one user, the second method is faster than repeatedly
calling the first method.
If this method throws an exception while removing more than one user, your code
must handle the exception by checking the remaining users carefully. When the
exception interrupted the call, some items might have been removed, while other
items might not yet have been removed.
These methods return the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
username Remove a user with this name.

usernames Remove all the users named in this array.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.addUser() on page 185
SecureDaemonProxy.getUser() on page 195
For the corresponding browser pages, see Users on page 201 in TIBCO Rendezvous
Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

202
| Chapter 6 Secure Daemons—rvsd & rvsrd

SecureDaemonProxy.setDefaultNetworkAndService()
Method

Declaration SecureDaemonProxy setDefaultNetworkAndService(

java.lang.String networkSpecification,
int servicePort)
throws ConfigurationException

Purpose Set the default network and service pair of the secure daemon.

Remarks When a client transport does not specify particular network and service
parameters, it automatically communicates over this default network and service.
For example, when the client program supplies null values for either of these
parameters, the secure daemon supplies this pair as a default.
This method returns the SecureDaemonProxy object, so programs can
conveniently chain additional method calls to the return value.

Parameter Description
networkSpecification Use this network as the default.

servicePort Use this UDP or PGM service as the default.

See Also SecureDaemonProxy on page 182

SecureDaemonProxy.getDefaultNetworkAndService() on page 191
NetworkServicePair on page 203
For the corresponding browser pages, see Default Network and Service on
page 180 in TIBCO Rendezvous Administration
For background information, see Network and Service Authorization on page 175
in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 NetworkServicePair 203
|

NetworkServicePair
Class

Declaration class com.tibco.tibrv.config.NetworkServicePair

extends java.lang.Object

Purpose Represent an network and service pair in a daemon component.

Remarks The method SecureDaemonProxy.getNetworksAndServices() and related

methods return objects of this class.

Constant Description
NetworkServicePair.UNSPECIFIED No value is set for this parameter.

Method Description Page

NetworkServicePair.getNetwork() Get the network. 204

NetworkServicePair.getService() Get the UDP or PGM service. 205

NetworkServicePair.toXml() Format the network and service 206

pair as an XML document.

Inherited Methods
java.lang.Object.equals()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString() override
java.lang.Object.wait()

See Also SecureDaemonProxy.getDefaultNetworkAndService() on page 191

SecureDaemonProxy.getNetworksAndServices() on page 193
For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Limiting Access on page 175 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

204
| Chapter 6 Secure Daemons—rvsd & rvsrd

NetworkServicePair.getNetwork()
Method

Declaration java.lang.String getNetwork()

Purpose Get the network.

See Also NetworkServicePair on page 203

For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Limiting Access on page 175 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 NetworkServicePair.getService() 205
|

NetworkServicePair.getService()
Method

Declaration int getService()

Purpose Get the UDP or PGM service.

See Also NetworkServicePair on page 203

For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Limiting Access on page 175 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

206
| Chapter 6 Secure Daemons—rvsd & rvsrd

NetworkServicePair.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the network and service pair as an XML document.

See Also NetworkServicePair on page 203

For the corresponding browser pages, see Authorize Network and Service Pairs
on page 203 in TIBCO Rendezvous Administration
For background information, see Limiting Access on page 175 in TIBCO
Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 User 207
|

User
Class

Declaration class com.tibco.tibrv.config.User

extends java.lang.Object

Purpose Represent a user record in a secure daemon component.

Remarks The method SecureDaemonProxy.getUser() and related methods return objects

of this class.
For security, you cannot get an existing password from a User object; however,
you may clear it and set a new one.

Method Description Page

User.addCertificateFromFile() Read user certificate data from a PEM file. 208

User.addCertificateFromText() Add a user certificate. 209

User.addCertificateFromPKCS12File() Read user certificate data from a PKCS #12 210

file.

User.clearPassword() Clear the user’s password. 211

User.getCertificates() Get all public certificates of the user. 212

User.getUsername() Get the username of the user. 213

User.removeCertificate() Remove a user certificate. 214

User.removeCertificates()

User.setPassword() Set a user’s password. 215

User.toXml() Format the user information as an XML 216

document.

See Also SecureDaemonProxy.addUser() on page 185

SecureDaemonProxy.getUser() on page 195
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

208
| Chapter 6 Secure Daemons—rvsd & rvsrd

User.addCertificateFromFile()
Method

Declaration UserCertificate addCertificateFromFile(

java.lang.String pathname)
throws ConfigurationException

Purpose Read user certificate data from a PEM file.

Parameter Description
pathname Read certificate data from this file.
The file must contain a public certificate in PEM encoding.

See Also User on page 207

User.addCertificateFromText() on page 209
User.getCertificates() on page 212
User.removeCertificate() on page 214
UserCertificate on page 217
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 User.addCertificateFromText() 209
|

User.addCertificateFromText()
Method

Declaration UserCertificate addCertificateFromText(

java.lang.String PEM_data)
throws ConfigurationException

Purpose Add a user certificate.

Parameter Description
PEM_data Add a new user certificate corresponding to this data.
The data must specify a public certificate in PEM encoding.

See Also User on page 207

User.addCertificateFromFile() on page 208
User.getCertificates() on page 212
User.removeCertificate() on page 214
UserCertificate on page 217
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

210
| Chapter 6 Secure Daemons—rvsd & rvsrd

User.addCertificateFromPKCS12File()
Method

Declaration UserCertificate addCertificateFromPKCS12File(

java.lang.String pathname,
java.lang.String password)
throws ConfigurationException

Purpose Read user certificate data from a PKCS #12 file.

Parameter Description
pathname Read certificate data from this file.
The file must contain a public certificate in PKCS #12 format.

password Supply a password to decode the PKCS #12 file.

See Also User on page 207

User.addCertificateFromFile() on page 208
User.getCertificates() on page 212
User.removeCertificate() on page 214
UserCertificate on page 217
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 User.clearPassword() 211
|

User.clearPassword()
Method

Declaration User clearPassword()

throws ConfigurationException

Purpose Clear the user’s password.

Remarks This method returns the User object, so programs can conveniently chain
additional method calls to the return value.

See Also User on page 207

User.setPassword() on page 215
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

212
| Chapter 6 Secure Daemons—rvsd & rvsrd

User.getCertificates()
Method

Declaration UserCertificate[] getCertificates()

throws ConfigurationException

Purpose Get all public certificates of the user.

See Also User on page 207

User.addCertificateFromFile() on page 208
User.addCertificateFromText() on page 209
User.removeCertificate() on page 214
UserCertificate on page 217
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 User.getUsername() 213
|

User.getUsername()
Method

Declaration java.lang.String getUsername()

Purpose Get the username of the user.

Remarks User credentials can be either a username and password pair, or an X.509
certificate.

See Also User on page 207

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

214
| Chapter 6 Secure Daemons—rvsd & rvsrd

User.removeCertificate()
Method

Related Form User.removeCertificates()

Declaration User removeCertificate(

int id)
throws ConfigurationException

User removeCertificates(
int[] ids)
throws ConfigurationException

Purpose Remove a user certificate.

Remarks These methods use internal certificate ID numbers to select the certificates to
remove; see UserCertificate.getId() on page 220.
These methods return the User object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
id Remove the user certificate with this certificate ID.

ids Remove the user certificates with these certificate IDs.

See Also User on page 207

User.addCertificateFromFile() on page 208
User.addCertificateFromText() on page 209
User.getCertificates() on page 212
UserCertificate on page 217
UserCertificate.getId() on page 220
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 User.setPassword() 215
|

User.setPassword()
Method

Declaration User setPassword(

java.lang.String password)
throws ConfigurationException

Purpose Set a user’s password.

Remarks This method returns the User object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
password Use this string as the user’s new password.

See Also User on page 207

User.clearPassword() on page 211
For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

216
| Chapter 6 Secure Daemons—rvsd & rvsrd

User.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the user information as an XML document.

See Also User on page 207

For the corresponding browser page, see Users on page 173 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 UserCertificate 217
|

UserCertificate
Class

Declaration class com.tibco.tibrv.config.UserCertificate

extends java.lang.Object

Purpose Represent an user’s public certificate.

Remarks The method User.getCertificates() and related methods return objects of this
class.

(Sheet 1 of 2)

Method Description Page

UserCertificate.getAssignmentDate() Get the date that the daemon registered 219
the certificate and assigned its ID.

UserCertificate.getId() Get the certificate ID assigned by the 220

daemon.

UserCertificate.getIndex() Get the index of the certificate. 221

UserCertificate.getIssuer() Get the certificate authority that issued 222

the certificate.

UserCertificate.getFileName() Get the name of the certificate file. 223

UserCertificate.getPublicKeyEngine() Get the name of the public key algorithm 224

that the certificate uses to create digital
signatures.

UserCertificate.getSerialNumber() Get the internal serial number of the 225

certificate.

UserCertificate.getSubject() Get information describing the authorized 226

certificate holder.

UserCertificate.getValidNotAfter() Get the certificate’s expiration date. 227

UserCertificate.getValidNotBefore() Get the date that the certificate is first 228

valid for use.

UserCertificate.getVersion() Get the certificate version number 229

assigned by the issuer.

TIBCO Rendezvous Configuration Tools

218
| Chapter 6 Secure Daemons—rvsd & rvsrd

(Sheet 2 of 2)

Method Description Page

UserCertificate.toXml() Format the user’s X.509 certificate 230
information as an XML document.

See Also User.getCertificates() on page 212

For the corresponding browser pages, see Users on page 201 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 UserCertificate.getAssignmentDate() 219
|

UserCertificate.getAssignmentDate()
Method

Declaration java.lang.String getAssignmentDate()

throws ConfigurationException

Purpose Get the date that the daemon registered the certificate and assigned its ID.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

220
| Chapter 6 Secure Daemons—rvsd & rvsrd

UserCertificate.getId()
Method

Declaration int getId()

Purpose Get the certificate ID assigned by the daemon.

Remarks Use this ID to remove certificates with User.removeCertificate() on page 214.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 UserCertificate.getIndex() 221
|

UserCertificate.getIndex()
Method

Declaration int getIndex()

throws ConfigurationException

Purpose Get the index of the certificate.

Remarks The index reflects the position of the certificate within the user’s list of certificates.
Index 1 denotes the first certificate.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

222
| Chapter 6 Secure Daemons—rvsd & rvsrd

UserCertificate.getIssuer()
Method

Declaration java.lang.String getIssuer()

throws ConfigurationException

Purpose Get the certificate authority that issued the certificate.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 UserCertificate.getFileName() 223
|

UserCertificate.getFileName()
Method

Declaration java.lang.String getFileName()

throws ConfigurationException

Purpose Get the name of the certificate file.

Remarks If the method User.addCertificateFromFile() created this certificate, then this

method returns the name of the file from which the daemon read the certificate
data. Otherwise, this method returns null.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

224
| Chapter 6 Secure Daemons—rvsd & rvsrd

UserCertificate.getPublicKeyEngine()
Method

Declaration java.lang.String getPublicKeyEngine()

throws ConfigurationException

Purpose Get the name of the public key algorithm that the certificate uses to create digital
signatures.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 UserCertificate.getSerialNumber() 225
|

UserCertificate.getSerialNumber()
Method

Declaration java.lang.String getSerialNumber()

throws ConfigurationException

Purpose Get the internal serial number of the certificate.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

226
| Chapter 6 Secure Daemons—rvsd & rvsrd

UserCertificate.getSubject()
Method

Declaration java.lang.String getSubject()

throws ConfigurationException

Purpose Get information describing the authorized certificate holder.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 UserCertificate.getValidNotAfter() 227
|

UserCertificate.getValidNotAfter()
Method

Declaration java.lang.String getValidNotAfter()

Purpose Get the certificate’s expiration date.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

228
| Chapter 6 Secure Daemons—rvsd & rvsrd

UserCertificate.getValidNotBefore()
Method

Declaration java.lang.String getValidNotBefore()

Purpose Get the date that the certificate is first valid for use.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

 UserCertificate.getVersion() 229
|

UserCertificate.getVersion()
Method

Declaration java.lang.String getVersion()

Purpose Get the certificate version number assigned by the issuer.

See Also UserCertificate on page 217

For the corresponding browser page, see Existing Users on page 202 in TIBCO
Rendezvous Administration
For background information, see Users on page 173 in TIBCO Rendezvous
Administration.

TIBCO Rendezvous Configuration Tools

230
| Chapter 6 Secure Daemons—rvsd & rvsrd

UserCertificate.toXml()
Method

Declaration java.lang.String toXml()

Purpose Format the user’s X.509 certificate information as an XML document.

See Also User on page 207

For the corresponding browser page, see Users on page 201 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 | 231

Chapter 7 Rendezvous Agent—rva

This chapter describes the proxy interface for the Rendezvous agent component
(rva), and the immediate-access data objects that support it.

Topics

• RvaProxy, page 232

• HttpTunnelParams, page 251
• RvaNetworkParams, page 264

See Also • RvaInformation, page 320

TIBCO Rendezvous Configuration Tools

232
| Chapter 7 Rendezvous Agent—rva

RvaProxy
Interface

Declaration interface com.tibco.tibrv.config.RvaProxy

extends DaemonProxy

Purpose Define methods for Rendezvous agents.

Constant Description
RvaProxy.DEFAULT_ACTIVE_FLUSH Default value, 3 seconds.

RvaProxy.DEFAULT_CLIENT_TIMEOUT Default value, 120 seconds.

RvaProxy.DEFAULT_INACTIVE_FLUSH Default value, 3 seconds.

RvaProxy.DEFAULT_MAX_CLIENT_QUEUE Default value, 500 messages.

RvaProxy.DEFAULT_MAX_PROXY_BUFFER Default value, 8 kilobytes.

RvaProxy.DEFAULT_MAX_QUEUE_SIZE Default value, 0 (no limit).

RvaProxy.DEFAULT_PING_INTERVAL Default value, 120 seconds.

RvaProxy.DEFAULT_REQUEST_FLUSH Default value, 3 seconds.

RvaProxy.DEFAULT_TUNNEL_PORT Default value, 0.

RvaProxy.IDLE_STATE Represent the idle state of rva.

Supply this constant to RvaProxy.changeState().

RvaProxy.RUNNING_STATE Represent the running state of rva.

Supply this constant to RvaProxy.changeState().

(Sheet 1 of 2)

Method Description Page

RvaProxy.addExportSubject() Add a subject for export. 235

RvaProxy.addSubject() Add a subject for import and export. 237

RvaProxy.addImportSubject() Add a subject for import. 236

TIBCO Rendezvous Configuration Tools

 RvaProxy 233
|

(Sheet 2 of 2)

Method Description Page

RvaProxy.changeState() Change the state of a Rendezvous agent 238
process.

RvaProxy.getExportSubjects() Get export subjects. 239

RvaProxy.getHttpTunnelParams() Get the agent’s HTTP tunnel 240

parameters.

RvaProxy.getImportSubjects() Get import subjects. 241

RvaProxy.getNetworkParams() Get parameters that specify the agent’s 242

network connections.

RvaProxy.isRunning() Determine the state of rva—running or 243

idle.

RvaProxy.removeExportSubject() Remove a subject for export. 244

RvaProxy.removeExportSubjects()

RvaProxy.removeImportSubject() Remove a subject for import. 245

RvaProxy.removeImportSubjects()

RvaProxy.removeSubject() Remove a subject for import and export. 246

RvaProxy.removeSubjects()

RvaProxy.setHttpTunnelParams() Set the agent’s HTTP tunnel 247

parameters.

RvaProxy.setNetworkParams() Set parameters that specify the agent’s 250

network connections.

Inherited Methods
DaemonProxy.getComponentName()
DaemonProxy.getComponentInformation()

XmlSerializable.printXml()
XmlSerializable.toXml()

Components The component rva supports this interface.

TIBCO Rendezvous Configuration Tools

234
| Chapter 7 Rendezvous Agent—rva

See Also For information about the parameters that this interface can access, see these
sections:
• Rendezvous Agent (rva) on page 267 in TIBCO Rendezvous Administration
• Browser Administration Interface on page 271 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

 RvaProxy.addExportSubject() 235
|

RvaProxy.addExportSubject()
Method

Declaration RvaProxy addExportSubject(

java.lang.String subject)
throws ConfigurationException

Purpose Add a subject for export.

Remarks rva exports messages from the network to clients (applets).

This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
subject Permit rva to export matching subjects. Wildcards are permitted.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

236
| Chapter 7 Rendezvous Agent—rva

RvaProxy.addImportSubject()
Method

Declaration RvaProxy addImportSubject(

java.lang.String subject)
throws ConfigurationException

Purpose Add a subject for import.

Remarks rva imports messages from clients (applets) to the network.

This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
subject Permit rva to import matching subjects. Wildcards are permitted.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvaProxy.addSubject() 237
|

RvaProxy.addSubject()
Method

Declaration RvaProxy addSubject(

java.lang.String subject)
throws ConfigurationException

Purpose Add a subject for import and export.

Remarks rvaimports messages from clients (applets) to the network—and exports

messages from the network to clients (applets).
This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
subject Permit rva to import and export matching subjects. Wildcards are
permitted.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

238
| Chapter 7 Rendezvous Agent—rva

RvaProxy.changeState()
Method

Declaration RvaProxy changeState(

int state)
throws ConfigurationException

RvaProxy changeState()
throws ConfigurationException

Purpose Change the state of a Rendezvous agent process.

Remarks The first method changes to the state that the argument specifies. The second
method toggles the current state.
These methods return the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
state Change to this state.
Supply one of two constants; either RvaProxy.IDLE_STATE or
RvaProxy.RUNNING_STATE.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvaProxy.getExportSubjects() 239
|

RvaProxy.getExportSubjects()
Method

Declaration java.lang.String[] getExportSubjects()

throws ConfigurationException

Purpose Get export subjects.

Remarks rva exports messages from the network to clients (applets).

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

240
| Chapter 7 Rendezvous Agent—rva

RvaProxy.getHttpTunnelParams()
Method

Declaration HttpTunnelParams getHttpTunnelParams()

throws ConfigurationException

Purpose Get the agent’s HTTP tunnel parameters.

See Also RvaProxy on page 232

RvaProxy.setHttpTunnelParams() on page 247
For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvaProxy.getImportSubjects() 241
|

RvaProxy.getImportSubjects()
Method

Declaration java.lang.String[] getImportSubjects()

throws ConfigurationException

Purpose Get import subjects.

Remarks rva imports messages from clients (applets) to the network.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

242
| Chapter 7 Rendezvous Agent—rva

RvaProxy.getNetworkParams()
Method

Declaration RvaNetworkParams getNetworkParams()

throws ConfigurationException

Purpose Get parameters that specify the agent’s network connections.

Remarks rva mediates between its clients (applets) and a Rendezvous daemon (rvd).

See Also RvaProxy on page 232

RvaProxy.setNetworkParams() on page 250
For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvaProxy.isRunning() 243
|

RvaProxy.isRunning()
Method

Declaration boolean isRunning()

throws ConfigurationException

Purpose Determine the state of rva—running or idle.

Remarks This method returns true if the state of rva is running; false if its state is idle.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

244
| Chapter 7 Rendezvous Agent—rva

RvaProxy.removeExportSubject()
Method

Related Forms RvaProxy.removeExportSubjects()

Declaration RvaProxy removeExportSubject(

java.lang.String subject)
throws ConfigurationException

RvaProxy removeExportSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove a subject for export.

Remarks These methods stop rva from exporting the subjects.

rva exports messages from the network to clients (applets).
This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
subject Remove this subject from the export list.

subjects Remove these subjects from the export list.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvaProxy.removeImportSubject() 245
|

RvaProxy.removeImportSubject()
Method

Related Forms RvaProxy.removeImportSubjects()

Declaration RvaProxy removeImportSubject(

java.lang.String subject)
throws ConfigurationException

RvaProxy removeImportSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove a subject for import.

Remarks These methods stop rva from importing the subjects.

rva imports messages from clients (applets) to the network.
This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
subject Remove this subject from the import list.

subjects Remove these subjects from the import list.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

246
| Chapter 7 Rendezvous Agent—rva

RvaProxy.removeSubject()
Method

Related Forms RvaProxy.removeSubjects()

Declaration RvaProxy removeSubject(

java.lang.String subject)
throws ConfigurationException

RvaProxy removeSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove a subject for import and export.

Remarks These methods stop rva from importing and exporting the subjects.
rvaimports messages from clients (applets) to the network—and exports
messages from the network to clients (applets).
This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
subject Remove this subject from the import and export lists.

subjects Remove these subjects from the import and export lists.

See Also RvaProxy on page 232

For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvaProxy.setHttpTunnelParams() 247
|

RvaProxy.setHttpTunnelParams()
Method

Declaration RvaProxy setHttpTunnelParams(

boolean enableHttpTunneling,
int tunnelPort,
int clientTimeout,
int pingInterval,
int maxClientQueue,
int maxQueueSize,
int activeFlush,
int inactiveFlush,
int requestFlush,
int maxProxyBuffer)
throws ConfigurationException

Purpose Set the agent’s HTTP tunnel parameters.

Remarks This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.
For an overview of HTTP tunneling, see these sections:
• HTTP Tunneling on page 15 in TIBCO Rendezvous Java Reference
• HTTP Tunnel on page 279 in TIBCO Rendezvous Administration
• TibrvRvaTransport on page 223 in TIBCO Rendezvous Java Reference

(Sheet 1 of 3)

Parameter Description
enableHttpTunneling When enabled, rva accepts HTTP connections from client transports. To
enable HTTP tunneling, check this box.

tunnelPort rva accepts HTTP connections from client transports on this this port.

clientTimeout In some situations, rva closes HTTP connections to flush data to clients
through intervening proxy servers. Each client transport subsequently
reestablishes its connection after a delay (specified in the client program).
Meanwhile, rva maintains state information for the client. If this timeout
expires before the client reconnects, rva can discard the state
information.
Ensure that this parameter (in seconds) is much greater than the
reconnect delay parameter of every client transport.

TIBCO Rendezvous Configuration Tools

248
| Chapter 7 Rendezvous Agent—rva

(Sheet 2 of 3)

Parameter Description
pingInterval Intervening proxy servers might automatically close client connections
to rva that appear inactive. To circumvent this feature, rva sends ping
messages to clients when a connection has been idle for this interval (in
seconds).
To disable this feature, supply zero.

maxClientQueue rva limits the length of the data queue for each client (data is outbound
from rva, inbound to the client). When a queue exceeds this number of
messages, rva discards subsequent messages as they arrive.
To disable this feature, supply zero.

maxQueueSize rva limits the size of the data queue for each client (data is outbound
from rva, inbound to the client). When a queue exceeds this size (in
kilobytes), rva discards subsequent messages as they arrive.
To disable this feature, supply zero.

activeFlush This parameter limits data latency (in seconds) caused by buffering in
intervening proxy servers. If rva has directed data to a client, and this
time limit has elapsed since rva last flushed the data, then rva closes the
connection to force proxy servers to deliver the data to the client. This
action occurs even when rva has more data queued for the client (that is,
the queue is active).
If you are certain that no proxy servers intervene between rva and the
client, set this parameter to zero.

inactiveFlush This parameter limits data latency (in seconds) caused by buffering in
intervening proxy servers. If rva has directed data to a client, and does
not have more data queued for the client (that is, the queue is inactive),
and this time limit has elapsed since rva last directed data to the client,
then rva closes the connection to force proxy servers to deliver the data
to the client.
If you are certain that no proxy servers intervene between rva and the
client, set this parameter to zero.

requestFlush This parameter limits data latency (in seconds) for reply messages. In some
application domains, the client sends a request message, and receives
only one small reply message. Setting this parameter smaller than
inactiveFlush can expedites delivery of such reply messages to the
client.

TIBCO Rendezvous Configuration Tools

 RvaProxy.setHttpTunnelParams() 249
|

(Sheet 3 of 3)

Parameter Description
maxProxyBuffer This hint estimates the size of the largest buffer (in kilobytes) in
intervening proxy servers. Before triggering an active flush, rva checks
the amount of data it directed to the client since the last flush; if that
amount is greater than this value, the proxy server has probably flushed
its buffer automatically, so rva does not close the connection to flush the
data.
If you are certain that no proxy servers intervene between rva and the
client, set this parameter to zero.

See Also RvaProxy on page 232

RvaProxy.getHttpTunnelParams() on page 240
For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

250
| Chapter 7 Rendezvous Agent—rva

RvaProxy.setNetworkParams()
Method

Declaration RvaProxy setNetworkParams(

int listenPort,
int servicePort,
java.lang.String networkSpecification,
java.lang.String daemonSpecification)
throws ConfigurationException

Purpose Set parameters that specify the agent’s network connections.

Remarks rva mediates between its clients (applets) and a Rendezvous daemon (rvd).
Changes to these parameters take effect only upon rva state transition from idle
to running.
This method returns the RvaProxy object, so programs can conveniently chain
additional method calls to the return value.

Parameter Description
listenPort rvalistens for client connection requests (from Java programs) on this
TCP port.

servicePort rva communicates with rvd on this UDP or PGM service.

networkSpecification rva communicates with rvd on this network.

daemonSpecification rva requests a client connection to rvd on this TCP port.

See Also RvaProxy on page 232

RvaProxy.getNetworkParams() on page 242
For background information, see Browser Administration Interface on page 271 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams 251
|

HttpTunnelParams
Class

Declaration class com.tibco.tibrv.config.HttpTunnelParams

extends java.lang.Object

Purpose Encapsulate HTTP tunnel parameters from Rendezvous agents.

Method Description Page

HttpTunnelParams.getActiveFlush() Extract the active flush interval 253
(in seconds).

HttpTunnelParams.getAsMap() Format the HTTP tunnel 254

parameters as a map.

HttpTunnelParams.getClientTimeout() Extract the client timeout interval 255

(in seconds).

HttpTunnelParams.getInactiveFlush() Extract the inactive flush interval 256

(in seconds).

HttpTunnelParams.getMaxClientQueue() Extract the maximum length (in 257

messages) of a client queue.

HttpTunnelParams.getMaxProxyBuffer() Extract the maximum size (in 258

bytes) of a proxy server buffer.

HttpTunnelParams.getMaxQueueSize() Extract the maximum size (in 259

bytes) of a client queue.

HttpTunnelParams.getPingInterval() Extract the ping interval (in 260

seconds).

HttpTunnelParams.getPort() Extract the HTTP port where rva 261

accepts tunneling connections
from Java clients.

HttpTunnelParams.getRequestFlush() Extract the request flush interval 262

(in seconds).

HttpTunnelParams.isEnabled() Extract a flag indicating whether 263

HTTP tunneling connections are
enabled.

TIBCO Rendezvous Configuration Tools

252
| Chapter 7 Rendezvous Agent—rva

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
RvaProxy.getHttpTunnelParams() returns instances of this class.

See Also Read-Only Objects on page 6

RvaProxy.getHttpTunnelParams() on page 240
HttpTunnelParams on page 251
HTTP Tunnel on page 279 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams.getActiveFlush() 253
|

HttpTunnelParams.getActiveFlush()
Method

Declaration int getActiveFlush()

Purpose Extract the active flush interval (in seconds).

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

254
| Chapter 7 Rendezvous Agent—rva

HttpTunnelParams.getAsMap()
Method

Declaration java.util.Map getAsMap()

Purpose Format the HTTP tunnel parameters as a map.

Remarks The resulting map is useful for iterative methods, such as printing.
This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams.getClientTimeout() 255
|

HttpTunnelParams.getClientTimeout()
Method

Declaration int getClientTimeout()

Purpose Extract the client timeout interval (in seconds).

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

256
| Chapter 7 Rendezvous Agent—rva

HttpTunnelParams.getInactiveFlush()
Method

Declaration int getInactiveFlush()

Purpose Extract the inactive flush interval (in seconds).

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams.getMaxClientQueue() 257
|

HttpTunnelParams.getMaxClientQueue()
Method

Declaration int getMaxClientQueue()

Purpose Extract the maximum length (in messages) of a client queue.

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

258
| Chapter 7 Rendezvous Agent—rva

HttpTunnelParams.getMaxProxyBuffer()
Method

Declaration int getMaxProxyBuffer()

Purpose Extract the maximum size (in bytes) of a proxy server buffer.

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams.getMaxQueueSize() 259
|

HttpTunnelParams.getMaxQueueSize()
Method

Declaration int getMaxQueueSize()

Purpose Extract the maximum size (in bytes) of a client queue.

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

260
| Chapter 7 Rendezvous Agent—rva

HttpTunnelParams.getPingInterval()
Method

Declaration int getPingInterval()

Purpose Extract the ping interval (in seconds).

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams.getPort() 261
|

HttpTunnelParams.getPort()
Method

Declaration int getPort()

Purpose Extract the HTTP port where rva accepts tunneling connections from Java clients.

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

262
| Chapter 7 Rendezvous Agent—rva

HttpTunnelParams.getRequestFlush()
Method

Declaration int getRequestFlush()

Purpose Extract the request flush interval (in seconds).

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

 HttpTunnelParams.isEnabled() 263
|

HttpTunnelParams.isEnabled()
Method

Declaration boolean isEnabled()

Purpose Extract a flag indicating whether HTTP tunneling connections are enabled.

Remarks This method does not interact with the component.

See Also HttpTunnelParams on page 251

TIBCO Rendezvous Configuration Tools

264
| Chapter 7 Rendezvous Agent—rva

RvaNetworkParams
Class

Declaration class com.tibco.tibrv.config.RvaNetworkParams

extends java.lang.Object

Purpose Encapsulate network parameters from Rendezvous agents.

Constant Description
RvaNetworkParams.UNSPECIFIED No value is set for the parameter.

Method Description Page

RvaNetworkParams.getAsMap() Format the network parameters as a map. 265

RvaNetworkParams.getDaemon() Extract the daemon parameter. 266

RvaNetworkParams.getListenPort() Extract the listen port parameter. 267

RvaNetworkParams.getNetwork() Extract the network parameter. 268

RvaNetworkParams.getService() Extract the service parameter. 269

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
RvaProxy.getNetworkParams() returns instances of this class.

See Also Read-Only Objects on page 6

RvaProxy.getNetworkParams() on page 242

TIBCO Rendezvous Configuration Tools

 RvaNetworkParams.getAsMap() 265
|

RvaNetworkParams.getAsMap()
Method

Declaration java.util.Map getAsMap()

Purpose Format the network parameters as a map.

Remarks The resulting map is useful for iterative methods, such as printing.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

266
| Chapter 7 Rendezvous Agent—rva

RvaNetworkParams.getDaemon()
Method

Declaration java.lang.String getDaemon()

Purpose Extract the daemon parameter.

Remarks rva requests a client connection to rvd on this TCP port.

This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvaNetworkParams.getListenPort() 267
|

RvaNetworkParams.getListenPort()
Method

Declaration int getListenPort()

Purpose Extract the listen port parameter.

Remarks rva listens for client connection requests (from Java programs) on this TCP port.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

268
| Chapter 7 Rendezvous Agent—rva

RvaNetworkParams.getNetwork()
Method

Declaration java.lang.String getNetwork()

Purpose Extract the network parameter.

Remarks rva communicates with rvd on this network.

This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvaNetworkParams.getService() 269
|

RvaNetworkParams.getService()
Method

Declaration int getService()

Purpose Extract the service parameter.

Remarks rva communicates with rvd on this UDP or PGM service.

This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

270
| Chapter 7 Rendezvous Agent—rva

TIBCO Rendezvous Configuration Tools

 | 271

Chapter 8 Current Value Cache—rvcache

This chapter describes the proxy interface for the Rendezvous recent values cache
component (rvcache), and the immediate-access data objects that support it.

Topics

• RvcacheProxy, page 272

• CachedField, page 285
• CachedSubject, page 289
• FaultToleranceParams, page 297
• RvcacheNetworkParams, page 306

See Also • RvcacheInformation, page 327

TIBCO Rendezvous Configuration Tools

272
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy
Interface

Declaration interface com.tibco.tibrv.config.RvcacheProxy

extends DaemonProxy

Purpose Define methods for a Rendezvous cache process.

Constant Description
RvcacheProxy.DEFAULT_ACTIVATION These three constants represent default values for
rvcache fault tolerance parameters. You may supply
RvcacheProxy.DEFAULT_HEARTBEAT
them to RvcacheProxy.setFaultToleranceParams() on
RvcacheProxy.DEFAULT_WEIGHT page 283.

RvcacheProxy.IDLE_STATE Represent the idle state of rvcache.

Supply this constant to
RvcacheProxy.changeState().

RvcacheProxy.RUNNING_STATE Represent the running state of rvcache.

Supply this constant to
RvcacheProxy.changeState().

RvcacheProxy.UNSPECIFIED Represent a parameter that is not currently specified

in rvcache.

(Sheet 1 of 2)

Method Description Page

RvcacheProxy.addSubjectMerge() Add a subject with merge 274
semantics.
RvcacheProxy.addSubjectsMerge()

RvcacheProxy.addSubjectReplace() Add a subject with replace 275

semantics.
RvcacheProxy.addSubjectsReplace()

RvcacheProxy.changeState() Change the state of an rvcache 276

process.

RvcacheProxy.disableFaultTolerance() Disable fault tolerance machinery. 277

TIBCO Rendezvous Configuration Tools

 RvcacheProxy 273
|

(Sheet 2 of 2)

Method Description Page

RvcacheProxy.getCachedSubjects() Get subjects that this process caches 278

RvcacheProxy.getFaultToleranceParams() Get fault tolerance parameters. 279

RvcacheProxy.getNetworkParams() Get transport parameters. 280

RvcacheProxy.isRunning() Determine the state of rvcache— 281

running or idle.

RvcacheProxy.removeSubject() Remove a subject from the cache. 282

RvcacheProxy.removeSubjects()

RvcacheProxy.setFaultToleranceParams() Enable fault tolerance machinery, 283

and set its parameters.

RvcacheProxy.setNetworkParams() Set transport parameters. 284

Inherited Methods
DaemonProxy.getComponentName()
DaemonProxy.getComponentInformation()

XmlSerializable.printXml()
XmlSerializable.toXml()

Components The component rvcache supports this interface.

See Also For information about the parameters that this interface can access, see these
sections:
• Current Value Cache on page 281 in TIBCO Rendezvous Administration
• Browser Administration Interface on page 296 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

274
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy.addSubjectMerge()
Method

Related Forms RvcacheProxy.addSubjectsMerge()

Declaration RvcacheProxy addSubjectMerge(

java.lang.String subject)
throws ConfigurationException

RvcacheProxy addSubjectsMerge(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Add a subject with merge semantics.

Remarks Merge semantics merges stored data from previous messages with data from new
messages; see Replace and Merge on page 289 in TIBCO Rendezvous
Administration.
This method returns the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
subject Begin caching subjects that match this specification. Wildcards are permitted.

subjects Begin caching subjects that match these specifications. Wildcards are
permitted.

See Also RvcacheProxy on page 272

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvcacheProxy.addSubjectReplace() 275
|

RvcacheProxy.addSubjectReplace()
Method

Related Forms RvcacheProxy.addSubjectsReplace()

Declaration RvcacheProxy addSubjectReplace(

java.lang.String subject)
throws ConfigurationException

RvcacheProxy addSubjectsReplace(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Add a subject with replace semantics.

Remarks Replace semantics replaces stored data from previous messages with data from
new messages; see Replace and Merge on page 289 in TIBCO Rendezvous
Administration.
This method returns the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
subject Begin caching subjects that match this specification. Wildcards are permitted.

subjects Begin caching subjects that match these specifications. Wildcards are
permitted.

See Also RvcacheProxy on page 272

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

276
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy.changeState()
Method

Declaration RvcacheProxy changeState(

int state)
throws ConfigurationException

RvcacheProxy changeState()
throws ConfigurationException

Purpose Change the state of an rvcache process.

Remarks The first method changes to the state that the argument specifies. The second
method toggles the current state.
These methods return the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
state Change to this state.
Supply one of two constants; either RvcacheProxy.IDLE_STATE or
RvcacheProxy.RUNNING_STATE.

See Also RvcacheProxy on page 272

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvcacheProxy.disableFaultTolerance() 277
|

RvcacheProxy.disableFaultTolerance()
Method

Declaration RvcacheProxy disableFaultTolerance()

throws ConfigurationException

Purpose Disable fault tolerance machinery.

Remarks This method returns the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

See Also RvcacheProxy on page 272

For background information, see these sections:
• Fault Tolerance on page 288 in TIBCO Rendezvous Administration
• Browser Administration Interface on page 296 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

278
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy.getCachedSubjects()
Method

Declaration CachedSubject[] getCachedSubjects()

throws ConfigurationException

Purpose Get subjects that this process caches

See Also RvcacheProxy on page 272

CachedSubject on page 289
For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvcacheProxy.getFaultToleranceParams() 279
|

RvcacheProxy.getFaultToleranceParams()
Method

Declaration FaultToleranceParams getFaultToleranceParams()

throws ConfigurationException

Purpose Get fault tolerance parameters.

Remarks This method returns a read only collection of fault tolerance parameters. For
descriptions of the parameters, see RvcacheProxy.setFaultToleranceParams() on
page 283.

See Also RvcacheProxy on page 272

FaultToleranceParams on page 297
For background information, see these sections:
• Fault Tolerance on page 288 in TIBCO Rendezvous Administration
• Browser Administration Interface on page 296 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

280
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy.getNetworkParams()
Method

Declaration RvcacheNetworkParams getNetworkParams()

throws ConfigurationException

Purpose Get transport parameters.

Remarks rvcache uses the transport for all network communication.

This method returns an array of parameters that specify the transport. For
descriptions of the parameters, see RvcacheProxy.setNetworkParams() on
page 284.

See Also RvcacheProxy on page 272

RvcacheProxy.setNetworkParams() on page 284
RvcacheNetworkParams on page 306
For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvcacheProxy.isRunning() 281
|

RvcacheProxy.isRunning()
Method

Declaration boolean isRunning()

throws ConfigurationException

Purpose Determine the state of rvcache—running or idle.

Remarks This method returns true if the state of rvcache is running; false if its state is
idle.

See Also RvcacheProxy on page 272

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

282
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy.removeSubject()
Method

Related Forms RvcacheProxy.removeSubjects()

Declaration RvcacheProxy removeSubject(

java.lang.String subject)
throws ConfigurationException

RvcacheProxy removeSubjects(
java.lang.String[] subjects)
throws ConfigurationException

Purpose Remove a subject from the cache.

Remarks After removing a subject, rvcache no longer stores it, nor forwards its values.
This method returns the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
subject Stop caching subjects that match this specification. Wildcards are permitted.

subjects Stop caching subjects that match these specifications. Wildcards are permitted.

See Also RvcacheProxy on page 272

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 RvcacheProxy.setFaultToleranceParams() 283
|

RvcacheProxy.setFaultToleranceParams()
Method

Declaration RvcacheProxy setFaultToleranceParams(

int servicePort,
java.lang.String network,
java.lang.String group,
int weight,
double heartbeat,
double activation)
throws ConfigurationException

Purpose Enable fault tolerance machinery, and set its parameters.

Remarks This method returns the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
servicePort Use this UDP or PGM service for internal fault tolerance protocols.

network Use this network for internal fault tolerance protocols.

group Join a fault tolerance group with this group name.

weight Use this member weight. You may supply the constant value
RvcacheProxy.DEFAULT_WEIGHT (10).

heartbeat Use this heartbeat interval (in seconds). You may supply the constant
value RvcacheProxy.DEFAULT_HEARTBEAT (3).

activation Use this activation interval (in seconds). You may supply the constant
value RvcacheProxy.DEFAULT_ACTIVATION (10).

See Also RvcacheProxy on page 272

For background information, see these sections:
• Fault Tolerance on page 288 in TIBCO Rendezvous Administration
• Browser Administration Interface on page 296 in TIBCO Rendezvous
Administration

TIBCO Rendezvous Configuration Tools

284
| Chapter 8 Current Value Cache—rvcache

RvcacheProxy.setNetworkParams()
Method

Declaration RvcacheProxy setNetworkParams(

int servicePort,
java.lang.String network,
java.lang.String daemon)
throws ConfigurationException

Purpose Set transport parameters.

Remarks rvcache uses the transport for all network communication.

This method returns the RvcacheProxy object, so programs can conveniently
chain additional method calls to the return value.

Parameter Description
servicePort Communicate on this UDP or PGM service.

network Communicate on this network.

daemon Request a client connection to rvd on this TCP port.

See Also RvcacheProxy on page 272

RvcacheProxy.getNetworkParams() on page 280
For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 CachedField 285
|

CachedField
Class

Declaration class com.tibco.tibrv.config.CachedField

extends java.lang.Object

Purpose Represent a field in a cached message.

Remarks The method CachedSubject.getFields() returns objects of this class.

Method Description Page

CachedField.getDataType() Represent a field in a cached 283
message.

CachedField.getFieldName() Get the Rendezvous datatype of 286

the field.

CachedField.getValue() Get the data value of the field. 288

Inherited Methods
java.lang.Object.equals()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString() override
java.lang.Object.wait()

See Also CachedSubject.getFields() on page 291

TIBCO Rendezvous Configuration Tools

286
| Chapter 8 Current Value Cache—rvcache

CachedField.getDataType()
Method

Declaration java.lang.String getDataType()

Purpose Get the Rendezvous datatype of the field.

See Also CachedField on page 285

For background information, see Rendezvous Datatypes on page 71 in TIBCO
Rendezvous Concepts.

TIBCO Rendezvous Configuration Tools

 CachedField.getFieldName() 287
|

CachedField.getFieldName()
Method

Declaration java.lang.String getFieldName()

Purpose Get the name of the field.

See Also CachedField on page 285

For background information, see Field Names and Field Identifiers on page 75 in
TIBCO Rendezvous Concepts.

TIBCO Rendezvous Configuration Tools

288
| Chapter 8 Current Value Cache—rvcache

CachedField.getValue()
Method

Declaration java.lang.String getValue()

Purpose Get the data value of the field.

See Also CachedField on page 285

For background information, see Messages on page 73 in TIBCO Rendezvous
Concepts.

TIBCO Rendezvous Configuration Tools

 CachedSubject 289
|

CachedSubject
Class

Declaration class com.tibco.tibrv.config.CachedSubject

extends java.lang.Object

Purpose Represent a subject in the cache.

Remarks The method RvcacheProxy.getCachedSubjects() returns objects of this class.

Constant Description
CachedSubject.MERGE_MODE CachedSubject.getStorageMethod() on page 294 returns
these constants.
CachedSubject.REPLACE_MODE

Method Description Page

CachedSubject.getFields() Get the message fields of the cached 291
subject.

CachedSubject.getInitialValuesServed() Get the number of times rvcache has 292

delivered this subject.

CachedSubject.getMessageSize() Get the size of the cached message (in 293

bytes).

CachedSubject.getStorageMethod() Get the mode for storing inbound 294

messages for the subject.

CachedSubject.getSubject() Get the subject name. 295

CachedSubject.getUpdatesApplied() Get the number of times that an 296

inbound message has updated the
cached data for this subject.

TIBCO Rendezvous Configuration Tools

290
| Chapter 8 Current Value Cache—rvcache

Inherited Methods
java.lang.Object.equals()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString() override
java.lang.Object.wait()

See Also RvcacheProxy.getCachedSubjects() on page 278

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

 CachedSubject.getFields() 291
|

CachedSubject.getFields()
Method

Declaration CachedField[] getFields()

Purpose Get the message fields of the cached subject.

See Also CachedField on page 285

CachedSubject on page 289
For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

292
| Chapter 8 Current Value Cache—rvcache

CachedSubject.getInitialValuesServed()
Method

Declaration int getInitialValuesServed()

Purpose Get the number of times rvcache has delivered this subject.

See Also CachedSubject on page 289

TIBCO Rendezvous Configuration Tools

 CachedSubject.getMessageSize() 293
|

CachedSubject.getMessageSize()
Method

Declaration int getMessageSize()

Purpose Get the size of the cached message (in bytes).

See Also CachedSubject on page 289

For background information, see Browser Administration Interface on page 296 in
TIBCO Rendezvous Administration.

TIBCO Rendezvous Configuration Tools

294
| Chapter 8 Current Value Cache—rvcache

CachedSubject.getStorageMethod()
Method

Declaration int getStorageMethod()

Purpose Get the mode for storing inbound messages for the subject.

Remarks This method returns the constants CachedSubject.MERGE_MODE and

CachedSubject.REPLACE_MODE.

See Also CachedSubject on page 289

For background information, see Replace and Merge on page 289 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 CachedSubject.getSubject() 295
|

CachedSubject.getSubject()
Method

Declaration java.lang.String getSubject()

Description Get the subject name.

See Also CachedSubject on page 289

For background information, see Replace and Merge on page 289 in TIBCO
Rendezvous Administration

TIBCO Rendezvous Configuration Tools

296
| Chapter 8 Current Value Cache—rvcache

CachedSubject.getUpdatesApplied()
Method

Declaration int getUpdatesApplied()

Description Get the number of times that an inbound message has updated the cached data
for this subject.

See Also CachedSubject on page 289

TIBCO Rendezvous Configuration Tools

 FaultToleranceParams 297
|

FaultToleranceParams
Class

Declaration class com.tibco.tibrv.config.FaultToleranceParams

extends java.lang.Object

Purpose Encapsulate fault tolerance parameters from Rendezvous recent value caches.

Constant Description
FaultToleranceParams.UNSPECIFIED No value is set for the parameter.

Method Description Page

FaultToleranceParams.getActivation() Extract the activation interval. 298

FaultToleranceParams.getAsMap() Format the fault tolerance parameters as a 299

map.

FaultToleranceParams.getGroup() Extract the name of the fault tolerance 300

group.

FaultToleranceParams.getHeartbeat() Extract the heartbeat interval. 301

FaultToleranceParams.getNetwork() Extract the network parameter for fault 302

tolerance protocols.

FaultToleranceParams.getService() Extract the effective UDP or PGM service 303

for fault tolerance protocols.

FaultToleranceParams.getWeight() Extract the fault tolerance weight of this 304

member.

FaultToleranceParams.isEnabled() Extract a flag indicating whether fault 305

tolerance is enabled.

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
RvcacheProxy.getFaultToleranceParams() returns instances of this class.

See Also Read-Only Objects on page 6

RvcacheProxy.getFaultToleranceParams() on page 279

TIBCO Rendezvous Configuration Tools

298
| Chapter 8 Current Value Cache—rvcache

FaultToleranceParams.getActivation()
Method

Declaration double getActivation()

Purpose Extract the activation interval.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 FaultToleranceParams.getAsMap() 299
|

FaultToleranceParams.getAsMap()
Method

Declaration java.util.Map getAsMap()

Purpose Format the fault tolerance parameters as a map.

Remarks The resulting map is useful for iterative methods, such as printing.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

300
| Chapter 8 Current Value Cache—rvcache

FaultToleranceParams.getGroup()
Method

Declaration java.lang.String getGroup()

Purpose Extract the name of the fault tolerance group.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 FaultToleranceParams.getHeartbeat() 301
|

FaultToleranceParams.getHeartbeat()
Method

Declaration double getHeartbeat()

Purpose Extract the heartbeat interval.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

302
| Chapter 8 Current Value Cache—rvcache

FaultToleranceParams.getNetwork()
Method

Declaration java.lang.String getNetwork()

Purpose Extract the network parameter for fault tolerance protocols.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 FaultToleranceParams.getService() 303
|

FaultToleranceParams.getService()
Method

Declaration int getService()

Purpose Extract the effective UDP or PGM service for fault tolerance protocols.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

304
| Chapter 8 Current Value Cache—rvcache

FaultToleranceParams.getWeight()
Method

Declaration int getWeight()

Purpose Extract the fault tolerance weight of this member.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 FaultToleranceParams.isEnabled() 305
|

FaultToleranceParams.isEnabled()
Method

Declaration boolean isEnabled()

Purpose Extract a flag indicating whether fault tolerance is enabled.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

306
| Chapter 8 Current Value Cache—rvcache

RvcacheNetworkParams
Class

Declaration class com.tibco.tibrv.config.RvcacheNetworkParams

extends java.lang.Object

Purpose Encapsulate network parameters from Rendezvous recent value caches.

Constant Description
RvcacheNetworkParams.UNSPECIFIED No value is set for the parameter.

Method Description Page

RvcacheNetworkParams.getAsMap() Format the network parameters as a map. 307

RvcacheNetworkParams.getDaemon() Extract the daemon parameter. 308

RvcacheNetworkParams.getNetwork() Extract the network parameter. 309

RvcacheNetworkParams.getService() Extract the service parameter. 310

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
RvaProxy.getNetworkParams() returns instances of this class.

See Also Read-Only Objects on page 6

RvaProxy.getNetworkParams() on page 242

TIBCO Rendezvous Configuration Tools

 RvcacheNetworkParams.getAsMap() 307
|

RvcacheNetworkParams.getAsMap()
Method

Declaration java.util.Map getAsMap()

Purpose Format the network parameters as a map.

Remarks The resulting map is useful for iterative methods, such as printing.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

308
| Chapter 8 Current Value Cache—rvcache

RvcacheNetworkParams.getDaemon()
Method

Declaration java.lang.String getDaemon()

Purpose Extract the daemon parameter.

Remarks rvcache requests a client connection to rvd on this TCP port.

This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvcacheNetworkParams.getNetwork() 309
|

RvcacheNetworkParams.getNetwork()
Method

Declaration java.lang.String getNetwork()

Purpose Extract the network parameter.

Remarks rvcache communicates with rvd on this network.

This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

310
| Chapter 8 Current Value Cache—rvcache

RvcacheNetworkParams.getService()
Method

Declaration int getService()

Purpose Extract the service parameter.

Remarks rvcache communicates with rvd on this UDP or PGM service.

This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 | 311

Chapter 9 Component Information

This chapter describes the read-only objects encapsulate general information

about Rendezvous components.

Topics

• ComponentInformation, page 312

• RvaInformation, page 320
• RvcacheInformation, page 327
• RvdInformation, page 333
• RvrdInformation, page 337
• RvsdInformation, page 340
• RvsrdInformation, page 342

TIBCO Rendezvous Configuration Tools

312
| Chapter 9 Component Information

ComponentInformation
Class

Declaration class com.tibco.tibrv.config.ComponentInformation

extends java.lang.Object

Purpose Encapsulate general information from Rendezvous components.

Method Description Page

ComponentInformation.getAsMap() Format the component information as a 313
map.

ComponentInformation.getHostname() Extract the name of the host computer 314

where the component is running.

ComponentInformation.getIpAddress() Extract the IP address of the host 315

computer where the component is
running.

ComponentInformation.getLicenseTicket() Extract the Rendezvous license ticket 316

that validates the component.

ComponentInformation.getName() Extract the component name. 317

ComponentInformation.getProcessID() Extract the process ID. 318

ComponentInformation.getVersion() Extract the version number of the 319

component (as a string).

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() returns objects of this class.

Subclasses RvaInformation on page 320

RvcacheInformation on page 327
RvdInformation on page 333
RvrdInformation on page 337
RvsdInformation on page 340
RvsrdInformation on page 342

See Also Read-Only Objects on page 6

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

 ComponentInformation.getAsMap() 313
|

ComponentInformation.getAsMap()
Method

Declaration java.util.Map getAsMap()

Purpose Format the component information as a map.

Remarks The resulting map is useful for iterative methods, such as printing.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

314
| Chapter 9 Component Information

ComponentInformation.getHostname()
Method

Declaration java.lang.String getHostname()

Purpose Extract the name of the host computer where the component is running.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 ComponentInformation.getIpAddress() 315
|

ComponentInformation.getIpAddress()
Method

Declaration java.lang.String getIpAddress()

Purpose Extract the IP address of the host computer where the component is running.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

316
| Chapter 9 Component Information

ComponentInformation.getLicenseTicket()
Method

Declaration java.lang.String getLicenseTicket()

Purpose Extract the Rendezvous license ticket that validates the component.
This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 ComponentInformation.getName() 317
|

ComponentInformation.getName()
Method

Declaration java.lang.String getName()

Purpose Extract the component name.

Remarks DaemonProxy.getComponentName() gets the same information (immediately

from the component).
This method does not interact with the component.

See Also DaemonProxy.getComponentName() on page 15

TIBCO Rendezvous Configuration Tools

318
| Chapter 9 Component Information

ComponentInformation.getProcessID()
Method

Declaration java.lang.String getProcessID()

throws java.lang.UnsupportedOperationException

Purpose Extract the process ID.

Remarks This method does not interact with the component.

Process ID information is available only when the component is from release 7.1
or later. With release 7.0 components, this method throws an exception.

TIBCO Rendezvous Configuration Tools

 ComponentInformation.getVersion() 319
|

ComponentInformation.getVersion()
Method

Declaration java.lang.String getVersion()

Purpose Extract the version number of the component (as a string).

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

320
| Chapter 9 Component Information

RvaInformation
Class

Declaration class com.tibco.tibrv.config.RvaInformation

extends ComponentInformation

Purpose Encapsulate general information from Rendezvous agents.

Method Description Page

RvaInformation.getClientPort() Extract the TCP port where the agent 322
listens for Java client connections.

RvaInformation.getState() Extract the state (running or idle) of the 323

agent.

RvaInformation.getTotalClients() Extract the number of Java client 324

transports that the agent serves.

RvaInformation.getTunnelClients() Extract the number of HTTP tunneling 325

Java client transports that the agent
serves.

RvaInformation.httpTunnelIsEnabled() Extract a flag indicating the whether the 326

agent accepts HTTP tunneling
connections from Java clients.

Inherited Methods
ComponentInformation.getAsMap()
ComponentInformation.getHostname()
ComponentInformation.getIpAddress()
ComponentInformation.getLicenseTicket()
ComponentInformation.getName()
ComponentInformation.getVersion()

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() can return instances of this class.

Superclasses ComponentInformation on page 312

See Also Read-Only Objects on page 6

TIBCO Rendezvous Configuration Tools

 RvaInformation 321
|

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

322
| Chapter 9 Component Information

RvaInformation.getClientPort()
Method

Declaration int getClientPort()

Purpose Extract the TCP port where the agent listens for Java client connections.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvaInformation.getState() 323
|

RvaInformation.getState()
Method

Declaration int getState()

Purpose Extract the state (running or idle) of the agent.

Remarks This method returns one of these constants:

• RvaProxy.IDLE_STATE
• RvaProxy.RUNNING_STATE

This method does not interact with the component.

See Also RvaProxy on page 232

TIBCO Rendezvous Configuration Tools

324
| Chapter 9 Component Information

RvaInformation.getTotalClients()
Method

Declaration int getTotalClients()

Purpose Extract the number of Java client transports that the agent serves.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvaInformation.getTunnelClients() 325
|

RvaInformation.getTunnelClients()
Method

Declaration int getTunnelClients()

Purpose Extract the number of HTTP tunneling Java client transports that the agent serves.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

326
| Chapter 9 Component Information

RvaInformation.httpTunnelIsEnabled()
Method

Declaration boolean httpTunnelIsEnabled()

Purpose Extract a flag indicating the whether the agent accepts HTTP tunneling
connections from Java clients.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvcacheInformation 327
|

RvcacheInformation
Class

Declaration class com.tibco.tibrv.config.RvcacheInformation

extends ComponentInformation

Purpose Encapsulate general information from Rendezvous recent value caches.

Constant Description
RvcacheInformation.FAULT_TOLERANCE_ENABLED Indicate whether a cache process can
participate in a fault tolerance group.
RvcacheInformation.FAULT_TOLERANCE_DISABLED

RvcacheInformation.SHALLOW Indicate whether a cache process uses

shallow or deep merge for nested
RvcacheInformation.DEEP
messages.

RvcacheInformation.STORE Indicate whether a cache process writes

cached values to its store file for
RvcacheInformation.MEMORY_ONLY
persistence, or operates in memory-only
mode.

Method Description Page

RvcacheInformation.getFaultToleranceState() Extract a constant indicating 329
whether the cache has enabled
fault tolerant operation.

RvcacheInformation.getMergeMode() Extract a constant indicating 330

whether the cache uses shallow or
deep merge for nested messages.

RvcacheInformation.getCacheMode() Extract a constant indicating 331

whether a cache process writes
cached values to its store file for
persistence, or operates in
memory-only mode.

RvcacheInformation.getState() Extract the state (running or idle) 332

of the cache.

TIBCO Rendezvous Configuration Tools

328
| Chapter 9 Component Information

Inherited Methods
ComponentInformation.getAsMap()
ComponentInformation.getHostname()
ComponentInformation.getIpAddress()
ComponentInformation.getLicenseTicket()
ComponentInformation.getName()
ComponentInformation.getVersion()

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() can return instances of this class.

Superclasses ComponentInformation on page 312

See Also Read-Only Objects on page 6

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

 RvcacheInformation.getFaultToleranceState() 329
|

RvcacheInformation.getFaultToleranceState()
Method

Declaration int getFaultToleranceState()

Purpose Extract a constant indicating whether the cache has enabled fault tolerant
operation.

Remarks This method returns one of these constants:

• RvcacheInformation.FAULT_TOLERANCE_ENABLED
• RvcacheInformation.FAULT_TOLERANCE_DISABLED

This method does not interact with the component.

See Also RvcacheInformation on page 327

TIBCO Rendezvous Configuration Tools

330
| Chapter 9 Component Information

RvcacheInformation.getMergeMode()
Method

Declaration int getMergeMode()

Purpose Extract a constant indicating whether the cache uses shallow or deep merge for
nested messages.

Remarks This method returns one of these constants:

• RvcacheInformation.SHALLOW
• RvcacheInformation.DEEP

This method does not interact with the component.

See Also RvcacheInformation on page 327

Replace and Merge on page 289 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

 RvcacheInformation.getCacheMode() 331
|

RvcacheInformation.getCacheMode()
Method

Declaration int getCacheMode()

Purpose Extract a constant indicating whether a cache process writes cached values to its
store file for persistence, or operates in memory-only mode.

Remarks This method returns one of these constants:

• RvcacheInformation.STORE
• RvcacheInformation.MEMORY_ONLY

This method does not interact with the component.

See Also RvcacheInformation on page 327

Memory-Only Mode on page 291 in TIBCO Rendezvous Administration

TIBCO Rendezvous Configuration Tools

332
| Chapter 9 Component Information

RvcacheInformation.getState()
Method

Declaration int getState()

Purpose Extract the state (running or idle) of the cache.

Remarks This method returns one of these constants:

• RvcacheProxy.IDLE_STATE
• RvcacheProxy.RUNNING_STATE

Remarks This method does not interact with the component.

See Also RvcacheProxy on page 272

TIBCO Rendezvous Configuration Tools

 RvdInformation 333
|

RvdInformation
Class

Declaration class com.tibco.tibrv.config.RvdInformation

extends ComponentInformation

Purpose Encapsulate general information from Rendezvous communications daemons.

Method Description Page

RvdInformation.getClientPort() Extract the TCP port where the 334
daemon listens for client connections.

RvdInformation.getNetworkServicesCount() Extract the number of network 335

services on which this daemon’s
clients communicate.

RvdInformation.getUsername() Extract the login name of the user that 336

started the component process.

Inherited Methods
ComponentInformation.getAsMap()
ComponentInformation.getHostname()
ComponentInformation.getIpAddress()
ComponentInformation.getLicenseTicket()
ComponentInformation.getName()
ComponentInformation.getVersion()

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() can return instances of this class.

Subclasses RvsdInformation on page 340

RvrdInformation on page 337

Superclasses ComponentInformation on page 312

See Also Read-Only Objects on page 6

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

334
| Chapter 9 Component Information

RvdInformation.getClientPort()
Method

Declaration int getClientPort()

Purpose Extract the TCP port where the daemon listens for client connections.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvdInformation.getNetworkServicesCount() 335
|

RvdInformation.getNetworkServicesCount()
Method

Declaration int getNetworkServicesCount()

Purpose Extract the number of network services on which this daemon’s clients
communicate.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

336
| Chapter 9 Component Information

RvdInformation.getUsername()
Method

Declaration java.lang.String getUsername()

Purpose Extract the login name of the user that started the component process.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvrdInformation 337
|

RvrdInformation
Class

Declaration class com.tibco.tibrv.config.RvrdInformation

extends RvdInformation

Purpose Encapsulate general information from Rendezvous routing daemons.

Method Description Page

RvrdInformation.getRoutingNamesCount() Extract the number of routing names 338
that the daemon embodies.

RvrdInformation.getStoreFilePath() Extract the file name of the daemon’s 339

store file.

Inherited Methods
RvdInformation.getClientPort()
RvdInformation.getNetworkServicesCount()
RvdInformation.getUsername()

ComponentInformation.getAsMap()
ComponentInformation.getHostname()
ComponentInformation.getIpAddress()
ComponentInformation.getLicenseTicket()
ComponentInformation.getName()
ComponentInformation.getVersion()

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() can return instances of this class.

Subclasses RvsrdInformation on page 342

Superclasses ComponentInformation on page 312

RvdInformation on page 333

See Also Read-Only Objects on page 6

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

338
| Chapter 9 Component Information

RvrdInformation.getRoutingNamesCount()
Method

Declaration int getRoutingNamesCount()

Purpose Extract the number of routing names that the daemon embodies.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

 RvrdInformation.getStoreFilePath() 339
|

RvrdInformation.getStoreFilePath()
Method

Declaration java.lang.String getStoreFilePath()

Purpose Extract the file name of the daemon’s store file.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

340
| Chapter 9 Component Information

RvsdInformation
Class

Declaration class com.tibco.tibrv.config.RvsdInformation

extends RvdInformation

Purpose Encapsulate general information from Rendezvous secure communications

daemons.

Method Description Page

RvsdInformation.getStoreFilePath() Extract the file name of the daemon’s 341
store file.

Inherited Methods
RvdInformation.getClientPort()
RvdInformation.getNetworkServicesCount()
RvdInformation.getUsername()

ComponentInformation.getAsMap()
ComponentInformation.getHostname()
ComponentInformation.getIpAddress()
ComponentInformation.getLicenseTicket()
ComponentInformation.getName()
ComponentInformation.getVersion()

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() can return instances of this class.

Superclasses ComponentInformation on page 312

RvdInformation on page 333

See Also Read-Only Objects on page 6

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

 RvsdInformation.getStoreFilePath() 341
|

RvsdInformation.getStoreFilePath()
Method

Declaration java.lang.String getStoreFilePath()

Purpose Extract the file name of the daemon’s store file.

Remarks This method does not interact with the component.

TIBCO Rendezvous Configuration Tools

342
| Chapter 9 Component Information

RvsrdInformation
Class

Declaration class com.tibco.tibrv.config.RvsrdInformation

extends RvrdInformation

Purpose Encapsulate general information from Rendezvous secure routing daemons.

Inherited Methods
RvrdInformation.getRoutingNamesCount()
RvrdInformation.getStoreFilePath()

RvdInformation.getClientPort()
RvdInformation.getNetworkServicesCount()
RvdInformation.getUsername()

ComponentInformation.getAsMap()
ComponentInformation.getHostname()
ComponentInformation.getIpAddress()
ComponentInformation.getLicenseTicket()
ComponentInformation.getName()
ComponentInformation.getVersion()

Remarks Instances of this class are read-only objects. Methods do not interact with the
component.
DaemonProxy.getComponentInformation() can return instances of this class.
This class does not add any new methods to its superclass.

Superclasses ComponentInformation on page 312

RvdInformation on page 333
RvrdInformation on page 337

See Also Read-Only Objects on page 6

DaemonProxy.getComponentInformation() on page 16

TIBCO Rendezvous Configuration Tools

 | 343

Chapter 10 Exceptions

This chapter describes the exception classes for the Rendezvous configuration
API.

Topics

• ConfigurationException, page 344

• FatalConfigurationException, page 345

TIBCO Rendezvous Configuration Tools

344
| Chapter 10 Exceptions

ConfigurationException
Class

Declaration class com.tibco.tibrv.config.ConfigurationException

extends java.lang.Exception

Purpose Encapsulate errors from the daemon component.

Remarks Configuration methods throw this class of exceptions when the daemon
component rejects a parameter or configuration command. The exception’s
message string contains the text of an error message from the daemon component.
Programs can extract the message with java.lang.Exception.getMessage().
To handle this exception, we recommend that programs log the error message,
and display it to the user. When appropriate, the program may offer the user an
opportunity to substitute a new parameter or command.

Inherited Methods
java.lang.Throwable.fillInStackTrace()
java.lang.Throwable.getCause()
java.lang.Throwable.getLocalizedMessage()
java.lang.Throwable.getMessage()
java.lang.Throwable.getStackTrace()
java.lang.Throwable.initCause
java.lang.Throwable.printStackTrace()
java.lang.Throwable.setStackTrace()
java.lang.Throwable.toString()

java.lang.Object.equals()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.wait()

TIBCO Rendezvous Configuration Tools

 FatalConfigurationException 345
|

FatalConfigurationException
Class

Declaration class com.tibco.tibrv.config.FatalConfigurationException

extends ConfigurationException

Purpose Encapsulate fatal errors.

Remarks Configuration methods throw this class of exceptions when a problem prevents
continued execution.
To handle these exceptions, we recommend that programs print a stack trace and
exit.

Constant Description
CORRUPTED_PACKAGE One of the Java configuration classes is missing or invalid.

INVALID_ANSWER The component could not answer a request from a method of the
configuration API.

UNAUTHORIZED The configuration program lacks correct administrator credentials.

UNEXPECTED_ANSWER The configuration API method could not parse an answer from the
component.

UNKNOWN_COMPONENT The daemon or component does not support the configuration

interface.

Inherited Methods
java.lang.Throwable.fillInStackTrace()
java.lang.Throwable.getCause()
java.lang.Throwable.getLocalizedMessage()
java.lang.Throwable.getMessage()
java.lang.Throwable.getStackTrace()
java.lang.Throwable.initCause
java.lang.Throwable.printStackTrace()
java.lang.Throwable.setStackTrace()
java.lang.Throwable.toString()

java.lang.Object.equals()
java.lang.Object.getClass()
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.wait()

TIBCO Rendezvous Configuration Tools

346
| Chapter 10 Exceptions

TIBCO Rendezvous Configuration Tools

 | 347

Chapter 11 Command Line Tool—tibrvcfg

This chapter describes a command line tool for configuring Rendezvous

daemons.

Topics

• Overview, page 348

• Requirements, page 351
• tibrvcfg, page 352

TIBCO Rendezvous Configuration Tools

348
| Chapter 11 Command Line Tool—tibrvcfg

Overview

The command line tool (tibrvcfg) lets you configure daemon components
without writing Java programs. The tool interacts with a component to execute
one configuration command, and outputs the results to stdio. Most of the
commands parallel methods of the configuration API.

XML
Three commands interact with XML documents:

dumpXML dumpXMLextracts the complete set of configuration information from a

component, and outputs it as an XML document.

mergeXML mergeXML and matchXML parse an XML file that specifies a configuration, compare
matchXML it with the current configuration of a component, arrange the minimal set of
configuration commands that would implement the specified configuration on
the component, and interact with the component to configure it accordingly.

Translation Rendezvous components do not accept or produce XML directly. Instead,

methods of the configuration API act as translators:
• dumpXMLgets current configuration data from a component, and builds an
XML document incorporating that data.
• Conversely, mergeXML and matchXML read an XML document, and build a set
of commands to achieve the specified configuration.

Sensitive dumpXML does not extract sensitive information from components—for example,
Information passwords or private keys. Instead, this command replaces sensitive information
with a static string.
This replacement is a security feature, but it can also create confusion for unwary
users. If you dump an XML document that contains such replacement strings, and
modify it to change some of the parameter values, you cannot successfully load
those changes (with the mergeXML or matchXML commands) unless you first
remove these replacement strings. For example, in the XML document below,
remove the indicated text—that is, everything in the security-parameters
section.

Example 1 Removing Security Replacement Strings from XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rendezvous SYSTEM "http://www.rv.tibco.com/dtd/rv">

TIBCO Rendezvous Configuration Tools

 Overview 349
|
<rendezvous url="http://arrakis:7580">
<configuration timestamp="20040907152842-0700">
<rvrd-parameters>
<logging connections="no"
subject-data="no" subject-interest="no" />
</rvrd-parameters>
<security-parameters>
<administrator password="!!!SECRET!!!"
username="Administrator" />
<certificate index="1" private-key-password="!!! SECRET !!!">
<use for="HTTPS" />
<use for="ROUTERS_TO_ROUTERS" />
<PEM-data>
-----BEGIN CERTIFICATE-----
MIICvzCCAiigAwIBAgIBATANBgkqhkiG9w0BAQQFADBhMQswCQYDVQQGEwJOQTEL
MAkGA1UECBMCTkExCzAJBgNVBAcTAk5BMRIwEAYDVQQKEwlBbm9ueW1vdXMxEjAQ
BgNVBAsTCUFub255bW91czEQMA4GA1UEAxMHYXJyYWtpczAeFw0wNDAzMzAyMjMy
MzFaFw0wNTAzMzAyMjMyMzFaMGExCzAJBgNVBAYTAk5BMQswCQYDVQQIEwJOQTEL
MAkGA1UEBxMCTkExEjAQBgNVBAoTCUFub255bW91czESMBAGA1UECxMJQW5vbnlt
b3VzMRAwDgYDVQQDEwdhcnJha2lzMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB
gQDAf+fcyb3UdMjPFtaXetSldSGTfrwV9/t+1xUlXaVb79w2jtS6RtNCg9WkzUy2
78DoZxlD3szKoZt7rdZlssCGWSVx2jO568alYF+5r5RR8Dj5I3ZEQC+iFJyCRprn
t/Kh07UKd3fNy8s4KoQBGTxs7C+mQpuNgpSHV5uMSDIF2wIDAQABo4GGMIGDMBEG
CWCGSAGG+EIBAQQEAwICRDALBgNVHQ8EBAMCAuwwEwYDVR0lBAwwCgYIKwYBBQUH
AwEwHQYDVR0OBBYEFL9s9h3DVCx/asG/Bqfka0Z/fLdwMB8GA1UdIwQYMBaAFL9s
9h3DVCx/asG/Bqfka0Z/fLdwMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEEBQAD
gYEAcJQDKbusUaEYOpMD3iNHSKPYQsrfa76DzxA10MGvLtOEh3kpRoeNKUvqZw5+
dQZIxOnQeY8X7l60GKuwvAiOsyUAgDdOWEGnDJed52+R8NXHg/okmdMnzC05QxO0
gJaiC1mm4zl03gFMtHNUqABh9qmjNJDI34bVwXXC2isCgFg=
-----END CERTIFICATE-----
!!! SECRET PRIVATE KEY !!!
</PEM-data>
</certificate>
<certificate index="2" />
<certificate index="3" />
<certificate index="4" />
</security-parameters>
</configuration>
</rendezvous>

After removal, the resulting XML document would look like this:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rendezvous SYSTEM "http://www.rv.tibco.com/dtd/rv">
<rendezvous url="http://arrakis:7580">
<configuration timestamp="20040907152842-0700">
<rvrd-parameters>
<logging connections="no"
subject-data="no" subject-interest="no" />
</rvrd-parameters>
<security-parameters>
</security-parameters>
</configuration>
</rendezvous>

TIBCO Rendezvous Configuration Tools

350
| Chapter 11 Command Line Tool—tibrvcfg

DTD A set of DTD files defines the correct syntax for Rendezvous configuration XML
documents. The configuration API verifies XML documents against this
definition.
You can easily reconfigure a component by editing the output of dumpXML, and
then supplying the modified file to mergeXML or matchXML. The edited document
must conform to the DTD.

TIBCO Rendezvous Configuration Tools

 Requirements 351
|

Requirements

Java SDK
The command line tool requires that you first install Java SDK runtime
environment 1.4 (or later). You can download this software from java.sun.com.

Environment Variables

Variable Description
TIBRV_HOME This variable identifies the directory on your computer where
you have installed Rendezvous software. The default location
is /TIBCO/TIBRV.

JAVA_HOME This variable identifies the directory on your computer where

you have installed Java SDK.

CLASSPATH Rendezvous installation places the Java archive file

rvconfig.jar in the lib directory under TIBRV_HOME. If you
have placed this file in any other location, the CLASSPATH
variable must include the complete pathname.
The CLASSPATH variable must also include the complete
pathname to the SDK file jsse.jar, which implements SSL.

TIBCO Rendezvous Configuration Tools

352
| Chapter 11 Command Line Tool—tibrvcfg

tibrvcfg
Command

Syntax tibrvcfg [-http-only]

[-login name:password ]
[-url base_url ]
command arg1 arg2 ...

Purpose Connect to a daemon component and run one configuration command.

Remarks This tool lets you send one configuration command to a component. The set of
configuration commands parallels the methods of the configuration API. For
details about any command, see page in this book that documents the
corresponding method. For XML commands, see XML Commands on page 353.
The script tibrvcfg resides in the bin directory under TIBRV_HOME.

(Sheet 1 of 2)

Parameter Description
-http-only When present, the configuration tool uses non-secure HTTP
protocols to connect to the component, instead of secure HTTPS
protocols.
You must specify -http-only to tibrvcfg if and only if the
component command line specified -http-only.

-login name:password When present, the configuration tool supplies this administrator
name and password when the component requests them. For more
information, see SecurityProxy.useCredentials() on page 171.

-url base_url When present, the configuration tool connects to the browser
administration interface of the component at this URL. When
loading an XML file, this parameter (if present) overrides the URL in
the XML file.
When absent, the configuration tool seeks the component at the
default URL, http://localhost:7580, which is appropriate for
rvd, rvrd, rvsd or rvsrd, running on the same computer as the
configuration tool.
Construct the URL from the IP address of the daemon’s host
computer, and its HTTP port.

TIBCO Rendezvous Configuration Tools

 tibrvcfg 353
|

(Sheet 2 of 2)

Parameter Description
command arg1 arg2 ... The remaining parameters specify the command to the component,
and its arguments.
If you omit the command, or supply an invalid command, the
configuration tool outputs a lengthy help message that lists all valid
commands.

Execution as a The tibrvcfg script is the most convenient way to use this tool, because it
Java Object automatically arranges the environment properly. However, you can bypass the
script, executing the tool as a Java object; for example:
java com.tibco.tibrv.config.tools.TibrvConfigurationTool ...

XML Commands

(Sheet 1 of 2)

Command Description
dumpXML [ output_filename ] dumpXML gets current configuration data from a component, and
builds an XML document incorporating that data.
When output_filename is present, dumpXML directs the XML
document to the specified file. The file is suitable as input for
the mergeXML or matchXML command. When output_filename
absent, the default is stdio.

mergeXML xml_file mergeXML reads an XML document, and builds a set of

commands to update the component with configuration in the
XML document—overlaying the existing configuration with
changes specified in the XML file. Where the two configurations
conflict, the XML document overrides the existing
configuration. Elements of the existing configuration that do
not conflict with the XML specification remain in force.
The parameter xml_file must contain an XML document
appropriate for configuring the component (its syntax must
conform to the DTD specification).

TIBCO Rendezvous Configuration Tools

354
| Chapter 11 Command Line Tool—tibrvcfg

(Sheet 2 of 2)

Command Description
matchXML xml_file matchXML reads an XML document, and builds a set of
commands that force the component to conform to the XML
document—removing elements of the existing configuration
that are absent from the XML specification.
The parameter xml_file must contain an XML document
appropriate for configuring the component (its syntax must
conform to the DTD specification).

Merge vs. Match To illustrate the difference between mergeXML and matchXML, consider an example
in which the existing configuration of rvrd has two routers, R1 and R2; the XML
document specifies a change to R2 and a new router R3:
• With mergeXML, R1 remains unchanged, R2 is modified, and R3 is added.
• With matchXML, R1 is removed, R2 is modified, and R3 is added.

Creating XML You may edit the XML output of dumpXML, and supply the edited file as input to
Input mergeXML or matchXML. The edited file must conform to the DTD.

Component State Some configuration commands interact with that the component’s state (idle or
running). For example, rva lets you change its network parameters at any time,
but the changes take effect only upon state transition from idle to running; see
also RvaProxy.setNetworkParams() on page 250.
Two XML attributes let you manipulate the component’s state before and after
executing configuration commands generated by the XML document. For
example:
<rva-parameters in-state="idle" out-state="running">

The attributes in this example guarantee a state transition to put new network
parameters into effect.

TIBCO Rendezvous Configuration Tools

 | 355

Index

A B
addAcceptAnyInterface() 125 BorderRouter 146
addActiveInterface() 127 addPolicyRule() 148
addAllowedSubject, addAllowedSubjects 154 getPolicyRule(), getPolicyRules() 150
addBorderRouter() 80 removePolicyRule() 151
addCertificateFromFile() 208 toXml() 152
addCertificateFromPKCS12File() 210
addCertificateFromText() 209
addExportSubject()
LocalNetworkInterface 92 C
RvaProxy 235
addImportSubject() cache 271
LocalNetworkInterface 93 cache mode (rvcache) 331
RvaProxy 236 CachedField 285
addLocalNetworkInterface() 130 getDataType() 286
addPassiveInterface() 132 getFieldName() 287
addPolicyRule() 148 getValue() 288
addRouter(), addRouters() 81 CachedSubject 289
addSeekAnyInterface() 135 getFields() 291
addSubject() getInitialValuesServed() 292
LocalNetworkInterface 94 getMessageSize() 293
RvaProxy 237 getStorageMethod() 294
addSubjectMerge(), addSubjectsMerge() 274 getSubject() 295
addSubjectReplace(), addSubjectsReplace() 275 getUpdatesApplied() 296
addUser(), addUsers() 185 CertificateSlot 172
agent 231 getIndex() 173
API architecture 3 getPathname() 174
authorizeListen() 186 getText() 175
authorizeListenAndSend() 187 getUses() 176
authorizeNetworkAndService(), setFromFile() 177
authorizeNetworksAndServices() 188 setFromText() 178
authorizeSend() 190 toXml() 179
changeState()
RvaProxy 238
RvcacheProxy 276
clearMaxBacklog() 137
clearPassword() 211

TIBCO Rendezvous Configuration Tools

356
| Index
ClientTransport 27 exceptions 343
getDescription() 28
getDetails() 29
getIdentifier() 30
getService() 31 F
getSubscriptions() 32
getUsername() 33 FatalConfigurationException 345
toXml() 34 FaultToleranceParams 297
command line tool 347 getActivation() 298
component information, get 16 getAsMap() 299
ComponentInformation 312 getGroup() 300
getAsMap() 313 getHeartbeat() 301
getHostname() 314 getNetwork() 302
getIpAddress() 315 getService() 303
getLicenseTicket() 316 getWeight() 304
getName() 317 isEnabled() 305
getProcessID() 318 for command line tool 351
getVersion() 319
ConfigurationException 344
connections() 106
current value cache 271 G
customer support xxii
general information, component 16
getActivation() 298
getActiveFlush() 253
D getAdministratorName() 166
getAllowedSubjects 156
DaemonManager 10 getAsMap()
constructor 11 ComponentInformation 313
getDaemonProxy() 13 FaultToleranceParams 299
getDaemonType() 12 HttpTunnelParams 254
DaemonProxy 14 LoggingParams 107
getComponentInformation() 16 RvaNetworkParams 265
getComponentName() 15 RvcacheNetworkParams 307
data accessors 6 getAssignmentDate() 219
deep merge (rvcache) 330 getBacklog()
disableFaultTolerance() 277 NeighborInterface 112
dumpXML 348 getBorderRouterName 157
getCachedSubjects() 278
getCacheMode() 331
getCertificates() 212
E getCertificateSlot(), getCertificateSlots() 167

environment variables 351

for API 8

TIBCO Rendezvous Configuration Tools

 Index 357
|
getClientCount() getHosts() 49
PortMapEntry 63 getHttpAddress() 37
Service 45 getHttpTunnelParams() 240
SubjectMap 67 getId()
getClientPort() NeighborInterface 114
RvaInformation 322 UserCertificate 220
RvdInformation 334 getIdentifier() 30
getClientTimeout() 255 getImportSubjects()
getClientTransports() LocalNetworkInterface 97
RvdProxy 23 RvaProxy 241
Service 46 getInactiveFlush() 256
getComponentInformation() 16 getInboundRates() 50
getComponentName() 15 getInboundTotals() 51
getCost() getIndex()
LocalNetworkInterface 95 CertificateSlot 173
NeighborInterface 113 UserCertificate 221
getDaemon() getInitialValuesServed() 292
RvaNetworkParams 266 getIpAddress()
RvcacheNetworkParams 308 ComponentInformation 315
getDaemonProxy() 13 Host 38
getDaemonType() 12 getIssuer() 222
getDataType() 286 getLastUpdate()
getDefaultNetworkAndService() 191 PortMap 60
getDescription() 28 SubjectMap 68
getDetails() getLicenseTicket() 316
ClientTransport 29 getListen() 192
Service 47 getListenPort() 267
getEffectivePort(), PortMapEntry 64 getLocalNetworkInterfaces() 138
getExportSubjects() getLocalPort() 115
LocalNetworkInterface 96 getLoggingParams() 82
RvaProxy 239 getMaxBacklog() 139
getFaultToleranceParams() 279 getMaxClientQueue() 257
getFaultToleranceState() 329 getMaxProxyBuffer() 258
getFieldName() 287 getMaxQueueSize() 259
getFields() 291 getMergeMode() 330
getFileName() 223 getMessageSize() 293
getFromInterface 158 getName()
getGroup() ComponentInformation 317
FaultToleranceParams 300 LocalNetworkInterface 98
SubjectMapEntry 72 Router 140
getHeartbeat() 301 getNeighborHost() 116
getHostCount() 48 getNeighborInterfaces() 141
getHostname() getNeighborName() 117
ComponentInformation 314 getNeighborPort() 118
Host 36

TIBCO Rendezvous Configuration Tools

358
| Index
getNetwork() getStorageMethod() 294
FaultToleranceParams 302 getStoreFilePath()
LocalNetworkInterface 99 RvrdInformation 339
NetworkServicePair 204 RvsdInformation 341
RvaNetworkParams 268 getSubectMaps(), RvdProxy 26
RvcacheNetworkParams 309 getSubject()
Service 52 CachedSubject 295
getNetworkParams() ImportSubject 87
RvaProxy 242 SubjectMapEntry 74
RvcacheProxy 280 UserCertificate 226
getNetworksAndServices() 193 getSubjectMapEntries(), SubjectMap 69
getNetworkServicesCount() 335 getSubscriberCount(), SubjectMapEntry 75
getOriginalPort(), PortMapEntry 65 getSubscriptionCount(), SubjectMap 70
getOutboundRates() 53 getSubscriptions()
getOutboundTotals() 54 ClientTransport 32
getPathname() 174 Service 56
getPingInterval() 260 getText() 175
getPolicyRule(), getPolicyRules() 150 getToInterface 159
getPort(), HttpTunnelParams 261 getTotalClients() 324
getPortMap(), RvdProxy 24 getTunnelClients() 325
getPortMapEntries(), PortMap 61 getType() 119
getPortNumber(), Service 55 getUpdatesApplied() 296
getProcessID() getUptime() 40
ComponentInformation 318 getUser(), getUsers() 195
getPublicKeyEngine() 224 getUsername()
getRank(), SubjectMapEntry 73 ClientTransport 33
getRequestFlush() 262 RvdInformation 336
getRouter(), getRouters() 83 User 213
getRoutingNamesCount() 338 getUses() 176
getSend() 194 getValidNotAfter() 227
getSerial() getValidNotBefore() 228
Host 39 getValidUses() 168
getSerialNumber() getValue() 288
UserCertificate 225 getVersion()
getService() ComponentInformation 319
ClientTransport 31 Host 41
FaultToleranceParams 303 UserCertificate 229
LocalNetworkInterface 100 getWeight()
NetworkServicePair 205 FaultToleranceParams 304
RvaNetworkParams 269 ImportSubject 88
RvcacheNetworkParams 310
getServices(), RvdProxy 25
getState()
RvaInformation 323
RvcacheInformation 332

TIBCO Rendezvous Configuration Tools

 Index 359
|

H J
Host 35 Java program structure 7
getHostname() 36
getHttpAddress() 37
getIpAddress() 38
getSerial() 39 L
getUptime() 40
getVersion() 41 LocalNetworkInterface 89
toXml() 42 addExportSubject() 92
HostnameVerifier 7 addImportSubject() 93
httpTunnelIsEnabled() 326 addSubject() 94
HttpTunnelParams 251 getCost() 95
getActiveFlush() 253 getExportSubjects() 96
getAsMap() 254 getImportSubjects() 97
getClientTimeout() 255 getName() 98
getInactiveFlush() 256 getNetwork() 99
getMaxClientQueue() 257 getService() 100
getMaxProxyBuffer() 258 removeExportSubject(),
getMaxQueueSize() 259 removeExportSubjects() 101
getPingInterval() 260 removeImportSubject(),
getPort() 261 removeImportSubjects() 102
getRequestFlush() 262 removeSubject(), removeSubjects() 103
isEnabled() 263 toXml() 104
LoggingParams 105
connections() 106
getAsMap() 107
I subjectData() 108
subjectInterest() 109
immediate-access classes 6
ImportSubject 86
getSubject() 87
getWeight() 88 M
isCompressed() 120
isEnabled() matchXML 348
FaultToleranceParams 305 memory-only mode (rvcache) 331
HttpTunnelParams 263 merge (rvcache) 330
isEnabled(), PortMap 59 mergeXML 348
isEncrypted() 121
isRunning()
RvaProxy 243
RvcacheProxy 281

TIBCO Rendezvous Configuration Tools

360
| Index

N R
NeighborInterface 110 read-only classes 6
getBacklog() 112 removeAllowedSubject, removeAllowedSubjects 160
getCost() 113 removeCertificate(), removeCertificates() 214
getId() 114 removeExportSubject(), removeExportSubjects()
getLocalPort() 115 LocalNetworkInterface 101
getNeighborHost() 116 RvaProxy 244
getNeighborName() 117 removeImportSubject(), removeImportSubjects()
getNeighborPort() 118 LocalNetworkInterface 102
getType() 119 RvaProxy 245
isCompressed() 120 removeListen() 196
isEncrypted() 121 removeListenAndSend() 197
toXml() 122 removeLocalNetworkInterface(),
NetworkServicePair 203 removeLocalNetworkInterfaces() 142
getNetwork() 204 removeNeighborInterface(),
getService() 205 removeNeighborInterfaces() 143
toXml() 206 removeNetworkAndService(),
removeNetworksAndServices() 198
removePolicyRule() 151
removeRouter(), removeRouters() 84
P removeSend() 200
removeSubject(), removeSubjects()
PEM 208 LocalNetworkInterface 103
PGM or UDP service 43 RvaProxy 246
PKCS12 210 RvcacheProxy 282
PolicyRule 153 removeUser(), removeUsers() 201
addAllowedSubject, addAllowedSubjects 154 Rendezvous agent 231
getAllowedSubjects 156 requirements
getBorderRouterName 157 API 8
getFromInterface 158 tibrvcfg 351
getToInterface 159 Router 123
removeAllowedSubject, addAcceptAnyInterface() 125
removeAllowedSubjects 160 addActiveInterface() 127
toXml() 161 addLocalNetworkInterface() 130
PortMap 58 addPassiveInterface() 132
getLastUpdate() 60 addSeekAnyInterface() 135
getPortMapEntries() 61 clearMaxBacklog() 137
isEnabled() 59 getLocalNetworkInterfaces() 138
PortMapEntry 62 getMaxBacklog() 139
getClientCount() 63 getName() 140
getEffectivePort() 64 getNeighborInterfaces() 141
getOriginalPort() 65 removeLocalNetworkInterface(),
printXml() 18 removeLocalNetworkInterfaces() 142
program structure 7 removeNeighborInterface(),

TIBCO Rendezvous Configuration Tools

 Index 361
|
removeNeighborInterfaces() 143 RvcacheProxy 272
setMaxBacklog() 144 addSubjectMerge(), addSubjectsMerge() 274
toXml() 145 addSubjectReplace(), addSubjectsReplace() 275
routing daemon 77 changeState() 276
rva 231 disableFaultTolerance() 277
RvaInformation 320 getCachedSubjects() 278
getClientPort() 322 getFaultToleranceParams() 279
getState() 323 getNetworkParams() 280
getTotalClients() 324 isRunning() 281
getTunnelClients() 325 removeSubject(), removeSubjects() 282
httpTunnelIsEnabled() 326 setFaultToleranceParams() 283
RvaNetworkParams 264 setNetworkParams() 284
getAsMap() 265 RvdInformation 333
getDaemon() 266 getClientPort() 334
getListenPort() 267 getNetworkServicesCount() 335
getNetwork() 268 getUsername() 336
getService() 269 RvdProxy 22
RvaProxy 232 getClientTransports() 23
addExportSubject() 235 getPortMap() 24
addImportSubject() 236 getServices() 25
addSubject() 237 getSubectMaps() 26
changeState() 238 rvrd 77
getExportSubjects() 239 RvrdInformation 337
getHttpTunnelParams() 240 getRoutingNamesCount() 338
getImportSubjects() 241 getStoreFilePath() 339
getNetworkParams() 242 RvrdProxy 78
isRunning() 243 addBorderRouter() 80
removeExportSubject(), addRouter(), addRouters() 81
removeExportSubjects() 244 getLoggingParams() 82
removeImportSubject(), getRouter(), getRouters() 83
removeImportSubjects() 245 removeRouter(), removeRouters() 84
removeSubject(), removeSubjects() 246 setLoggingParams() 85
setHttpTunnelParams() 247 rvsd 181
setNetworkParams() 250 RvsdInformation 340
rvcache 271 getStoreFilePath() 341
RvcacheInformation 327 rvsrd 181
getCacheMode() 331 RvsrdInformation 342
getFaultToleranceState() 329
getMergeMode() 330
getState() 332
RvcacheNetworkParams 306 S
getAsMap() 307
getDaemon() 308 secure daemons 181
getNetwork() 309
getService() 310

TIBCO Rendezvous Configuration Tools

362
| Index
SecureDaemonProxy 182 setFromText() 178
addUser(), addUsers() 185 setHttpTunnelParams() 247
authorizeListen() 186 setLoggingParams() 85
authorizeListenAndSend() 187 setMaxBacklog() 144
authorizeNetworkAndService(), setNetworkParams()
authorizeNetworksAndServices() 188 RvaProxy 250
authorizeSend() 190 RvcacheProxy 284
getDefaultNetworkAndService() 191 setPassword() 215
getListen() 192 shallow merge (rvcache) 330
getNetworksAndServices() 193 store mode (rvcache) 331
getSend() 194 subjectData() 108
getUser(), getUsers() 195 subjectInterest() 109
removeListen() 196 SubjectMap 66
removeListenAndSend() 197 getClientCount() 67
removeNetworkAndService(), getLastUpdate() 68
removeNetworksAndServices() 198 getSubjectMapEntries() 69
removeSend() 200 getSubscriptionCount() 70
removeUser(), removeUsers() 201 SubjectMapEntry 71
setDefaultNetworkAndService() 202 getGroup() 72
SecurityProxy 164 getRank() 73
getAdministratorName() 166 getSubject() 74
getCertificateSlot(), getCertificateSlots() 167 getSubscriberCount() 75
getValidUses() 168 support, contacting xxii
setCertificateUses() 169
setCredentials() 170
useCredentials() 171
Service 43 T
getClientCount() 45
getClientTransports() 46 technical support xxii
getDetails() 47 TIBCO_HOME xix
getHostCount() 48 tibrvcfg 347
getHosts() 49 command line syntax 352
getInboundRates() 50 toXml() 19
getInboundTotals() 51 BorderRouter 152
getNetwork() 52 CertificateSlot 179
getOutboundRates() 53 ClientTransport 34
getOutboundTotals() 54 Host 42
getPortNumber() 55 LocalNetworkInterface 104
getSubscriptions() 56 NeighborInterface 122
toXml() 57 NetworkServicePair 206
setCertificateUses() 169 PolicyRule 161
setCredentials() 170 Router 145
setDefaultNetworkAndService() 202 Service 57
setFaultToleranceParams() 283 User 216
setFromFile() 177 UserCertificate 230

TIBCO Rendezvous Configuration Tools

 Index 363
|

U
UDP or PGM service 43
useCredentials() 171
User 207
addCertificateFromFile() 208
addCertificateFromPKCS12File() 210
addCertificateFromText() 209
clearPassword() 211
getCertificates() 212
getUsername() 213
removeCertificate(), RemoveCertificates() 214
setPassword() 215
toXml() 216
UserCertificate 217
getAssignmentDate() 219
getFileName() 223
getId() 220
getIndex() 221
getIssuer() 222
getPublicKeyEngine() 224
getSerialNumber() 225
getSubject() 226
getValidNotAfter() 227
getValidNotBefore() 228
getVersion() 229
toXml() 230

X
X509TrustManager 7
XML 348
XmlSerializable 17
printXml() 18
toXml() 19

TIBCO Rendezvous Configuration Tools