/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
|
* add the following below this CDDL HEADER, with the fields enclosed
|
* by brackets "[]" replaced with your own identifying * information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Portions Copyright 2006 Sun Microsystems, Inc.
|
*/
|
|
package org.opends.quicksetup.installer.webstart;
|
|
import java.io.IOException;
|
import java.net.MalformedURLException;
|
import java.net.URL;
|
|
import javax.jnlp.DownloadService;
|
import javax.jnlp.DownloadServiceListener;
|
import javax.jnlp.ServiceManager;
|
import javax.jnlp.UnavailableServiceException;
|
|
import org.opends.quicksetup.i18n.ResourceProvider;
|
import org.opends.quicksetup.installer.InstallException;
|
import org.opends.quicksetup.util.Utils;
|
|
/**
|
* This class is used to download the files that have been marked as lazy
|
* in the OpenDSQuickSetup.jnlp file.
|
*
|
* The global idea is to force the user to download just one jar file
|
* (quicksetup.jar) to display the Web Start installer dialog. Then QuickSetup
|
* will call this class and it will download the jar files. Until this class is
|
* not finished the WebStartInstaller will be on the
|
* InstallProgressStep.DOWNLOADING step.
|
*/
|
public class WebStartDownloader implements DownloadServiceListener,
|
JnlpProperties
|
{
|
private InstallException ex;
|
|
private boolean isFinished;
|
|
private int downloadPercentage = 0;
|
|
private int currentPercMin = 0;
|
|
private int currentPercMax = 0;
|
|
/**
|
* Starts the downloading of the jar files. If forceDownload is set to
|
* <CODE>true</CODE> the files will be re-downloaded even if they already
|
* are on cache.
|
*
|
* This method does not block the thread that calls it.
|
*
|
* @param forceDownload used to ignore the case and force download.
|
*/
|
public void start(final boolean forceDownload)
|
{
|
isFinished = false;
|
Thread t = new Thread(new Runnable()
|
{
|
public void run()
|
{
|
try
|
{
|
startDownload(forceDownload);
|
} catch (MalformedURLException mfe)
|
{
|
mfe.printStackTrace();
|
// This is a bug
|
ex =
|
new InstallException(InstallException.Type.BUG, getExceptionMsg(
|
"bug-msg", mfe), mfe);
|
} catch (IOException ioe)
|
{
|
ioe.printStackTrace();
|
StringBuffer buf = new StringBuffer();
|
String[] jars = getJarUrls();
|
for (int i = 0; i < jars.length; i++)
|
{
|
if (i != 0)
|
{
|
buf.append(",");
|
}
|
buf.append(jars[i]);
|
}
|
String[] arg =
|
{ buf.toString() };
|
ex =
|
new InstallException(InstallException.Type.DOWNLOAD_ERROR,
|
getExceptionMsg("downloading-error", arg, ioe), ioe);
|
} catch (RuntimeException re)
|
{
|
re.printStackTrace();
|
// This is a bug
|
ex =
|
new InstallException(InstallException.Type.BUG, getExceptionMsg(
|
"bug-msg", re), re);
|
}
|
}
|
});
|
t.start();
|
}
|
|
/**
|
* Returns <CODE>true</CODE> if the install is finished and
|
* <CODE>false</CODE> otherwise.
|
* @return <CODE>true</CODE> if the install is finished and
|
* <CODE>false</CODE> otherwise.
|
*/
|
public boolean isFinished()
|
{
|
return isFinished;
|
}
|
|
/**
|
* Returns the current download percentage.
|
* @return the current download percentage.
|
*/
|
public int getDownloadPercentage()
|
{
|
return downloadPercentage;
|
}
|
|
/**
|
* Starts synchronously the downloading on this thread. The thread calling
|
* this method will be blocked. If forceDownload is set to
|
* <CODE>true</CODE> the files will be re-downloaded even if they already
|
* are on cache.
|
* @param forceDownload used to ignore the case and force download.
|
* @throws MalformedURLException if there is an error with the URL that we
|
* get from the JnlpProperties.
|
* @throws IOException if a network problem occurs.
|
*/
|
private void startDownload(boolean forceDownload)
|
throws MalformedURLException, IOException
|
{
|
DownloadService ds;
|
|
try
|
{
|
ds =
|
(DownloadService) ServiceManager.lookup(
|
"javax.jnlp.DownloadService");
|
} catch (UnavailableServiceException e)
|
{
|
ds = null;
|
}
|
|
if (ds != null)
|
{
|
String[] urls = getJarUrls();
|
String[] versions = getJarVersions();
|
|
for (int i = 0; i < urls.length && (getException() == null); i++)
|
{
|
currentPercMin = (100 * i) / urls.length;
|
currentPercMax = (100 * (i + 1)) / urls.length;
|
|
// determine if a particular resource is cached
|
String sUrl = urls[i];
|
String version = versions[i];
|
|
URL url = new URL(sUrl);
|
boolean cached = ds.isResourceCached(url, version);
|
|
if (cached && forceDownload)
|
{
|
try
|
{
|
ds.removeResource(url, version);
|
} catch (IOException ioe)
|
{
|
}
|
cached = false;
|
}
|
|
if (!cached)
|
{
|
// if not in the cache load the resource into the cache
|
ds.loadResource(url, version, this);
|
}
|
}
|
}
|
isFinished = true;
|
}
|
|
/**
|
* Returns the InstallException that has occurred during the download or
|
* <CODE>null</CODE> if no exception occurred.
|
* @return the InstallException that has occurred during the download or
|
* <CODE>null</CODE> if no exception occurred.
|
*/
|
public InstallException getException()
|
{
|
return ex;
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void downloadFailed(URL url, String version)
|
{
|
ex =
|
new InstallException(InstallException.Type.DOWNLOAD_ERROR, getMsg(
|
"downloading-error", new String[]
|
{ url.toString() }), null);
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void progress(URL url, String version, long readSoFar, long total,
|
int overallPercent)
|
{
|
if (overallPercent >= 0)
|
{
|
downloadPercentage = getPercentage(overallPercent);
|
}
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void upgradingArchive(URL url, String version, int patchPercent,
|
int overallPercent)
|
{
|
if (overallPercent >= 0)
|
{
|
downloadPercentage = getPercentage(overallPercent);
|
}
|
}
|
|
/**
|
* {@inheritDoc}
|
*/
|
public void validating(URL url, String version, long entry, long total,
|
int overallPercent)
|
{
|
if (overallPercent >= 0)
|
{
|
downloadPercentage = getPercentage(overallPercent);
|
}
|
}
|
|
/**
|
* Returns the jar files in a String[] from the System properties.
|
* @return the jar files from the System properties.
|
*/
|
private String[] getJarUrls()
|
{
|
String jars = System.getProperty(LAZY_JAR_URLS);
|
return jars.split(" ");
|
}
|
|
|
/**
|
* Returns the downloaded percentage based on how much of the current jar file
|
* has been downloaded.
|
* @param currentJarRatio the download ratio of the jar file that is being
|
* currently downloaded.
|
* @return the downloaded percentage based on how much of the current jar file
|
* has been downloaded.
|
*/
|
private int getPercentage(int currentJarRatio)
|
{
|
int perc =
|
currentPercMin
|
+ (currentJarRatio * (currentPercMax - currentPercMin) / 100);
|
return perc;
|
}
|
|
/**
|
* Returns the java jar versions in a String[]. Currently just returns some
|
* null strings.
|
* @return the java jar versions in a String[].
|
*/
|
private String[] getJarVersions()
|
{
|
return new String[getJarUrls().length];
|
}
|
|
/* Some commodity methods to get localized messages */
|
private String getExceptionMsg(String key, Exception ex)
|
{
|
return getExceptionMsg(key, null, ex);
|
}
|
|
private String getExceptionMsg(String key, String[] args, Exception ex)
|
{
|
return Utils.getExceptionMsg(ResourceProvider.getInstance(), key, args, ex);
|
}
|
|
private String getMsg(String key, String[] args)
|
{
|
return ResourceProvider.getInstance().getMsg(key, args);
|
}
|
}
|
