#131 : `IHKPluginUserRightId.kt`

plugins/org.projectforge.plugins.ihk/src/main/kotlin/org/projectforge/plugins/ihk/IHKPluginUserRightId.kt Énumération Kotlin / identifiant de droit utilisateur, plugins/org.projectforge.plugins.ihk/src/main/kotlin/org/projectforge/plugins/ihk/IHKPluginUserRightId.kt 60 lignes · 24 code · 30 commentaires · 6 vides

Énumération Kotlin implémentant IUserRightId pour définir le droit d'accès unique du plugin IHK. Fournit une classe interne ProviderService pour l'indexation Hibernate Search et le fournisseur de droits via SPI.

Architecture

Définition de l'énumération

@Indexed
@TypeBinding(binder = TypeBinderRef(type = HibernateSearchUserRightIdTypeBinder::class))
enum class IHKPluginUserRightId(
    override val id: String,
    override val orderString: String,
    override val i18nKey: String
) : IUserRightId {
    IHK("PLUGIN_IHK", "plugin70", "plugins.ihk");
}

Paramètre	Valeur	Signification
`id`	`"PLUGIN_IHK"`	Identifiant unique parmi tous les plugins ; stocké en base de données pour les affectations de droits utilisateur
`orderString`	`"plugin70"`	Clé de tri pour le tableau des droits de la page UserEditPage ; le motif pluginnn garantit que les plugins sont triés après les droits intégrés
`i18nKey`	`"plugins.ihk"`	Clé pour le nom affiché du droit dans l'interface utilisateur ; résolue via `IHKI18nResources.properties`

Intégration Hibernate Search

Les annotations @Indexed et @TypeBinding lient cette énumération à HibernateSearchUserRightIdTypeBinder, permettant la recherche en texte intégral sur les affectations de droits utilisateur. Lorsqu'une requête Hibernate Search parcourt les entités PFUserDO pour les droits, ce binder sait comment indexer les identifiants de droits basés sur une énumération.

ProviderService (SPI)

La classe interne ProviderService implémente RightRightIdProviderService, une interface SPI Java. Sa méthode getUserRightIds() renvoie les entrées de l'énumération via Arrays.asList(*entries.toTypedArray()). Elle est chargée par le ServiceLoader et contribue au registre global de tous les droits utilisateur connus dans le système.

class ProviderService : RightRightIdProviderService {
    override fun getUserRightIds(): Collection<IUserRightId> {
        return Arrays.asList<IUserRightId>(*entries.toTypedArray())
    }
}

Décisions de conception

Énumération Kotlin plutôt que Java : Écrite en Kotlin malgré le reste du plugin IHK en Java. Cela s'aligne avec la stratégie de migration de ProjectForge consistant à écrire les nouveaux types d'énumération/identifiant en Kotlin pour une syntaxe concise avec les propriétés du constructeur override val.
Enregistrement SPI via META-INF/services : La classe interne ProviderService est enregistrée dans META-INF/services/org.projectforge.framework.persistence.api.RightRightIdProviderService (non montré mais implicite par le motif), rendant les droits des plugins automatiquement découvrables sans code d'enregistrement explicite.
Valeur unique de l'énumération : Le plugin IHK est suffisamment simple pour n'avoir besoin que d'un seul droit (PLUGIN_IHK), contrairement à ToDo qui a PLUGIN_TODO. Le motif d'énumération s'adapte proprement si des sous-droits futurs sont nécessaires (par exemple, PLUGIN_IHK_ADMIN).
Chaîne d'ordre "plugin70" : La convention de nommage pluginNN (où NN est un nombre incrémenté) garantit un ordre déterministe dans le tableau d'administration des droits. IHK utilise 70, le plaçant après les plugins antérieurs comme ToDo (plugin10).

Historique Git

868d6abb7 2025 -> 2026
63081666f En-têtes des fichiers source : 2024 -> 2025.
067a4cbb1 Migration en cours...
b1560ca43 Migration en cours...