org.nuiton.util
Class ApplicationConfig

java.lang.Object
  org.nuiton.util.ApplicationConfig

public class ApplicationConfig
extends java.lang.Object

Application configuration.

A finir...

• Ajout d'annotations sur les methodes pour preciser plus de chose pour les options (pattern, min/max, alias, description, ...)
• Trouver un moyen de document les options et actions pour automatiquement generer l'aide en ligne. Pour eviter de devoir maintenir une methode dans lequel est ecrit l'aide en plus des options.
• Prise en compte du flag useOnlyAliases
• Vu qu'en java on ne peut pas pointer une methode mais seulement une classe il y a un bout des actions qui sont des chaines (nom de la methode). Il faudrait faire un plugin maven qui check que l'action existe bien durant la compilation. Il est simple de le faire a l'execution mais c trop tard :(

Usage

Create subclass of ApplicationConfig, where in constructor you call setConfigFileName(String), setDefaultOption(String, String), addAlias(String, String...), addActionAlias(String, String), to have properly value.

     
     conf = new MonAppConfig();
     conf.parse(args);
     here you can used conf.getOption(key);
     conf.doAction(0);
     ...
     conf.doAction(n);
 

Lecture des fichiers de configuration

La lecture des fichiers de configuration se fait durant l'appel de la methode parse(java.lang.String[]) en utilisant la valeur de getConfigFileName() pour trouver les fichiers (voir Les options de configuration pour l'ordre de chargement des fichiers)

La sauvegarde

La sauvegarde des options se fait via une des trois methodes disponibles :

• save(File, boolean,String...) sauve les données dans le fichier demandé
• saveForSystem(java.lang.String...) sauvegarde les donnees dans /etc
• saveForUser(java.lang.String...) sauvegarde les donnees dans $HOME

Lors de l'utilisation de la methode saveForSystem(java.lang.String...) ou saveForUser(java.lang.String...) seules les options lues dans un fichier ou modifiées par programmation (setOption(java.lang.String, java.lang.String) seront sauvegardées. Par exemple les options passees sur la ligne de commande ne seront pas sauvees.

Les options de configuration

Cette classe permet de lire les fichiers de configuration, utiliser les variable d'environnement et de parser la ligne de commande. L'ordre de prise en compte des informations trouvées est le suivant (le premier le plus important) :

• options ajoutees par programmation: setOption(String, String)
• ligne de commande
• variable d'environnement de la JVM: java -Dkey=value
• variable d'environnement; export key=value
• fichier de configuration du repertoire courant: $user.dir/filename
• fichier de configuration du repertoire home de l'utilisateur: $user.home/.filename
• fichier de configuration du repertoire /etc: /etc/filename
• fichier de configuration trouve dans le classpath: $CLASSPATH/filename
• options ajoutees par programmation: defaults.put(key, value)

Les options sur la ligne de commande sont de la forme:

 --option key value
 --monOption key value1 value2
 

• --option key value: est la syntaxe par defaut
• --monOption key value1 value2: est la syntaxe si vous avez ajouter une methode setMonOption(key, value1, value2) sur votre classe de configuration qui herite de ApplicationConfig. Dans ce cas vous pouvez mettre les arguments que vous souhaitez du moment qu'ils soient convertibles de la representation String vers le type que vous avez mis.

Les actions

Les actions ne peuvent etre que sur la ligne de commande. Elles sont de la forme:

 --le.package.LaClass#laMethode arg1 arg2 arg3 ... argN
 

Une action est donc defini par le chemin complet vers la methode qui traitera l'action. Cette methode peut-etre une methode static ou non. Si la methode n'est pas static lors de l'instanciation de l'objet on essaie de passer en parametre du constructeur la classe de configuration utilisee pour permettre a l'action d'avoir a sa disposition les options de configuration. Si aucun constructeur avec comme seul parametre une classe heritant de ApplicationConfig n'existe alors le constructeur par defaut est utilise (il doit etre accessible). Toutes methodes d'actions faisant parties d'un meme objet utiliseront la meme instance de cette objet lors de leur execution.

