org.tentackle.update.AbstractUpdateServiceImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tentackle-update Show documentation
Show all versions of tentackle-update Show documentation
Tentackle Application Update Service
/*
* Tentackle - https://tentackle.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.tentackle.update;
import org.tentackle.common.FileHelper;
import org.tentackle.common.TentackleRuntimeException;
import java.io.IOException;
import java.io.Serial;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.rmi.RemoteException;
import java.rmi.server.RMIClientSocketFactory;
import java.rmi.server.RMIServerSocketFactory;
import java.rmi.server.UnicastRemoteObject;
import java.util.Map;
import java.util.OptionalLong;
import java.util.StringTokenizer;
import java.util.concurrent.ConcurrentHashMap;
/**
* Server side update service implementation.
*/
public abstract class AbstractUpdateServiceImpl extends UnicastRemoteObject implements UpdateService {
@Serial
private static final long serialVersionUID = 1L;
@SuppressWarnings("serial")
private final Map downloadSizes = new ConcurrentHashMap<>(); // size in bytes of the download ZIPs
@SuppressWarnings("serial")
private final Map checksumHashes = new ConcurrentHashMap<>(); // checksum hashes of the download ZIPs
private String updateURL;
/**
* Creates an update service object.
*
* @param port the tcp-port, 0 = system default
* @param updateURL the http url where to download the updates from
* @throws RemoteException if failed to export object
*/
public AbstractUpdateServiceImpl(int port, String updateURL) throws RemoteException {
super(port);
setUpdateURL(updateURL);
}
/**
* Creates an update service object.
*
* @param port the tcp-port, 0 = system default
* @param updateURL the http url where to download the updates from
* @param csf the client socket factory
* @param ssf the server socket factory
* @throws RemoteException if failed to export object
*/
public AbstractUpdateServiceImpl(int port, String updateURL, RMIClientSocketFactory csf, RMIServerSocketFactory ssf) throws RemoteException {
super(port, csf, ssf);
setUpdateURL(updateURL);
}
/**
* Gets the artifact name excluding the version.
*
* Example:
*
admin-jlink-client
*
* @return the artifact name
*/
public abstract String getArtifactName();
/**
* Gets the server version.
*
* @return the version
*/
public abstract String getVersion();
/**
* Gets the update base URL.
*
* @return the url (with trailing slash!)
*/
public String getUpdateURL() {
return updateURL;
}
/**
* Sets the update base URL.
*
* @param updateURL the url
*/
public void setUpdateURL(String updateURL) {
this.updateURL = updateURL.endsWith("/") ? updateURL : (updateURL + "/");
}
@Override
public UpdateInfo getUpdateInfo(ClientInfo clientInfo) throws RemoteException {
try {
URL zipURL = createZipURL(clientInfo);
URL checksumURL = createChecksumURL(clientInfo);
String checksumHash = determineChecksumHash(checksumURL);
long size = determineDownloadSize(zipURL);
String updateExecutor = createUpdateExecutor(clientInfo);
return createUpdateInfo(getVersion(), zipURL, checksumHash, size, updateExecutor);
}
catch (IOException ex) {
throw new RemoteException("cannot create update info", ex);
}
}
/**
* Creates the update info to be returned to the client.
*
* @param version the new application version
* @param zipURL the URL to download the zip file
* @param checksumHash the checksum hash
* @param size the download size
* @param updateExecutor the filename to execute to perform the update
* @return the update info
*/
protected UpdateInfo createUpdateInfo(String version, URL zipURL, String checksumHash, long size, String updateExecutor) {
return new UpdateInfo(version, zipURL, checksumHash, size, updateExecutor);
}
/**
* Creates the name of the update executor.
*
* @param clientInfo the client info
* @return the executor name
*/
protected String createUpdateExecutor(ClientInfo clientInfo) {
return clientInfo.getPlatform().contains("win") ? "update.cmd" : "update.sh";
}
/**
* Creates the URL for the ZIP file.
*
* @param clientInfo the client info
* @return the URL
*/
protected URL createZipURL(ClientInfo clientInfo) {
try {
return new URL(createBaseUrlName(clientInfo) + ".zip");
}
catch (MalformedURLException e) {
throw new TentackleRuntimeException(e);
}
}
/**
* Creates the URL for the checksum hash file.
*
* @param clientInfo the client info
* @return the URL
*/
protected URL createChecksumURL(ClientInfo clientInfo) {
try {
return new URL(createBaseUrlName(clientInfo) + ".sha256");
}
catch (MalformedURLException e) {
throw new TentackleRuntimeException(e);
}
}
/**
* Creates the base URL name without extension.
*
* @param clientInfo the client info
* @return the URL string
*/
protected String createBaseUrlName(ClientInfo clientInfo) {
StringBuilder buf = new StringBuilder();
buf.append(getUpdateURL())
.append(getArtifactName())
.append('-').append(getVersion())
.append('-').append(clientInfo.getPlatform())
.append('-').append(clientInfo.getArchitecture());
if (clientInfo.getInstallationType() == InstallationType.JPACKAGE) {
buf.append("-pkg");
}
return buf.toString();
}
/**
* Determines the checksum hash.
*
* @param checksumURL the URL of the checksum hash file
* @return the hash value
* @throws IOException if failed
*/
protected String determineChecksumHash(URL checksumURL) throws IOException {
String shaHash = checksumHashes.get(checksumURL);
if (shaHash == null) {
shaHash = new StringTokenizer(new String(FileHelper.download(checksumURL))).nextToken();
checksumHashes.put(checksumURL, shaHash);
}
return shaHash;
}
/**
* Determines the download size of the ZIP file.
*
* @param zipURL the download URL
* @return the size in bytes, -1 if content-length in header response
* @throws IOException if failed
*/
protected long determineDownloadSize(URL zipURL) throws IOException {
Long size = downloadSizes.get(zipURL);
if (size == null) {
try {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(zipURL.toURI())
.method("HEAD", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = client.send(request, HttpResponse.BodyHandlers.ofString());
OptionalLong contentLength = response.headers().firstValueAsLong("content-length");
size = contentLength.orElse(-1);
downloadSizes.put(zipURL, size);
}
catch (InterruptedException | URISyntaxException ex) {
throw new IOException("cannot determine expected download size of " + zipURL, ex);
}
}
return size;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy