Uploaded image for project: 'Shiro'
  1. Shiro
  2. SHIRO-216

Add @Documented to Shiro authorization annotations

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 1.1.0
    • 2.0.0, 1.8.0
    • Documentation
    • None

    Description

      Since security concerns are an important part of good API documentation, it would be nice if the Shiro authorization annotations like @RequiresUser and @RequiresPermissions were included in standard Javadoc output.

      For example, if a method in my application has this signature:

      @RequiresAuthentication
      public Account getAccount()

      { ... }

      It would be nice if the javadoc generated for my method included the fact that the @RequiresAuthentication annotation is present.

      I believe this can be done by simply adding @java.lang.annotation.Documented to each of the Shiro annotation types. See:

      http://download.oracle.com/javase/6/docs/api/java/lang/annotation/Documented.html

      As a point of reference, Spring annotations like @Transactional and @PreAuthorize do have the @java.lang.annotation.Documented annotation.

      Attachments

        Issue Links

          Activity

            People

              bmarwell Benjamin Marwell
              mbrictson Matt Brictson
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: