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

Nested Classes

Modifier and Type	Class and Description
static class	IsisConfig.Action
static class	IsisConfig.Option Options.

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.nuiton.util.Version	apiVersion
protected File	backupSessionDirectory
static String	CONFIG_FILENAME
static String	COPYRIGHT_TEXT
protected static org.nuiton.util.Version	databaseVersion
protected static org.nuiton.util.Version	majorVersion
static 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

Fields inherited from class org.nuiton.util.ApplicationConfig

actions, ADJUSTING_PROPERTY, aliases, APP_NAME, cacheAction, cacheOption, classpath, CONFIG_ENCODING, CONFIG_FILE_NAME, CONFIG_PATH, context, curfile, defaults, env, etcfile, homefile, inParseOptionPhase, jvm, line, LIST_SEPARATOR, options, osName, pcs, unparsed, useOnlyAliases, userPath

Constructor Summary

Constructors

Constructor and Description
IsisConfig()

Method Summary

Methods

Modifier and Type	Method and Description
static org.nuiton.util.Version	getApiVersion() La version de l'api de programmation ex: 3.2.0
File	getBackupDirectory()
File	getBackupSessionDirectory()
File	getCommunityDatabaseDirectory() Retourne le repertoire racine de toutes les donnees communauté (commit utilisateur).
File	getCompileDirectory() Retourne le repertoire ou sont stockes les scripts compiles.
File	getContextDatabaseDirectory() Get database directory to use for script.
File	getDatabaseDirectory() Retourne le repertoire racine de toutes les donnees (script, simulation region, ...)
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
String	getDefaultExportNames()
List<String>	getDefaultExportNamesAsList()
String	getDefaultMapFilename()
String	getDefaultResultNames()
List<String>	getDefaultResultNamesAsList()
String	getDefaultTagValue()
Map<String,String>	getDefaultTagValueAsMap()
String	getElapsedTimeAsString() Retourne le temps écoulé depuis de debut de l'application (en secondes).
String	getEncoding() Retourne l'encoding a utiliser pour les fichiers textes.
File	getJavadocDirectory() Get javadoc directory.
String	getJavadocURL()
Locale	getLocale() Retourne l'objet Locale a utilise pour la langue.
File	getMonitoringDirectory() Retourne le repertoire ou sont stockes les informations relatives aux simulations en cours.
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
String	getSimulatorClassfile()
int	getSimulatorSshControlCheckInterval() Retourne l'interval de temps a utiliser pour recuperer le fichier de control.
String	getSimulatorSshDataPath() Retourne le chemin relatif ou abs du repertoire root des données d'isis.
String	getSimulatorSshIsisHome() Retourne le chemin distant ou est installé isis.
String	getSimulatorSshJavaPath() Java path directory.
int	getSimulatorSshMaxThreads() Retourne le nombre de thread simultane a utiliser par le pool de thread du launcher SSH.
String	getSimulatorSshPbsBinPath() PBS bin path directory.
String	getSimulatorSshPbsQsubOptions() PBS qsub options (command line).
String	getSimulatorSshServer() Retourne l'url du serveur de simulation accessible via SSH.
String	getSimulatorSshTmpPath() Retourne l'emplacement du dossier temporaire distant.
String	getSimulatorSshUserHome() Get remote user home directory.
String	getSimulatorSshUsername() Retourne le login pour acceder au serveur de simulation accessible via SSH.
String	getSmtpServer() Retourne le serveur SMTP a utiliser pour l'envoie de mail.
File	getSSHPrivateKeyFilePath() Retourne la clé privée de l'utilisteur courant.
long	getStartingTime() Retourne le temps de départ de l'application en millisecondes.
String	getUserMail() Retourne l'email de l'utilisateur.
String	getUserName() Retourne le nom usuel de l'utilisateur.
static 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	isScriptAutoconfig() Get script auto configuration option value.
boolean	isSimulationShowOnlyError()
void	setDefaultExportNames(List<String> exportNames)
void	setDefaultResultNames(List<String> resultNames)
void	setDefaultTagValues(Map<String,String> tagValues)
void	setLocale(String locale) Change application locale.
void	setSimulatorClassfile(String value)
void	setSimulatorLauncher(String value)
void	setSimulatorSshControlCheckInterval(int interval) Change control check interval.
void	setSimulatorSshDataPath(String datapath) Change remote datapath.
void	setSimulatorSshIsisHome(String isishome) Change isis home on ssh server.
void	setSimulatorSshJavaPath(String path) Change Java bin path.
void	setSimulatorSshMaxThreads(int max) Set number of ssh simulation thread to use.
void	setSimulatorSshPbsBinPath(String path) Change PBS bin path.
void	setSimulatorSshPbsQsubOptions(String options) Change PBS qsub options (command line).
void	setSimulatorSshServer(String sshServer) Change ssh server url value.
void	setSimulatorSshTmpPath(String sshtemppath) Change ssh temp path.
void	setSimulatorSshUserHome(String userhome) Change isis remote home directory.
void	setSimulatorSshUsername(String username) Change ssh username.
void	setSSHPrivateKeyFilePath(File sshFile) Set ssh private key file path.

Methods inherited from class org.nuiton.util.ApplicationConfig

addAction, addActionAlias, addAlias, addPropertyChangeListener, addPropertyChangeListener, convertOption, createAction, doAction, doAllAction, firePropertyChange, getActionStep, getConfigFileName, getConfigFileNameOption, getConfigPath, getEncodingOption, getFlatOptions, getFlatOptions, getMethods, getObject, getObject, getOption, getOption, getOption, getOptionAsBoolean, getOptionAsClass, getOptionAsDate, getOptionAsDouble, getOptionAsFile, getOptionAsFloat, getOptionAsInt, getOptionAsList, getOptionAsLocale, getOptionAsLong, getOptionAsObject, getOptionAsObject, getOptionAsProperties, getOptionAsSingleton, getOptionAsSingleton, getOptionAsTime, getOptionAsTimestamp, getOptionAsURL, getOptionAsVersion, getOptions, getOptionStartsWith, getParams, getPrintableConfig, getPropertyChangeListeners, getPropertyChangeListeners, getSystemConfigFile, getSystemConfigurationPath, getUnparsed, getUserConfigDirectory, getUserConfigFile, getUserHome, getUsername, hasListeners, hasOption, hasOption, installSaveUserAction, isAdjusting, isUseOnlyAliases, loadActions, loadDefaultOptions, loadResource, migrateUserConfigurationFile, parse, printConfig, printConfig, putObject, putObject, removePropertyChangeListener, removePropertyChangeListener, replaceRecursiveOptions, save, saveForSystem, saveForUser, saveResource, setAdjusting, setAppName, setConfigFileName, setDefaultOption, setEncoding, 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.

majorVersion

protected static final org.nuiton.util.Version majorVersion

databaseVersion

protected static final org.nuiton.util.Version databaseVersion

apiVersion

protected static final org.nuiton.util.Version apiVersion

COPYRIGHT_TEXT

public static final String COPYRIGHT_TEXT

CONFIG_FILENAME

public static final String CONFIG_FILENAME

SEP

public static final String SEP

separateur de liste

See Also:

Constant Field Values

backupSessionDirectory

protected transient 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 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 File getDatabaseDirectory()

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

Returns:

database directory

getCommunityDatabaseDirectory

public File getCommunityDatabaseDirectory()

Retourne le repertoire racine de toutes les donnees communauté (commit utilisateur).

Returns:

community database directory

getContextDatabaseDirectory

public 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 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 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 File getMonitoringDirectory()

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

Returns:

monitoring directory

getJavadocDirectory

public File getJavadocDirectory()

Get javadoc directory. Create directory if not exists.

Returns:

javadoc directory

getLocale

public Locale getLocale()

Retourne l'objet Locale a utilise pour la langue.

Returns:

application Locale

setLocale

public void setLocale(String locale)

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

Parameters:

locale - new locale

getEncoding

public String getEncoding()

Retourne l'encoding a utiliser pour les fichiers textes.

Overrides:

getEncoding in class org.nuiton.util.ApplicationConfig

