APPX Desktop Client Launched via Java Web Start

This document will explain how to start the APPX Desktop Client via Java Web Start Technology.

Overview

When you publish the APPX Desktop Client using Java Web Start technology you ensure the most current version of the application will be deployed, as well as the correct version of the Java Runtime Environment (JRE). Since the APPX Desktop Client will only be configured on the web server, you will not need to install the client on each desktop in your enterprise, just have the user base run the application for a published URL. This document applies to APPX Desktop Client version 5.0.4 and above. These instructions do not require any APPX server configuration other than an APPX Login Manager configured to accept logins. APPX server on any platform may be connected to via the client when launched with Java Web Start. The size of the APPX Java Web Start bundle is about 1.3 MB. When the APPX Desktop Client is run for the first time, Java Web Start will download the entire package ; the next time it will check only for modified jar files (an upgrade) and download them. If this is not the case, the application will start immediately.

Required software components

APPX Desktop Client Java Web Start Bundle

You can get the APPX Desktop Client Java Web Start Bundle from here for Unix or Linux or here for Windows.

APPX Server

You need a functioning APPX installation. Follow instructions in this document to install APPX on Windows if you don't already have APPX installed.

Web Server

You need a functioning web server configured with jnlp mime type support. Apache and IIS are two common servers.

Quick steps

APPX Desktop Client Java Web Start Bundle

  • Unbundle the APPX Desktop Client Java Web Start Bundle files into a directory off of your web server's web root.
  • Configure the .html file to link to the .jnlp file.
  • Edit the .jnlp file and modify any href tags to fit your web server.
  • Web Server .jnlp mime type settings
    • Apache
      • /etc/mime.types

APPX Server

Install APPX Server. No special configuration is needed in the APPX Server for APPX Desktop Client connectivity when launched via Java Web Start, just make sure you have an APPX Client Manager ( Unix or Linux or Windows) listening and accepting logins.

Detailed steps

Here are the steps I used to load the APPX Desktop Client via Java Web Start. These instructions assume that you already have a working installation of APPX Server that is configured with a Client Manager ( Unix or Linux or Windows) and accepting logins. You must also have a web server installed and started.

Download and place the APPX Desktop Client Java Web Start Bundle.

For a Windows Web Server, download the Java Web Start Bundle from here. For my Linux/Unix server I downloaded version 5.0.4 from here. Place the bundle in a directory off of your web server's web root and follow the steps below to install and configure.

  • I am going to use the command line tool wget to fetch the file bundle:

[joe@webserver /]$ cd /var/www/html 
[joe@webserver /]$ sudo wget http://www.appx.com/ftp/appx/products/appx/client/5.0.4/java_web.tgz
[joe@webserver html]$ 

  • Now let's untar the files

[joe@webserver html]$ sudo tar xzvf java_web.tgz

appx/
appx/appx32.gif
appx/README.txt
appx/INSTALL.txt
appx/appx.html
appx/splash.gif
appx/APPXLaunchButton.png
appx/appx-small.png
appx/appx-nativelib.jar
appx/appx.jar
appx/appx.jnlp

[joe@webserver html]$ ls -la

total 1216
drwxr-xr-x  3 root root    4096 Mar  4 14:27 .
drwxr-xr-x 10 root root    4096 Jun 26  2007 ..
drwxrwxrwx  2 root root    4096 Mar  3 14:40 appx
-rw-r--r--  1 root root 1233805 Mar  4 14:27 java_web.tgz

[joe@webserver html]$ cd appx
[joe@webserver appx]$ ls

appx32.gif  appx.html  appx.jar  appx.jnlp  APPXLaunchButton.png appx-small.png appx-nativelib.jar  INSTALL.txt  README.txt  splash.gif

APPX Desktop Client Web Start Bundle Components

appx32.gif

The appx32.gif file is the file used as an application runtime icon. It is referenced by the appx.jnlp file that we review later in this document.

