#131: `IHKPluginUserRightId.kt`

plugins/org.projectforge.plugins.ihk/src/main/kotlin/org/projectforge/plugins/ihk/IHKPluginUserRightId.kt Enum Kotlin / identificador de derecho de usuario, plugins/org.projectforge.plugins.ihk/src/main/kotlin/org/projectforge/plugins/ihk/IHKPluginUserRightId.kt 60 líneas · 24 código · 30 comentarios · 6 en blanco

Enum Kotlin que implementa IUserRightId para definir el único derecho de acceso del plugin IHK. Proporciona una clase interna ProviderService para la indexación de Hibernate Search y el SPI del proveedor de derechos.

Arquitectura

Definición del Enum

@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");
}

Parámetro	Valor	Significado
`id`	`"PLUGIN_IHK"`	Identificador único entre todos los plugins; almacenado en la base de datos para asignaciones de derechos de usuario
`orderString`	`"plugin70"`	Clave de ordenación para la tabla de derechos de UserEditPage; el patrón pluginnn asegura que los plugins se ordenen después de los derechos incorporados
`i18nKey`	`"plugins.ihk"`	Clave para el nombre mostrado del derecho en la interfaz de usuario; resuelta mediante `IHKI18nResources.properties`

Integración con Hibernate Search

Las anotaciones @Indexed y @TypeBinding vinculan este enum a HibernateSearchUserRightIdTypeBinder, permitiendo la búsqueda de texto completo en las asignaciones de derechos de usuario. Cuando una consulta de Hibernate Search escanea entidades PFUserDO en busca de derechos, este enlazador de tipos sabe cómo indexar IDs de derechos basados en enum.

ProviderService (SPI)

La clase interna ProviderService implementa RightRightIdProviderService, una interfaz SPI de Java. Su método getUserRightIds() devuelve las entradas del enum mediante Arrays.asList(*entries.toTypedArray()). Esto es cargado por el ServiceLoader y contribuye con el derecho IHK al registro global de todos los derechos de usuario conocidos en el sistema.

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

Decisiones de diseño

Enum Kotlin sobre enum Java: Escrito en Kotlin a pesar de que el resto del plugin IHK está en Java. Esto se alinea con la estrategia de migración de ProjectForge de escribir nuevos tipos enum/id en Kotlin para una sintaxis concisa con propiedades de constructor override val.
Registro SPI mediante META-INF/services: La clase interna ProviderService se registra en META-INF/services/org.projectforge.framework.persistence.api.RightRightIdProviderService (no se muestra pero se deduce del patrón), haciendo que los derechos del plugin sean automáticamente detectables sin código de registro explícito.
Valor único del enum: El plugin IHK es lo suficientemente simple como para necesitar solo un derecho (PLUGIN_IHK), a diferencia de ToDo que tiene PLUGIN_TODO. El patrón enum escala limpiamente si se necesitan sub-derechos futuros (por ejemplo, PLUGIN_IHK_ADMIN).
Cadena de orden "plugin70": La convención de nomenclatura pluginNN (donde NN es un número incremental) asegura un orden determinista en la tabla de administración de derechos. IHK usa 70, colocándolo después de plugins anteriores como ToDo (plugin10).

Historial de Git

868d6abb7 2025 -> 2026
63081666f Encabezados de archivos fuente: 2024-> 2025.
067a4cbb1 Migración en progreso...
b1560ca43 Migración en progreso...