This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository nuiton-config. See https://gitlab.nuiton.org/nuiton/nuiton-config.git commit 9e511bd7646e75e2152dfca3bbf453fe6fd3256d Author: Tony CHEMIT <chemit@codelutin.com> Date: Fri Sep 30 15:23:27 2016 +0200 Add example module --- nuiton-config-example/LICENSE.txt | 165 +++++++++++++++++++++ nuiton-config-example/README.md | 0 nuiton-config-example/pom.xml | 95 ++++++++++++ .../src/license/THIRD-PARTY.properties | 17 +++ .../org/nuiton/config/example/MyApplication.java | 45 ++++++ .../config/example/MyApplicationConfigOption.java | 157 ++++++++++++++++++++ .../example/MyApplicationConfigProvider.java | 56 +++++++ .../org.nuiton.config.ApplicationConfigProvider | 1 + nuiton-config-example/src/site/apt/index.apt | 45 ++++++ nuiton-config-example/src/site/site_fr.xml | 47 ++++++ pom.xml | 10 +- 11 files changed, 630 insertions(+), 8 deletions(-) diff --git a/nuiton-config-example/LICENSE.txt b/nuiton-config-example/LICENSE.txt new file mode 100644 index 0000000..cca7fc2 --- /dev/null +++ b/nuiton-config-example/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/nuiton-config-example/README.md b/nuiton-config-example/README.md new file mode 100644 index 0000000..e69de29 diff --git a/nuiton-config-example/pom.xml b/nuiton-config-example/pom.xml new file mode 100644 index 0000000..b26c4b3 --- /dev/null +++ b/nuiton-config-example/pom.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.nuiton</groupId> + <artifactId>nuiton-config-project</artifactId> + <version>3.0-SNAPSHOT</version> + </parent> + + <artifactId>nuiton-config-example</artifactId> + + <name>Nuiton Config :: Example</name> + <description>Nuiton Config Example</description> + <inceptionYear>2016</inceptionYear> + + <properties> + + <javaVersion>1.8</javaVersion> + <signatureArtifactId>java18</signatureArtifactId> + <signatureVersion>1.0</signatureVersion> + + <!-- Post Release configuration --> + <skipPostRelease>false</skipPostRelease> + + </properties> + + <dependencies> + + <dependency> + <groupId>${project.groupId}</groupId> + <artifactId>nuiton-config</artifactId> + <version>${project.version}</version> + </dependency> + + </dependencies> + + <build> + + <plugins> + + <plugin> + <groupId>${project.groupId}</groupId> + <artifactId>nuiton-config-maven-plugin</artifactId> + <version>${project.version}</version> + <executions> + <execution> + <phase>generate-sources</phase> + <id>generate-config</id> + <configuration> + <modelName>MyApplication</modelName> + </configuration> + <goals> + <goal>generate</goal> + </goals> + </execution> + </executions> + </plugin> + + </plugins> + + </build> + + <profiles> + + <profile> + <id>reporting</id> + <activation> + <property> + <name>performRelease</name> + <value>true</value> + </property> + </activation> + + <reporting> + <plugins> + <plugin> + <groupId>${project.groupId}</groupId> + <artifactId>nuiton-config-maven-plugin</artifactId> + <version>${project.version}</version> + <reportSets> + <reportSet> + <reports> + <report>report</report> + </reports> + </reportSet> + </reportSets> + </plugin> + </plugins> + </reporting> + + </profile> + + </profiles> +</project> diff --git a/nuiton-config-example/src/license/THIRD-PARTY.properties b/nuiton-config-example/src/license/THIRD-PARTY.properties new file mode 100644 index 0000000..357b66f --- /dev/null +++ b/nuiton-config-example/src/license/THIRD-PARTY.properties @@ -0,0 +1,17 @@ +# Generated by org.codehaus.mojo.license.AddThirdPartyMojo +#------------------------------------------------------------------------------- +# Already used licenses in project : +# - BSD License +# - COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0 +# - Indiana University Extreme! Lab Software License, vesion 1.1.1 +# - Lesser General Public License (LGPL) v 3.0 +# - Lesser General Public License (LPGL) +# - Lesser General Public License (LPGL) v 2.1 +# - MIT License +# - The Apache Software License, Version 2.0 +#------------------------------------------------------------------------------- +# Please fill the missing licenses for dependencies : +# +# +#Fri Sep 30 13:56:47 CEST 2016 +commons-primitives--commons-primitives--1.0=The Apache Software License, Version 2.0 diff --git a/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplication.java b/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplication.java new file mode 100644 index 0000000..ca3bcfc --- /dev/null +++ b/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplication.java @@ -0,0 +1,45 @@ +package org.nuiton.config.example; + +/*- + * #%L + * Nuiton Config :: Example + * %% + * Copyright (C) 2016 Code Lutin, Tony Chemit + * %% + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ + +import org.nuiton.config.ArgumentsParserException; + +/** + * Created on 30/09/16. + * + * @author Tony Chemit - chemit@codelutin.com + */ +public class MyApplication { + + public static void main(String... args) throws ArgumentsParserException { + + MyApplicationConfig config = new MyApplicationConfig(); + config.get().parse(args); + + System.out.println("Configuration file name : " + config.getConfigFile()); + System.out.println("Application data directory : " + config.getDataDirectory()); + System.out.println("Application db directory : " + config.getDbDirectory()); + + } + +} diff --git a/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplicationConfigOption.java b/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplicationConfigOption.java new file mode 100644 index 0000000..f69f9b2 --- /dev/null +++ b/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplicationConfigOption.java @@ -0,0 +1,157 @@ +package org.nuiton.config.example; + +/*- + * #%L + * Nuiton Config :: Example + * %% + * Copyright (C) 2016 Code Lutin, Tony Chemit + * %% + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ + +import org.nuiton.config.ApplicationConfig; +import org.nuiton.config.ConfigOptionDef; + +import java.io.File; + +public enum MyApplicationConfigOption implements ConfigOptionDef { + + /** + * le nom du fichier de configuration (sans le prefix .) + */ + CONFIG_FILE( + String.class, + ApplicationConfig.CONFIG_FILE_NAME, + "Nom du fichier de configuration", + "application", + true, + true + ), + + /** + * le repertoire ou est stoquee la base locale + */ + DATA_DIRECTORY( + File.class, + "data.directory", + "Répertoire de données", + "${user.home}/.application", + true, + true + ), + + /** + * le repertoire ou est stoquee la base locale + */ + DB_DIRECTORY( + File.class, + "db.directory", + "Répertoire de la base de données", + "${data.directory}/db", + true, + true + ); + + /** + * Clef qui represente l'option (c'est celle enregistrée dans le fichier de configuration). + */ + protected final String key; + + /** + * Clef i18n de description de l'option + */ + protected final String description; + + /** + * Type de l'option + */ + protected final Class<?> type; + + /** + * Valeur par défaut de l'option + */ + protected String defaultValue; + + /** + * Drapeau pour savoir si on ne doit pas sauvegarder cette option + */ + protected boolean _transient; + + /** + * Drapeau pour savoir si l'option est modifiable + */ + protected boolean _final; + + MyApplicationConfigOption(Class<?> type, + String key, + String description, + String defaultValue, + boolean _transient, + boolean _final) { + this.key = key; + this.description = description; + this.defaultValue = defaultValue; + this.type = type; + this._final = _final; + this._transient = _transient; + } + + @Override + public boolean isFinal() { + return _final; + } + + @Override + public boolean isTransient() { + return _transient; + } + + @Override + public String getDefaultValue() { + return defaultValue; + } + + @Override + public String getDescription() { + return description; + } + + @Override + public String getKey() { + return key; + } + + @Override + public Class<?> getType() { + return type; + } + + @Override + public void setDefaultValue(String defaultValue) { + this.defaultValue = defaultValue; + } + + @Override + public void setTransient(boolean _transient) { + this._transient = _transient; + } + + @Override + public void setFinal(boolean _final) { + this._final = _final; + } + +} diff --git a/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplicationConfigProvider.java b/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplicationConfigProvider.java new file mode 100644 index 0000000..dc08a02 --- /dev/null +++ b/nuiton-config-example/src/main/java/org/nuiton/config/example/MyApplicationConfigProvider.java @@ -0,0 +1,56 @@ +package org.nuiton.config.example; + +/*- + * #%L + * Nuiton Config :: Example + * %% + * Copyright (C) 2016 Code Lutin, Tony Chemit + * %% + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Lesser Public License for more details. + * + * You should have received a copy of the GNU General Lesser Public + * License along with this program. If not, see + * <http://www.gnu.org/licenses/lgpl-3.0.html>. + * #L% + */ + +import org.nuiton.config.ApplicationConfigProvider; +import org.nuiton.config.ConfigActionDef; + +import java.util.Locale; + +/** + * Created on 30/09/16. + * + * @author Tony Chemit - chemit@codelutin.com + */ +public class MyApplicationConfigProvider implements ApplicationConfigProvider { + + @Override + public String getName() { + return "application"; + } + + @Override + public String getDescription(Locale locale) { + return "Configuration"; + } + + @Override + public MyApplicationConfigOption[] getOptions() { + return MyApplicationConfigOption.values(); + } + + @Override + public ConfigActionDef[] getActions() { + return new ConfigActionDef[0]; + } +} diff --git a/nuiton-config-example/src/main/resources/META-INF/services/org.nuiton.config.ApplicationConfigProvider b/nuiton-config-example/src/main/resources/META-INF/services/org.nuiton.config.ApplicationConfigProvider new file mode 100644 index 0000000..499f119 --- /dev/null +++ b/nuiton-config-example/src/main/resources/META-INF/services/org.nuiton.config.ApplicationConfigProvider @@ -0,0 +1 @@ +org.nuiton.config.example.MyApplicationConfigProvider \ No newline at end of file diff --git a/nuiton-config-example/src/site/apt/index.apt b/nuiton-config-example/src/site/apt/index.apt new file mode 100644 index 0000000..d29c8c0 --- /dev/null +++ b/nuiton-config-example/src/site/apt/index.apt @@ -0,0 +1,45 @@ +~~~ +~~ #%L +~~ Nuiton Config :: Example +~~ %% +~~ Copyright (C) 2016 Code Lutin, Tony Chemit +~~ %% +~~ This program is free software: you can redistribute it and/or modify +~~ it under the terms of the GNU Lesser General Public License as +~~ published by the Free Software Foundation, either version 3 of the +~~ License, or (at your option) any later version. +~~ +~~ This program is distributed in the hope that it will be useful, +~~ but WITHOUT ANY WARRANTY; without even the implied warranty of +~~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +~~ GNU General Lesser Public License for more details. +~~ +~~ You should have received a copy of the GNU General Lesser Public +~~ License along with this program. If not, see +~~ <http://www.gnu.org/licenses/lgpl-3.0.html>. +~~ #L% +~~~ + ---- + Nuiton Config Exemple + ---- + ---- + 2016-09-30 + ---- + +Utilisation + + 3 étapes pour utiliser <<nuiton-config>> : + +* Décrire les options de la configuration + + Écrire la classe qui définit les options de configuration. + +* Générer la classe de configuration + + Utiliser le mojo <<generate>> pour générer la classe de configuration java <org.nuiton.config.application.MyApplicationConfig> + +* Générer la documentation de la configuration + + Utiliser le mojo de report <<report>> ou <<aggregate-report>> pour générer la documentations des configurations détectées. + +TODO Pointer sur les fichiers sources et générés. diff --git a/nuiton-config-example/src/site/site_fr.xml b/nuiton-config-example/src/site/site_fr.xml new file mode 100644 index 0000000..30815f3 --- /dev/null +++ b/nuiton-config-example/src/site/site_fr.xml @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + #%L + Nuiton Config :: Example + %% + Copyright (C) 2016 Code Lutin, Tony Chemit + %% + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Lesser Public License for more details. + + You should have received a copy of the GNU General Lesser Public + License along with this program. If not, see + <http://www.gnu.org/licenses/lgpl-3.0.html>. + #L% + --> + + +<project name="${project.name}" xmlns="http://maven.apache.org/DECORATION/1.4.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.4.0 http://maven.apache.org/xsd/decoration-1.4.0.xsd"> + + <bannerLeft> + <name>${project.name}</name> + <href>index.html</href> + </bannerLeft> + + <body> + + <breadcrumbs> + <item name="${project.name}" href="./index.html"/> + </breadcrumbs> + + <menu ref="parent"/> + <menu name="Utilisateur"> + <item name="Accueil" href="index.html"/> + </menu> + <menu ref="reports"/> + + </body> +</project> diff --git a/pom.xml b/pom.xml index 396878f..5aba643 100644 --- a/pom.xml +++ b/pom.xml @@ -15,7 +15,7 @@ <name>Nuiton Config</name> <description>Simple Application config</description> <url>http://nuiton-config.nuiton.org</url> - <inceptionYear>2013</inceptionYear> + <inceptionYear>2016</inceptionYear> <developers> @@ -48,6 +48,7 @@ <modules> <module>nuiton-config</module> <module>nuiton-config-maven-plugin</module> + <module>nuiton-config-example</module> </modules> <scm> @@ -291,13 +292,6 @@ <version>${doxiaVersion}</version> </dependency> - <dependency> - <groupId>xml-apis</groupId> - <artifactId>xml-apis</artifactId> - <version>2.0.2</version> - <scope>provided</scope> - </dependency> - </dependencies> </dependencyManagement> -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.