com.jahnelgroup.jackson.security.SecureField.kt Maven / Gradle / Ivy

Go to download
package com.jahnelgroup.jackson.security

import com.jahnelgroup.jackson.security.policy.RoleBasedFieldSecurityPolicy
import com.jahnelgroup.jackson.security.policy.CreatedByFieldSecurityPolicy
import com.jahnelgroup.jackson.security.policy.FieldSecurityPolicy
import com.jahnelgroup.jackson.security.policy.EvalulationLogic
import kotlin.reflect.KClass

/**
 * Declares a field to be protected from being serialized by Jackson. Access
 * controls are based on [FieldSecurityPolicy] policies which can be combined
 * together with [EvalulationLogic].
 *
 * @author Steven Zgaljic
 * @since 1.0.0
 */
@Target(AnnotationTarget.FIELD)
@Retention(AnnotationRetention.RUNTIME)
@Repeatable
annotation class SecureField(

    /**
     * The list of [FieldSecurityPolicy] policies that must be met
     * in order to permit access to a field. The default policy is
     * the [CreatedByFieldSecurityPolicy] policy.
     */
    val policies: Array> = arrayOf(CreatedByFieldSecurityPolicy::class),

    /**
     * The logic by which the policies are all evaluated together.
     *
     * The default logic is AND.
     */
    val policyLogic: EvalulationLogic = EvalulationLogic.AND,

    /**
     * The list of user roles that must be met in order to permit
     * access to a field. Providing roles will automatically add the
     * [RoleBasedFieldSecurityPolicy] policy to the policies list.
     */
    val roles : Array = emptyArray(),

    /**
     * The logic by which the roles are all evaluated together.
     *
     * The default logic is AND.
     */
    val roleLogic: EvalulationLogic = EvalulationLogic.AND
)