README.txt

README.txt contains the following very brief instructions to the reader.

Place these files in a directory named /appx/ off your web server's webroot.

You need to change three items, all references to www.example.com to read your site URL:

In appx.html
 appx.html: ---> var url = "http://www.example.com/appx/appx.jnlp";
appx.html: ---> deployJava.launchButtonPNG = "http://www.example.com/appx/APPXLaunchButton.png";


In appx.jnlp:
appx.jnlp: ---> <jnlp spec="1.5+" codebase="http://www.example.com/appx" href="appx.jnlp" version ="5.0.4"> 

Please see our Wiki at http://wiki.appx.com/wiki/bin/view/Main/LaunchingAPPXDesktopClientFromWebPageViaJavaWebstart for further documentation. 

INSTALL.txt

INSTALL.txt points the reader to README.txt

appx.html

The appx.html file exists only to provide the user with a link to click the appx.jnlp file. It is not technically needed because if someone entered the path to the jnlp file the application would launch just the same as if the jnlp file had been clicked from a link in the html file. Let's take a look at the appx.html file. This file is just a starter file that you can use to load the .jnlp file. There is a bit of javascript code that attempts to detect if a JRE is installed on the user's desktop for the Java Web Start launch. If the JRE needs to be installed or updated the script will either attempt to update the JRE or present the user with the appropriate link to download the software manually.

appx.html contents
[joe@webserver appx]$ cat appx.html

<HTML>
   <HEAD>
      <TITLE>APPX Desktop Client Web Start</TITLE>
      <body link="#333333" vlink="#444444" alink="#106D86"> 
   </HEAD>
   <BODY BGCOLOR=#146C86>
      <font face="Verdana, Arial, Helvetica, sans-serif" size="2">
      <font color=white>
      <center>
      
      <hr>
      <font veranda>
      <font style=bold>
      <font size=13pt>
      <font color=white>
APPX Desktop Client Web Start Demonstration
      
      <h3>
Clicking the icon below will attempt to detect if the correct Java JRE is installed, and if possible install it.  If the installer determines you need an updated JRE but it can't auto install a JRE, it will place you on Sun's download page for your platform.  After the JRE requirement is met, the APPX Desktop Client will be downloaded and launched.
      <hr>
      
      <h3>
      <!--<A HREF="http://www.example.com/appx/appx.jnlp">Click</a> To Launch the APPX Desktop Client Demonstration-->
      <!-- Start of Sun's deployJava.js script that attempts to detect if Java is installed and install it or updated -->
      <!-- as needed for Windows, Linux and Mac.  Sun encourages you to hotlink their version of the script -->
      <!-- because they update it as needed.  At the moment, the Windows platform has the best support for detection -->
      <!-- This deployJava.js script is meant to replace the A HREF line above, so we've left it commented out -->
      <script src="http://java.com/js/deployJava.js"></script>
      <script>
         var url = "http://www.example.com/appx/appx.jnlp";
         deployJava.launchButtonPNG = "http://www.example.com/appx/APPXLaunchButton.png";
         deployJava.createWebStartLaunchButton(url, '1.6+');
      </script>
      <BR>
      <hr>
      <h5>Please see our <a href=http://wiki.appx.com/wiki/bin/view/Main/LaunchingAPPXDesktopClientFromWebPageViaJavaWebstart>Wiki</a> for further documentation. 
   </BODY>
</HTML>

[joe@webserver appx]$ 

appx.html modifications

You should change the following two URL values in your appx.html file to match your site.

         var url = " http://www.example.com/appx/appx.jnlp ";
         deployJava.launchButtonPNG = " http://www.example.com/appx/APPXLaunchButton.png ";

splash.gif

This is the initial image displayed while the APPX Desktop Client is loading, it is referenced by name in the appx.jnlp file.

APPXLaunchButton.png