Si la methode utilise les arguments variants alors tous les arguments jusqu'au prochain -- ou la fin de la ligne de commande sont utilises. Sinon Le nombre exact d'argument necessaire a la methode sont utilises.

Les arguments sont automatiquement converti dans le bon type reclame par la methode.

Si l'on veut des arguments optionnels le seul moyen actuellement est d'utiliser une methode avec des arguments variants

Les actions ne sont pas execute mais seulement parsees. Pour les executer il faut utiliser la méthode doAction(int) qui prend en argument un numero de 'step'. Par defaut toutes les actions sont de niveau 0 et sont executee dans l'ordre d'apparition sur la ligne de commande. Si l'on souhaite distinguer les actions il est possible d'utiliser l'annotation ApplicationConfig.Action.Step sur la methode qui fera l'action en precisant une autre valeur que 0.

 doAction(0);
 ... do something ...
 doAction(1);
 

dans cette exemple on fait un traitement entre l'execution des actions de niveau 0 et les actions de niveau 1.

Les arguments non parsées

Tout ce qui n'est pas option ou action est considere comme non parse et peut etre recupere par la methode getUnparsed(). Si l'on souhaite forcer la fin du parsing de la ligne de commande il est possible de mettre --. Par exemple:

 monProg "mon arg" --option k1 v1 -- --option k2 v2 -- autre
 

Dans cet exemple seule la premiere option sera considere comme une option. On retrouvera dans unparsed: "mon arg", "--option", "k2", "v2", "--", "autre"

Les alias

On voit qu'aussi bien pour les actions que pour les options, le nom de la methode doit etre utilise. Pour eviter ceci il est possible de definir des alias ce qui permet de creer des options courtes par exemple. Pour cela, on utilise la methode addAlias(java.lang.String, java.lang.String...).

 addAlias("-v", "--option", "verbose", "true");
 addAlias("-o", "--option", "outputfile");
 addAlias("-i", "--mon.package.MaClass#MaMethode", "import");
 

