artisynth.core.util

Class ArtisynthDataManager

java.lang.Object

artisynth.core.util.ArtisynthDataManager

public class ArtisynthDataManager
extends java.lang.Object

Utility class for manager remote data files, allowing them to be downloaded on demand (and hence stay out of source version control)

Author:

antonio

Field Summary

Fields

Modifier and Type	Field and Description
static java.io.File	DEFAULT_LOCAL_ROOT Default directory for storing downloaded files

Constructor Summary

Constructors

Constructor and Description
ArtisynthDataManager()
ArtisynthDataManager(java.lang.String remoteUri) Creates a data manager capable of transfering files to/from a remote folder or server
ArtisynthDataManager(java.lang.String remoteUri, java.io.File localRoot) Creates a data manager capable of transfering files to/from a remote folder or server

Method Summary

Modifier and Type	Method and Description
void	addAuthenticator(URIxMatcher matcher, org.apache.commons.vfs2.UserAuthenticator auth) Adds an authenticator that can respond to domain/username/password requests.
Cryptor	getCryptor() Gets the current en/de-cryptor to be used for storing passwords.
java.io.File	getFile(java.lang.String filename) Get file with path relative to storage root.
java.io.File	getFile(java.lang.String src, java.lang.String dst) Get file with path relative to storage root.
FileManager	getFileManager() Get underlying file manager
java.io.File	getLocalRoot() Gets the local directory containing downloaded files
java.io.File	getPackageRelativeFile(java.lang.Object obj, java.lang.String filename) Returns a file retrieved from the data storage server, specified relative to a given package.
java.io.File	getPackageRelativeFile(java.lang.Package pkg, java.lang.String filename) Returns a file retrieved from the data storage server, specified relative to a given package.
URIx	getRemoteRoot() Gets the root directory of the remove filesystem
void	loadConfig(java.io.File configFile) Loads configuration from a JSON file
void	putFile(java.io.File source, java.lang.String filename) Upload a file with path relative to storage root
void	putPackageRelativeFile(java.io.File source, java.lang.Object obj, java.lang.String dest) Uploads a file to the data storage server, at a location specified relative to a given package.
void	putPackageRelativeFile(java.io.File source, java.lang.Package pkg, java.lang.String dest) Uploads a file to the data storage server, specified relative to a given package.
void	setCredentials(java.lang.String username, java.lang.String password) Set username and password credentials.
void	setCryptor(Cryptor cryptor) Set an en/de-cryptor to be used for storing passwords
void	setEncryptedCredentials(java.lang.String username, java.lang.String encryptedPassword) Set the username and password credentials.
void	setLocalRoot(java.io.File file) Sets the local directory to download files to
void	setRemoteRoot(java.lang.String remote) Sets the root directory of the remote filesystem
void	setRemoteRoot(java.net.URI remote) Sets the root directory of the remote filesystem
void	setRemoteRoot(URIx remote) Sets the root directory of the remote filesystem

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LOCAL_ROOT

public static final java.io.File DEFAULT_LOCAL_ROOT

Default directory for storing downloaded files

Constructor Detail

ArtisynthDataManager

public ArtisynthDataManager()

ArtisynthDataManager

public ArtisynthDataManager(java.lang.String remoteUri)

Creates a data manager capable of transfering files to/from a remote folder or server

Parameters:

remoteUri - URI for remote root

ArtisynthDataManager

public ArtisynthDataManager(java.lang.String remoteUri,
                            java.io.File localRoot)

Creates a data manager capable of transfering files to/from a remote folder or server

Parameters:

remoteUri - URI for remote root

localRoot - local directory to use for storing files

Method Detail

loadConfig

public void loadConfig(java.io.File configFile)

Loads configuration from a JSON file

Keys: remote_uri, local_dir, username, password, encrypted_password, cipher, cipher_key (base64)

   {
    "remote_uri": "davs://research.hct.ece.ubc.ca/owncloud/remote.php/webdav/",
    "local_dir": "tmp/.cache/data/",
    "username": "artisynth_user",
    "password": "artisynth_password",
   }
 

The encrypted password is assumed encrypted with the provided cipher/key. If no cipher is provided, a default is assumed. An encrypted password takes precedence over a plaintext one if both are provided.

Parameters:

configFile - configuration file

setRemoteRoot

public void setRemoteRoot(java.net.URI remote)

Sets the root directory of the remote filesystem

Parameters:

remote - remote file system root directory

setRemoteRoot

public void setRemoteRoot(URIx remote)

Sets the root directory of the remote filesystem

Parameters:

remote - remote file system root directory

setRemoteRoot

