Module de.codecamp.vaadin.security.spring
Package de.codecamp.vaadin.security.spring.access

Annotation Type SecuredAccess

@Target({TYPE,METHOD,ANNOTATION_TYPE}) @Retention(RUNTIME) @Documented public @interface SecuredAccess
This annotation is used to secure routes and endpoints. It can also be used as meta-annotation to create reusable access rule annotations.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    SecuredAccess.NotSetAccessEvaluator
    The default class used when no evaluator has been set.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    checkLayout
    Returns whether the parent layout chain should also be checked for access.
    Class<? extends AccessEvaluator>
    evaluator
    A programmatic evaluator to control access.
    String
    value
    A Spring Security expression to control access.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXPRESSION_NOT_SET
    The default string used when no expression has been set.

  • Field Details

    • EXPRESSION_NOT_SET

      static final String EXPRESSION_NOT_SET
      The default string used when no expression has been set.
      See Also:

  • Element Details

    • value

      String value
      A Spring Security expression to control access.

      If both an expression and an evaluator are set, both must be satisfied to grant access.

      Returns:
      a Spring Security expression
      See Also:
      Default:
      "___NOT_SET___"

    • evaluator

      Class<? extends AccessEvaluator> evaluator
      A programmatic evaluator to control access.

      If both an expression and an evaluator are set, both must be satisfied to grant access.

      Returns:
      a AccessEvaluator
      Default:
      de.codecamp.vaadin.security.spring.access.SecuredAccess.NotSetAccessEvaluator.class

    • checkLayout

      boolean checkLayout
      Returns whether the parent layout chain should also be checked for access. Naturally, this is only applicable for routes and not endpoints.
      Returns:
      whether the parent layout chain should also be checked for access (where applicable)
      Default:
      true