[M2] composant plexus et configuration

Version imprimable

23/04/2007, 13h10
dvicente72

[M2] composant plexus et configuration

Salut à tous,

j'essaye de créer un composant Plexus pour Maven 2 permettant de gérer ma factory Hibernate afin de l'utiliser dans un ou plusieurs plugins.

Comment faire pour configurer ce composant plexus à partir du pom.xml sans avoir à "setter" les valeurs à partir de mon Mojo ?

merci d'avance pour votre aide

Tu n'as pas besoin d'un composant Plexus pour celà. Un simple bean sera suffisant avec des getter/setter. Ensuite dans ton mojo, tu ajoutes ton bean comme champ de ton mojo et tu pourra le configurer dans ton pom.

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
public class HibernateFactory
{
    private String field1;
 
    public String getField1()
    {
        return field1;
    }
    public void setField1( String field)
    {
        field1 = field;
    }
}

Code:

1
2
3
4
5
6
7
8
9
 
public MyMojo
    extends AbstractMojo
{
    /**
     * @parameter
     */
    private HibdernateFactory factory;
}

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
<projet>
  <build>
    <plugins>
        <plugin>
           <groupId>yourMojoGroupId</groupId>
           <artifactId>yourMojoArtifactId</artifactId>
           <configuration>
               <factory>
                  <field1>yourValue</field1>
               </factory>
           </configuration>
    </plugins>
  </build>
</project>

23/04/2007, 14h26
dvicente72

ok merci emmanuel.
23/04/2007, 14h44
evenisse

Peux-tu compléter ton thread sur la mailing list utilisateur de maven? ainsi, tout le monde pourra en profiter.
23/04/2007, 15h09
dvicente72

je veux bien mais je ne sais pas ce que c'est "la mailing list utilisateur de maven" ?
23/04/2007, 15h17
evenisse

oops, ce n'était pas la liste utilisateur, mais la liste de dev car je vois que tu as fait un post sur dev@maven.apache.org à propos de ce sujet.

Sinon, pour info, la liste utilisateurs de maven est users@maven.apache.org
23/04/2007, 16h16
dvicente72

est-ce qu'utiliser un simple bean pour gerer ma factory Hibernate me permet de ne la charger qu'un seule fois , dans le cas d'un projet multi-module ?

ou à chaque appel du mojo pour chaque module, un nouvel objet factory va être créer ?
23/04/2007, 16h24
evenisse

je ne me souviens plus exactement, mais je crois qu'un nouvel objet va être créé à chaque appel car les exécutions des plugins sont indépendante les unes des autres
23/04/2007, 16h31
dvicente72

c'est bien pour ça que je voulais faire un composant plexus afin qu'il soit configuré et initalisé par le container qu'un seule fois lors de l'execution afin de réduire le cout de création de la session.
23/04/2007, 19h46
evenisse

Je ne suis pas sure qu'une instance de composant est unique entre deux plugin.
Que doit faire exactement ta factory? comment l'utilises-tu dans tes plugins?
24/04/2007, 08h13
dvicente72

non c'est pas entre 2 plugins mais pour le même plugin lors de l'exécution du goal sur un projet multi-modules.

C'est pour mon plugin Dashboard, je suis en train de faire la persistence dans une base pour faire des graphes d'historiques des divers indicateurs Qualité.

Or dans Hibernate, c'est la création de la session qui a un coût assez important.

Donc je veux crèer un composant plexus donc la configuration est passée à runtime de telle manière qu'une fois le plugin chargé et configuré , j'ai une session Hibernate opérationnelle.

De telle manière à ce que, quand maven execute le goal "persistdb" sur un projet multi-module, la session ne soit créée qu'une seule fois et non à chaque exécution du goal sur chaque module.

j'espére avoir été clair.
24/04/2007, 11h05
evenisse

OK, c'est clair maintenant :)

Tu va créer un bean comme specifié ci-dessus et tu vas lui ajouter les tags javadoc de plexus afin de générer le descripteur. Pour générer le descripteur, tu dois utiliser le plugin maven pour plexus

http://plexus.codehaus.org/guides/de...tions/cdc.html
24/04/2007, 11h36
dvicente72

ok d'accord mais après ?

comment, à partir du pom.xml de mon projet qui va utiliser mon plugin dashboard qui lui-même va utiliser le composant plexus, je fais pour positionner la configuration à runtime ?
24/04/2007, 12h06
evenisse

Comme dans l'exemple du pom ci-dessus, ou alors je rate quelque chose
24/04/2007, 15h37
dvicente72

