[#ISSUE 1005] - Expand checkstyle to all modules (root).

apache · Sep 10, 2023 · 4fb0d75 · 4fb0d75
1 parent 2dee4ff
commit 4fb0d75
Show file tree

Hide file tree

Showing 780 changed files with 15,584 additions and 13,441 deletions.
diff --git a/.asf.yaml b/.asf.yaml
@@ -25,12 +25,12 @@ github:
     issues: true
     projects: true
   enabled_merge_buttons:
-    squash:  false
-    merge:   true
-    rebase:  false
+    squash: false
+    merge: true
+    rebase: false
 
 notifications:
   pullrequests: [email protected]
   commits: [email protected]
-  issues:  [email protected]
+  issues: [email protected]
   jira_options: link label worklog
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -25,37 +25,37 @@ updates:
     open-pull-requests-limit: 50
     ignore:
       - dependency-name: "jakarta.platform:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.activation:jakarta.activation-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.annotation:jakarta.annotation-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.enterprise:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.xml.bind:jakarta.xml.bind-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.servlet.*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.ws.rs:jakarta.ws.rs-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.validation:jakarta.validation-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.web:jakarta.servlet.jsp.jstl"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "jakarta.servlet.jsp.jstl:jakarta.servlet.jsp.jstl-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.jaxb:jaxb-runtime"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.omnifaces:omnifaces"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.springframework*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "com.flowlogix:flowlogix-jee"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.eclipse.jetty:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
   # Dependencies for Maven - on 1.12.x
   - package-ecosystem: 'maven'
@@ -66,34 +66,34 @@ updates:
     open-pull-requests-limit: 50
     ignore:
       - dependency-name: "jakarta.servlet.*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "javax.servlet:javax.servlet-api"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.web:jakarta.servlet.jsp.jstl"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.glassfish.jersey.*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.jasig.cas.client:*"
-        update-types: ["version-update:semver-minor"]
+        update-types: [ "version-update:semver-minor" ]
       - dependency-name: "org.slf4j:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.codehaus.groovy:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "ch.qos.logback:logback-classic"
-        update-types: ["version-update:semver-minor"]
+        update-types: [ "version-update:semver-minor" ]
       - dependency-name: "com.hazelcast:hazelcast"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "org.aspectj:*"
-        update-types: ["version-update:semver-patch"]
+        update-types: [ "version-update:semver-patch" ]
 
       - dependency-name: "org.springframework*:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
 
       - dependency-name: "org.eclipse.jetty:*"
-        update-types: ["version-update:semver-major"]
+        update-types: [ "version-update:semver-major" ]
       - dependency-name: "com.github.mjeanroy:junit-servers-jetty"
-        update-types: ["version-update:semver-minor"]
+        update-types: [ "version-update:semver-minor" ]
 
   # Dependencies for GitHub Actions
   - package-ecosystem: 'github-actions'

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -5,29 +5,36 @@ For more details on how to report a vulnerablity see: https://www.apache.org/sec
 
 Following this checklist to help us incorporate your contribution quickly and easily:
 
- - [ ] Make sure there is a [GitHub issue](https://github.com/apache/shiro/issues) filed 
-       for the change (usually before you start working on it).  Trivial changes like typos do not 
-       require a GitHub issue.  Your pull request should address just this issue, without pulling in other changes.
- - [ ] Each commit in the pull request should have a meaningful subject line and body.
- - [ ] Format the pull request title like `[#XXX] - Fixes bug in SessionManager`,
-       where you replace `#XXX` with the appropriate GitHub issue. Best practice
-       is to use the GitHub issue title in the pull request title and in the first line of the commit message.
- - [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- - [ ] add `fixes #XXX` if merging the PR should close a related issue.
- - [ ] Run `mvn verify` to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
- - [ ] If you have a group of commits related to the same change, please squash your commits into one and force push your branch using `git rebase -i`. 
- - [ ] Committers: Make sure a milestone is set on the PR
-
-Trivial changes like typos do not require a GitHub issue (javadoc, comments...). 
+- [ ] Make sure there is a [GitHub issue](https://github.com/apache/shiro/issues) filed
+  for the change (usually before you start working on it). Trivial changes like typos do not
+  require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
+- [ ] Each commit in the pull request should have a meaningful subject line and body.
+- [ ] Format the pull request title like `[#XXX] - Fixes bug in SessionManager`,
+  where you replace `#XXX` with the appropriate GitHub issue. Best practice
+  is to use the GitHub issue title in the pull request title and in the first line of the commit message.
+- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
+- [ ] add `fixes #XXX` if merging the PR should close a related issue.
+- [ ] Run `mvn verify` to make sure basic checks pass. A more thorough check will be performed on your pull request
+  automatically.
+- [ ] If you have a group of commits related to the same change, please squash your commits into one and force push your
+  branch using `git rebase -i`.
+- [ ] Committers: Make sure a milestone is set on the PR
+
+Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
 In this case, just format the pull request title like `[DOC] - Add javadoc in SessionManager`.
-
-If this is your first contribution, you have to read the [Contribution Guidelines](https://github.com/apache/shiro/blob/master/CONTRIBUTING.md)
 
-If your pull request is about ~20 lines of code you don't need to sign an [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) 
+If this is your first contribution, you have to read
+the [Contribution Guidelines](https://github.com/apache/shiro/blob/master/CONTRIBUTING.md)
+
+If your pull request is about ~20 lines of code you don't need to sign
+an [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf)
 if you are unsure please ask on the developers list.
 
-To make clear that you license your contribution under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
+To make clear that you license your contribution under
+the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
 you have to acknowledge this by using the following check-box.
 
- - [ ] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- - [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
+- [ ] I hereby declare this contribution to be licenced under
+  the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
+- [ ] In any other case, please file
+  an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -59,45 +59,45 @@ jobs:
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+      - name: Checkout repository
+        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
 
-    - name: Cache local Maven repository
-      uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 #v3.3.2
-      with:
-        path: ~/.m2
-        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
-        restore-keys: ${{ runner.os }}-m2
+      - name: Cache local Maven repository
+        uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 #v3.3.2
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+          # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
-      with:
-        category: "/language:${{matrix.language}}"
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # v2.13.4
+        with:
+          category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -21,7 +21,7 @@ permissions:
   contents: read
 
 on:
-  workflow_dispatch: {}
+  workflow_dispatch: { }
   push:
     branches: [ main, '1.11.x', '1.10.x', '1.9.x' ]
   pull_request:

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -24,7 +24,7 @@ permissions:
   pull-requests: write
 
 on:
-  workflow_dispatch: {}
+  workflow_dispatch: { }
   schedule:
     # every day 5min after midnight, UTC.
     - cron: "5 0 * * *"