fr.ifremer.isisfish
Class IsisConfig

java.lang.Object
  org.nuiton.util.ApplicationConfig
      fr.ifremer.isisfish.IsisConfig

public class IsisConfig
extends org.nuiton.util.ApplicationConfig

Isis fish configuration.

Version:

$Revision: 1310 $ Last update: $Date: 2008-08-23 00:46:00 +0200 (Sat, 23 Aug 2008) $ by : $Author: bpoussin $

Author:

poussin

Nested Class Summary

static class	IsisConfig.Action
static class	IsisConfig.Option Options.

Nested classes/interfaces inherited from class org.nuiton.util.ApplicationConfig

org.nuiton.util.ApplicationConfig.CacheItem<T>, org.nuiton.util.ApplicationConfig.OptionDef

Field Summary

protected static org.nuiton.util.Version	apiVersion
protected java.io.File	backupSessionDirectory
static java.lang.String	CONFIG_FILENAME
static java.lang.String	COPYRIGHT_TEXT
protected static org.nuiton.util.Version	databaseVersion
static java.lang.String	REPORT_EMAIL
static java.lang.String	SEP separateur de liste
protected long	startingTime Mémorise une unité de temps en millisecondes.
static int	STEP_AFTER_INIT Config step after init.
static int	STEP_AFTER_INIT_VCS Config step after init vcs.
static int	STEP_AFTER_UI Config step after ui.
static int	STEP_BEFORE_EXIT Config step before exit.
protected static org.nuiton.util.Version	version La version du logiciel constitue de l.d.a.r l: le numero de version du logiciel d: le numero de version du schema de la base de donnees a: le numero de version de l'api des scripts r: le numero de version de de l'interface graphique ou autre modif mineur lors de l'increment de l, d, a et r sont remis a 0 lors de l'increment de d, a et r sont remis a 0 lors de l'increment de a, r est remis a 0 Un changement d'UI ne modifie jamais le numero de version de database Un changement de schema de base pour lequel on ne peut pas faire de migration de donnees demande automatiquement un changement de version d'application.

Fields inherited from class org.nuiton.util.ApplicationConfig

actions, aliases, cacheAction, cacheOption, classpath, CONFIG_FILE_NAME, curfile, defaults, env, etcfile, homefile, inParseOptionPhase, jvm, line, options, pcs, unparsed, useOnlyAliases

Constructor Summary

IsisConfig()

Method Summary