En faite avant le parsing de la ligne de commande tous les alias trouves sont automatiquement remplacer par leur correspondance. Il est donc possible d'utiliser ce mecanisme pour autre chose par exemple:

 addAlias("cl", "Code Lutin");
 addAlias("bp", "Benjamin POUSSIN);
 

Dans le premier exemple on simplifie une option de flags l'option -v n'attend donc plus d'argument. Dans le second exemple on simplifie une option qui attend encore un argment de type File. Enfin dans le troisieme exemple on simplifie la syntaxe d'une action et on force le premier argument de l'action a etre "import".

Conversion de type

Pour la conversion de type nous utilisons common-beans. Les types supportes sont:

• les primitif (byte, short, int, long, float, double, char, boolean)
• String
• File
• URL
• Class
• SqlDate
• SqlTime
• SqlTimestamp
• les tableaux d'un type primitif ou String. Chaque element doit etre separe par une virgule.

Pour suporter d'autre type, il vous suffit d'enregistrer de nouveau converter dans commons-beans.

Les substitutions de variable

ApplicationConfig supporte les substition de variables de la forme ${xxx} où xxx est une autre variable de la configuration.

Exemple (dans un fichier de configuration):

 firstname = John
 lastname = Doe
 fullname = ${firstname} ${lastname}
 

getOption("fullname") retournera "John Doe".

Since:

0.30

Version:

$Revision: 1899 $

Last update $Date: 2010-07-09 11:16:28 +0200 (ven., 09 juil. 2010) $ by

Author:

poussin

Nested Class Summary

static class	ApplicationConfig.Action Defines a runtime action to be launched via the ApplicationConfig.Action.doAction() method.
protected static class	ApplicationConfig.CacheItem<T> Item used for cacheOption
static interface	ApplicationConfig.OptionDef Le contrat de marquage des options, on utilise cette interface pour caracteriser une option de configuration.

Field Summary

protected java.util.Map<java.lang.Integer,java.util.List<ApplicationConfig.Action>>	actions TODO
static java.lang.String	ADJUSTING_PROPERTY Property name of adjusting internal state.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	aliases TODO
static java.lang.String	APP_NAME TODO
protected java.util.Map<java.lang.Class<?>,java.lang.Object>	cacheAction TODO
protected java.util.Map<java.lang.String,ApplicationConfig.CacheItem<?>>	cacheOption TODO
protected java.util.Properties	classpath TODO
static java.lang.String	CONFIG_FILE_NAME Configuration file key option.
static java.lang.String	CONFIG_PATH Configuration directory where config path in located.
protected java.util.Properties	curfile TODO
protected java.util.Properties	defaults TODO
protected java.util.Properties	env TODO
protected java.util.Properties	etcfile TODO
protected java.util.Properties	homefile TODO
protected boolean	inParseOptionPhase vrai si on est en train de parser les options de la ligne de commande.
protected java.util.Properties	jvm TODO
protected java.util.Properties	line TODO
protected java.util.Properties	options TODO
protected java.lang.String	osName System os name.
protected java.beans.PropertyChangeSupport	pcs suport of config modification.
protected java.util.List<java.lang.String>	unparsed contient apres l'appel de parse, la liste des arguments non utilises
protected boolean	useOnlyAliases TODO
protected java.lang.String	userPath Deprecated. since 1.2.1, and can't be removed (for migration purpose)

Constructor Summary

ApplicationConfig()
Init ApplicationConfig with current simple class name as config file.

Method Summary

void	addAction(ApplicationConfig.Action action) Add action to list of action to do
void	addActionAlias(java.lang.String alias, java.lang.String actionMethod) Add alias for action.
void	addAlias(java.lang.String alias, java.lang.String... target) All argument in aliases as key is substitued by target.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
protected ApplicationConfig.Action	createAction(java.lang.String name, java.util.ListIterator<java.lang.String> args) Create action from string, string must be [package.]
void	doAction(int step) Do action in specified step.
protected void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
java.lang.String	getConfigFileName() Get name of file where options are read (in /etc, $HOME, $CURDIR).
protected java.lang.String	getConfigFileNameOption()
java.lang.String	getConfigPath() Get configuration file path to use.
java.util.Properties	getFlatOptions() Get all options as flat Properties object (replace inner options).
java.util.Properties	getFlatOptions(boolean replaceInner) Get all options as flat Properties object.
protected java.util.Map<java.lang.String,java.lang.reflect.Method>	getMethods() Get all set method on this object or super object.
java.lang.Object	getOption(ApplicationConfig.OptionDef key) Get option value from a option definition.
<T> T	getOption(java.lang.Class<T> clazz, java.lang.String key) Get option value as typed value.
java.lang.String	getOption(java.lang.String key) get option value as string.
boolean	getOptionAsBoolean(java.lang.String key) Get option value as boolean.
java.lang.Class<?>	getOptionAsClass(java.lang.String key) Get option value as Class.
java.sql.Date	getOptionAsDate(java.lang.String key) Get option value as Date.
double	getOptionAsDouble(java.lang.String key) Get option value as double.
java.io.File	getOptionAsFile(java.lang.String key) Get option value as File.
int	getOptionAsInt(java.lang.String key) Get option value as int.
java.sql.Time	getOptionAsTime(java.lang.String key) Get option value as Time.
java.sql.Timestamp	getOptionAsTimestamp(java.lang.String key) Get option value as Timestamp.
java.net.URL	getOptionAsURL(java.lang.String key) Get option value as URL.
java.util.Properties	getOptions() Get all options from configuration.
java.util.Properties	getOptionStartsWith(java.lang.String prefix) Permet de recuperer l'ensemble des options commencant par une certaine chaine.
protected java.lang.String[]	getParams(java.lang.reflect.Method m, java.util.ListIterator<java.lang.String> args) Take required argument for method in args.
java.beans.PropertyChangeListener[]	getPropertyChangeListeners()
java.beans.PropertyChangeListener[]	getPropertyChangeListeners(java.lang.String propertyName)
java.io.File	getSystemConfigFile() Obtain the system config file location.
protected java.lang.String	getSystemConfigurationPath() Get system configuration path.
java.util.List<java.lang.String>	getUnparsed() Return list of unparsed command line argument
java.io.File	getUserConfigFile() Obtain the user config file location.
static java.lang.String	getUserHome() Get user home directory (system property user.home).
java.lang.String	getUsername() Get user name (system property user.name).
protected java.lang.String	getUserPath() Get user configuration path.
boolean	hasListeners(java.lang.String propertyName)
protected void	installSaveUserAction(java.lang.String... properties) Install the saveUserAction on givne properties.
boolean	isAdjusting()
boolean	isUseOnlyAliases()
protected void	migrateUserConfigurationFile(java.io.File oldHomeConfig, java.io.File homeConfig) Move old user configuration file oldHomeConfig to homeConfig.
void	parse(java.lang.String[] args) Parse option and call set necessary method, read jvm, env variable, Load configuration file and prepare Action.
void	printConfig() For debugging.
void	printConfig(java.io.PrintStream output) Print out current configuration in specified output.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
protected java.lang.String	replaceRecursiveOptions(java.lang.String option) Replace included ${xxx} suboptions by their values.
void	save(java.io.File file, boolean forceAll, java.lang.String... excludeKeys) Save configuration, in specified file.
void	saveForSystem(java.lang.String... excludeKeys) Save configuration, in system directory (/etc/) using the getConfigFileName().
void	saveForUser(java.lang.String... excludeKeys) Save configuration, in user home directory using the getConfigFileName().
void	setAdjusting(boolean adjusting)
void	setAppName(java.lang.String appName) Use appName to add a context in config.file and config.path options.
void	setConfigFileName(java.lang.String name) Set name of file where options are read (in /etc, $HOME, $CURDIR) This set used setDefaultOption(String, String)
protected void	setDefaultOption(java.lang.String key, java.lang.String value) Used to put default configuration option in config option.
void	setOption(java.lang.String key, java.lang.String value) Set option value.
void	setOptions(java.util.Properties options) Set manually options when you don't want to use parse method to check properties file configured by setConfigFileName(java.lang.String).
void	setUseOnlyAliases(boolean useOnlyAliases)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE_NAME

public static final java.lang.String CONFIG_FILE_NAME

Configuration file key option.

See Also:

Constant Field Values

APP_NAME

public static final java.lang.String APP_NAME

TODO

See Also:

Constant Field Values

ADJUSTING_PROPERTY

public static final java.lang.String ADJUSTING_PROPERTY

Property name of adjusting internal state.

Since:

1.3

See Also:

Constant Field Values

CONFIG_PATH

public static final java.lang.String CONFIG_PATH

Configuration directory where config path in located. Use default system configuration if nothing is defined:

• Linux : /etc/xxx.properties
• Windows : C:\\Windows\\System32\\xxx.properties
• Mac OS : /etc/

See Also:

Constant Field Values

osName

protected java.lang.String osName

System os name. (windows, linux, max os x)

useOnlyAliases

protected boolean useOnlyAliases

TODO

userPath

@Deprecated
protected java.lang.String userPath

Deprecated. since 1.2.1, and can't be removed (for migration purpose)

file $user.home/.[filename] Not used anymore. Just used for migration issue.

inParseOptionPhase

protected boolean inParseOptionPhase

vrai si on est en train de parser les options de la ligne de commande.

defaults

protected java.util.Properties defaults

TODO

classpath

protected java.util.Properties classpath

TODO

etcfile

protected java.util.Properties etcfile

TODO

homefile

protected java.util.Properties homefile

TODO

curfile

protected java.util.Properties curfile

TODO

env

protected java.util.Properties env

TODO

jvm

protected java.util.Properties jvm

TODO

line

protected java.util.Properties line

TODO

options

protected java.util.Properties options

TODO

cacheOption

protected java.util.Map<java.lang.String,ApplicationConfig.CacheItem<?>> cacheOption

TODO

cacheAction

protected java.util.Map<java.lang.Class<?>,java.lang.Object> cacheAction

TODO

unparsed

protected java.util.List<java.lang.String> unparsed

contient apres l'appel de parse, la liste des arguments non utilises

aliases

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> aliases

TODO

actions

protected java.util.Map<java.lang.Integer,java.util.List<ApplicationConfig.Action>> actions

TODO

pcs

protected java.beans.PropertyChangeSupport pcs

suport of config modification.

Constructor Detail

ApplicationConfig

public ApplicationConfig()

Init ApplicationConfig with current simple class name as config file. Also init converters.

See Also:

ConverterUtil.initConverters()

Method Detail

getUserHome

public static java.lang.String getUserHome()

Get user home directory (system property user.home).

Returns:

user home directory

getUsername

public java.lang.String getUsername()

Get user name (system property user.name).

Returns:

user name

setDefaultOption

protected void setDefaultOption(java.lang.String key,
                                java.lang.String value)

Used to put default configuration option in config option. Those options are used as fallback value.

Parameters:

key - default property key

value - default property value

save

public void save(java.io.File file,
                 boolean forceAll,
                 java.lang.String... excludeKeys)
          throws java.io.IOException

Save configuration, in specified file.

Parameters:

file - file where config will be writen

forceAll - if true save all config option (with defaults, classpath, env, command line)

excludeKeys - optional list of keys to exclude from

Throws:

java.io.IOException - if IO pb

saveForSystem

public void saveForSystem(java.lang.String... excludeKeys)

Save configuration, in system directory (/etc/) using the getConfigFileName(). Default, env and commande line note saved.

Parameters:

excludeKeys - optional list of keys to exclude from

saveForUser

public void saveForUser(java.lang.String... excludeKeys)

Save configuration, in user home directory using the getConfigFileName(). Default, env and commande line note saved

Parameters:

excludeKeys - optional list of keys to exclude from

getSystemConfigFile

public java.io.File getSystemConfigFile()

Obtain the system config file location.

Returns:

the system config file location

getUserConfigFile

public java.io.File getUserConfigFile()

Obtain the user config file location.

Returns:

the user config file location

getUnparsed

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

Return list of unparsed command line argument

Returns:

list of unparsed arguments

addAction

public void addAction(ApplicationConfig.Action action)

Add action to list of action to do

Parameters:

action - action to add, can be null.

doAction

public void doAction(int step)
              throws java.lang.IllegalAccessException,
                     java.lang.IllegalArgumentException,
                     java.lang.reflect.InvocationTargetException,
                     java.lang.InstantiationException

Do action in specified step.

Parameters:

step - do action only defined in this step

Throws:

java.lang.IllegalAccessException - if action invocation failed

java.lang.IllegalArgumentException - if action invocation failed

java.lang.reflect.InvocationTargetException - if action invocation failed

java.lang.InstantiationException - if action invocation failed

See Also:

ApplicationConfig.Action.Step

setUseOnlyAliases

public void setUseOnlyAliases(boolean useOnlyAliases)

isUseOnlyAliases

public boolean isUseOnlyAliases()

addAlias

public void addAlias(java.lang.String alias,
                     java.lang.String... target)

All argument in aliases as key is substitued by target.

Parameters:

alias - alias string as '-v'

target - substitution as '--option verbose true'

addActionAlias

public void addActionAlias(java.lang.String alias,
                           java.lang.String actionMethod)

Add alias for action. This method put just -- front the actionMethod and call addAlias(String, String...)

Parameters:

alias - the alias to add for the given method action

actionMethod - must be fully qualified method path: package.Class.method

setConfigFileName

public void setConfigFileName(java.lang.String name)

Set name of file where options are read (in /etc, $HOME, $CURDIR) This set used setDefaultOption(String, String)

Parameters:

name - file name

getConfigFileName

public java.lang.String getConfigFileName()

Get name of file where options are read (in /etc, $HOME, $CURDIR).

Returns:

name of file

isAdjusting

public boolean isAdjusting()

setAdjusting

public void setAdjusting(boolean adjusting)

getConfigFileNameOption

protected java.lang.String getConfigFileNameOption()

setAppName

public void setAppName(java.lang.String appName)

Use appName to add a context in config.file and config.path options. Ex for an application named 'pollen' : config.file option becomes pollen.config.file

Parameters:

appName - to use as application context

Since:

1.2.1

getConfigPath

public java.lang.String getConfigPath()

Get configuration file path to use. Use (in order) one of the following definition:

• CONFIG_PATH option
• system dependant path

Returns:

path to use with endind File.separator

Since:

1.2.1

getSystemConfigurationPath

protected java.lang.String getSystemConfigurationPath()

Get system configuration path. Currently supported:

• Windows : C:\Windows\System32
• Unix : /etc/

Returns:

the system path

Since:

1.2.1

getUserPath

protected java.lang.String getUserPath()

Get user configuration path. Currently supported:

• Windows : ${user.home}\\Application Data\\
• Max os x : ${user.home}/Library/Application Support
• Unix : ${user.home}/.config

Unix norm is based on freedesktop concept explained here : http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

Returns:

the user configuration path

Since:

1.2.1

setOption

public void setOption(java.lang.String key,
                      java.lang.String value)

Set option value.

Parameters:

key - property key

value - property value

getOption

public java.lang.String getOption(java.lang.String key)

get option value as string. Replace inner ${xxx} value.

Parameters:

key - the option's key

Returns:

String representation value

replaceRecursiveOptions

protected java.lang.String replaceRecursiveOptions(java.lang.String option)

Replace included ${xxx} suboptions by their values.

Parameters:

option - option to replace into

Returns:

replaced option

Since:

1.1.3

getOptionStartsWith

public java.util.Properties getOptionStartsWith(java.lang.String prefix)

Permet de recuperer l'ensemble des options commencant par une certaine chaine.

Parameters:

prefix - debut de cle a recuperer

Returns:

la liste des options filtrées

getOption

public java.lang.Object getOption(ApplicationConfig.OptionDef key)

Get option value from a option definition.

Parameters:

key - the definition of the option

Returns:

the value for the given option

getOption

public <T> T getOption(java.lang.Class<T> clazz,
                       java.lang.String key)

Get option value as typed value.

Type Parameters:

T - type of the object wanted as return type

Parameters:

clazz - type of object wanted as return type

key - the option's key

Returns:

typed value

getOptionAsFile

public java.io.File getOptionAsFile(java.lang.String key)

Get option value as File.

Parameters:

key - the option's key

Returns:

value as file

getOptionAsURL

public java.net.URL getOptionAsURL(java.lang.String key)

Get option value as URL.

Parameters:

key - the option's key

Returns:

value as URL

getOptionAsClass

public java.lang.Class<?> getOptionAsClass(java.lang.String key)

Get option value as Class.

Parameters:

key - the option's key

Returns:

value as Class

getOptionAsDate

public java.sql.Date getOptionAsDate(java.lang.String key)

Get option value as Date.

Parameters:

key - the option's key

Returns:

value as Date

getOptionAsTime

public java.sql.Time getOptionAsTime(java.lang.String key)

Get option value as Time.

Parameters:

key - the option's key

Returns:

value as Time

getOptionAsTimestamp

public java.sql.Timestamp getOptionAsTimestamp(java.lang.String key)

Get option value as Timestamp.

Parameters:

key - the option's key

Returns:

value as Timestamp

getOptionAsInt

public int getOptionAsInt(java.lang.String key)

Get option value as int.

Parameters:

key - the option's key

Returns:

value as int

getOptionAsDouble

public double getOptionAsDouble(java.lang.String key)

Get option value as double.

Parameters:

key - the option's key

Returns:

value as double

getOptionAsBoolean

public boolean getOptionAsBoolean(java.lang.String key)

Get option value as boolean.

Parameters:

key - the option's key

Returns:

value as boolean.

getOptions

public java.util.Properties getOptions()

Get all options from configuration.

Returns:

Properties which contains all options

setOptions

public void setOptions(java.util.Properties options)

Set manually options when you don't want to use parse method to check properties file configured by setConfigFileName(java.lang.String).

Parameters:

options - Properties which contains all options to set

getFlatOptions

public java.util.Properties getFlatOptions()

Get all options as flat Properties object (replace inner options).

Returns:

flat Properties object

Since:

1.2.2

getFlatOptions

public java.util.Properties getFlatOptions(boolean replaceInner)

Get all options as flat Properties object.

Parameters:

replaceInner - if true replace imbricated options by theirs values

Returns:

flat Properties object

Since:

1.2.2

installSaveUserAction

protected void installSaveUserAction(java.lang.String... properties)

Install the saveUserAction on givne properties.

Parameters:

properties - properties on which insalls the saveUserAction

getMethods

protected java.util.Map<java.lang.String,java.lang.reflect.Method> getMethods()

Get all set method on this object or super object.

Returns:

map with method name without set and in lower case as key, and method as value

getParams

protected java.lang.String[] getParams(java.lang.reflect.Method m,
                                       java.util.ListIterator<java.lang.String> args)

Take required argument for method in args. Argument used is removed from args. If method has varArgs, we take all argument to next '--'

Parameters:

m - the method to call

args - iterator with many argument (equals or more than necessary

Returns:

the arguments found for the given method

createAction

protected ApplicationConfig.Action createAction(java.lang.String name,
                                                java.util.ListIterator<java.lang.String> args)
                                         throws ArgumentsParserException,
                                                java.lang.InstantiationException,
                                                java.lang.IllegalAccessException,
                                                java.lang.IllegalArgumentException,
                                                java.lang.reflect.InvocationTargetException

Create action from string, string must be [package.][class][#][method] if package, class or method missing, default is used

Parameters:

name - name of the action

args - arguments for action invocation

Returns:

the created action

Throws:

ArgumentsParserException - if parsing failed

java.lang.IllegalAccessException - if could not create action

java.lang.IllegalArgumentException - if could not create action

java.lang.InstantiationException - if could not create action

java.lang.reflect.InvocationTargetException - if could not create action

parse

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

Parse option and call set necessary method, read jvm, env variable, Load configuration file and prepare Action.

Parameters:

args - argument as main(String[] args)

Throws:

ArgumentsParserException - if parsing failed

migrateUserConfigurationFile

protected void migrateUserConfigurationFile(java.io.File oldHomeConfig,
                                            java.io.File homeConfig)
                                     throws java.io.IOException

Move old user configuration file oldHomeConfig to homeConfig.

Parameters:

oldHomeConfig - old configuration file path

homeConfig - new configuration file path

Throws:

java.io.IOException - if could not move configuration file

printConfig

public void printConfig()

For debugging.

printConfig

public void printConfig(java.io.PrintStream output)

Print out current configuration in specified output.

Parameters:

output - output to write config to

Since:

1.1.4

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

hasListeners

public boolean hasListeners(java.lang.String propertyName)

getPropertyChangeListeners

public java.beans.PropertyChangeListener[] getPropertyChangeListeners(java.lang.String propertyName)

getPropertyChangeListeners

public java.beans.PropertyChangeListener[] getPropertyChangeListeners()