Package com.jbstrap.ui.authorization

Annotation Interface Private

@Documented @Retention(RUNTIME) @Target({TYPE,FIELD}) public @interface Private

Sets Private visibility on a page, UI, or component

Pages that are set to private only appear if the user is logged in, and they have a role assigned, that has access the Page,Component or UI. The component can appear, if the user's current role isn't listed in the annotation as a denied role, and role is added to the allowed roles through code.

If no denied or allowed role is specified, the default visibility will be enabled, meaning that the page, UI, or component will be visible to any logged in user.

Since:
4.0
Author:
JBStrap

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    allowed
    The roles that can access the page, UI or component.
    String[]
    denied
    The roles that can't access the page, UI or component.

  • Element Details

    • allowed

      String[] allowed

      The roles that can access the page, UI or component.

      If there's a role, that's also in the list of denied roles, the denial will be considered stronger, meaning that the role won't be able to access the UI, page or component.

      Multiple roles can be specified, and a wildcard character can be used. The wildcard character is "*", which means that in the place of the *, any number of characters can be.

      Returns:
      An array of roles that have access to the page, ui or component
      Default:
      {}

    • denied

      String[] denied

      The roles that can't access the page, UI or component.

      The denial is considered stronger, so if a role is listed as both allowed and denied, it won't be visible for the role.

      Multiple roles can be specified, and a wildcard character can be used. The wildcard character is "*", which means that in the place of the *, any number of characters can be.

      Returns:
      An array of roles that don't have access to the page, ui or component
      Default:
      {}