Deploying Ephox EditLive! for Java

Summary

The Ephox EditLive! for Java auto-deploy feature allows users to have Ephox EditLive! for Java seamlessly installed when running a page containing Ephox EditLive! for Java, rather than them having to physically download and install Ephox EditLive! for Java themselves.  This greatly simplifies the process for the end user.  This article contains the following information:

More Information

What is the auto-deploy feature?

The auto-deploy feature of Ephox EditLive! for Java allows users to have Ephox EditLive! for Java seamlessly installed or upgraded when running a page containing Ephox EditLive! for Java, rather than them having to physically download and install Ephox EditLive! for Java themselves.  This greatly simplifies the process for the end user.

The auto-deploy procedure takes advantage of Java Applet technology using signed JAR files.  All of the necessary files for this are included in the editlivejava folder, which is installed on your machine as part of the Ephox EditLive! for Java Development Kit.

To see how this auto-deploy feature works simply view any of our online demonstrations on the Ephox Web site.  If you do not have Ephox EditLive! for Java; installed the auto-deploy feature will seamlessly download and install it for you.

Implementing the auto-deploy feature

In order for your pages to use the auto-deploy feature you will need to have all of the EditLive! for Java installation files copied to your server.  These are installed as part of the Ephox EditLive! for Java Development Kit.

  1. Download the Ephox EditLive! for Java Development Kit from the Ephox Web site.
  2. Install the Ephox EditLive! for Java Development Kit.
  3. Upload the editlivejava folder that is installed with the Ephox EditLive! for Java Development Kit to your Web server.
  4. Ensure that in your pages that contain Ephox EditLive! for Java set the setDownloadDirectory property to reference the editlivejava folder.

To set the setDownloadDirectory property set the property to where the EditLive! for Java installation files (the "editlivejava" folder) can be found on your server.  This is done at the beginning of the server side code block where the EditLive! for Java JavaScript object is instantiated.

var editlivejava1;
editlivejava1 = new EditLiveJava("ELJApplet1","600","400");
editlivejava1.setDownloadDirectory("../editlivejava");
editlivejava1.setLocalDeployment(true);

Installing the JRE

Ephox EditLive! for Java requires that JRE Version 1.3.1-02 is installed on the user's computer.  If this is not detected then Ephox EditLive! for Java's auto-deployment feature will automatically install this version of the JRE.  Ephox EditLive! for Java's setLocalDeployment property determines where the JRE will be downloaded from.  An example of setting this attribute is provided in the code sample above.

When this property is set to true the JRE will be downloaded from the local server's editlivejava folder.  When this property is set to false the JRE will be downloaded from a Sun Microsystems server.

Installing the JRE from your own server

This is recommended when users will usually be accessing Ephox EditLive! for Java Web applications on an intranet.  In this case it will commonly be much faster to download the JRE from the local server than from a Sun Microsystems server.  It should be noted though, that while installing the JRE in this manner, no progress indicator will be displayed to the user.

Installing the JRE from a Sun Microsystems server

This is recommended when users will usually be accessing Ephox EditLive! for Java on a network external to the server on which the editlivejava folder can be found (ie. accessing Ephox EditLive! for Java over the Internet).  In this case download times for the JRE can be expected to be much slower than an install over an intranet.  Sun Microsystems deploys the JRE 1.3.1-02 on the Internet in the form of a .cab file.  When the JRE is installed in this way a progress indicator will be visible to the user.

See Also

Copyright © 2001-2004 Ephox Corporation. All Rights Reserved.