Jolt Relay

Note: The Jolt Relay is transparent to Jolt clients and Jolt servers. A Jolt server can simultaneously connect to intranet clients directly, or through the Jolt Relay to Internet clients.

Jolt Internet Relay Path

Jolt Relay Failover

There are two points of failovers associated with JRLY:

Jolt Client to JRLY Connection Failover

If one server address does not result in a successful session, the failover function allows the Jolt Client API to connect to the next free (unconnected) JRLY specified in the argument list of the API. To enable this failover in a Windows 2000 environment, multiple Windows 2000 JRLY services can be executed. In a non-Windows 2000 environment, multiple JRLY processes are executed. Each JRLY (service or process) has its own configuration file. This type of failover is handled by the client API features in BEA Jolt, which allow you to specify a list of Jolt server addresses (JSL or JRLY).

JRLY to JRAD Adapter Connection Failover

Each JRLY configuration file has a list of JRAD addresses. When a JRAD is unavailable, JRLY tries to connect to the next free (unconnected) JRAD, in a round-robin fashion. Two JRLYs cannot connect to the same JRAD. Given these facts, you can make the connection efficient by giving different JRAD address orders. That is, if you make one extra JRAD available on standby, the first JRLY that loses its JRAD connects to the extra JRAD. This type of failover is handled by JRLY alone.

If any of the listed JRADs are not executing when JRLY is started, the initial connection fails. When a Jolt client tries to connect to JRLY, the JRLY again tries to connect to the JRAD.

To accommodate the failover functionality, you have to boot multiple JRADs by configuring them in the UBBCONFIG file.

Jolt Relay Process

The JRLY (front-end relay) process can be started before or after the JRAD is started. If the JRAD is not available when the JRLY is started, the JRLY attempts to connect to the JRAD when it receives a client request. If JRLY is still unable to connect to the JRAD, the client is denied access and a warning is written to the JRLY error log file.

Starting the JRLY on UNIX

Start the JRLY process by typing the command name at a system prompt.

jrly -f config_file_path

If the configuration file does not exist or cannot be opened, the JRLY prints an error message.

If the JRLY is unable to start, it writes a message to standard error and attempts to log the startup failure in the error log, then exits.

JRLY Command-line Options for Windows 2000

This section describes command-line options that are available from the Windows 2000 version of JRLY.exe. Note the following:

The JRLY command-line options are detailed in the following table:

JRLY Command-line Options for Windows 2000

Option	Description
jrly -install [display_suffix]	Install jrly as a Windows 2000 service. Example 1: jrly -install In this example, the default JRLY is installed as a Windows 2000 Service and is displayed in the Service Control Manager (SCM) as Jolt Relay. Example 2: jrly -install MASTER In this case, an instance of JRLY is installed as a Windows 2000 Service and is displayed in the SCM as Jolt Relay_MASTER. The suffix, MASTER, does not have any significance; it is only used to uniquely identify various instances of JRLYs. At this point, this instance of JRLY is not ready to start. It must be assigned the configuration file (see the set command discussion) that specifies the listening TCP/IP port, JSH connection TCP/IP port, log files, and sockettimeout. This file should not be shared between various instances of JRLY.
jrly -remove [display_suffix] | -all	Remove one or all instances of JRLY from Windows 2000 service. If [display_suffix] is specified, this command removes the specified JRLY service. If [display_suffix] is not specified, this command removes the default JRLY from being a Windows 2000 Service. If the -all option is specified, all JRLY Windows 2000 Services are removed. Related Windows 2000 registry entries under HKEY_LOCAL_MACHINE\System\ CurrentControlSet\Services\BEA JoltRelay and HKEY_LOCAL_MACHINE\Software\ BEA Systems\Jolt\x.x are removed.
jrly -set [-d display_suffix] -f config_file	Update the registry with the full path of a new configuration file. Example 1: jrly -set -f c:\tux71\udataobj\jolt\jrly.con In this example, the default JRLY Windows 2000 Service (Jolt Relay) is assigned a configuration file called jrly.con that is located in: c:\tuxdir\udataobj\jolt directory. Example 2: jrly -set -d MASTER -f c:\tuxdir\udataobj\jolt\master.con Here, the JRLY Windows 2000 Service instance, called Jolt Relay_MASTER is assigned a configuration file called jrly_master.con that is located in c:\tuxdir\udataobj\jolt directory.
jrly -manual [display_suffix]	Set the start/stop to manual. This command sets the specified JRLY instance to be manually controlled, using either the command-line options or the SCM.
jrly -auto [display_suffix]	Set the start/stop to automatic. This command sets all the operations for a specified Windows 2000 Service to be automatically started when the OS boots and stopped when the OS shuts down.
jrly -start [display_suffix]	Start the specified JRLY.
jrly -stop [display_suffix]	Stop the specified JRLY.
jryl -version	Print the current version of JRLY binary.
jrly -help	Print command-line options with brief descriptions.

JRLY Command-line Option for UNIX

There is only one JRLY command-line option for UNIX:

JRLY Command-line Option for UNIX

Option	Description
jrly -f config_file_path	Start the JRLY process. This option starts the JRLY process. If the configuration file does not exist or cannot be opened, the JRLY prints an error message. If the JRLY cannot start, it writes a message to standard error, attempts to log the startup failure in the error log, then exits.

JRLY Configuration File

The format of the configuration file is a TAG=VALUE format. Blank lines or lines starting with a "#" are ignored. The following listing contains an example of the formal specifications of the configuration file.

Specification of Configuration File

LOGDIR=<LOG_DIRECTORY_PATH>
ACCESS_LOG=<ACCESS_FILE_NAME in LOGDIR>
ERROR_LOG=<ERROR_FILE_NAME in LOGDIR>
LISTEN=<IP:Port combination where JRLY will accept connections>
CONNECT=<IP:Port combination associated with JRAD>

SOCKETTIMEOUT=<Seconds for socket accept()function>

Note: SOCKETTIMEOUT is the duration (in seconds) of which the relay Windows 2000 service blocks the establishment of new socket connections to allow network activity (new connections, data to be read, closed connections). It is valid only on Windows 2000 machines. SOCKETTIMEOUT also affects the SCM. When the SCM requests that the service stop, the SCM needs to wait at least SOCKETTIMEOUT seconds before doing so.

The following listing shows an example of the JRLY configuration file. The CONNECT line specifies the IP address and port number of JRAD machine.

Example of JRLY Configuration File

LOGDIR=/usr/log/relay
ACCESS_LOG=access_log
ERROR_LOG=errorlog
# jrly will listen on port 4444
LISTEN=200.100.10.100:4444
CONNECT=machine1:port1
CONNECT=machine2:port2

SOCKETTIMEOUT=30            //See text under listing

The format for directory and filenames is determined by the operating system. UNIX systems use the forward slash (/). Windows 2000 systems use the backslash (\). If any file specified in LOGDIR, ACCESS_LOG or ERROR_LOG cannot be opened for writing, the JRLY prints an error message on stderr and exits.

The formats for host names and port numbers are shown in the following table.

Host Name and Port Number Formats