Groupe 1A (socle)
Date de création :	30/11/2003
Dernière modification :	01/10/2003
Diffusion :	internet

Créé son service de groupes uPortal

Qu'est qu'un "service de groupe"

Un service permet de connecter uPortal sur n'importe qu'elle sources de données afin d'extraire une liste de groupes et de membres.

 <service>
   <name>local</name>
   <service_factory>org.jasig.portal.groups.ReferenceIndividualGroupServiceFactory</service_factory>
   <entity_store_factory>org.jasig.portal.groups.ReferenceEntityStoreFactory</entity_store_factory>
   <group_store_factory>org.jasig.portal.groups.ReferenceEntityGroupStoreFactory</group_store_factory>
   <entity_searcher_factory>org.jasig.portal.groups.ReferenceEntitySearcherFactory</entity_searcher_factory>
   <internally_managed>true</internally_managed>
   <caching_enabled>true</caching_enabled>
 </service>

name : Nom du service (il doit être unique dans le fichier de configuration compositeGroupServices.xml)

service_factory : indique le nom de la classe de factory qui crée l'exécution de service.

entity_store_factory : est le nom de la classe de factory pour le stockage d'entité (person).

group_store_factory : est le nom de la classe de factory pour le stockage des groupes.
entity_searcher_factory : est le nom de classe de factory pour la recherche d'entité,
- classe qui renvoie des EntityIdentifiers pour les membres potentiels de groupe.
- Il est probable que chaque service de groupe ait sa propre exécution de recherche d'entité (bien que quelques réalisations peuvent être ineffectives).
- La recherche d'entité renvoie :
  - pour "local" : des objets EntityIdentifiers pour ChannelDefinitions et IPersons de la base de données de référence
- La recherche d'entité est nécessaire pour les clients du groupe service de comme le Groups Manager.
- Les utilisateurs doivent pouvoir trouver les membres de groupe qu'ils recherchent avec une recherche par des attributs comme le nom, plutôt que par la lecture de tous les membres.
internally_managed : contient une valeur booléenne, vraie ou fausse.
caching_enabled : a une valeur booléenne, vraie ou fausse.

Cet service va se caractériser par 6 éléments (classes java):

EntityStoreFactory : factory pour stocker les entités
GroupStoreFactory : factory pour stocker les groupes
EntitySearcherFactory : factory pour faire des recherches
EntityStore : classe qui gère le stockage des entités (personne, canaux, etc...)
GroupStore : classe qui gère le stockage des groupes
EntitySearcher : classe qui gère la recherche des objets

Interface java pour un "service de groupe"

Pour un exemple plus parlant je vais créer un service factice qui regroupe les classes suiavntes :

TESTEntityStoreFactory
TESTGroupStoreFactory
TESTEntitySearcherFactory
TESTEntityStore
TESTGroupStore
TESTEntitySearcher

Chaque classe doit implémenter une interface :

Classe	Interface
TESTEntityStoreFactory	IEntityStoreFactory
TESTGroupStoreFactory	IEntityGroupStoreFactory
TESTEntitySearcherFactory	IEntitySearcherFactory
TESTEntityStore	IEntityStore
TESTGroupStore	IEntityGroupStore
TESTEntitySearcher	IEntitySearcher

Méthode	Explications
IEntityStoreFactory
IEntityStore newEntityStore()	Renvoie une instance de l'implémentation stockage des indentités. Cette méthode va faire appel à la classe implémentant l'interface IEntityStore (cf TESTEntityStore).
IEntityGroupStoreFactory
IEntityGroupStore newGroupStore()	Renvoie une instance de l'implémentation stockage des groupes. Cette méthode va faire appel à la classe implémentant l'interface IEntityGroupStore (cf TESTGroupStore).
IEntitySearcherFactory
IEntitySearcher newEntitySearcher()	Renvoie une instance de l'implémentation de la recherche d'identité. Cette méthode va faire appel à la classe implémentant l'interface IEntitySearcher (cf TESTEntitySearcher).
IEntityStore
Iterator findEntitiesForGroup(IEntityGroup group)	Recoit un objet groupe et renvoie un Iterator des identités (IEntities) membre du groupe passé en paramêtre.
IEntity newInstance(String key)	Renvoit un objet permetteant d'identifier l'indentité de manière unique dans uPortal. Encore assez obscur fait appel a un objet EntityImpl
IEntity newInstance(String key, Class type)
IEntityGroupStore
delete(IEntityGroup group)	Supprime le groupe (dans votre backend) passez en paramêtre
IEntityGroup find(String key)	Renvoie une instance de l'objet groupe identifié par la clé key
Iterator findContainingGroups(IGroupMember gm)	Renvoie les groupes dont gm (groupe membre) est membre. Il renvoie l'Iterator de la Collection des groupes.
Iterator findEntitiesForGroup(IEntityGroup group)	Renvoie les membres du groupe (group) Il renvoie l'Iterator de la Collection des membres.
ILockableEntityGroup findLockable(String key)	Renvoie un groupe qui pourra être vérouillé en vue d'une mise à jour.
String[] findMemberGroupKeys(IEntityGroup group)	Renvoie un tableau contenant les clés des groupes étant membre du groupe passé en paramêtre
Iterator findMemberGroups(IEntityGroup group)	Renvoie les groupes étant membre du groupe passé en paramêtre Il renvoie l'Iterator de la Collection des groupes.
IEntityGroup newInstance(Class entityType)	Renvoit un objet permetteant d'identifier le groupe de manière unique dans uPortal. Encore assez obscur fait appel a un objet EntityGroupImpl
EntityIdentifier[] searchForGroups(String query, int method, Class leaftype)	Trouve les objets EntityIdentifiers pour les groupes dont le nom répond à la requête (Le symbole * peut être utilisé).
update(IEntityGroup group)	Ajout ou met à jour un groupe et ces membres dans le backend
updateMembers(IEntityGroup group)	Valide les membres d'un groupe (utilisation de transaction)
IEntitySearcher
EntityIdentifier[] searchForEntities(String query, int method, Class type)	Trouve les objets EntityIdentifiers pour les identités dont le nom répond à la requête (Le symbole * peut être utilisé).

Création : 30/11/2003 - Julien Marchal (UN2)
Modifications :

Créé son service de groupes uPortal

Qu'est qu'un "service de groupe"

Interface java pour un "service de groupe"

Classe

Interface

Méthode

Explications

IEntityStoreFactory

IEntityGroupStoreFactory

IEntitySearcherFactory

IEntityStore

IEntityGroupStore

IEntitySearcher