APPXLaunchButton.png is an image file that is displayed for the user to click to begin the JRE detection and ultimately start the APPX Desktop Client.

appx-nativelib.jar

The appx-nativelib.jar file contains platform specific files for the proper execution of the appx.jar file.

appx.jar

The APPX Desktop Client in Java jar format.

appx.jnlp

This is an XML file that defines the environment that the APPX Desktop Client will run it. The file is made up of elements, element values, element stanzas and comments. The file is documented with comments. Now take a look at the appx.jnlp file.

appx.jnlp contents
[joe@webserver appx]$ cat appx.jnlp
<?xml version="1.0" encoding="utf-8"?>
<!-- JNLP File for APPX Desktop Client 5.0.4 -->
<?xml version="1.0" encoding="utf-8"?>
<!-- JNLP File for APPX Desktop Client  -->
<!-- example JNLP file that will launch the APPX Desktop Client 5.0.4 -->

<!-- where the jnlp file lives on the web -->
<jnlp spec="1.5+" codebase="http://www.example.com/appx" href="appx.jnlp" version ="5.0.4">
   <information>
      <title>APPX Desktop Client  Java Web Start Demo Application</title>
      <vendor>APPX Software, Inc.</vendor>
      <homepage href="http://www.appx.com"/>
      <description>APPX Desktop Client version 5.0.4.</description>
      <description kind="short">Connects to APPX Client Login Manager.</description>
      <!-- hover help for this app.  -->
      <description kind="tooltip">APPX Desktop Client 5.0.4</description>
      <!-- This is the APPX Desktop Client application icon and splash screen. -->
      <!-- relative to codebase -->
      <icon href="appx32.gif" kind="default"/>
      <icon href="splash.gif" kind="splash"/>
      <!-- allow app to run without Internet access -->
      <offline-allowed />
   </information>
   
   <!-- The APPX Desktop Client requires the all-permissions value for the security element -->
   <security>
      <all-permissions />
   </security>

   <resources>
      <!-- Acceptable JVMs in preferred order, best first -->
      <!-- Sun JVM -->
      <j2se version="1.6+" href="http://java.sun.com/products/autodl/j2se" />
      <!-- This swing.noxp value prevents a "look and feel" issue on Vista -->
      <property name="swing.noxp" value="true"/>
      <!-- application code, load before launch. JNLP 1.6 main="true" indicates jar with main class -->
      <jar href="appx.jar" main="true" download="eager" />
      <nativelib href="appx-nativelib.jar"/>
   </resources>

   <!-- application class with main method -->
   <!-- This is the section where you would add startup parameters for the APPX -->
   <!-- Desktop Client.  Items such as TCP port number, initial window size etc -->
   <application-desc main-class="start.Appx"> 
      <!-- command line arguments -->
      <argument>-windowTitle=APPX - $(host):$(port)</argument>
      <argument>-remotePort=8064</argument>
      <argument>-remoteUser=prospect</argument>
      <argument>-remoteHost=demo.appx.com</argument>
      <argument>-remotePassword=prospect</argument>
      <argument>-screenRows=28</argument>
      <argument>-screenColumns=110</argument>
      <argument>-SSLMode=disabled</argument>
   </application-desc>
</jnlp>

[joe@webserver appx]$ 

appx.jnlp modifications

You should change the following URL value in your appx.jnlp file to match your site.

         codebase=" http://www.example.com/appx " href="appx.jnlp"

Towards the end of the appx.jnlp file, notice the application-desc elements with argument attributes of -windowTitle, -remoteHost ... You can add any APPX Desktop Client startup parameter that you normally find when you select Options, Advanced upon initially starting the APPX Desktop Client.

Table of possible element / attribute available to you in a JNLP file.

Element

Attributes

Description

Since

Required

jnlp

This is the main xml element for a jnlp file. Everything is contained within the jnlp element.

1.0

yes

spec

