Overview

The SDK (Java) supplies a dataIn/dataOut commarea mechanism for unformatted binary data exchange between an application and a TIBCO Object Service Broker rule. A rule called via the SDK (Java) can use all the TIBCO Object Service Broker facilities except the text-presentation DISPLAY statement. To facilitate commarea binary data exchange between an application and a rule, developers can use TIBCO Object Service Broker MAP tables to process data in the dataIn commarea and to return data back to the application through the dataOut commarea.

Remote Communication

The SDK (Java) is a remote interface that communicates with TIBCO Object Service Broker. TIBCO Object Service Broker supports this interface in the same way on all platforms with no user application code change. In a Java environment, applications use the SDK (Java) to control a session in the local or another computer (on any platform), or in another work space on the same computer (in z/OS only).

How Can It Be Used?

With the SDK (Java), you write an application to manage a TIBCO Object Service Broker session using a set of Java classes. To make the services of TIBCO Object Service Broker available to your program, you write specific code that makes use of the SDK (Java) classes and that exerts complete control over TIBCO Object Service Broker sessions. Refer to Sample Application Using the SDK (Java).

Compiling

The SDK (Java) is supplied as a cli.jar file. To use the interface, an application calls the methods of the SDK (Java) classes. The classes within cli.jar can be made accessible to the application via the CLASSPATH system environment variable or can be embedded in your application .jar file.

Thread Safety

Most Session class methods are thread safe at a session level. In other words, when two threads try to run a method of the same SDK (Java) Session object, the behavior is unpredictable. This applies to the following: start, stop, reset, startTrans, stopTrans, call, shutdown, and execTran.

transNestLevel, endMessage, isActive, and userId can be run at the same time as any other method on the same Session object.

The methods of the SessionException and Misc classes are fully thread safe.

Constants

To facilitate application development, the Session class contains the following constants, which are defined as static public final fields:


MAXRULEEXPRLEN	The maximum length of a rules call string. For more information, refer to call. The value is 514.
MAXENDMSGLEN	The maximum length of a rules end message. For more information, refer to endMessage and to the ENDMSG shareable tool. The value is 148.