Version 9.6
 —  EntireX RPC Programming  —

Using the Broker ID in Applications

The Broker ID describes the connection from a client or server to a Broker instance. It indicates the protocol or transport method to be used and where the Broker is located. We distinguish two styles of Broker IDs: the URL-style Broker ID and the transport-method-style Broker ID.

The URL-style Broker ID is the recommended style. Simple forms of this style are identical with the transport method style. For both styles, the syntax, values, defaults, examples, and restrictions are listed.

This document covers the following topics:


URL-style Broker ID

The URL syntax is described in RFC1738 and related RFCs.

<protocol><host><port><parameter>
Element Description Permitted Values Default Note
<protocol> The transport protocol. tcpip://, ssl://, http://, https://, or none; tcpip:// Not case-sensitive.
<host> The host where the Broker operates. A valid host name. This may be a numerical IP address or a domain name. localhost For the syntax of the domain name, see RFC1034 (Domain Names - Concepts and Facilities).
<port> The port where the Broker listens. a valid port number in the form ": n ", where n is an integer.

Non-Java-based components:
The default port is resolved by the domain name service (DNS) for all components. If the DNS cannot resolve the port, 1971 is used for TCP/IP and 1958 is used for SSL.

Java-based-components:
The default depends on the protocol:

tcpip:// 1971
ssl:// 1958
http:// 80
https:// 443
 
<parameter> Parameters in the form
?<parm1>&<parm2>&...
The keys and the permitted values depend on the protocol. none See Examples of Parameters.

Examples

Examples of Parameters

Java Programming Language

  1. poolsize=n (n: number of connections)

  2. pooltimeout=n (n: number of seconds until timeout)

  3. compresslevel=[0|1|2|3|4|5|6|7|8|9|DEFAULT_COMPRESSION|NO_COMPRESSION|BEST_SPEED|DEFLATED|BEST_COMPRESSION|N|Y]

    (set the level of compression; N is mapped to NO_COMPRESSION; Y is mapped to 6, see Using Compression under Writing Advanced Applications - EntireX Java ACI

  4. encryptionlevel=[0|1|2] (set the encryption level, see Encryption under Writing Applications using EntireX Security)

  5. For http, https: checkheaders=[yes|no] (check http headers if yes)

  6. For http, https: log=[yes|no] (enable tracing if yes)

  7. For ssl: verify_client=[yes|no] (SSL client has to send certificate if yes)

  8. For ssl: verify_server=[yes|no] (verify that the host name of the Broker is the common name of the certificate, if yes.)

Other Programming Languages

  1. For ssl: verify_client=[yes|no] (SSL client has to send certificate if yes)

  2. For ssl: verify_server=[yes|no] (verify that the host name of the Broker is the common name of the certificate if yes)

Top of page

Transport-method-style Broker ID

Transport methods TCP, SSL and NET are available. The transport method may be omitted, whereby certain rules apply. See Default Rules. The transport methods TCP and NET may be also combined. See Examples below.

Transport Method TCP

<host><port>:TCP

Element Description Permitted Values Default
<host> The host where the Broker operates. Valid host name consisting of a domain name or a numerical IP address. localhost
<port> The port where the Broker listens. Valid port number. The default port is resolved by the domain name service (DNS). If the DNS cannot resolve the port, 1971 is used.

Transport Method SSL

<host><port>:SSL

Element Description Permitted Values Default
<host> The host where the Broker operates. Valid host name consisting of a domain name or a numerical IP address. localhost
<port> The port where the Broker listens. Valid port number. The default port is resolved by the domain name service (DNS). If the DNS cannot resolve the port, 1958 is used.

Transport Method NET (Entire Net-Work) under z/OS, BS2000/OSD and z/VSE

<name><node>:[<svc>]:NET

Element Description Permitted Values Default
<name> Sequence of letters Any sequence of letters is allowed. none
<node> Sequence of digits A node number for Entire Net-Work or a database ID. The node number is required. none
<svc> SVC number
z/OS, z/VSE SVCnnn, where nnn is a valid SVC number. SVC must be uppercase. When omitted, the default SVC number is used.
BS2000/OSD Not applicable.
none

Examples

Default Rules

Technical Limitations

Java

Other Programming Languages

Top of page