Returns:

encoding to use

getSmtpServer

public String getSmtpServer()

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

Returns:

smtp server address

getUserName

public String getUserName()

Retourne le nom usuel de l'utilisateur.

Returns:

username

getUserMail

public String getUserMail()

Retourne l'email de l'utilisateur.

Returns:

user email

getSimulatorClassfile

public String getSimulatorClassfile()

setSimulatorClassfile

public void setSimulatorClassfile(String value)

getSimulatorSshServer

public String getSimulatorSshServer()

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

Returns:

simulator server

setSimulatorSshServer

public void setSimulatorSshServer(String sshServer)

Change ssh server url value.

Parameters:

sshServer -

getSimulatorSshUsername

public String getSimulatorSshUsername()

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

Returns:

simulator username

setSimulatorSshUsername

public void setSimulatorSshUsername(String username)

Change ssh username.

Parameters:

username - username

getSimulatorSshDataPath

public String getSimulatorSshDataPath()

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

Returns:

simulator data path

setSimulatorSshDataPath

public void setSimulatorSshDataPath(String datapath)

Change remote datapath.

Parameters:

datapath - datapath

getSimulatorSshUserHome

public String getSimulatorSshUserHome()

Get remote user home directory.

Returns:

remote user home

setSimulatorSshUserHome

public void setSimulatorSshUserHome(String userhome)

Change isis remote home directory.

Parameters:

userhome - new remote home

getSimulatorSshIsisHome

public String getSimulatorSshIsisHome()

Retourne le chemin distant ou est installé isis.

Returns:

remote isis home

setSimulatorSshIsisHome

public void setSimulatorSshIsisHome(String isishome)

Change isis home on ssh server.

Parameters:

isishome - isis home

getSimulatorSshTmpPath

public String getSimulatorSshTmpPath()

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

Returns:

tmp dir

setSimulatorSshTmpPath

public void setSimulatorSshTmpPath(String sshtemppath)

Change ssh temp path.

Parameters:

sshtemppath - temp path

getSimulatorSshPbsBinPath

public String getSimulatorSshPbsBinPath()

PBS bin path directory.

Returns:

path

setSimulatorSshPbsBinPath

public void setSimulatorSshPbsBinPath(String path)

Change PBS bin path.

Parameters:

path - new path

getSimulatorSshPbsQsubOptions

public String getSimulatorSshPbsQsubOptions()

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

Returns:

options

setSimulatorSshPbsQsubOptions

public void setSimulatorSshPbsQsubOptions(String options)

Change PBS qsub options (command line).

Parameters:

options - new options

getSimulatorSshJavaPath

public String getSimulatorSshJavaPath()

Java path directory.

Returns:

path

setSimulatorSshJavaPath

public void setSimulatorSshJavaPath(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 File getSSHPrivateKeyFilePath()

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

Returns:

private ssh key path

setSSHPrivateKeyFilePath

public void setSSHPrivateKeyFilePath(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

isScriptAutoconfig

public boolean isScriptAutoconfig()

Get script auto configuration option value.

Returns:

autoconfiguration

setSimulatorLauncher

public void setSimulatorLauncher(String value)

isSimulationShowOnlyError

public boolean isSimulationShowOnlyError()

getDefaultExportNames

public String getDefaultExportNames()

setDefaultExportNames

public void setDefaultExportNames(List<String> exportNames)

getDefaultExportNamesAsList

public List<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 String getDefaultMapFilename()

getDefaultResultNames

public String getDefaultResultNames()

setDefaultResultNames

public void setDefaultResultNames(List<String> resultNames)

getDefaultResultNamesAsList

public List<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 String getDefaultTagValue()

setDefaultTagValues

public void setDefaultTagValues(Map<String,String> tagValues)

getDefaultTagValueAsMap

public Map<String,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 String getJavadocURL()

getBackupDirectory

public File getBackupDirectory()

getStartingTime

public long getStartingTime()

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

Returns:

application start millis time

getElapsedTimeAsString

public 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 File getBackupSessionDirectory()

getScriptClassLoader

public 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