public void setRemoteRoot(java.lang.String remote)

Sets the root directory of the remote filesystem

Parameters:

remote - remote file system root directory

getRemoteRoot

public URIx getRemoteRoot()

Gets the root directory of the remove filesystem

Returns:

remote root directory (URI)

setLocalRoot

public void setLocalRoot(java.io.File file)

Sets the local directory to download files to

Parameters:

file - local directory for downloading files

getLocalRoot

public java.io.File getLocalRoot()

Gets the local directory containing downloaded files

Returns:

local directory root

setCryptor

public void setCryptor(Cryptor cryptor)

Set an en/de-cryptor to be used for storing passwords

Parameters:

cryptor - en/de-cryptor

getCryptor

public Cryptor getCryptor()

Gets the current en/de-cryptor to be used for storing passwords. If no cryptor was set, we use a default one provided by VFS2

Returns:

cryptor for storing passwords

setCredentials

public void setCredentials(java.lang.String username,
                           java.lang.String password)

Set username and password credentials. The password here is assumed to be in plaintext.

Parameters:

username - user name

password - plaintext password

setEncryptedCredentials

public void setEncryptedCredentials(java.lang.String username,
                                    java.lang.String encryptedPassword)

Set the username and password credentials. The password here is assumed to already be encrypted using this manager's Cryptor (see setCryptor(Cryptor)). This allows for some obfuscation of passwords.

Parameters:

username - user name

encryptedPassword - encrypted password

addAuthenticator

public void addAuthenticator(URIxMatcher matcher,
                             org.apache.commons.vfs2.UserAuthenticator auth)

Adds an authenticator that can respond to domain/username/password requests. This authenticator is used for any URIs that match patterns provided in `matcher'

Parameters:

matcher - object that checks whether a supplied URI matches a given set of criteria

auth - the authenticator object

getPackageRelativeFile

public java.io.File getPackageRelativeFile(java.lang.Object obj,
                                           java.lang.String filename)

Returns a file retrieved from the data storage server, specified relative to a given package. The fully qualified package name is expanded into a folder structure used for identifying the desired file on the storage server.

The package is determined from obj, either directly, if obj is an instance of Package, or by determining the package that the supplied resource belongs to.

Parameters:

obj - object used to determine the package

filename - path relative to the package directory

Returns:

desired file

getPackageRelativeFile

public java.io.File getPackageRelativeFile(java.lang.Package pkg,
                                           java.lang.String filename)

Returns a file retrieved from the data storage server, specified relative to a given package. The fully qualified package name is expanded into a folder structure used for identifying the desired source file on the storage server.

Parameters:

pkg - package used for determining path on storage server

filename - path relative to the package directory

Returns:

desired local file

getFile

public java.io.File getFile(java.lang.String filename)

Get file with path relative to storage root.

Parameters:

filename - file path name relative to storage root

Returns:

link to local file

getFile

public java.io.File getFile(java.lang.String src,
                            java.lang.String dst)

Get file with path relative to storage root.

Parameters:

src - file path name relative to storage root

dst - local destination

Returns:

link to local file

putPackageRelativeFile

public void putPackageRelativeFile(java.io.File source,
                                   java.lang.Object obj,
                                   java.lang.String dest)
                            throws java.io.IOException

Uploads a file to the data storage server, at a location specified relative to a given package. The fully qualified package name is expanded into a folder structure used for identifying the desired target destination on the storage server.

The package is determined from obj, either directly, if obj is an instance of Package, or by determining the package that the supplied resource belongs to.

Parameters:

source - file to upload

obj - object used to determine the package

dest - path relative to the package directory

Throws:

java.io.IOException - if upload fails, such as invalid destination or insufficient privileges

putPackageRelativeFile

public void putPackageRelativeFile(java.io.File source,
                                   java.lang.Package pkg,
                                   java.lang.String dest)
                            throws java.io.IOException

Uploads a file to the data storage server, specified relative to a given package. The fully qualified package name is expanded into a folder structure used for identifying the desired target file on the storage server.

Parameters:

source - file to upload

pkg - package used for determining path on storage server

dest - path relative to the package directory

Throws:

java.io.IOException - if upload fails, such as invalid destination or insufficient privileges

putFile

public void putFile(java.io.File source,
                    java.lang.String filename)
             throws java.io.IOException

Upload a file with path relative to storage root

Parameters:

source - file to upload

filename - destination

Throws:

java.io.IOException - if upload fails, such as invalid destination or insufficient privileges

getFileManager

public FileManager getFileManager()

Get underlying file manager

Returns:

delegate for handling file transfers