static org.nuiton.util.Version	getApiVersion() La version de l'api de programmation ex: 3.2.0
java.io.File	getBackupDirectory()
java.io.File	getBackupSessionDirectory()
java.io.File	getCompileDirectory() Retourne le repertoire ou sont stockes les scripts compiles.
java.io.File	getContextDatabaseDirectory() Get database directory to use for script.
java.io.File	getDatabaseDirectory() Retourne le repertoire racine de toutes les donnees (script, simulation region, ...)
java.lang.String	getDatabaseLockMode() Retourne le lock a utiliser pour la base h2.
static org.nuiton.util.Version	getDatabaseVersion() La version de la base ex: 3.2
java.lang.String	getDefaultExportNames()
java.util.List<java.lang.String>	getDefaultExportNamesAsList()
java.lang.String	getDefaultMapFilename()
java.lang.String	getDefaultResultNames()
java.util.List<java.lang.String>	getDefaultResultNamesAsList()
java.lang.String	getDefaultTagValue()
java.util.Map<java.lang.String,java.lang.String>	getDefaultTagValueAsMap()
java.lang.String	getElapsedTimeAsString() Retourne le temps écoulé depuis de debut de l'application (en secondes).
java.lang.String	getEncoding() Retourne l'encoding a utiliser pour les fichiers textes.
java.io.File	getJavadocDirectory() Get javadoc directory.
java.lang.String	getJavadocURL()
java.util.Locale	getLocale() Retourne l'objet Locale a utilise pour la langue.
java.io.File	getMonitoringDirectory() Retourne le repertoire ou sont stockes les informations relatives aux simulations en cours.
java.lang.ClassLoader	getScriptClassLoader() Retourne un class loader contenant le repertoire de compilation Il permet alors de charger des classes qui viennent d'etre compilees dans isis If current thread is in simulation then return specific simulation compilation directory, else default compilation directory
java.lang.String	getSimulatorClassfile()
int	getSimulatorSshControlCheckInterval() Retourne l'interval de temps a utiliser pour recuperer le fichier de control.
java.lang.String	getSimulatorSshDataPath() Retourne le chemin relatif ou abs du repertoire root des données d'isis.
java.lang.String	getSimulatorSshIsisHome() Retourne le chemin distant ou est installé isis.
java.lang.String	getSimulatorSshJavaPath() Java path directory.
int	getSimulatorSshMaxThreads() Retourne le nombre de thread simultane a utiliser par le pool de thread du launcher SSH.
java.lang.String	getSimulatorSshPbsBinPath() PBS bin path directory.
java.lang.String	getSimulatorSshPbsQsubOptions() PBS qsub options (command line).
java.lang.String	getSimulatorSshServer() Retourne l'url du serveur de simulation accessible via SSH.
java.lang.String	getSimulatorSshTmpPath() Retourne l'emplacement du dossier temporaire distant.
java.lang.String	getSimulatorSshUserHome() Get remote user home directory.
java.lang.String	getSimulatorSshUsername() Retourne le login pour acceder au serveur de simulation accessible via SSH.
java.lang.String	getSmtpServer() Retourne le serveur SMTP a utiliser pour l'envoie de mail.
java.io.File	getSSHPrivateKeyFilePath() Retourne la clé privée de l'utilisteur courant.
long	getStartingTime() Retourne le temps de départ de l'application en millisecondes.
java.lang.String	getUserMail() Retourne l'email de l'utilisateur.
java.lang.String	getUserName() Retourne le nom usuel de l'utilisateur.
static java.lang.String	getVersion() Le nombre global ex: 3.2.0.0
static org.nuiton.util.Version	getVersionNumber()
boolean	isLaunchUI() Get launch.ui option value.
boolean	isPerformCron() Get perform cron option value.
boolean	isPerformMigration() Get perform migration option value.
boolean	isPerformVcsUpdate() Get perform vcs update option value.
boolean	isSimulationShowOnlyError()
void	parse(java.lang.String[] args) Surcharge pour la migration des options de config qui ont change de nom TODO: lors du passage en version 4.0 on pourrait supprimer cette methode
void	setDefaultExportNames(java.util.List<java.lang.String> exportNames)
void	setDefaultResultNames(java.util.List<java.lang.String> resultNames)
void	setDefaultTagValues(java.util.Map<java.lang.String,java.lang.String> tagValues)
void	setLocale(java.lang.String locale) Change application locale.
void	setSimulatorClassfile(java.lang.String value)
void	setSimulatorLauncher(java.lang.String value)
void	setSimulatorSshControlCheckInterval(int interval) Change control check interval.
void	setSimulatorSshDataPath(java.lang.String datapath) Change remote datapath.
void	setSimulatorSshIsisHome(java.lang.String isishome) Change isis home on ssh server.
void	setSimulatorSshJavaPath(java.lang.String path) Change Java bin path.
void	setSimulatorSshMaxThreads(int max) Set number of ssh simulation thread to use.
void	setSimulatorSshPbsBinPath(java.lang.String path) Change PBS bin path.
void	setSimulatorSshPbsQsubOptions(java.lang.String options) Change PBS qsub options (command line).
void	setSimulatorSshServer(java.lang.String sshServer) Change ssh server url value.
void	setSimulatorSshTmpPath(java.lang.String sshtemppath) Change ssh temp path.
void	setSimulatorSshUserHome(java.lang.String userhome) Change isis remote home directory.
void	setSimulatorSshUsername(java.lang.String username) Change ssh username.
void	setSSHPrivateKeyFilePath(java.io.File sshFile) Set ssh private key file path.

Methods inherited from class org.nuiton.util.ApplicationConfig

addAction, addActionAlias, addAlias, addPropertyChangeListener, addPropertyChangeListener, createAction, doAction, firePropertyChange, getConfigFileName, getMethods, getOption, getOption, getOption, getOptionAsBoolean, getOptionAsClass, getOptionAsDate, getOptionAsDouble, getOptionAsFile, getOptionAsInt, getOptionAsTime, getOptionAsTimestamp, getOptionAsURL, getOptions, getOptionStartsWith, getParams, getPropertyChangeListeners, getPropertyChangeListeners, getUnparsed, getUserHome, getUsername, hasListeners, isUseOnlyAliases, printConfig, printConfig, removePropertyChangeListener, removePropertyChangeListener, replaceRecursiveOptions, save, saveForSystem, saveForUser, setConfigFileName, setDefaultOption, setOption, setOptions, setUseOnlyAliases

