Package fish.payara.cdi.auth.roles

Annotation Type RolesPermitted

  • @InterceptorBinding
@Target({TYPE,METHOD})
@Retention(RUNTIME)
public @interface RolesPermitted
    Defines a list of roles which a caller must be in to access either methods within an annotated class, or a singular annotated method. Roles defined on a method level will always overrule those defined on a class level.
    Author:
    Michael Ranaldo

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      LogicalOperator semantics
      Whether accessing caller must be in any one of the given roles (OR) or all given roles (AND).
      @NotNull String[] value
      The roles which are allowed to access this method.

    • Element Detail

      • value

        @NotNull
@NotNull String[] value
        The roles which are allowed to access this method. Defaults to an empty string.
        Returns:
        A String array of permitted roles.
        Default:
        {""}

      • semantics

        LogicalOperator semantics
        Whether accessing caller must be in any one of the given roles (OR) or all given roles (AND).
        Returns:
        the operator used to determine access
        See Also:
        LogicalOperator
        Default:
        fish.payara.cdi.auth.roles.LogicalOperator.OR