The spec attribute can be 1.0, 1.5.0, or 1.6.0 or can use the wildcards such as 1.0+ or 1.6+. It denoted the minimum version of the JNLP Specification that this jnlp file can work with.

1.0

codebase

The codebase attribute specifies the base location for all relative URLs specified in href attributes in the JNLP file.

1.0

href

The href specifies the URL of the JNLP file itself.

1.0

version

The version of the application being launched, as well as the version of the JNLP file itself.

1.0

information

The information element contains other elements that describe the application and it's source.

1.0

yes

os

Specifies the operating system for which this information element should be considered.

1.5.0

arch

Specifies the architecture for which this information element should be considered

1.5.0

platform

Specifies the platform for which this information element should be considered.

1.5.0

locale

Specifies the locale for which this information element should be considered.

1.5.0

title

The title element specifies the title of the application.

1.0

yes

vendor

The vendor element specifies the provider of the application.

1.0

yes

homepage

The homepage of the application.

1.0

href

A URL pointing to where more information on this application can be found.

1.0

yes

description

A short statement describing the application.

1.0

kind

An indicator as to what type of description this is, legal values are one-line, short, and tooltip.

1.0

icon

Describes an icon that can be used to identify the application to the user.

1.0

href

A URL pointing to the icon file, may be in one of the following formats: gif, jpg, png, ico.

1.0

yes

kind

Indicates the suggested use of the icon, can be: default, selected, disabled, rollover, splash, or shortcut.

1.0

width

Can be used to indicate the resolution of the image.

1.0

height

Can be used to indicate the resolution of the image.

1.0

depth

Can be used to indicate the resolution of the image.

1.0

offline-allowed

Indicates that this application can operate when the client system is disconnected from the network.

1.0

shortcut

The shortcut element can be used to indicate an application's preferences for desktop integration.

1.5.0

online

Can be used to describe the application's preference for creating a shortcut to run online or offline.

1.5.0

desktop

Can be used to indicate an application's preference for putting a shortcut on the users desktop.

1.5.0

menu

Can be used to indicate an application's preference for putting a menu item in the users start menus.

1.5.0

sub-menu

Can be used to indicate an application's preference for where to place the menu item.

1.5.0

association

Can be used to hint to the JNLP client that it wishes to be registered with the operating system as the primary handler of certain extensions and a certain mime-type.

1.5.0

extensions

Contains a list of file extensions (separated by spaces) that the application requests it be registered to handle.

1.5.0

mime-type

Contains the mime-type that the application requests it be registered to handle.

1.5.0

related-content

Describes an additional piece of related content that may be integrated with the application.

1.5.0

href

A URL pointing to the related content.

1.5.0

yes

update

The update element is used to indicate the preferences for how application updates should be handled by the JNLP Client.

1.6.0

check

Indicates the preference for when the JNLP Client should check for updates. It can be always, timeout, or background..

1.6.0

policy

Indicates the preference for how the JNLP Client should handle an application update when it is known an update is available before the application is launched. It can be always, prompt-update, or prompt-run.

1.6.0

1.0

security

This element can be used to request enhanced permissions.

1.0

all-permissions

Requests that the application be run with all permissions.

1.0

j2ee-application-client-permissions

Requests that the application be run with a permission set that meets the security specifications of the J2EE Application Client environment.

1.0

1.0

resources

Describes all the resources that are needed for an application.

1.0

yes

os

Specifies the operating system for which the resources element should be considered.

1.0

arch

Specifies the architecture for which the resources element should be considered.

1.0

locale

Specifies that the locales for which the resources element should be considered.

java (or java se)

Specifies what version(s) of Java to run the application with.

1.6.0 (java)

version

Describes an ordered list of version ranges to use.

1.0

yes

href

The URL denoting the supplier of this version of java, and where it may be downloaded from.

1.0

java-vm-args

Indicates an additional set of standard and non-standard virtual machine arguments that the application would prefer the JNLP

Client to use when launching Java.