malheureusement, ça ne fonctionne pas.

Effectivement, en faisant comme tu as dit, avec HibernateFactory en tant que parameter de mon mojo, j'ai bien une propagation des propriétés mais cela ne sert à rien de le définir comme un composant plexus car à l'exécution, j'ai bien une instance différente d'hibernateFactory à chaque exécution du goal sur chaque module.

à l'inverse, quand je définis HibernateFactory en tant que component de mon mojo, j'ai bien qu'un instance créé pour l'ensemble du build mais par contre, il n'y a aucune propagation des propriétés du pom.xml vers le composant plexus HibernateFactory.

si tu as d'autres idées, je suis preneur, en attendant, merci pour ton aide très précieuse.
24/04/2007, 16h06
evenisse

Bon, dernière idée.

Tu peux essayer d'utiliser ton HibernateFactory en tant que component de ton mojo et un bean pour définir les valeurs de ta factory. Dans ton mojo, tu configure ton HibernateFactory avec les valeurs du bean.
24/04/2007, 16h38
dvicente72

c'est ce que je viens de faire.

Effectivement, j'ai bien un hibernateFactory unique créé comme composant plexus et ensuite dans mon mojo, je sette les propriétés dans la factory, ce qui me permet de créer une session stockée par la factory et de pouvoir réutiliser la même à chaque utilisation du goal sur chaque module.

Un enorme merci pour ton aide Emmanuel.
25/04/2007, 11h37
Palmer

Bonjour,

J'ai suivi votre discussion par curiosité, mais je dois avouer que je n'ai pas compris grand chose.. Quelqu'un pourrait il m'éclairer sur la notion de composant plexus ? Qu'est est ce exactement ? un Plugin ?

Merci
25/04/2007, 11h49
evenisse

Plexus est un framework IOC comme le sont Spring, Avalon...
Il est utilisé au coeur de Maven.

Un composant Plexus est une classe avec une stratégie d'initialization (singleton, par lookup...), d'initialization automatique des champs de la classes et un cycle de vie.

Bien que le site de Plexus ne soit pas encore très fourni, tu peux le regarder.
Personnellement, je trouve que l'utilisation de Plexus est beaucoup plus simple que celle de Spring, mais ce n'est pas le sujet ;)
25/04/2007, 12h06
dvicente72
Plexus est un container de composants (creation et gestion des objets ) utilisant le pattern d'inversion de contrôle ou injection de dépendances, à l'image de ce que fait Spring.

Plexus est à la base du développement de Maven.

L'idée est de pouvoir définir un composant développé en Java via un descripteur (pour plexus c'est components.xml ) et de laisser le container s'occuper de créer, configurer et gérer le cycle de vie du composant.

En l'occurence, dans le cas qui me concerne, je définis un composant plexus et ensuite je déclare dans mon plugin que j'utilise ce composant comme suit :
Code:

1 2 3 4 5 6 7 /** * Hibernate Service * @component * */ protected HibernateService hibernateService;
le fait que HibernateService soit un composant Plexus et déclaré comme telle dans mon plugin, je n'ai pas à m'occuper de son instantiation, c'est Maven qui s'en occupe.

ça m'assure que ce composant est unique lors d'une exécution d'un goal.

Dans mon cas, c'est pour mutualiser la creation de la session Hibernate qui est assez longue à initialiser et sur un projet multi-modules comme le mien ( on doit être proche de 168 modules en cascade ), ça me permet d'initialiser une session sur le premier module (ça prend 2s ) et j'utilise la même pour les autres, au lieu d'instantier à chaque fois une classe HibernateService, créer une session => 168x2s = 5 min 36 rien que pour obtenir une session Hibernate.

J'espere avoir été clair et ne pas avoir raconté de conneries.

Emmanuel, si tu peux apporter ton avis ?
25/04/2007, 12h12
evenisse
Très bonne explication :)

L'utilisation de Plexus permet de simplifier le code.
La déclaration faite dans l'exemple de david évite d'écrire des tas de ligne de code pouvant être source d'erreur
Code:

1 2 3 4 5 6 7 HibernateSessionFactory factory = new HibernateSessionFactory(); factory.setXXX(...); factory.setYYY(...); ... factury.initialize(...); ...
Avec Pexus, il n'y a pas besoin de toute ces lignes, tout est géré
25/04/2007, 13h07
Palmer

Je comprends mieux... grand merci pour vos explications :)
04/05/2007, 09h40
dvicente72
j'essaye d'utiliser le composant plexus ResourceManager
comme suit dans mon composant plexus :
Code:

