- Fundamentals
- Installation
- Configuration on the server side
- Usage: client site programming
- Advanced Usage
KRemote Files is a secure Open Source client/server framework that allows to program very easily remote file access, file uploads/downloads and RPC through HTTP. File transfers include powerful features like file chunking and automatic recovery mechanism. KRemote Files allows 3 types of operation over HTTP:
- Accessing remote files with
java.io.Filesyntax. - Files upload and download using
java.io.OutputStreamandjava.io.InputStreamsyntax. - Secure RPC calls.
We first create a RemoteSession that establishes a link with the KRremote Files server:
// Parameters for connection to our remote server
String url = "https://www.acme.com/ServerFileManager";
String username = "username";
char[] password = { 'd', 'e', 'm', 'o' };
// Establish a session with the remote server
RemoteSession remoteSession = new RemoteSession(url, username,
password);We can now create a RemoteFile and use it as if it were a java.io.File:
// Display info on our remote /mydir/Koala.jpg
RemoteFile koala = new RemoteFile(remoteSession, "/mydir/Koala.jpg");
System.out.println("Display remote " + koala + " info...");
System.out.println("last modified: " + new Date(koala.lastModified()));
System.out.println("length : " + koala.length());
System.out.println("Parent : " + koala.getParent());We display the files located in remote directories with RemoteFile.listFiles(), which acts as java.io.File.listFiles() method:
// List all files located in remote directory /mydir
RemoteFile remoteDir = new RemoteFile(remoteSession, "/mydir");
RemoteFile[] remoteFiles = remoteDir.listFiles();
System.out.println();
System.out.println("All files located in " + remoteDir + ": "
+ Arrays.asList(remoteFiles));We want now to upload a new file to remote mydir. We simply use a RemoteOutputStream which implements a java.io.OutputStream :
// Upload user.home/Tulips.jpg to remote directory /mydir
String userHome = System.getProperty("user.home") + File.separator;
File file = new File(userHome + "Tulips.jpg");
Path path = file.toPath();
try (OutputStream outputStream = new RemoteOutputStream(remoteSession,
"/mydir/Tulips.jpg");) {
Files.copy(path, outputStream);
}We have of course a complete access to all OutputStream methods; this will be helpful if we want to create a nice progress indicator for our users. This is the same Tulips.jpg upload with alternate syntax using only stream methods:
File file = new File(userHome + "Tulips.jpg");
try (InputStream in = new BufferedInputStream(
new FileInputStream(file));
OutputStream out = new RemoteOutputStream(remoteSession,
"/mydir/Tulips.jpg")) {
byte[] buffer = new byte[4096];
int n = 0;
while ((n = in.read(buffer)) != -1) {
out.write(buffer, 0, n);
}
}Download is as straightforward, we use a RemoteInputStream which implements a java.io.InputStream :
File file = new File(userHome + "Tulips.jpg");
try (InputStream in = new RemoteInputStream(remoteSession,
"/mydir/Tulips.jpg");
OutputStream out = new BufferedOutputStream(
new FileOutputStream(file));) {
byte[] buffer = new byte[4096];
int n = 0;
while ((n = in.read(buffer)) != -1) {
out.write(buffer, 0, n);
}
}KRemote Files include a simple to use RPC mechanism, without stubbing, code generation, XML or JSON. It is secured so that only authenticated users can call remote Java methods.
This is a calculator class located on remote server:
package com.kremotefiles.quickstart;
import org.kawanfw.file.api.server.ClientCallable;
/**
* A simple calculator to be called from the client side.
* Requires the client to be authenticated.
*/
public class Calculator implements ClientCallable {
public Calculator() {
}
public int add(int a, int b) {
return (a + b);
}
}The ClientCallable interface is a marker interface that indicates to KRemote Files server that Calculatorclass is callable only by valid and authenticated users.
We use RemoteSession.call method to call the add method from client side:
String resultStr = remoteSession
.call("com.kremotefiles.quickstart.Calculator.add", 20, 22);
int result = Integer.parseInt(resultStr);
System.out.println("Result: " + result);The KRemote Files framework consists of:
- A Client Library.
- A Server Manager.
- User Configuration classes injected at runtime (start of server container).
The Client Library is installed on the client side - typically a PC/Mac or an Android device. The client application - typically a Desktop or Android application - accesses the remote files or java classes it through APIs. The execution of each KRemote Files command is conditioned by the rules defined in the User Configuration classes.
All communications between the PC and the Server are done using HTTP protocol on the standard 80 and 443 ports.
- Easy file upload/download & RPC programming.
- Optimized and designed to manage heavy traffic.
- Supports file chunking & automatic recovery.
- Built-in security.
- Easy access of remote files with
java.io.FileAPI - Power of FTP and RMI without the hassles.
- Free and Open Source Software.
KRemote Files is 100% written in Java, and functions identically under Android Microsoft Windows, Linux and all versions of UNIX supporting Java 7+ and Servlet 2.5.
The following environments are supported in this version:
| OS | JVM (Java Virtual Machine) |
|---|---|
| Android | Dalvik 4.0.3+ |
| Windows | Oracle Java SE 7, Java SE 8, Java SE 9 |
| UNIX/Linux | Oracle Java SE 7, Java SE 8 and Java SE 9 OpenJDK 7, OpenJDK 8, OpenJDK 9 |
| OS X / macOS | Oracle Java SE 7 for OS X 10.7.3+ Oracle Java SE 8 for OS X 10.8+ Oracle Java SE 9 for mac OS 10.10+ |
| Servlet Containers |
|---|
| All Servlet containers that implement the Servlet 2.5+ specifications. |
KRemote Files is licensed through the GNU Lesser General Public License (LGPL v2.1): you can use it for free and without any constraints in your open source projects as well as in your commercial applications.
Download and unzip kremote-files-1.0-bin.zip or download and untar kremote-files-1.0-bin.tar.gz.
Add the jars of the /lib subdirectory to your Servlet container webapp library folder. (Typically in /WEB-INF/lib).
Create a “Server” project and add the jars of the /lib subdirectory to your development CLASSPATH, or for Maven users:
<groupId>com.kremote-files</groupId>
<artifactId>kremote-files</artifactId>
<version>1.0</version>Create a “Client” project and add to your development CLASSPATH the path to the jars located in the /lib subdirectory of your installation folder, or for Maven users:
<groupId>com.kremote-files</groupId>
<artifactId>kremote-files</artifactId>
<version>1.0</version>Add the 3 following lines to your AndroidManifest.xml:
<uses-permission android:name=*"android.permission.INTERNET"*/>
<uses-permission android:name=*"android.permission.ACCESS_NETWORK_STATE"*/>
<uses-permission android:name=*"android.permission.WRITE_EXTERNAL_STORAGE"*/>The Configuration on the server side addresses:
- Client login and password verification.
- Defining the uploaded user files location on the server.
- Defining the session security management.
All Commands sent by the client side are received by the Server File Manager servlet. The Server Manager servlet then:
- Authenticates the client call.
- For file commands :
-
- Executes the file command asked.
- Sends the result of the command back to the client side.
- For RPC commands :
- Tests if client user is authenticated.
- Sends the return value of the called Java method to the client.
Add the Server File Manager servlet to your web.xml:
<servlet>
<servlet-name>ServerFileManager</servlet-name>
<servlet-class>org.kawanfw.file.servlet.ServerFileManager</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ServerFileManager</servlet-name>
<url-pattern>ServerFileManager</url-pattern>
</servlet-mapping>All server configurations are done through Java classes called “Configurators” in our terminology. A Configurator is a user-developed Java class that implements one of the Configurator Java interfaces. The Configurator instance is dynamically loaded by the KRemote Files Server at bootstrap through DI (Dependency injection). The methods of the Configurator instance are then called internally by the Server File Manager servlet when necessary.
KRemote Files uses one main Configurator:
FileConfigurator.
The second type of Configurator is SessionConfigurator. There is no setup required for this Configurator and it is recommended to let KRemote Files automatically use the default DefaultJwtSessionConfiguratorimplementation. Session Configurators are discussed in Session Security.
Note that KRemote Files comes with Default Configurator classes:
it’s not required to write your own Configurator
(in case you only want to test KRemote Files, etc.).
See the Quick Start.
The FileConfigurator interface allows to define basic access and security settings. A concrete implementation code will let you:
- Define How to authenticate a remote client user.
- Define for each username the home directory of files on the server.
- Optionally define the
java.util.logging.Loggerthat KRemote Files will use for logging.
Note that KRemote Files comes with a default FileConfigurator implementation that is very liberal and should be extended: DefaultFileConfigurator.
If no FileConfigurator is implemented, the server loads and uses the DefaultFileConfigurator class.
The KRemote Files Server settings are coded in a concrete implementation of the FileConfigurator interface with the methods:
logingetHomeDirgetLogger
You don't want your KRemote Files server be accessible to the whole world. KRemote Files provides a mechanism that allows to check the username and password sent by the remote client program. This is done through the login method of FileConfigurator interface. If login returns true, access is granted.
The username and password should be checked against an applicative access mechanism, such as a LDAP directory, a login table in the database, etc.
The following example will check that the username and password passed by the client match an access list defined in a SQL table of your host database:
/**
* Our own Acme Company authentication of remote client users. This methods
* overrides the {@code DefaultFileConfigurator.login} method. <br>
* The (username, password) values are checked against the user_login table.
*
* @param username
* the username sent by client side
* @param password
* the user password sent by client side
* @param iPAddress
* the client IP address value (For security tests).
*
* @return true if access is granted, else false
*/
@Override
public boolean login(String username, char[] password, String iPAddress)
throws IOException, SQLException {
Connection connection = null;
try {
// Extract a Connection from our Pool
connection = this.getConnection();
// Compute the hash of the password
Sha1 sha1 = new Sha1();
String hashPassword = null;
try {
hashPassword = sha1.getHexHash(new String(password).getBytes());
} catch (Exception e) {
throw new IOException("Unexpected Sha1 failure", e);
}
// Check (username, password) existence in user_login table
String sql = "SELECT username FROM user_login "
+ "WHERE username = ? AND hash_password = ?";
PreparedStatement prepStatement = connection.prepareStatement(sql);
prepStatement.setString(1, username);
prepStatement.setString(2, hashPassword);
ResultSet rs = prepStatement.executeQuery();
if (rs.next()) {
// Yes! (username, password) are authenticated
return true;
}
return false;
} finally {
if (connection != null) {
connection.close();
}
}
}Note:
The included SshAuthFileConfigurator is a concrete FileConfigurator that extends DefaultFileConfigurator.
It allows zero-code client (username, password) authentication using SSH.
getHomeDir allows to define the home directory for each client user, aka where the users files will be stored when uploaded.
Default implementation in DefaultFileConfigurator always return:
user.home/.kremote-server-root
where user.home is the value returned by System.getProperty("user.home").
See the included Configurators PerUserHomeFileConfigurator and SysRootHomeFileConfigurator and if you want to define other standard implementations, or you can always code your own getHomeDir.
Default implementation in DefaultFileConfigurator defines a java.util.logging.Logger whose pattern is user.home/.kawansoft/log/kremote_files.log and that logs 50Mb into 4 rotating files.
Your concrete FileConfigurator implementations are passed to KRemote Files as parameters of the ServerFileManager servlet in your web.xml configuration file.
The FileConfiguratorClassName parameter lets you define your FileConfigurator concrete implementation. Following is an example if you want to inject your org.acme.config.MyFileConfiguratorclass:
<servlet>
<servlet-name>ServerFileManager</servlet-name>
<servlet-class>org.kawanfw.file.servlet.ServerFileManager</servlet-class>
<init-param>
<param-name>fileConfiguratorClassName</param-name>
<param-value>org.acme.config.MyFileConfigurator</param-value>
</init-param>
<init-param>
<param-name>jwt_secret_value</param-name>
<param-value>MySecretValue</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ServerFileManager</servlet-name>
<url-pattern>ServerFileManager</url-pattern>
</servlet-mapping>If you don’t provide a parameter for fileConfiguratorClassName, KRemote Files will use the default implementation DefaultFileConfigurator.
The init parameter jwt_secret_value allows to set the secret value used by JWT (Java Web Toolkit) for token creation. See Session Security.
if you don't want the secret value to be stored in plain text in web.xml: it is possible to set this value at runtime just after server start using the public static String JwtSessionStore.JWT_SECRET_VALUE.
The RPC mechanism has been designed to be very simple to use but sill secure
How to declare your server class as callable by the client side
Any server Java class method maybe called by the client side if the server class follows the following requirements:
-
The class must implement the ClientCallable or ClientCallableNoAuth interface.
-
The class must have a default visible constructor with no parameters. (It is the constructor that will be invoked by the Server Manager servlet).
ClientCallable and ClientCallableNoAuth are marker interfaces and have no method: they allow to indicate to the Server File Manager that the classes are callable from the client side.
The interface to implement depends on your authentication need:
- Implement
ClientCallableif you require that users must be authenticated to use the class. - Implement
ClientCallableNoAuthif you want your class to be callable by any user, without authentication.
After restarting you server, type the http address of the ServerFileManager servlet in a browser:
http://www.yourhost.com/path-to-servlet/ServerFileManager
It will display your configuration and a status line that should display: OK & Running.
If not, the configuration errors are detailed in red for correction.
The client API is composed of 4 main classes:
| Name | Role |
|---|---|
| RemoteSession | Main class for establishing an http session with a remote host and for executing from client side some basic operations |
| RemoteFile | Allows to execute java.io.File methods on remote files. |
| RemoteInputStream | Obtains input bytes from a remote file. Used to download a remote file. |
| RemoteOutputStream | An output stream for writing data to a remote file. Used to upload a file. |
RemoteSession is the main class for establishing an http session with a remote host.
The RemoteSession instance is passed to all other client API classes and is used by them for session identification and authentication.
RemoteSession is also used and for executing some basic client side operations:
- Get the Java version of the servlet container on the remote server.
- Call remote Java methods.
- Returns with one call the length of a list of files located on the remote host.
The RemoteSession constructor takes at least three parameters:
url: the URL of the path to the KRemote Files Manager Servlet.username: the user username for authentication.password: the authentication password.
The RemoteSession is created only if the KRemote Files Manager has authenticated the user. The authentication is done by invoking the login method of the FileConfigurator instance.
Example of RemoteSession creation:
// Define URL of the path to the ServerFileManager servlet
String url = "https://www.acme.org/ServerFileManager";
// The login info for strong authentication on server side
String username = "myUsername";
char[] password = { 'm', 'y', 'P', 'a', 's', 's', 'w', 'o', 'r', 'd' };
// Establish a session with the remote server
RemoteSession remoteSession = new RemoteSession(url, username, password);Communication via an (authenticating) proxy server is done using a java.net.Proxy instance. If proxy requires authentication, pass the credentials via a java.net. PasswordAuthentication instance:
Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(
"proxyHostname", 8080));
PasswordAuthentication passwordAuthentication = null;
// If proxy requires authentication:
passwordAuthentication = new PasswordAuthentication("proxyUsername",
"proxyPassword".toCharArray());
RemoteSession remoteSession = new RemoteSession(url, username,
password, proxy, passwordAuthentication);RemoteSession methods throw exclusively the following exceptions:
Table of Exceptions thrown by RemoteSession methods
| Exception | Signification |
|---|---|
| java.net.UnknownHostException | The URL is malformed. |
| InvalidLoginException | The (username, password) authentication failed on the remote KRemote Files Manager. (The implemented File.Configurator.login method returned false). |
| java.net.UnknownHostException | There is no Internet connection. There is an error in HTTP address in the url parameter. |
| java.net.ConnectException | The HTTP Request returned a HTTP Status Code != OK (200). Use RemoteSession.getHttpStatusCode() to retrieve the Status Code. |
| java.net.SocketException | Network failure during transmission. |
| RemoteException | An unexpected Exception has been thrown by the server. Signals KRemote Files product failure. |
| java.io.IOException | For all other IO / Network / System Error. |
Use RemoteSession.call to call a remote Java method:
First parameter is the full name of the method to call with the notation: package_name.className.methodName. Example: org.kawanfw.examples.Calculator.add
All following parameters are optional and are the parameters of the remote method.
The result is always returned as a String.
The requirements for the Java class on the server are explained in RPC rules for calling Java methods from the client side.
Example of a RemoteSession call:
// OK: call the add(int a, int b) remote method that returns a + b:
String result = remoteSession.call(
"org.kawanfw.examples.Calculator.add" ", 41, 42);
System.out.println("Calculator Result: " + result);of the remote org.kawanfw.examples.Calculator class:
package org.kawanfw.examples;
import org.kawanfw.file.api.server.ClientCallable;
/**
* Simple calculator to be called from the client side.
* Requires the client to be authenticated.
*/
public class Calculator implements ClientCallable {
/**
* Constructor
*/
public Calculator() throws Exception {
}
public int add(int a, int b) {
return (a + b);
}
}RemoteFile is the main class for accessing remote files.
RemoteFile methods have the same names, signatures and behaviors as java.io.File methods:
a RemoteFile method is a java.io.File method that is executed on the remote host.
The few differences with java.io.File are:
- There is only one constructor that takes as parameter a
RemoteSessionand a pathname. The pathname is defined with a"/"separator on all platforms and must be absolute. File.compareTo(File)andFile.renameTo(File)methods take aRemoteFileparameter in this class.- File methods that return
java.io.Fileinstance(s) returnRemoteFileinstance(s) in this class. - The
File.toURI()andFile.toURL() methods are meaningless in this context and are thus not ported. - The static
File.listRoots()andFile.createTempFile()are not ported. - The Java 7+
File.toPath()method is not ported as this KRemote Files version does not support remotejava.nio.file.Pathobjects.
Note that the real pathname used on host for File method execution depends on the KRemote Files configuration of FileConfigurator.getHomeDir(). This follows the same principle of FTP server mechanisms.
Example:
If FileConfigurator.getHomeDir(String username) returns /home/<username> and client username is "mike" :
new RemoteFile(remoteSession, "/myfile.txt").exists();will return he result of the execution on remote host of:
new File("/home/mike/myfile.txt").exists();Note: the user rights are the rights of the servlet container when accessing remote files.
When using java.io.FilenameFilter and java.io.FileFilter filters, the filter implementation must follow these rules:
- The filter must implement
Serializable. - Thus, the filter class must already exist on the server side.
- When using anonymous inner class for
FilenameFilterorFileFilter: it must be public static.
RemoteFile methods throw corresponding java.io.File Exceptions plus the following Exceptions that are wrapped by a RuntimeException (except java.lang.SecurityException which is not wrapped).
Table of Exceptions thrown by RemoteFile methods
| Exception | Signification |
|---|---|
| java.net.UnknownHostException | There is no more Internet connection. |
| InvalidLoginException | The RemoteSession has been closed. |
| java.net.ConnectException | The HTTP Request returned a Http Status Code != OK (200). Use RemoteSession.getHttpStatusCode() to retrieve the Status Code. |
| java.net.SocketException | Network failure during transmission. |
| java.lang.SecurityException | The remote java.io.File throwed a java.lang.SecurityException. |
| RemoteException | The remote java.io.File throwed an Exception. |
| java.io.IOException | For all other IO / Network / System Error. |
// Define URL of the path to the ServerFileManager servlet
String url = "https://www.acme.org/ServerFileManager";
// The login info for strong authentication on server side
String username = "myUsername";
char[] password = { 'm', 'y', 'P', 'a', 's', 's', 'w', 'o', 'r', 'd' };
// Establish a session with the remote server
RemoteSession remoteSession = new RemoteSession(url, username, password);
// Create a new RemoteFile that maps a file on remote server
RemoteFile remoteFile = new RemoteFile(remoteSession, "/Koala.jpg");
// We can use all the familiar java.io.File methods on our RemoteFile
if (remoteFile.exists()) {
System.out.println(remoteFile.getName() + " length : "
+ remoteFile.length());
System.out.println(remoteFile.getName() + " canWrite: "
+ remoteFile.canWrite());
}
// List files on our remote root directory
remoteFile = new RemoteFile(remoteSession, "/");
RemoteFile[] files = remoteFile.listFiles();
for (RemoteFile file : files) {
System.out.println("Remote file: " + file);
}
// List all text files in out root directory
// using an Apache Commons IO 2.5 FileFiter
FileFilter fileFilter = new SuffixFileFilter(".txt");
files = remoteFile.listFiles(fileFilter);
for (RemoteFile file : files) {
System.out.println("Remote text file: " + file);
}A RemoteInputStream obtains input bytes from a remote File.
The remote file bytes are read with standards java.io.InputStream read methods and can thus be downloaded into a local file.
A RemoteOutputStream is an output stream for writing data to a remote file.
It allows to create a remote file by writing bytes on the RemoteOutputStream with standards OutputStream write methods.
These classes are provided to :
- Offer APIs with no learning curve.
- Allow easy existing code migration, because they implement
java.io.InputStreamandjava.io.OutputStream. - Allow easy use of progress bars for file uploads and downloads.
RemoteInputStream and RemoteInputStream implement automatic file chunking and recovery mechanism as described in Data transport.
Simply use RemoteInputStream or RemoteOutputStream to download or upload the files, and increment the Progress Bar in the read/write loop.
At the end of the read/write, set the Progress Bar progress indicator to 100.
Example:
Declare the global variables used by the Progress Monitor and in the read/write loop:
/**
* Progress between 0 and 100.
* Updated by doFileUpload() at each 1% input stream read
*/
private int progress = 0;
/** Says to doFileUpload() code if transfer is cancelled */
private boolean cancelled = false;The doFileUpload method is called to upload a file:
/**
* Do the file upload.
*/
private void doFileUpload() {
try {
// BEGIN MODIFY WITH YOUR VALUES
String userHome = System.getProperty("user.home");
String url = "http://localhost:8080/kremote-files/ServerFileManager";
String username = "username";
char[] password = "password".toCharArray();
File file = new File(userHome + File.separator + "image_1.jpg");
String pathname = "/image_1_1.jpg"; // remote file path
// END MODIFY WITH YOUR VALUES
RemoteSession remoteSession = new RemoteSession(url, username,
password);
long fileLength = file.length();
try (InputStream in = new BufferedInputStream(
new FileInputStream(file));
OutputStream out = new RemoteOutputStream(remoteSession,
pathname, fileLength);) {
int tempLen = 0;
byte[] buffer = new byte[1024 * 4];
int n = 0;
while ((n = in.read(buffer)) != -1) {
tempLen += n;
// Test if user has cancelled the upload
if (cancelled)
throw new InterruptedException(
"Upload cancelled by User!");
// Add 1 to progress for each 1% upload
if (tempLen > fileLength / 100) {
tempLen = 0;
progress++;
}
out.write(buffer, 0, n);
}
out.close();
} finally {
// When finished, set to the maximum value to stop the
// ProgressMonitor
progress = 100;
}
remoteSession.logoff();
System.out.println("File upload done.");
} catch (Exception e) {
if (e instanceof InterruptedException) {
System.out.println(e.getMessage());
return;
}
System.err.println("Exception thrown during Upload:");
e.printStackTrace();
}
}Assuming you want to display a progress indicator using javax.swing.SwingWorker, you would start as a Thread the previous code. To update the progress bar, the SwingWorker.doInBackground() method would be overridden :
@Override
public Void doInBackground() {
// Reset values at each upload
cancelled = false;
progress = 0;
setProgress(0);
// progress is ++ at each
// 1% file transfer in doFileUpload()
while (progress < 100) {
try {
Thread.sleep(50);
} catch (InterruptedException ignore) {
}
// Say to doFileUpload() that
// user has cancelled the upload
if (isCancelled()) {
cancelled = true;
break;
}
setProgress(Math.min(progress, 100));
}
return null;
}A complete example is available in FileTransferProgressMonitorDemo.java.
Session management (token creation, token verification, etc.) is defined with the SessionConfigurator interface and the selected concrete implementation.
It is neither required nor advised to define a SessionConfigurator implementation, the default implementation coded in DefaultJwtSessionConfigurator requires no setup, except passing a secret value at JavaEE web server startup.
DefaultJwtSessionConfiguratoruses the standardized JWT (JSON Web Tokens) session management protocol. See DefaultJwtSessionConfigurator Javadoc or source code for more information and for passing the secret value.
If you want to create your own session management: create a session configurator class that implements SessionConfigurator.
Then modify your web.xml to pass your class name as the init parameter value of a sessionConfiguratorClassName init parameter name of theServerFileManager servlet :
<servlet>
<servlet-name>ServerFileManager</servlet-name>
<servlet-class>org.kawanfw.file.servlet.ServerFileManager</servlet-class>
<init-param>
<param-name>fileConfiguratorClassName</param-name>
<param-value>org.acme.config.MyFileConfigurator</param-value>
</init-param>
<init-param>
<param-name>sessionConfiguratorClassName</param-name>
<param-value>org.acme.MySessionConfigurator</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>ServerFileManager</servlet-name>
<url-pattern>ServerFileManager</url-pattern>
</servlet-mapping>KRemote Files transfers the least possible meta-information:
- Request parameters are transported in UTF-8 format.
- JSON format is used for data & classes transport.
All requests are streamed, especially for file uploads and downloads:
- Output requests (from client side) are streamed to avoid buffering any content body by streaming directly to the socket to the server.
- input response (for client side) are streamed efficiently read the response body by streaming directly from the socket to the server.
Large files are split in chunks that are uploaded in sequence when using RemoteOutputStream. The default chunk length is 10Mb. You can change the default value with SessionParameters.setUploadChunkLength(long) before passing SessionParameters to RemoteSession class constructor.
SessionParameters usage is described in Session parameters.
Large file are split in chunks that are downloaded in sequence when using RemoteInputStream. The default chunk length is 10Mb. You can change the default value with SessionParameters.setDownloadChunkLength(long) before passing SessionParameters to RemoteSession class constructor.
Note that file chunking requires that all chunks be uploaded/downloaded to/from to the same web server. Thus, file chunking does not support true stateless architecture with multiple identical web servers. If you want to set a full stateless architecture with multiple identical web servers, you must disable file chunking.
This is done by setting a 0 upload and download chunk length value using:
KRemote Files supports recovery for large files upload and download.
In case of recoverable I/O or communication Exception, aka SocketException, the recall of the upload or download sequence will restart the transfer at the last chunk non completely transmitted.
The only condition is to recall the upload/download in the same JVM run (so recovery will not be supported if application is completely stopped and restarted.)
For example, when using default chunk length of 10Mb: if the upload of a 2Gb file is interrupted at 1,8Gb, only the remaining 200Mb will be resent when re-invoking RemoteInputStream or RemoteOutputStream sequence in the same JVM life cycle.
Chunks are stored in temporary directories. See Managing temporary files for more information.
You may use multiple different RemoteSession in your programs. And you may use them in background threads.
Please note that RemoteSession is not thread safe: only one thread may access an RemoteSession instance at a time. Otherwise, results are unpredictable.
However, RemoteSession is cloneable. Just clone your current RemoteSession to get a new one to use for simultaneous file operations:
// Establish a session with the remote server
RemoteSession remoteSession = new RemoteSession(url, username, password);
// Establish a secondary RemoteSession for background thread:
RemoteSession secondaryRemoteSession = remoteSession.clone();You may use multiple RemoteSession that access different KRemote Files Servers in the same program.
There is nothing to set on the client side. Simply use different url parameters in your RemoteSession constructors.
For each url defined, there must be a corresponding Server File Manager servlet on the server side:
// The main Server File Manager
String url = "https://www.acme.org/ServerFileManager";
// The second Server File Manager
String url2 = "https://www.acme.org/ServerFileManager2";
// The login info for strong authentication on server side
// (Assuming it's the same for the two Server File Managers)
String username = "myUsername";
char[] password = { 'm', 'y', 'P', 'a', 's', 's', 'w', 'o', 'r', 'd' };
// Establish a session with the first remote server
RemoteSession remoteSession = new RemoteSession(url, username,
password);
// Establish a session with the second remote server
RemoteSession remoteSession2 = new RemoteSession(url2,
username, password);There is some configuration on the server side: a second Server File Manager servlet must be defined in web.xml with the corresponding new Configurators classes passed as parameters to the new servlet:
<servlet>
<servlet-name>ServerFileManager2</servlet-name>
<servlet-class>org.kawanfw.file.servlet.ServerFileManager</servlet-class>
<init-param>
<param-name>FileConfiguratorClassName</param-name>
<param-value>org.acme.config.MyFileConfigurator2</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>ServerFileManager2</servlet-name>
<url-pattern>ServerFileManager2</url-pattern>
</servlet-mapping>The SessionParameters class allows also to define some settings for the KRemote Files session:
-
Timeout value, in milliseconds, to be used when opening a communications link with the remote server. Defaults to 0 (no timeout).
-
Read timeout, in milliseconds, that specifies the timeout when reading from remote Input stream. Defaults to 0 (no timeout).
-
Boolean to say if HTTP content must be compressed. Defaults to true.
-
Download chunk length to be used by
RemoteInputStream. Defaults to 10Mb. 0 means files are not chunked. -
Upload chunk length to be used by
RemoteOutputStream. Defaults to 10Mb. 0 means files are not chunked.
This example shows how to change some timeout default values:
String url = "https://www.acme.org/ServerFileManager";
String username = "myUsername";
char[] password = { 'm', 'y', 'P', 'a', 's', 's', 'w', 'o', 'r', 'd' };
SessionParameters sessionParameters = new SessionParameters();
// Sets the timeout until a connection is established to 10 seconds
sessionParameters.setConnectTimeout(10);
// Sets the read timeout to 60 seconds
sessionParameters.setReadTimeout(60);
// We will use no proxy
Proxy proxy = null;
PasswordAuthentication passwordAuthentication = null;
RemoteSession remoteSession = new RemoteSession(url, username,
password, proxy, passwordAuthentication, sessionParameters);
// Etc.KRemote Files uses temporary files on client side only. These temporary files contain:
- Result of the
RemoteFile.listmethods. - Result of the
RemoteFile.listFilesmethod. - Chunks created by
RemoteInputStreamandRemoteOutputStream.
Temporary files are created to allows streaming and/or to release as soon as possible network resources (servlet streams).
These temporary files are automatically cleaned (deleted).
If you want to insure the cleaning of temporary files, they are located in the user.home/.kawansoft/tmp directory.
(Where user.home is the System.getProperty("user.home") value of the user that starts the client application and/or the servlet container on the server side.)