JBoss Seam est vraiment un framework très riche mais certaines de ses fonctionalités sont mal documentées.
C’est le cas des filtres Hibernate. La documentation de Seam sur le sujet est plutôt lapidaire et inutilisable en l’état.
Je ne vais pas revenir en détail sur les filtre Hibernate qui sont très bien documentés dans la documentation d’Hibernate, rappelons juste qu’il s’agit d’une solution ingénieuse permettant d’enrichir la clause « where » d’une requête hibernate au runtime.
Pour créer un filtre Hibernate dans le contexte d’un projet Seam, on aura recours aux annotations Hibernate correspondantes.
Prenons comme exemple un stock de véhicule d’occasion pour lequel on a développé toute une série de formulaires de recherche, de pages de navigation et un composant Seam exploitant une collection de requêtes pour peupler les listes de mots clés des formulaires de recherche et orchestrer la navigation dans le stock de véhicules.
Les véhicules comportent un champ « stockVoLib » qui détermine l’origine du véhicule (reprise, véhicule de direction ou véhicule de démonstration). Ce champ était ignoré jusque là et tout à coup notre client souhaite créer une navigation identique à celle existante mais restreinte à un type d’origine (je veux pouvoir naviguer uniquement dans les véhicules de direction).
Pour répondre à cette demande. On peut soit modifier l’existant en enrichissant toutes les pages et toutes les requêtes avec le critère « stockVoLib » soit mettre en œuvre un filtre qui nous fera économiser beaucoup de travail et évitera de fragiliser les processus existant en nous épargnant un refactoring lourd.
Suivant ma règle d’or préférée : « quand on peut déplacer du développement en paramétrage et qu’on ne créé pas une usine à gaz, il ne faut pas hésiter », j’opte pour le filtre et ça tombe bien pour la suite de l’aticle 
.
1.Création d’un filtre Hibernate en annotations
On commence par définir le filtre soit dans l’entité concernée, soit au niveau package. Comme un filtre peut s’appliquer a plusieurs entités je préfère le définir au niveau package. J’ajoute donc un fichier « package-info.java » dans le package de mes entités pour y définir mon filtre.
@FilterDef(name = "stockLib", defaultCondition = "stockLibele = :aStockLib", parameters = @ParamDef(name = "aStockLib", type = "string")) package org.fpp.domain; import org.hibernate.annotations.FilterDef; import org.hibernate.annotations.ParamDef;
Mon filtre s’appelle stockLib, il comporte une condition par défaut qui sera utilisée si aucune condition n’est définie à l’application du filtre sur l’entité et il comporte un paramètre de type chaîne appelé « aStockLib ».
A toutes fins utiles, je rappelle que la condition définie dans un filtre correspond à un « where » SQL et non HQL.
J’applique ensuite le filtre sur une ou plusieurs entités de mon application (un filtre peut aussi être appliqué à une collection). En l’occurrence je n’ai qu’une seule entité concernée « usedCar »;
@Entity
@Filter(name = "stockLib")
public class usedCar {
...
2.Utilisation du filtre sous Hibernate
A ce stade, le filtre est utilisable avec Hibernate. On peut l’activer et le paramétrer en récupérant la session Hibernate (si on est en JPA on utilise le getDelegate de l’entityManager).
Session session=(Session) entityManager.getDelegate();
session.enableFilter("stockLib").setParameter("aStockLib", "VD");
...
session.disableFilter("stockLib");
3.Et dans Seam
Mais Seam permet d’aller plus loin en donnant la possibilité de créer un composant filtre (encapsulant le filtre Hibernate) dans lequel on peut injecter dynamiquement les paramètres.
Il suffit d’ajouter ce composant dans le fichiers components.xml de Seam.
<persistence:filter name="stockLibFilter">
<persistence:name>stockLib</persistence:name>
<persistence:parameters>
<key>aStockLib</key>
<value>#{parameterHdl.stockLib}</value>
</persistence:parameters>
</persistence:filter>
A noter que la valeur des paramètres dans ce « meta-filtre » Seam doivent toujours être en expression language même si on souhaite injecter une constante : #{‘VD’}.
Ici, « parameterHdl » est un composant Seam dans lequel le paramètre stockLib est injecté depuis l’URL grâce à l’entrée suivante dans le fichier pages.xml
<param name="stockLib" value="#{parameterHdl.stockLib}" required="false"/>
A présent le filtre Seam peut être utilisé pour créer un EntityManager spécifique sur lequel le filtre est activé.
<persistence:managed-persistence-context name="emStockLib" auto-create="true" persistence-unit-jndi-name="java:/fppEntityManagerFactory" >
<persistence:filters>
<value>#{stockLibFilter}</value>
</persistence:filters>
</persistence:managed-persistence-context>
Ce nouvel entityManager pourra être injecté dans les composants à la place l’entityManager standard (sans filtre) pour bénéficier du filtre. A noter que contrairement à Hibernate, le filtre est actif par défaut sur cet entityManger, il n’y a pas de manipulation à faire pour l’activer.
Mais ce n’est pas tout !
4.Activation dynamique des filtres dans Seam
Et c’est là où la documentation de Seam est vraiment lacunaire : l’activation des filtres peut être gérée dynamiquement.
Ainsi on peut écrire quelque chose du type :
<persistence:filter name="stockLibFilter" enabled="#{!(empty parameterHdl.stockLib)}">
<persistence:name>stockLib</persistence:name>
<persistence:parameters>
<key>aStockLib</key>
<value>#{parameterHdl.stockLib}</value>
</persistence:parameters>
</persistence:filter>
Notez le paramètre enabled qui contient une expression booléenne. Ici on n’active le filtre que si le champ stockLib du composant parameterHdl n’est pas vide, c’est à dire, par extension, si l’url contient un paramètre stockLib avec une valeur.
Dans ce mode d’utilisation on peut appliquer le filtre à l’entityManager principal de l’application (pas besoin d’en créer un spécifique pour le filtre) et le filtre s’activera ou non en fonction de l’évaluation de son paramètre enabled. Paramètre qui sera évalué à chaque appel de l’entityManager (et oui on est sous Seam).
<persistence:managed-persistence-context name="entityManager" auto-create="true" persistence-unit-jndi-name="java:/fppEntityManagerFactory" >
<persistence:filters>
<value>#{stockLibFilter}</value>
</persistence:filters>
</persistence:managed-persistence-context>
On a donc injecté un filtre Hibernate activé conditionnellement dans l’entityManager et celui-ci s’activera ou non en fonction du context de l’application.
Seule précaution à prendre, si le paramètre enabled du filtre utilise un composant Seam comme c’est le cas ici, il faut que ce composant n’utilise pas l’entityManager dans lequel le filtre est injecté , sinon on obtient un plantage pour cause de référence circulaire au démarrage de l’application.