1 2 3 4 5 6 /** * @plexus.requirement * */ private ResourceManager locator;
or ça ne fonctionne pas car quand je debugge dans mon composant plexus et que je passe dans la methode initialize, j'ai bien un DefaultResourceManager mais quand je regarde chaque loader contenu dans le ResourceManager, les paths ou directories ou jar sont null, comme si il n'avait pu initialiser les paths de recherche.

et donc evidemment , quand je recherche mon fichier, j'ai une exception.

Par contre, quand je déclare le composant plexus ResourceManager directement dans mon plugin Maven, là ça fonctionne.

une idée ?

merci d'avance
04/05/2007, 12h11
evenisse

Quelle est la version de Plexus utilisée lorsque tu débugge et celle de ton maven?
04/05/2007, 12h55
dvicente72

c'est la même version la 1.0-alpha-4
04/05/2007, 14h09
evenisse

alpha-4, c'est une veille version de maven que tu as ;)
04/05/2007, 14h13
dvicente72

oui :ouin: je suis tj en maven 2.0.4
04/05/2007, 14h18
evenisse

dans la 2.0.4, la version de plexus est la 1.0-alpha-9 (comme dans la dernière version de maven). regarde dans $M2_HOME/core
04/05/2007, 14h21
dvicente72

oui mais moi je parle uniquement du org.codehaus.plexus:plexus-resources
04/05/2007, 14h26
evenisse

Effectivement, si on ne parle pas de la même chose, çà ne va pas aider :)

Je suis sûr à 90% que le pb vient de la version de plexus et non de celle de plexus-resources
04/05/2007, 14h38
dvicente72

je suis en train de faire un test avec maven 2.0.6 et un repository vide.

et je te tiens au courant
04/05/2007, 14h44
evenisse

Changer la version de maven ne devrait pas ton pb en mode debug, il faut que tu regardes la version de plexus utilisée dans le classpath lors de l'exécution de tes tests
04/05/2007, 15h07
dvicente72

effectivement ça n'a pas changé grand chose, par contre avec mvn -X, j'ai ceci :

org.codehaus.plexus:plexus-container-default:jar:1.0-alpha-8

si c'est bien ce que tu me demandes
04/05/2007, 15h11
evenisse

qu'est ce que tu as dans ton components.xml?

et voilà !!

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
<component-set>
  <components>
    <component>
      <role>org.codehaus.mojo.dashboard.report.plugin.hibernate.HibernateService</role>
      <implementation>org.codehaus.mojo.dashboard.report.plugin.hibernate.HibernateServiceImpl</implementation>
      <lifecycle-handler>plexus-configurable</lifecycle-handler>
      <description>Service Hibernate</description>
      <configuration>
        <mapping>hibernate.cfg.xml</mapping>
      </configuration>
    </component>
    <component>
      <role>org.codehaus.mojo.dashboard.report.plugin.configuration.ConfigurationService</role>
      <implementation>org.codehaus.mojo.dashboard.report.plugin.configuration.ConfigurationServiceImpl</implementation>
      <lifecycle-handler>plexus-configurable</lifecycle-handler>
      <description>Service Dashboard Configuration</description>
      <requirements>
        <requirement>
          <role>org.codehaus.plexus.resource.ResourceManager</role>
          <field-name>locator</field-name>
        </requirement>
      </requirements>
      <configuration>
        <configfile>config/maven-dashboard-config.xml</configfile>
      </configuration>
    </component>
  </components>
</component-set>

ok, il faut que tu ajoutes classloaders que tu veux utiliser car il faut les configurer, comme ceci:

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
    <component>
      <role>org.codehaus.plexus.resource.loader.ResourceLoader</role>
      <role-hint>file</role-hint>
      <implementation>org.codehaus.plexus.resource.loader.FileResourceLoader</implementation>
      <configuration>
        <paths>
          <path implementation="java.lang.String">/path/to/resources/directory</path>
        </paths>
      </configuration>
    </component>
    <component>
      <role>org.codehaus.plexus.resource.loader.ResourceLoader</role>
      <role-hint>jar</role-hint>
      <implementation>org.codehaus.plexus.resource.loader.JarResourceLoader</implementation>
      <configuration>
        <paths>
          <path implementation="java.lang.String">/path/to/myfile.jar</path>
        </paths>
      </configuration>
    </component>
 
[...]

moi je veux bien mais je pensais que c'était le container qui s'occupait de renseigner les paths de recherche nécessaires à chaque loader