Methods inherited from class java.lang.Object

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

Field Detail

STEP_AFTER_INIT

public static final int STEP_AFTER_INIT

Config step after init.

See Also:

ApplicationConfig.Action.Step, Constant Field Values

STEP_AFTER_INIT_VCS

public static final int STEP_AFTER_INIT_VCS

Config step after init vcs.

See Also:

ApplicationConfig.Action.Step, Constant Field Values

STEP_AFTER_UI

public static final int STEP_AFTER_UI

Config step after ui.

See Also:

ApplicationConfig.Action.Step, Constant Field Values

STEP_BEFORE_EXIT

public static final int STEP_BEFORE_EXIT

Config step before exit.

See Also:

ApplicationConfig.Action.Step, Constant Field Values

version

protected static final org.nuiton.util.Version version

La version du logiciel constitue de l.d.a.r

l: le numero de version du logiciel

d: le numero de version du schema de la base de donnees

a: le numero de version de l'api des scripts

r: le numero de version de de l'interface graphique ou autre modif mineur

lors de l'increment de l, d, a et r sont remis a 0 lors de l'increment de d, a et r sont remis a 0 lors de l'increment de a, r est remis a 0

Un changement d'UI ne modifie jamais le numero de version de database Un changement de schema de base pour lequel on ne peut pas faire de migration de donnees demande automatiquement un changement de version d'application.

databaseVersion

protected static final org.nuiton.util.Version databaseVersion

apiVersion

protected static final org.nuiton.util.Version apiVersion

COPYRIGHT_TEXT

public static final java.lang.String COPYRIGHT_TEXT

CONFIG_FILENAME

public static final java.lang.String CONFIG_FILENAME

SEP

public static final java.lang.String SEP

separateur de liste

See Also:

Constant Field Values

REPORT_EMAIL

public static final java.lang.String REPORT_EMAIL

See Also:

Constant Field Values

backupSessionDirectory

protected transient java.io.File backupSessionDirectory

startingTime

protected long startingTime

Mémorise une unité de temps en millisecondes. Auparavant, c'etait System.nanoTime(), mais cette unité de temps n'est pas lié a une date. Par exemple, ca permet juste de mesuré avec une precision de 10-9 le temps ecoulé, par l'heure qu'il est à cette unité de temps.

Constructor Detail

IsisConfig

public IsisConfig()

Method Detail

getVersionNumber

public static org.nuiton.util.Version getVersionNumber()

getVersion

public static java.lang.String getVersion()

Le nombre global ex: 3.2.0.0

Returns:

full version

getDatabaseVersion

public static org.nuiton.util.Version getDatabaseVersion()

La version de la base ex: 3.2

Returns:

database version

getApiVersion

public static org.nuiton.util.Version getApiVersion()

La version de l'api de programmation ex: 3.2.0

Returns:

api version

getDatabaseDirectory

public java.io.File getDatabaseDirectory()

Retourne le repertoire racine de toutes les donnees (script, simulation region, ...)

Returns:

database directory

getContextDatabaseDirectory

public java.io.File getContextDatabaseDirectory()

Get database directory to use for script. Defaut to getDatabaseDirectory() value, but to SimulationContext.getScriptDirectory() during a simulation.

Returns:

script database directory

getDatabaseLockMode

public java.lang.String getDatabaseLockMode()

Retourne le lock a utiliser pour la base h2. Par defaut la base utilise 'file'. Les valeurs acceptées sont : - file - socket - no http://www.h2database.com/html/features.html#database_file_locking

Returns:

h2 db lock mode

getCompileDirectory

public java.io.File getCompileDirectory()

Retourne le repertoire ou sont stockes les scripts compiles. Create directory if not exists. Make a specific build directory for running simulation.

Returns:

compilation directory

getMonitoringDirectory

public java.io.File getMonitoringDirectory()

Retourne le repertoire ou sont stockes les informations relatives aux simulations en cours.

Returns:

monitoring directory

getJavadocDirectory

public java.io.File getJavadocDirectory()

Get javadoc directory. Create directory if not exists.

Returns:

javadoc directory

getLocale

public java.util.Locale getLocale()

Retourne l'objet Locale a utilise pour la langue.

Returns:

application Locale

setLocale

public void setLocale(java.lang.String locale)

Change application locale. (used during application config command line parse)

Parameters:

locale - new locale

getEncoding

public java.lang.String getEncoding()

Retourne l'encoding a utiliser pour les fichiers textes.

Returns:

encoding to use

getSmtpServer

public java.lang.String getSmtpServer()

Retourne le serveur SMTP a utiliser pour l'envoie de mail.

Returns:

smtp server address

getUserName

public java.lang.String getUserName()

Retourne le nom usuel de l'utilisateur.

Returns:

username

getUserMail

public java.lang.String getUserMail()

Retourne l'email de l'utilisateur.

Returns:

user email

getSimulatorClassfile

public java.lang.String getSimulatorClassfile()

setSimulatorClassfile

public void setSimulatorClassfile(java.lang.String value)

getSimulatorSshServer

public java.lang.String getSimulatorSshServer()

Retourne l'url du serveur de simulation accessible via SSH.

Returns:

simulator server

setSimulatorSshServer

public void setSimulatorSshServer(java.lang.String sshServer)

Change ssh server url value.

Parameters:

sshServer -

getSimulatorSshUsername

public java.lang.String getSimulatorSshUsername()

Retourne le login pour acceder au serveur de simulation accessible via SSH.

Returns:

simulator username

setSimulatorSshUsername

public void setSimulatorSshUsername(java.lang.String username)

Change ssh username.

Parameters:

username - username

getSimulatorSshDataPath

public java.lang.String getSimulatorSshDataPath()

Retourne le chemin relatif ou abs du repertoire root des données d'isis.

Returns:

simulator data path

setSimulatorSshDataPath

public void setSimulatorSshDataPath(java.lang.String datapath)

Change remote datapath.

Parameters:

datapath - datapath

getSimulatorSshUserHome

public java.lang.String getSimulatorSshUserHome()

Get remote user home directory.

Returns:

remote user home

setSimulatorSshUserHome

public void setSimulatorSshUserHome(java.lang.String userhome)

Change isis remote home directory.

Parameters:

userhome - new remote home

getSimulatorSshIsisHome

public java.lang.String getSimulatorSshIsisHome()

Retourne le chemin distant ou est installé isis.

Returns:

remote isis home

setSimulatorSshIsisHome

public void setSimulatorSshIsisHome(java.lang.String isishome)

Change isis home on ssh server.

Parameters:

isishome - isis home

getSimulatorSshTmpPath

public java.lang.String getSimulatorSshTmpPath()

Retourne l'emplacement du dossier temporaire distant. Ce dossier doit être ABSOLUT.

Returns:

tmp dir

setSimulatorSshTmpPath

public void setSimulatorSshTmpPath(java.lang.String sshtemppath)

Change ssh temp path.

Parameters:

sshtemppath - temp path

getSimulatorSshPbsBinPath

public java.lang.String getSimulatorSshPbsBinPath()

PBS bin path directory.

Returns:

path

setSimulatorSshPbsBinPath

public void setSimulatorSshPbsBinPath(java.lang.String path)

Change PBS bin path.

Parameters:

path - new path

getSimulatorSshPbsQsubOptions

public java.lang.String getSimulatorSshPbsQsubOptions()

PBS qsub options (command line). See man qsub for available options.

Returns:

options

setSimulatorSshPbsQsubOptions

public void setSimulatorSshPbsQsubOptions(java.lang.String options)

Change PBS qsub options (command line).

Parameters:

options - new options

getSimulatorSshJavaPath

public java.lang.String getSimulatorSshJavaPath()

Java path directory.

Returns:

path

setSimulatorSshJavaPath

public void setSimulatorSshJavaPath(java.lang.String path)

Change Java bin path.

Parameters:

path - new path

getSimulatorSshControlCheckInterval

public int getSimulatorSshControlCheckInterval()

Retourne l'interval de temps a utiliser pour recuperer le fichier de control.

Returns:

time (in seconds)

setSimulatorSshControlCheckInterval

public void setSimulatorSshControlCheckInterval(int interval)

Change control check interval.

Parameters:

interval - interval

