JRun SDK Guide
Embedding JRun

Rebranding JRun tools

JRun includes several executable JAR files that have GUIs. These tools rely on image files and resource bundles for their look and feel. It is possible to edit these files to rebrand these tools.

The tools with GUIs are:

• JRun Launcher
• Web Server Configuration tool
• JRun Enterprise Deployment Wizard
• JRun Enterprise Deployment Wizard Installer

Most commonly, you will want to rebrand the JRun Launcher and the Web Server Configuration tool. This section describes how to rebrand these two tools.

In addition to the techniques described in this section, you can use the source code included in the JRun SDK to write your own custom JRun tools to be part of your application suite. The SDK provides source code for the following tools:

• JRun Management Console (JMC)
• Web server connectors
• Windows service
• JRun Launcher
• JAAS Windows login module
• OpenSSL toolkit

For more information about source code, see "JRun source code".

Rebranding the Web Server Configuration tool

Retail JRun customers use the Web Server Configuration tool to connect their external web servers to the JRun application server. As an OEM, you can rebrand the tool so it looks like part of your customer's application suite.

To rebrand the Web Server Configuration tool:

1. Stop all JRun servers and JRun utilities.
2. Make a back-up copy of the wsconfig.jar file.
3. Extract the image and text files using the JAR utility.

   For example, to extract the images used by the Web Server Configuration tool, use the following command:

   %> jar -xf wsconfig.jar jrunx\connectorinstaller\gui\resources
   

   The JAR utility extracts the images and maintains their directory structure.

4. Change the files using the techniques in the following sections.
5. Replace the existing files in the JAR with your new files.

   For example, to add the images back into the wsconfig.jar, use the following command:

   %> jar -uvf wsconfig.jar jrunx\connectorinstaller\gui\resources\
   

Replacing images

The wsconfig.jar executable JAR file contains images used in the Web Server Configuration tool. The images are located in the /jrunx/connectorinstaller/gui/resources directory.

The tool reads in these images at runtime. When you change the images, they appear the next time that you start the tool.

The following table describes the images used by the Web Server Configuration tool:

Image name	Size	Appearance
jrun-title.gif	366 x 80
jrun-title-bg.gif	40 x 80
jr_16_256.gif	16 x 16

Use the following techniques when rebranding the Web Server Configuration tool:

• Do not change the size of the images without testing. This can adversely affect the GUI layout.
• You must use the same filenames for the images.

The following image shows the Web Server Configuration tool as it might appear after rebranding:

Replacing text

The wsconfig.jar executable JAR file contains text files that are used in the Web Server Configuration tool. The text files are located in the /jrunx/connectorinstaller/gui directory. Each resource bundle provides the text for the tool in one language.

The following table describes the resource bundles used by the Web Server Configuration tool:

File	Description
resource.properties	The English-language version of the text used by the Web Server Configuration tool. The text is stored using the ISO-8859-1 (English: Latin-1) character set.
resource_de.properties	The German-language version of the text used by the Web Server Configuration tool. The text is stored using the ISO-8859-1 (English: Latin-1) character set with escaped Unicode sequences for special characters.
resource_fr.properties	The French-language version of the text used by the Web Server Configuration tool. The text is stored using the ISO-8859-1 (English: Latin-1) character set with escaped Unicode sequences for special characters.
resource_ja.properties	The Japanese-language version of the text used by the Web Server Configuration tool. The text is stored using escaped Unicode sequences.
resource_ko.properties	The Korean-language version of the text used by the Web Server Configuration tool. The text is stored using escaped Unicode sequences.

Resource bundles contain only Strings. The format of a resource bundle is as follows:

token_name=token_content

Use one token per line. Comments are indicated with a pound sign (#) at the beginning of the line; for example:

# Add Configuration Dialog

Add.WindowTitle=Add Web Server Configuration
Add.JRunPanelTitle=JRun Server Properties
Add.WebServerPanelTitle=Web Server Properties

Each token_name is referenced in the Web Server Configuration tool at runtime.

Use the following techniques when rebranding the Web Server Configuration tool:

• Do not replace a token with another token that is significantly longer or shorter than the existing token. This can change the GUI layout.
• If you are working with foreign-language versions, write the text in the native format, and then use a tool that converts characters to Unicode.
• The easiest way to rebrand the tool is to replace all occurrences of the word "JRun" with the name of your application.
• You must use the same names for the resource bundles.

Rebranding the JRun Launcher

Retail JRun customers use the JRun Launcher to start, stop, and restart JRun servers. As an OEM, you can rebrand the tool to make it look like it is part of the customer's application suite.

To rebrand the JRun Launcher:

1. Stop all JRun servers and JRun utilities.
2. Make a back-up copy of the jrun.jar file.
3. Extract the image and text files using the JAR utility.

   For example, to extract the jrun_logo.gif image used by the JRun Launcher, use the following command:

   %> jar -xf jrun.jar jrunx\launcher\resources\jrun_logo.gif
   

   The JAR utility extracts the image and maintains its directory structure.

4. Change the files using the techniques in the following sections.
5. Replace the existing files in the JAR with your new files.

   For example, to add the jrun_logo.gif file back into the jrun.jar:

   %> jar -uvf jrun.jar jrunx\launcher\resources\jrun_logo.gif
   

Replacing the JRun logo

The jrun.jar executable JAR file contains the image used in the JRun Launcher. The image is located in the /jrunx/launcher/resources directory.

The tool reads in the image at runtime. When you change the image, it appears the next time that you start the tool.

The following table describes the image used by the JRun Launcher tool:

Image name	Size	Appearance
jrun_logo.gif	16 x 16

Use the following techniques when rebranding the JRun Launcher:

• Do not change the size of the image without testing. This can adversely affect the GUI layout.
• You must use the same filename for the image.

Replacing text

The jrun.jar executable JAR file contains text files used in the JRun Launcher. The text files are located in the /jrunx/launcher directory.

To rebrand the JRun Launcher, change the values of the tokens in the properties file. The following table describes the tokens that you will most likely change for the JRun Launcher tool:

Token	Description
GUIView.WindowTitle	Appears in the title bar of the JRun Launcher tool. The default is JRun Launcher.
GUIView.ServersTableHeader	Appears at the top of the servers column in the JRun Launcher tool. The default is JRun Servers.

The naming convention and usage of the resource bundles are the same as with the Web Server Configuration tool's resource bundles. For more information on working with these files, see "Replacing text".

Using the JRun Launcher source code

The JRun SDK also includes source code for the JRun Launcher utility. The C source code for the JRun Launcher is contained in the sdk_root/src/C/launcher directory. Source code is provided for the following platforms:

• AIX
• Alpha
• HP-UX
• Generic UNIX
• Windows

You must have a C compiler to compile the JRun Launcher source code.

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/jrun/4/JRun_SDK_Guide/embedding5.htm

Add Comment