donc il faut que je fasse comme ça ?

Code:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
 
<component-set>
  <components>
    <component>
      <role>org.codehaus.mojo.dashboard.report.plugin.hibernate.HibernateService</role>
      <implementation>org.codehaus.mojo.dashboard.report.plugin.hibernate.HibernateServiceImpl</implementation>
      <lifecycle-handler>plexus-configurable</lifecycle-handler>
      <description>Service Hibernate</description>
      <configuration>
        <mapping>hibernate.cfg.xml</mapping>
      </configuration>
    </component>
    <component>
      <role>org.codehaus.mojo.dashboard.report.plugin.configuration.ConfigurationService</role>
      <implementation>org.codehaus.mojo.dashboard.report.plugin.configuration.ConfigurationServiceImpl</implementation>
      <lifecycle-handler>plexus-configurable</lifecycle-handler>
      <description>Service Dashboard Configuration</description>
      <requirements>
        <requirement>
          <role>org.codehaus.plexus.resource.ResourceManager</role>
          <field-name>locator</field-name>
        </requirement>
      </requirements>
      <configuration>
        <configfile>config/maven-dashboard-config.xml</configfile>
      </configuration>
    </component>
    <component>
      <role>org.codehaus.plexus.resource.loader.ResourceLoader</role>
      <role-hint>file</role-hint>
      <implementation>org.codehaus.plexus.resource.loader.FileResourceLoader</implementation>
      <configuration>
        <paths>
          <path implementation="java.lang.String">/path/to/resources/directory</path>
        </paths>
      </configuration>
    </component>
    <component>
      <role>org.codehaus.plexus.resource.loader.ResourceLoader</role>
      <role-hint>jar</role-hint>
      <implementation>org.codehaus.plexus.resource.loader.JarResourceLoader</implementation>
      <configuration>
        <paths>
          <path implementation="java.lang.String">/path/to/myfile.jar</path>
        </paths>
      </configuration>
    </component>
  </components>
</component-set>

et comment je fais pour selectionner le path pour mon jar par rapport au repository ?

04/05/2007, 15h59
evenisse

Le container ne peux pas connaitre les paths que tu veux utiliser, comment pourrait-it savoir que tu veux utiliser "D:\directory1\directory2\" ou "/home/username/something"?

Si les paths sont dépendant du runtime ou de l'utilisateur, je ne pense pas que plexus-resources est ce qu'il te faut :?

Tu peux peut-être modifier plexus-resources afin de pouvoir ajouter au runtime de nouveaux paths et ton mojo l'utiliserait pour lui fournir la liste des jars à charger.
04/05/2007, 16h40
dvicente72

Autant pour moi.

effectivement, c'est de ma faute et ce pour plusieurs raisons.

En fait, je viens de me rendre compte que le ResourceManager utilise essentiellemnt par défaut le ThreadContextClasspathResourceLoader et les autres loaders ont leurs paths de recherche vide.

Quand j'utilise le ResourceManager dans mon plugin, en fait ma classe plugin se trouve dans la liste des classes du ThreadContextClasspathResourceLoader et donc il trouve bien mon fichier de config xml dans mon propre jar.

Par contre quand j'utilise ResourceManager dans mon composant plexus, quand le plugin est initialisé par Maven, il initialise mon composant plexus et donc aussi le ResourceManager mais à ce moment-là, la liste des classes du ThreadContextClasspathResourceLoader sont uniquement celles contenues dans le classworlds.

et effectivement en regardant de plus près comment Checkstyle utilisait le ResourceManager (qui lui l'utilise directement dans son plugin), il ajoute des paths de recherche notamment pour les fichiers ( FileResourceLoader ).

il va donc falloir que je revois ma conception ou que je trouve un moyen d'initaliser correctement mon composant plexus concernant les paths.

Par contre, je trouve quand même que l'association et la configuration des composants plexus entre eux sont assez compliquées ou alors ça manque de docs

En tout cas, merci pour ton aide, ça m'a bien fait avancer.
04/05/2007, 16h46
evenisse

Citation:

Envoyé par david.vicente@tiscali.fr

Par contre, je trouve quand même que l'association et la configuration des composants plexus entre eux sont assez compliquées ou alors ça manque de docs

çà manque surtout de docs, mais ce n'est pas compliqué, beaucoup moins que Spring (c'est mon avis perso :lol: )

Citation:

Envoyé par david.vicente@tiscali.fr

En tout cas, merci pour ton aide, ça m'a bien fait avancer.

Pas de problème.