getSimulatorSshMaxThreads

public int getSimulatorSshMaxThreads()

Retourne le nombre de thread simultane a utiliser par le pool de thread du launcher SSH.

Returns:

number of thread to use

setSimulatorSshMaxThreads

public void setSimulatorSshMaxThreads(int max)

Set number of ssh simulation thread to use.

Parameters:

max - max

getSSHPrivateKeyFilePath

public java.io.File getSSHPrivateKeyFilePath()

Retourne la clé privée de l'utilisteur courant.

Returns:

private ssh key path

setSSHPrivateKeyFilePath

public void setSSHPrivateKeyFilePath(java.io.File sshFile)

Set ssh private key file path.

Parameters:

sshFile - new value

isLaunchUI

public boolean isLaunchUI()

Get launch.ui option value.

Returns:

launch ui option value

isPerformMigration

public boolean isPerformMigration()

Get perform migration option value.

Returns:

perform migration option value

isPerformVcsUpdate

public boolean isPerformVcsUpdate()

Get perform vcs update option value.

Returns:

perform vcs update option value

isPerformCron

public boolean isPerformCron()

Get perform cron option value.

Returns:

perform cron option value

setSimulatorLauncher

public void setSimulatorLauncher(java.lang.String value)

isSimulationShowOnlyError

public boolean isSimulationShowOnlyError()

getDefaultExportNames

public java.lang.String getDefaultExportNames()

setDefaultExportNames

public void setDefaultExportNames(java.util.List<java.lang.String> exportNames)

getDefaultExportNamesAsList

public java.util.List<java.lang.String> getDefaultExportNamesAsList()

Returns:

la liste des noms d'exports par defaut sous forme de liste, a partir de la propriete IsisConfig.Option.DEFAULT_EXPORT_NAMES ou null si ils n'ont jamais ete sauves par l'utilisateur. by user.

See Also:

IsisConfig.Option.DEFAULT_EXPORT_NAMES

getDefaultMapFilename

public java.lang.String getDefaultMapFilename()

getDefaultResultNames

public java.lang.String getDefaultResultNames()

setDefaultResultNames

public void setDefaultResultNames(java.util.List<java.lang.String> resultNames)

getDefaultResultNamesAsList

public java.util.List<java.lang.String> getDefaultResultNamesAsList()

Returns:

les resultats par defaut d'une simulation sous forme de liste a partir de la propriete IsisConfig.Option.DEFAULT_RESULT_NAMES

See Also:

IsisConfig.Option.DEFAULT_RESULT_NAMES

getDefaultTagValue

public java.lang.String getDefaultTagValue()

setDefaultTagValues

public void setDefaultTagValues(java.util.Map<java.lang.String,java.lang.String> tagValues)

getDefaultTagValueAsMap

public java.util.Map<java.lang.String,java.lang.String> getDefaultTagValueAsMap()

Returns:

le dictionnaire des tags par defaut d'une simulation a partir de la propriete IsisConfig.Option.DEFAULT_TAG_VALUE

See Also:

IsisConfig.Option.DEFAULT_TAG_VALUE

getJavadocURL

public java.lang.String getJavadocURL()

getBackupDirectory

public java.io.File getBackupDirectory()

getStartingTime

public long getStartingTime()

Retourne le temps de départ de l'application en millisecondes.

Returns:

application start millis time

getElapsedTimeAsString

public java.lang.String getElapsedTimeAsString()

Retourne le temps écoulé depuis de debut de l'application (en secondes).

Returns:

le temps écoulé en seconde sous forme de chaine

getBackupSessionDirectory

public java.io.File getBackupSessionDirectory()

getScriptClassLoader

public java.lang.ClassLoader getScriptClassLoader()

Retourne un class loader contenant le repertoire de compilation Il permet alors de charger des classes qui viennent d'etre compilees dans isis If current thread is in simulation then return specific simulation compilation directory, else default compilation directory

Returns:

the class loader adequate

parse

public void parse(java.lang.String[] args)
           throws org.nuiton.util.ArgumentsParserException

Surcharge pour la migration des options de config qui ont change de nom

TODO: lors du passage en version 4.0 on pourrait supprimer cette methode

Overrides:

parse in class org.nuiton.util.ApplicationConfig

Parameters:

args -

Throws:

org.nuiton.util.ArgumentsParserException