Getting started with xfNetLink Java

This topic lists all the steps that need to be completed to successfully create a distributed system using xfNetLink Java. Note that these steps may not all be done by you, the Synergy developer. For example, you may create the Java JAR file and give it to a Java developer to create a web front-end for your application. The Java developer may also work with a web-page developer to create the HTML portions of the user interface. However, these steps should give you a feel for everything that needs to be done, regardless of who does it. See also figure 1.

1. Steps in creating an xfNetLink Java – xfServerPlus application.

1.

Install the Java Development Kit. See System requirements for supported versions.

2.

Install the necessary Synergy software. The components you need to install vary depending on your set-up (e.g., what OS your source files are on, where you intend to do the development, and so on).

• The Java class wrapper generation tools, genxml and genjava, are part of the xfNetLink Java distribution. After installing, set your classpath. See Setting the classpath.
• The Professional Series Development Environment (or Workbench) installation includes dbl2xml, the SMC/ELB comparison utility, the MDU and SMC files, and genxml. On UNIX and OpenVMS, these utilities are part of the Synergy DBL installation.
• xfServerPlus must be installed on your Synergy server machine. The xfServerPlus installation also includes the MDU, SMC files, and genxml. For detailed steps on setting up xfServerPlus, see Configuration overview.

3.

Modularize your existing Synergy code for the routines that you want to access remotely and encapsulate them in ELBs or shared images. See Preparing Your Synergy Server Code.

4.

Populate the Synergy Method Catalog with information about your Synergy routines. We recommend that you do this by attributing your code and running dbl2xml (see Using attributes to define Synergy methods). Alternatively, you may use the Method Definition Utility to enter the data (see Using the MDU to define Synergy methods). As you do this, you’ll group the routines into interfaces.

If you choose to put the SMC somewhere other than DBLDIR, set the XFPL_SMCPATH environment variable (see Setting the XFPL_SMCPATH environment variable for xfServerPlus).

5.

In the xfpl.ini file, set logging options for the xfServerPlus log and set logicals that point to the ELBs you specified in the SMC. You may also need to set other options in the xfpl.ini file; see Appendix A: Configuration Settings for a complete list of xfpl.ini configuration settings.

If you choose to put the xfpl.ini file somewhere other than DBLDIR, set the XFPL_INIPATH environment variable.

For information on the log and XFPL_INIPATH, see Using server-side logging and Setting the XFPL_INIPATH environment variable. See Defining logicals for information on setting logicals that point to your ELBs.

6.

Create a user account on the xfServerPlus machine to run xfServerPlus sessions, and then start xfServerPlus. See the topic for your operating system:

• Running xfServerPlus on Windows
• Running xfServerPlus on UNIX
• Running xfServerPlus on OpenVMS

7.

Generate the class wrappers:

• If you’re using Workbench, create a Synergy/DE Java Component project and specify the component information, such as a name and location for the JAR file, the Java version you want to target, and the interfaces you want to include. Then, use the menu option to generate class wrappers. See Creating a Synergy/DE Java Component project and Generating Java class wrappers.
• If you’re using the command line, run the genxml utility to create an XML file, and then run genjava to create the Java class wrappers. See Creating a Java JAR file from the command line.

8.

(optional) Modify the generated Java source files, if necessary. See Editing the Java source files.

9.

Build the JAR file:

• If you’re using Workbench, use the menu option to compile the Java classes and create a JAR file. See Building a JAR file in Workbench.
• If you’re using the command line, run the batch file that was created by genjava to compile the files and create the JAR file. See Building a JAR file from the command line.

10.

Distribute the JAR file and other necessary files to the Java developer, who will then use the JAR file when writing the client-side code for your distributed application. See Setting up your environment for development and Using your JAR file: The basics.