1.0

initial-heap-size

Indicates the initial size of the Java heap.

1.0

max-heap-size

Indicates the maximum size of the Java heap.

1.0

jar

Specifies a JAR file that is part of the application's classpath.

1.0

yes

href

The URL of the jar file.

1.0

yes

version

The requested version of the jar file. Requires using the version-based download protocol

1.0

main

Indicates if this jar contains the class containing the main method of the application.

1.0

download

Can be used to indicate this jar may be downloaded lazily, or when needed.

1.0

size

Indicates the downloadable size of the jar file in bytes.

1.0

part

Can be used to group resources together so they will be downloaded at the same time.

1.0

nativelib

Specifies a JAR file that contains native libraries in it's root directory.

1.0

href

The URL of the jar file.

1.0

yes

version

The requested version of the jar file. Requires using the version-based download protocol

1.0

download

Can be used to indicate this jar may be downloaded lazily.

1.0

size

Indicates the downloadable size of the jar file in bytes.

1.0

part

Can be used to group resources together so they will be downloaded at the same time.

1.0

extension

Contains pointer to an additional component-desc or installer-desc to be used with this application.

1.0

href

The URL to the additional extension jnlp file.

1.0

yes

version

The version of the additional extension jnlp file.

1.0

name

The name of the additional extension jnlp file

1.0

ext-download

Can be used in an extension element to denote the parts contained in a component-extension.

1.0

ext-part

Describes the name of a part that can be expected to be found in the extension.

1.0

yes

download

Can be used to indicate this extension may be downloaded eagerly or lazily.

1.0

part

Denotes the name of a part in this jnlp file to include the extension in.

1.0

package

Can be used to indicate to the JNLP Client which packages are implemented in which JAR files.

1.0

name

Package name contained in the jar files of the given part.

1.0

yes

part

Part name containing the jar files that include the given package name.

1.0

yes

recursive

Can be used to indicated that all package names beginning with the given name, can be found in the given part.

1.0

property

Defines a system property that will be available through the System.getProperty and System.getProperties methods.

1.0

name

Name of the system property.

1.0

yes

value

Value it will be set to.

1.0

yes

1.0

Note: A jnlp file must contain one of application-desc, applet-desc, component-desc, or installer-desc

1.0

yes

applicaation-desc

Denotes this is the jnlp file for an application.

1.0

main-class

The name of the class containing the public static void main(String[]) method of the application.

1.0

yes

argument

Each argument contains (in order) an additional argument to be passed to main.

1.0

applet-desc

Denotes this is the jnlp file for an applet.

1.0

main-class

This is the name of the main Applet class.

1.0

yes

documentbase

The document base for the Applet as a URL.

1.0

name

Name of the Applet.

1.0

yes

width

The width of the applet in pixels.

1.0

yes

height

The height of the applet in pixels

1.0

yes

param

A set of parameters that can be passed into the applet.

1.0

name

The name of this parameter

1.0

yes

value

The value of this parameter

1.0

yes

component-desc

Denotes this is the jnlp file for a component extension.

1.0

installer-desc

Denotes this is the jnlp file for an installed extension.

1.0

main-class

The name of the class containing the public static void main(String[]) method of the installer.

1.0

yes

Configure your web server's jnlp Mime type settings.

Your webserver needs to support the .jnlp mime type. There are too many web servers and web server version that each configure via different actions, syntax or configuration file location that it is beyond the scope of this document to cover mime type configuration fully. However, this might be enough to get you on the right track if your server is not already configured for jnlp mime type support.

Apache web server Mime type settings

You need to add a mime type entry for jnlp. You can either use the Apache AddType directive inside the Apache httpd.conf file or the .htaccess file, or modify the Apache web server global mime.types file. The location of this mime.types file is specified by the TypesConfig Apache directive. Apache recommends that you use the AddType directive.

If you wish to modify the Apache global TypesConfig file and the file exists in /etc/mime.types, then you might try syntax like the following which will grep for the jnlp entry, and if not found will append an entry for jnlp support.

[joe@webserver /]$ grep -qs 'application/x-java-jnlp-file' /etc/mime.types || echo 'application/x-java-jnlp-file jnlp' >> /etc/mime.types
[joe@webserver /]$ 

Or, if you wish to modify an .htaccess file in your http://www.example.com/appx/ directory, and your web server is configured to allow .htaccess modifications then try the following syntax which will grep for the jnlp entry, and if not found will append an entry for jnlp support.

[joe@webserver /]$ grep -qs 'application/x-java-jnlp-file' /var/www/html/appx/.htaccess || echo 'AddType application/x-java-jnlp-file jnlp' >> /var/www/html/appx/.htaccess 
[joe@webserver /]$ 

Microsoft IIS web server Mime type settings

Windows 2000 IIS Server

Start the IIS Management Console and perform the following steps:

  • Right-click server computer in left pane, then select Properties from the drop-down menu.
  • In the 'Computer MIME Map,' click the [Edit] button.
  • The File Types window is displayed. Click New Type.
  • In the File Type box, enter the following in the Associated Extension edit box:
    • jnlp
  • In the Content Type (MIME) box, enter:
    • Application/x-java-jnlp-file jnlp
  • Click [Ok] to close the File Type box. Click [Ok] again to close the File Types Window. Click [Ok] in the Server properties window to save the changes. Restart the IIS Admin Service.
Windows Server 2003 and XP IIS Server

Start the IIS Management Console and perform the following steps:

  • Right-click server computer in left pane, then select Properties from the drop-down menu.
  • In the HTTP Headers tab, click [MIME Types].
  • The MIME Types window displays. Click [New].
  • In the MIME Type box, enter the following in the Extension edit box:
    • jnlp
  • In the MIME type box, enter:
    • Application/x-java-jnlp-file jnlp
  • Click [OK] to close the MIME Type box. Click [OK] again to close the MIME Types Window. Click [OK] in the Server properties window to save the changes. Restart the IIS Admin Service.
Windows Vista IIS Server

Start the IIS Management Console and perform the following steps:

  • Double-click the MIME Types module.
  • The MIME Types window displays. Click [Add] in the Action panel.
  • The Add MIME Type window displays. Enter the following in the File Name Extension box:
    • jnlp
  • In the MIME Type box, enter:
    • Application/x-java-jnlp-file jnlp
  • Click [OK] to close the MIME Type window. Restart the IIS Admin Service.

That's all there is to publishing APPX Desktop Client utilizing Java Web Start technology.

Troubleshooting tips

  • To clear the Web Start Cache
    • javaws -uninstall This will remove all cached applications.
  • Clear Browser's temporary files.

Bugs:

  1. Fixed - Bug Description 1.
  2. OPEN - Bug test - Test bug. Not valid.

Comments:

Read what other users have said about this page or add your own comments.


Is there a .zip version of java_web.tgz? Or something that Windows Vista knows how to uncompress?

-- RogerHuffman - 26 Mar 2009

You should be able to use WinRAR to unzip a tgz file on Windows. WinRAR is a free download, available at http://download.cnet.com/WinRAR/3000-2250_4-10007677.html, and other places as well. But your point is a good one, and we'll probably add a zip file version shortly.

-- AlKalter - 26 Mar 2009

The application cannot connect if the user’s browser has a proxy server configured. The browser downloads the “JAR” file without any problem, when I give the user name and password I cannot connect to APPX server. Is there any configuration that can solve this problem?

-- GerardoLopez - 01 Apr 2009

-- JoeOrtagus - 04 Mar 2009
Edit | Attach | Watch | Print version | History: r73 | r67 < r66 < r65 < r64 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r65 - 2012-02-23 - JoeOrtagus
 
  • Edit
  • Attach
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback