URL Cleanup

This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).

# Fixed URLs

## Fixed Success
These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* [ ] http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd with 1 occurrences migrated to:
  https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd ([https](https://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd) result 200).

# Ignored
These URLs were intentionally ignored.

* http://www.w3.org/2000/svg with 1 occurrences

.editorconfig

@@ -1,22 +0,0 @@
-# EditorConfig for Spring Security
-# see https://github.com/spring-projects/spring-security/blob/master/CONTRIBUTING.adoc#mind-the-whitespace
-
-root = true
-
-[*]
-end_of_line = lf
-trim_trailing_whitespace = true
-insert_final_newline = true
-max_line_length = 120
-
-[*.{java,xml}]
-indent_style = tab
-indent_size = 4
-charset = utf-8
-continuation_indent_size = 8
-
-ij_smart_tabs = false
-ij_java_align_multiline_parameters = false
-
-[*.gradle]
-indent_style = tab

.gitattributes

@@ -1,18 +0,0 @@
-# Normalize line endings to auto.
-* text auto
-
-# Ensure that line endings for DOS batch files are not modified.
-*.bat -text
-
-# Ensure the following are treated as binary.
-*.cer      binary
-*.graffle  binary
-*.jar      binary
-*.jpeg     binary
-*.jpg      binary
-*.keystore binary
-*.odg      binary
-*.otg      binary
-*.png      binary
-*.hsx      binary
-*.serialized binary

.github/ISSUE_TEMPLATE.md

@@ -1,40 +0,0 @@
-<!--
-For Security Vulnerabilities, please use https://spring.io/security-policy
--->
-
-### Summary
-
-<!-- 
-Please provide a high level summary of the issue you are having
--->
-
-### Actual Behavior
-
-<!-- 
-Please describe step by step the behavior you are observing
--->
-
-### Expected Behavior
-
-<!--
-Please describe step by step the behavior you expect
--->
-
-### Configuration
-
-<!--
-Please provide any configuration you have.
--->
-
-### Version
-
-<!--
-Please describe what version you are using. Does the problem occur in other versions?
--->
-
-### Sample
-
-<!--
-Providing a complete sample (i.e. link to a github repository) will give this issue higher
-priority than issues that do not have a complete sample
--->

.github/ISSUE_TEMPLATE/bug.md

@@ -1,28 +0,0 @@
----
-name: Bug
-about: Create a bug report to help us improve
-title: ''
-labels: 'status: waiting-for-triage, type: bug'
-assignees: ''
-
----
-
-<!--
-Do NOT report Security Vulnerabilities here. Please use https://github.com/spring-projects/spring-security/security/policy
--->
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Sample**
-
-A link to a GitHub repository with a [minimal, reproducible sample](https://stackoverflow.com/help/minimal-reproducible-example).
-
-Reports that include a sample will take priority over reports that do not.
-At times, we may require a sample, so it is good to try and include a sample up front.

.github/ISSUE_TEMPLATE/config.yml

@@ -1,5 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: Community Support
-    url: https://stackoverflow.com/questions/tagged/spring-security
-    about: Please ask and answer questions on StackOverflow with the tag `spring-security`.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -1,25 +0,0 @@
----
-name: Enhancement
-about: Suggest an enhancement for this project
-title: ''
-labels: 'status: waiting-for-triage, type: enhancement'
-assignees: ''
-
----
-
-**Expected Behavior**
-
-<!--- Tell us how it should work -->
-
-**Current Behavior**
-
-<!--- Explain the difference from current behavior -->
-
-**Context**
-
-<!--- 
-How has this issue affected you?
-What are you trying to accomplish?
-What other alternatives have you considered?
-Are you aware of any workarounds?
--->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +0,0 @@
-<!--
-For Security Vulnerabilities, please use https://pivotal.io/security#reporting
--->
-
-<!--
-Before creating new features, we recommend creating an issue to discuss the feature. This ensures that everyone is on the same page before extensive work is done.
-
-Thanks for contributing to Spring Security. Please provide a brief description of your pull-request and reference any related issue numbers (prefix references with gh-).
--->

.github/dependabot.template.yml

@@ -1,41 +0,0 @@
-version: 2
-
-registries:
-  spring-milestones:
-    type: maven-repository
-    url: https://repo.spring.io/milestone
-
-updates:
-
-  - package-ecosystem: "gradle"
-    target-branch: "main"
-    directory: "/"
-    schedule:
-      interval: "daily"
-      time: "03:00"
-      timezone: "Etc/UTC"
-    labels: [ "type: dependency-upgrade" ]
-    registries:
-      - "spring-milestones"
-    ignore:
-      - dependency-name: "com.nimbusds:nimbus-jose-jwt" # nimbus-jose-jwt gets updated when oauth2-oidc-sdk is updated to ensure consistency
-      - dependency-name: "org.python:jython" # jython updates break integration tests
-      - dependency-name: "org.apache.directory.server:*" # ApacheDS version > 1.5.5 contains break changes
-      - dependency-name: "org.junit:junit-bom"
-        update-types: [ "version-update:semver-major" ]
-      - dependency-name: "org.mockito:mockito-bom"
-        update-types: [ "version-update:semver-major" ]
-      - dependency-name: "*"
-        update-types: [ "version-update:semver-major", "version-update:semver-minor" ]
-
-  #    GitHub Actions
-
-  - package-ecosystem: github-actions
-    target-branch: "main"
-    directory: "/"
-    schedule:
-      interval: weekly
-    ignore:
-      - dependency-name: "sjohnr/*"
-      - dependency-name: "spring-io/*"
-      - dependency-name: "spring-security-release-tools/*"

.github/dependabot.yml

@@ -1,137 +0,0 @@
-version: 2
-registries:
-  spring-milestones:
-    type: maven-repository
-    url: https://repo.spring.io/milestone
-updates:
-  - package-ecosystem: gradle
-    target-branch: 5.8.x
-    directory: /
-    schedule:
-      interval: daily
-      time: '03:00'
-      timezone: Etc/UTC
-    labels:
-      - 'type: dependency-upgrade'
-    registries:
-      - spring-milestones
-    ignore:
-      - dependency-name: com.nimbusds:nimbus-jose-jwt
-      - dependency-name: org.python:jython
-      - dependency-name: org.apache.directory.server:*
-      - dependency-name: org.junit:junit-bom
-        update-types:
-          - version-update:semver-major
-      - dependency-name: org.mockito:mockito-bom
-        update-types:
-          - version-update:semver-major
-      - dependency-name: '*'
-        update-types:
-          - version-update:semver-major
-          - version-update:semver-minor
-  - package-ecosystem: gradle
-    target-branch: 6.2.x
-    directory: /
-    schedule:
-      interval: daily
-      time: '03:00'
-      timezone: Etc/UTC
-    labels:
-      - 'type: dependency-upgrade'
-    registries:
-      - spring-milestones
-    ignore:
-      - dependency-name: com.nimbusds:nimbus-jose-jwt
-      - dependency-name: org.python:jython
-      - dependency-name: org.apache.directory.server:*
-      - dependency-name: org.junit:junit-bom
-        update-types:
-          - version-update:semver-major
-      - dependency-name: org.mockito:mockito-bom
-        update-types:
-          - version-update:semver-major
-      - dependency-name: '*'
-        update-types:
-          - version-update:semver-major
-          - version-update:semver-minor
-  - package-ecosystem: gradle
-    target-branch: main
-    directory: /
-    schedule:
-      interval: daily
-      time: '03:00'
-      timezone: Etc/UTC
-    labels:
-      - 'type: dependency-upgrade'
-    registries:
-      - spring-milestones
-    ignore:
-      - dependency-name: com.nimbusds:nimbus-jose-jwt
-      - dependency-name: org.python:jython
-      - dependency-name: org.apache.directory.server:*
-      - dependency-name: org.junit:junit-bom
-        update-types:
-          - version-update:semver-major
-      - dependency-name: org.mockito:mockito-bom
-        update-types:
-          - version-update:semver-major
-      - dependency-name: com.gradle.enterprise
-        update-types:
-          - version-update:semver-major
-          - version-update:semver-minor
-      - dependency-name: '*'
-        update-types:
-          - version-update:semver-major
-          - version-update:semver-minor
-  - package-ecosystem: github-actions
-    target-branch: 5.8.x
-    directory: /
-    schedule:
-      interval: weekly
-    labels:
-      - 'type: task'
-      - 'in: build'
-    ignore:
-      - dependency-name: sjohnr/*
-  - package-ecosystem: github-actions
-    target-branch: main
-    directory: /
-    schedule:
-      interval: weekly
-    labels:
-      - 'type: task'
-      - 'in: build'
-    ignore:
-      - dependency-name: sjohnr/*
-  - package-ecosystem: github-actions
-    target-branch: docs-build
-    directory: /
-    schedule:
-      interval: weekly
-    labels:
-      - 'type: task'
-      - 'in: build'
-    ignore:
-      - dependency-name: sjohnr/*
-
-  - package-ecosystem: npm
-    target-branch: docs-build
-    directory: /
-    schedule:
-      interval: weekly
-
-  - package-ecosystem: npm
-    target-branch: main
-    directory: /docs
-    schedule:
-      interval: weekly
-  - package-ecosystem: npm
-    target-branch: 6.2.x
-    directory: /docs
-    schedule:
-      interval: weekly
-  - package-ecosystem: npm
-    target-branch: 5.8.x
-    directory: /docs
-    schedule:
-      interval: weekly

.github/workflows/clean_build_artifacts.yml

@@ -1,23 +0,0 @@
-name: Clean build artifacts
-on:
-  schedule:
-    - cron: '0 10 * * *' # Once per day at 10am UTC
-
-permissions:
-  contents: read
-
-jobs:
-  main:
-    runs-on: ubuntu-latest
-    if: ${{ github.repository == 'spring-projects/spring-security' }}
-    permissions:
-      contents: none
-    steps:
-      - name: Delete artifacts in cron job
-        env:
-          GH_ACTIONS_REPO_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
-        run: |
-          echo "Running clean build artifacts logic"
-          output=$(curl -X GET -H "Authorization: token $GH_ACTIONS_REPO_TOKEN" https://api.github.com/repos/spring-projects/spring-security/actions/artifacts | grep '"id"' | cut -d : -f2 | sed 's/,*$//g')
-          echo Output is $output
-          for id in $output; do curl -X DELETE -H "Authorization: token $GH_ACTIONS_REPO_TOKEN" https://api.github.com/repos/spring-projects/spring-security/actions/artifacts/$id; done;

.github/workflows/continuous-integration-workflow.yml

@@ -1,132 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches-ignore:
-      - "dependabot/**"
-  schedule:
-    - cron: '0 10 * * *' # Once per day at 10am UTC
-  workflow_dispatch: # Manual trigger
-
-env:
-  DEVELOCITY_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_SECRET_ACCESS_KEY }}
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    name: Build
-    uses: spring-io/spring-security-release-tools/.github/workflows/build.yml@v1
-    strategy:
-      matrix:
-        os: [ ubuntu-latest, windows-latest ]
-        jdk: [ 17 ]
-    with:
-      runs-on: ${{ matrix.os }}
-      java-version: ${{ matrix.jdk }}
-      distribution: temurin
-    secrets: inherit
-  test:
-    name: Test Against Snapshots
-    uses: spring-io/spring-security-release-tools/.github/workflows/test.yml@v1
-    strategy:
-      matrix:
-        include:
-          - java-version: 21-ea
-            toolchain: 21
-          - java-version: 17
-            toolchain: 17
-    with:
-      java-version: ${{ matrix.java-version }}
-      test-args: --refresh-dependencies -PforceMavenRepositories=snapshot -PisOverrideVersionCatalog -PtestToolchain=${{ matrix.toolchain }} -PspringFrameworkVersion=6.1.+ -PreactorVersion=2023.0.+ -PspringDataVersion=2023.1.+ --stacktrace
-    secrets: inherit
-  check-samples:
-    name: Check Samples
-    runs-on: ubuntu-latest
-    if: ${{ github.repository_owner == 'spring-projects' }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up gradle
-        uses: spring-io/spring-gradle-build-action@v2
-        with:
-          java-version: 17
-          distribution: temurin
-      - name: Check samples project
-        env:
-          LOCAL_REPOSITORY_PATH: ${{ github.workspace }}/build/publications/repos
-          SAMPLES_DIR: ../spring-security-samples
-        run: |
-          # Extract version from gradle.properties
-          version=$(cat gradle.properties | grep "version=" | awk -F'=' '{print $2}')
-          # Extract samplesBranch from gradle.properties
-          samples_branch=$(cat gradle.properties | grep "samplesBranch=" | awk -F'=' '{print $2}')
-          ./gradlew publishMavenJavaPublicationToLocalRepository
-          ./gradlew cloneRepository -PrepositoryName="spring-projects/spring-security-samples" -Pref="$samples_branch" -PcloneOutputDirectory="$SAMPLES_DIR"
-          ./gradlew --project-dir "$SAMPLES_DIR" --init-script spring-security-ci.gradle -PlocalRepositoryPath="$LOCAL_REPOSITORY_PATH" -PspringSecurityVersion="$version" :runAllTests
-  check-tangles:
-    name: Check for Package Tangles
-    runs-on: ubuntu-latest
-    if: ${{ github.repository_owner == 'spring-projects' }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up gradle
-        uses: spring-io/spring-gradle-build-action@v2
-        with:
-          java-version: 17
-          distribution: temurin
-      - name: Check for package tangles
-        env:
-          STRUCTURE101_LICENSEID: ${{ secrets.STRUCTURE101_LICENSEID }}
-        run: |
-          ./gradlew check s101 -Ps101.licenseId="$STRUCTURE101_LICENSEID" --stacktrace
-  deploy-artifacts:
-    name: Deploy Artifacts
-    needs: [ build, test, check-samples, check-tangles ]
-    uses: spring-io/spring-security-release-tools/.github/workflows/deploy-artifacts.yml@v1
-    with:
-      should-deploy-artifacts: ${{ needs.build.outputs.should-deploy-artifacts }}
-    secrets: inherit
-  deploy-docs:
-    name: Deploy Docs
-    needs: [ build, test, check-samples, check-tangles ]
-    uses: spring-io/spring-security-release-tools/.github/workflows/deploy-docs.yml@v1
-    with:
-      should-deploy-docs: ${{ needs.build.outputs.should-deploy-artifacts }}
-    secrets: inherit
-  deploy-schema:
-    name: Deploy Schema
-    needs: [ build, test, check-samples, check-tangles ]
-    uses: spring-io/spring-security-release-tools/.github/workflows/deploy-schema.yml@v1
-    with:
-      should-deploy-schema: ${{ needs.build.outputs.should-deploy-artifacts }}
-    secrets: inherit
-  perform-release:
-    name: Perform Release
-    needs: [ deploy-artifacts, deploy-docs, deploy-schema ]
-    uses: spring-io/spring-security-release-tools/.github/workflows/perform-release.yml@v1
-    with:
-      should-perform-release: ${{ needs.deploy-artifacts.outputs.artifacts-deployed }}
-      project-version: ${{ needs.deploy-artifacts.outputs.project-version }}
-      milestone-repo-url: https://repo.spring.io/artifactory/milestone
-      release-repo-url: https://repo1.maven.org/maven2
-      artifact-path: org/springframework/security/spring-security-core
-      slack-announcing-id: spring-security-announcing
-    secrets: inherit
-  notify_result:
-    name: Check for failures
-    needs: [ perform-release ]
-    if: failure()
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-    steps:
-      - name: Send Slack message
-        # Workaround while waiting for Gamesight/slack-workflow-status#38 to be fixed
-        # See https://github.com/Gamesight/slack-workflow-status/issues/38
-        uses: sjohnr/slack-workflow-status@v1-beta
-        with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
-          channel: '#spring-security-ci'
-          name: 'CI Notifier'

.github/workflows/dependabot-auto-merge-forward.yml

@@ -1,57 +0,0 @@
-name: Auto Merge Forward Dependabot Commits
-
-on:
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-concurrency:
-  group: dependabot-auto-merge-forward
-
-jobs:
-  get-supported-branches:
-    uses: spring-io/spring-security-release-tools/.github/workflows/retrieve-spring-supported-versions.yml@actions-v1
-    with:
-      project: spring-security
-      type: oss
-      repository_name: spring-projects/spring-security
-
-  auto-merge-forward-dependabot:
-    name: Auto Merge Forward Dependabot Commits
-    runs-on: ubuntu-latest
-    needs: [get-supported-branches]
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout
-        id: checkout
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
-      - name: Setup GitHub User
-        id: setup-gh-user
-        run: |
-          git config user.name 'github-actions[bot]'
-          git config user.email 'github-actions[bot]@users.noreply.github.com'
-      - name: Run Auto Merge Forward
-        id: run-auto-merge-forward
-        uses: spring-io/spring-security-release-tools/.github/actions/auto-merge-forward@actions-v1
-        with:
-          branches: ${{ needs.get-supported-branches.outputs.supported_versions }},main
-          from-author: dependabot[bot]
-  notify_result:
-    name: Check for failures
-    needs: [ auto-merge-forward-dependabot ]
-    if: failure()
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-    steps:
-      - name: Send Slack message
-        uses: Gamesight/slack-workflow-status@v1.3.0
-        with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
-          channel: '#spring-security-ci'
-          name: 'CI Notifier'

.github/workflows/deploy-docs.yml

@@ -1,33 +0,0 @@
-name: Deploy Docs
-on:
-  push:
-    branches-ignore:
-      - "gh-pages"
-      - "dependabot/**"
-    tags: '**'
-  repository_dispatch:
-    types: request-build-reference # legacy
-  #schedule:
-  #- cron: '0 10 * * *' # Once per day at 10am UTC
-  workflow_dispatch:
-permissions: read-all
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    if: github.repository_owner == 'spring-projects'
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-      with:
-        ref: docs-build
-        fetch-depth: 1
-    - name: Dispatch (partial build)
-      if: github.ref_type == 'branch'
-      env:
-        GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
-      run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD) -f build-refname=${{ github.ref_name }}
-    - name: Dispatch (full build)
-      if: github.ref_type == 'tag'
-      env:
-        GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
-      run: gh workflow run deploy-docs.yml -r $(git rev-parse --abbrev-ref HEAD)

.github/workflows/gradle-wrapper-upgrade-execution.yml

@@ -1,32 +0,0 @@
-name: Execute Gradle Wrapper Upgrade
-
-on:
-  schedule:
-    - cron:  '0 2 * * *' # 2am UTC
-  workflow_dispatch:
-
-jobs:
-  upgrade_wrapper:
-    name: Execution
-    runs-on: ubuntu-latest
-    steps:
-      - name: Set up Git configuration
-        env:
-          TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          git config --global url."https://unused-username:${TOKEN}@github.com/".insteadOf "https://github.com/"
-          git config --global user.name 'github-actions[bot]'
-          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Set up JDK 17
-        uses: actions/setup-java@v4
-        with:
-          java-version: '17'
-          distribution: 'temurin'
-      - name: Set up Gradle
-        uses: gradle/gradle-build-action@v3
-      - name: Upgrade Wrappers
-        run: ./gradlew clean upgradeGradleWrapperAll --continue -Porg.gradle.java.installations.auto-download=false
-        env:
-          WRAPPER_UPGRADE_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/mark-duplicate-dependabot-prs.yml

@@ -1,46 +0,0 @@
-name: Mark Duplicate Dependabot PRs
-
-on:
-  pull_request:
-    types: [closed]
-
-jobs:
-  check_duplicate_prs:
-    runs-on: ubuntu-latest
-    if: github.event.pull_request.merged == true && github.event.pull_request.user.login == 'dependabot[bot]'
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v4
-
-      - name: Extract Dependency Name from PR Title
-        id: extract
-        run: |
-          PR_TITLE="${{ github.event.pull_request.title }}"
-          DEPENDENCY_NAME=$(echo "$PR_TITLE" | awk -F ' from ' '{print $1}')
-          echo "dependency_name=$DEPENDENCY_NAME" >> $GITHUB_OUTPUT
-
-      - name: Find PRs
-        id: find_duplicates
-        env:
-          DEPENDENCY_NAME: ${{ steps.extract.outputs.dependency_name }}
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          PRS=$(gh pr list --search 'milestone:${{ github.event.pull_request.milestone.title }} is:merged in:title "$DEPENDENCY_NAME"' --json number --jq 'map(.number) | join(",")')
-          echo "prs=$PRS" >> $GITHUB_OUTPUT
-
-      - name: Label Duplicate PRs
-        if: steps.find_duplicates.outputs.prs != ''
-        env:
-          PRS: ${{ steps.find_duplicates.outputs.prs }}
-          CURRENT_PR_NUMBER: ${{ github.event.pull_request.number }}
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        shell: bash
-        run: |
-          for i in ${PRS//,/ }
-          do
-            if [ ! $i -eq "$CURRENT_PR_NUMBER" ]; then
-              echo "Marking PR $i as duplicate"
-              gh pr edit "$i" --add-label "status: duplicate"
-              gh pr comment "$i" --body "Duplicate of #$CURRENT_PR_NUMBER"
-            fi
-          done

.github/workflows/merge-dependabot-pr.yml

@@ -1,52 +0,0 @@
-name: Merge Dependabot PR
-
-on: pull_request_target
-
-run-name: Merge Dependabot PR ${{ github.ref_name }}
-
-permissions: write-all
-
-jobs:
-  merge-dependabot-pr:
-    runs-on: ubuntu-latest
-    if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'spring-projects/spring-security' }}
-    steps:
-
-      - uses: actions/checkout@v4
-        with:
-          show-progress: false
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: 17
-
-      - name: Set Milestone to Dependabot Pull Request
-        id: set-milestone
-        run: |
-          if test -f pom.xml
-          then
-            CURRENT_VERSION=$(mvn help:evaluate -Dexpression="project.version" -q -DforceStdout)
-          else
-            CURRENT_VERSION=$(cat gradle.properties | sed -n '/^version=/ { s/^version=//;p }')
-          fi
-          export CANDIDATE_VERSION=${CURRENT_VERSION/-SNAPSHOT}
-          MILESTONE=$(gh api repos/$GITHUB_REPOSITORY/milestones --jq 'map(select(.due_on != null and (.title | startswith(env.CANDIDATE_VERSION)))) | .[0] | .title')
-          
-          if [ -z $MILESTONE ]
-          then
-            gh run cancel ${{ github.run_id }}
-            echo "::warning title=Cannot merge::No scheduled milestone for $CURRENT_VERSION version"
-          else
-            gh pr edit ${{ github.event.pull_request.number }} --milestone $MILESTONE
-            echo mergeEnabled=true >> $GITHUB_OUTPUT
-          fi
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Merge Dependabot pull request
-        if: steps.set-milestone.outputs.mergeEnabled
-        run: gh pr merge ${{ github.event.pull_request.number }} --auto --rebase
-        env:
-          GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}

.github/workflows/milestone-spring-releasetrain.yml

@@ -1,40 +0,0 @@
-name: Check Milestone
-on:
-  milestone:
-    types: [created, opened, edited]
-env:
-  DUE_ON: ${{ github.event.milestone.due_on }}
-  TITLE: ${{ github.event.milestone.title }}
-permissions:
-  contents: read
-jobs:
-  spring-releasetrain-checks:    
-    name: Check DueOn is on a Release Date
-    runs-on: ubuntu-latest
-    if: ${{ github.repository == 'spring-projects/spring-security' }}
-    permissions:
-      contents: none
-    steps:
-    - name: Print Milestone Being Checked
-      run: echo "Validating DueOn '$DUE_ON' for milestone '$TITLE'"
-    - name: Validate DueOn
-      if: env.DUE_ON != ''
-      run: |
-        export TOOL_VERSION=0.1.1
-        wget "https://repo.maven.apache.org/maven2/io/spring/releasetrain/spring-release-train-tools/$TOOL_VERSION/spring-release-train-tools-$TOOL_VERSION.jar"
-        java -cp "spring-release-train-tools-$TOOL_VERSION.jar" io.spring.releasetrain.CheckMilestoneDueOnMain --dueOn "$DUE_ON" --expectedDayOfWeek MONDAY --expectedMondayCount 3
-  notify_result:
-    name: Check for failures
-    needs: [spring-releasetrain-checks]
-    if: failure()
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-    steps:
-      - name: Send Slack message
-        uses: Gamesight/slack-workflow-status@v1.3.0
-        with:
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
-          channel: '#spring-security-ci'
-          name: 'CI Notifier'

.github/workflows/pr-build-workflow.yml

@@ -1,44 +0,0 @@
-name: PR Build
-
-on: pull_request
-
-env:
-  DEVELOCITY_ACCESS_KEY: ${{ secrets.GRADLE_ENTERPRISE_SECRET_ACCESS_KEY }}
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-latest
-    if: ${{ github.repository == 'spring-projects/spring-security' }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up gradle
-        uses: spring-io/spring-gradle-build-action@v2
-        with:
-          java-version: '17'
-          distribution: 'temurin'
-      - name: Build with Gradle
-        run: ./gradlew clean build -PskipCheckExpectedBranchVersion --continue
-  generate-docs:
-    name: Generate Docs
-    runs-on: ubuntu-latest
-    if: ${{ github.repository == 'spring-projects/spring-security' }}
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up gradle
-        uses: spring-io/spring-gradle-build-action@v2
-        with:
-          java-version: '17'
-          distribution: 'temurin'
-      - name: Run Antora
-        run: ./gradlew -PbuildSrc.skipTests=true :spring-security-docs:antora
-      - name: Upload Docs
-        id: upload
-        uses: actions/upload-artifact@v4
-        with:
-          name: docs
-          path: docs/build/site
-          overwrite: true

.github/workflows/release-scheduler.yml

@@ -1,24 +0,0 @@
-name: Release Scheduler
-on:
-  schedule:
-  - cron: '15 15 * * MON' # Every Monday at 3:15pm UTC
-  workflow_dispatch:
-permissions: read-all
-jobs:
-  dispatch_scheduled_releases:
-    name: Dispatch scheduled releases
-    if: github.repository_owner == 'spring-projects'
-    strategy:
-      matrix:
-        # List of active maintenance branches.
-        branch: [ main, 6.2.x, 6.1.x, 5.8.x ]
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 1
-    - name: Dispatch
-      env:
-        GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
-      run: gh workflow run update-scheduled-release-version.yml -r ${{ matrix.branch }}

.github/workflows/trigger-dependabot-auto-merge-forward.yml

@@ -1,22 +0,0 @@
-name: Trigger Dependabot Auto Merge Forward
-
-on:
-  push:
-    branches:
-      - '*.x'
-
-permissions: read-all
-
-jobs:
-  trigger-worflow:
-    name: Trigger Workflow
-    runs-on: ubuntu-latest
-    if: ${{ github.event.commits[0].author.username == 'dependabot[bot]' && github.repository == 'spring-projects/spring-security' }}
-    steps:
-      - name: Checkout
-        id: checkout
-        uses: actions/checkout@v4
-      - id: trigger
-        env:
-          GH_TOKEN: ${{ secrets.GH_ACTIONS_REPO_TOKEN }}
-        run: gh workflow run dependabot-auto-merge-forward.yml -r main

.github/workflows/update-dependabot.yml

@@ -1,36 +0,0 @@
-name: Update dependabot.yml
-
-on:
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-
-  get-supported-branches:
-    uses: spring-io/spring-security-release-tools/.github/workflows/retrieve-spring-supported-versions.yml@actions-v1
-    with:
-      project: spring-security
-      type: oss
-      repository_name: spring-projects/spring-security
-
-  main:
-    runs-on: ubuntu-latest
-    needs: [get-supported-branches]
-    if: ${{ (github.repository == 'spring-projects/spring-security') && (github.ref == 'refs/heads/main') }}
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 1
-      - uses: spring-io/spring-security-release-tools/.github/actions/generate-dependabot-yml@actions-v1
-        name: Update dependabot.yml
-        with:
-          gradle-branches: ${{ needs.get-supported-branches.outputs.supported_versions }},main
-          github-actions-branches: ${{ needs.get-supported-branches.outputs.supported_versions }},main,docs-build
-          gh-token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: Update dependabot.yml

.github/workflows/update-scheduled-release-version.yml

@@ -1,13 +0,0 @@
-name: Update Scheduled Release Version
-
-on:
-  workflow_dispatch: # Manual trigger only. Triggered by release-scheduler.yml on main.
-
-permissions:
-  contents: read
-
-jobs:
-  update-scheduled-release-version:
-    name: Update Scheduled Release Version
-    uses: spring-io/spring-security-release-tools/.github/workflows/update-scheduled-release-version.yml@v1
-    secrets: inherit

.gitignore

@@ -1,32 +1,8 @@
-classes/
-target/
-*/src/*/java/META-INF
-*/src/META-INF/
-*/src/*/java/META-INF/
-.classpath
-.springBeans
+#*
+.#*
+*~
+_site
+.idea
+*.sw[op]
 .project
-.DS_Store
-.settings/
-.idea/*
-out/
-bin/
-intellij/
-build/
-*.log
-*.log.*
-*.iml
-*.ipr
-*.iws
-.gradle/
-atlassian-ide-plugin.xml
-!etc/eclipse/.checkstyle
-.checkstyle
-s101plugin.state
-.attach_pid*
-.~lock.*#
-
-!.idea/checkstyle-idea.xml
-!.idea/externalDependencies.xml
-
-node_modules
+sample-pages

.idea/checkstyle-idea.xml

@@ -1,16 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="CheckStyle-IDEA">
-    <option name="configuration">
-      <map>
-        <entry key="checkstyle-version" value="8.14" />
-        <entry key="copy-libs" value="false" />
-        <entry key="location-0" value="BUNDLED:(bundled):Sun Checks" />
-        <entry key="location-1" value="BUNDLED:(bundled):Google Checks" />
-        <entry key="scan-before-checkin" value="false" />
-        <entry key="scanscope" value="JavaOnlyWithTests" />
-        <entry key="suppress-errors" value="false" />
-      </map>
-    </option>
-  </component>
-</project>

.idea/externalDependencies.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ExternalDependencies">
-    <plugin id="CheckStyle-IDEA" />
-    <plugin id="org.jetbrains.plugins.gradle" />
-  </component>
-</project>

.ruby-gemset

@@ -0,0 +1 @@
+spring-gh-pages

.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.0

.sdkmanrc

@@ -1,6 +0,0 @@
-# Use sdkman to run "sdk env" to initialize with correct JDK version
-# Enable auto-env through the sdkman_auto_env config
-# See https://sdkman.io/usage#config
-# A summary is to add the following to ~/.sdkman/etc/config
-# sdkman_auto_env=true
-java=17.0.3-tem

.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-	"java.import.gradle.enabled": false
-}

CONTRIBUTING.adoc

@@ -1,154 +0,0 @@
-= Contributing to Spring Security
-
-First off, thank you for taking the time to contribute! :+1: :tada:
-
-== Table of Contents
-
-* <<code-of-conduct>>
-* <<how-to-contribute>>
-* <<ask-questions>>
-* <<find-an-issue>>
-* <<create-an-issue>>
-* <<issue-lifecycle>>
-* <<submit-a-pull-request>>
-* <<build-from-source>>
-* <<code-style>>
-
-[[code-of-conduct]]
-== Code of Conduct
-
-This project is governed by the https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md[Spring code of conduct].
-By participating you are expected to uphold this code.
-Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
-
-[[how-to-contribute]]
-== How to Contribute
-
-[[ask-questions]]
-=== Ask Questions
-
-If you have a question, check Stack Overflow using
-https://stackoverflow.com/questions/tagged/spring-security+or+spring-ldap+or+spring-authorization-server+or+spring-session?tab=Newest[this list of tags].
-Find an existing discussion, or start a new one if necessary.
-
-If you believe there is an issue, search through https://github.com/spring-projects/spring-security/issues[existing issues] trying a  few different ways to find discussions, past or current, that are related to the issue.
-Reading those discussions helps you to learn about the issue, and helps us to make a decision.
-
-[[find-an-issue]]
-=== Find an Existing Issue
-
-There are many issues in Spring Security with the labels https://github.com/spring-projects/spring-security/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+ideal-for-contribution%22[`ideal-for-contribution`] or https://github.com/spring-projects/spring-security/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+first-timers-only%22[`first-timers-only`] that are a great way to contribute to a discussion or <<submit-a-pull-request,to a PR>>.
-You can volunteer by commenting on these tickets, and we will assign them to you.
-
-[[create-an-issue]]
-=== Create an Issue
-
-Reporting an issue or making a feature request is a great way to contribute.
-Your feedback and the conversations that result from it provide a continuous flow of ideas.
-However, before creating a ticket, please take the time to <<ask-questions,ask and research>> first.
-
-If you create an issue after a discussion on Stack Overflow, please provide a description in the issue instead of simply referring to Stack Overflow.
-The issue tracker is an important place of record for design discussions and should be self-sufficient.
-
-Once you're ready, create an issue on https://github.com/spring-projects/spring-security/issues[GitHub].
-
-Many issues are caused by subtle behavior, typos, and unintended configuration.
-Creating a https://stackoverflow.com/help/minimal-reproducible-example[Minimal Reproducible Example] (starting with https://start.spring.io for example) of the problem helps the team quickly triage your issue and get to the core of the problem.
-
-We love contributors, and we may ask you to <<submit-a-pull-request,submit a PR with a fix>>.
-
-[[issue-lifecycle]]
-=== Issue Lifecycle
-
-When an issue is first created, it is flagged `waiting-for-triage` waiting for a team member to triage it.
-Once the issue has been reviewed, the team may ask for further information if needed, and based on the findings, the issue is either assigned a target branch (or no branch if a feature) or is closed with a specific status.
-The target branch is https://spring.io/projects/spring-security#support[the earliest supported branch] where <<choose-a-branch,the change will be applied>>.
-
-When a fix is ready, the issue is closed and may still be re-opened until the fix is released.
-After that the issue will typically no longer be reopened.
-In rare cases if the issue was not at all fixed, the issue may be re-opened.
-In most cases however any follow-up reports will need to be created as new issues with a fresh description.
-
-[[build-from-source]]
-=== Build from Source
-
-See https://github.com/spring-projects/spring-security/tree/main#building-from-source[Build from Source] for instructions on how to check out, build, and import the Spring Security source code into your IDE.
-
-[[code-style]]
-=== Source Code Style
-
-The wiki pages https://github.com/spring-projects/spring-framework/wiki/Code-Style[Code Style] and https://github.com/spring-projects/spring-framework/wiki/IntelliJ-IDEA-Editor-Settings[IntelliJ IDEA Editor Settings] define the source file coding standards we use along with some IDEA editor settings we customize.
-
-To format the code as well as check the style, run `./gradlew format check`.
-
-[[submit-a-pull-request]]
-=== Submit a Pull Request
-
-We are excited for your pull request! :heart:
-
-Please do your best to follow these steps.
-Don't worry if you don't get them all correct the first time, we will help you.
-
-[[sign-cla]]
-1. If you have not previously done so, please sign the https://cla.spring.io/sign/spring[Contributor License Agreement].
-You will be reminded automatically when you submit the PR.
-[[create-an-issue]]
-1. Must you https://github.com/spring-projects/spring-security/issues/new/choose[create an issue] first? No, but it is recommended for features and larger bug fixes. It's easier discuss with the team first to determine the right fix or enhancement.
-For typos and straightforward bug fixes, starting with a pull request is encouraged.
-Please include a description for context and motivation.
-Note that the team may close your pull request if it's not a fit for the project.
-[[choose-a-branch]]
-1. Always check out the branch indicated in the milestone and submit pull requests against it (for example, for milestone `5.8.3` use the `5.8.x` branch).
-If there is no milestone, choose `main`.
-Once merged, the fix will be forwarded-ported to applicable branches including `main`.
-[[create-a-local-branch]]
-1. Create a local branch
-If this is for an issue, consider a branch name with the issue number, like `gh-22276`.
-[[write-tests]]
-1. Add documentation and JUnit Tests for your changes.
-[[update-copyright]]
-1. In all files you edited, if the copyright header is of the form 2002-20xx, update the final copyright year to the current year.
-[[add-since]]
-1. If on `main`, add `@since` JavaDoc attributes to new public APIs that your PR adds
-[[change-rnc]]
-1. If you are updating the XSD, please instead update the RNC file and then run `./gradlew :spring-security-config:rncToXsd`.
-[[format-code]]
-1. For each commit, build the code using `./gradlew format check`.
-This command ensures the code meets most of <<code-style,the style guide>>; a notable exception is import order.
-[[commit-atomically]]
-1. Choose the granularity of your commits consciously and squash commits that represent
-multiple edits or corrections of the same logical change.
-See https://git-scm.com/book/en/Git-Tools-Rewriting-History[Rewriting History section of Pro Git] for an overview of streamlining the commit history.
-[[format-commit-messages]]
-1. Format commit messages using 55 characters for the subject line, 72 characters per line
-for the description, followed by the issue fixed, for example, `Closes gh-22276`.
-See the https://git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines[Commit Guidelines section of Pro Git] for best practices around commit messages, and use `git log` to see some examples.
-Present tense is preferred.
-+
-[indent=0]
-----
-Address NullPointerException
-
-Closes gh-22276
-----
-[[reference-issue]]
-1. If there is a prior issue, reference the GitHub issue number in the description of the pull request.
-+
-[indent=0]
-----
-Closes gh-22276
-----
-
-If accepted, your contribution may be heavily modified as needed prior to merging.
-You will likely retain author attribution for your Git commits granted that the bulk of your changes remain intact.
-You may also be asked to rework the submission.
-
-If asked to make corrections, simply push the changes against the same branch, and your pull request will be updated.
-In other words, you do not need to create a new pull request when asked to make changes.
-When it is time to merge, you'll be asked to squash your commits.
-
-==== Participate in Reviews
-
-Helping to review pull requests is another great way to contribute.
-Your feedback can help to shape the implementation of new features.
-When reviewing pull requests, however, please refrain from approving or rejecting a PR unless you are a core committer for Spring Security.

Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "github-pages"
+gem "rouge"

Gemfile.lock

@@ -0,0 +1,129 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.10.0)
+    colorator (0.1)
+    ethon (0.9.0)
+      ffi (>= 1.3.0)
+    execjs (2.7.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.13)
+    gemoji (2.1.0)
+    github-pages (86)
+      github-pages-health-check (= 1.1.0)
+      jekyll (= 3.1.6)
+      jekyll-coffeescript (= 1.0.1)
+      jekyll-feed (= 0.5.1)
+      jekyll-gist (= 1.4.0)
+      jekyll-github-metadata (= 2.0.2)
+      jekyll-mentions (= 1.1.3)
+      jekyll-paginate (= 1.1.0)
+      jekyll-redirect-from (= 0.10.0)
+      jekyll-sass-converter (= 1.3.0)
+      jekyll-seo-tag (= 2.0.0)
+      jekyll-sitemap (= 0.10.0)
+      jemoji (= 0.6.2)
+      kramdown (= 1.11.1)
+      liquid (= 3.0.6)
+      listen (= 3.0.6)
+      mercenary (~> 0.3)
+      rouge (= 1.11.1)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.1.0)
+      addressable (~> 2.3)
+      net-dns (~> 0.8)
+      octokit (~> 4.0)
+      public_suffix (~> 1.4)
+      typhoeus (~> 0.7)
+    html-pipeline (2.4.1)
+      activesupport (>= 2, < 5)
+      nokogiri (>= 1.4)
+    i18n (0.7.0)
+    jekyll (3.1.6)
+      colorator (~> 0.1)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-feed (0.5.1)
+    jekyll-gist (1.4.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.0.2)
+      jekyll (~> 3.1)
+      octokit (~> 4.0)
+    jekyll-mentions (1.1.3)
+      html-pipeline (~> 2.3)
+      jekyll (~> 3.0)
+    jekyll-paginate (1.1.0)
+    jekyll-redirect-from (0.10.0)
+      jekyll (>= 2.0)
+    jekyll-sass-converter (1.3.0)
+      sass (~> 3.2)
+    jekyll-seo-tag (2.0.0)
+      jekyll (~> 3.1)
+    jekyll-sitemap (0.10.0)
+    jekyll-watch (1.4.0)
+      listen (~> 3.0, < 3.1)
+    jemoji (0.6.2)
+      gemoji (~> 2.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0)
+    json (1.8.3)
+    kramdown (1.11.1)
+    liquid (3.0.6)
+    listen (3.0.6)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    mercenary (0.3.6)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    multipart-post (2.0.0)
+    net-dns (0.8.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    pkg-config (1.1.7)
+    public_suffix (1.5.3)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rouge (1.11.1)
+    safe_yaml (1.0.4)
+    sass (3.4.22)
+    sawyer (0.7.0)
+      addressable (>= 2.3.5, < 2.5)
+      faraday (~> 0.8, < 0.10)
+    terminal-table (1.6.0)
+    thread_safe (0.3.5)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages
+  rouge
+
+BUNDLED WITH
+   1.12.5

LICENSE.txt

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        https://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       https://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

README.adoc

@@ -1,78 +0,0 @@
-image::https://badges.gitter.im/Join%20Chat.svg[Gitter,link=https://gitter.im/spring-projects/spring-security?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge]
-
-image:https://github.com/spring-projects/spring-security/actions/workflows/continuous-integration-workflow.yml/badge.svg?branch=main["Build Status", link="https://github.com/spring-projects/spring-security/actions/workflows/continuous-integration-workflow.yml"]
-
-image:https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A["Revved up by Develocity", link="https://ge.spring.io/scans?search.rootProjectNames=spring-security"]
-
-= Spring Security
-
-Spring Security provides security services for the https://docs.spring.io[Spring IO Platform]. Spring Security 6.0 requires Spring 6.0 as
-a minimum and also requires Java 17.
-
-For a detailed list of features and access to the latest release, please visit https://spring.io/projects[Spring projects].
-
-== Code of Conduct
-Please see our https://github.com/spring-projects/.github/blob/main/CODE_OF_CONDUCT.md[code of conduct]
-
-== Downloading Artifacts
-See https://docs.spring.io/spring-security/reference/getting-spring-security.html[Getting Spring Security] for how to obtain Spring Security.
-
-== Documentation
-Be sure to read the https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/[Spring Security Reference].
-Extensive JavaDoc for the Spring Security code is also available in the https://docs.spring.io/spring-security/site/docs/current/api/[Spring Security API Documentation].
-
-== Quick Start
-See https://docs.spring.io/spring-security/reference/servlet/getting-started.html[Hello Spring Security] to get started with a "Hello, World" application.
-
-== Building from Source
-Spring Security uses a https://gradle.org[Gradle]-based build system.
-In the instructions below, https://vimeo.com/34436402[`./gradlew`] is invoked from the root of the source tree and serves as
-a cross-platform, self-contained bootstrap mechanism for the build.
-
-=== Prerequisites
-https://docs.github.com/en/get-started/quickstart/set-up-git[Git] and the https://www.oracle.com/java/technologies/downloads/#java17[JDK17 build].
-
-Be sure that your `JAVA_HOME` environment variable points to the `jdk-17` folder extracted from the JDK download.
-
-=== Check out sources
-[indent=0]
-----
-git clone git@github.com:spring-projects/spring-security.git
-----
-
-=== Install all `spring-*.jar` into your local Maven repository.
-
-[indent=0]
-----
-./gradlew publishToMavenLocal
-----
-
-=== Compile and test; build all JARs, distribution zips, and docs
-
-[indent=0]
-----
-./gradlew build
-----
-
-The reference docs are not currently included in the distribution zip.
-You can build the reference docs for this branch by running the following command:
-
-----
-./gradlew :spring-security-docs:antora
-----
-
-That command publishes the docs site to the `_docs/build/site_` directory.
-The https://github.com/spring-projects/spring-security/tree/docs-build[playbook branch] describes how to build the reference docs in detail.
-
-Discover more commands with `./gradlew tasks`.
-
-== Getting Support
-Check out the https://stackoverflow.com/questions/tagged/spring-security[Spring Security tags on Stack Overflow].
-https://spring.io/support[Commercial support] is available too.
-
-== Contributing
-https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request[Pull requests] are welcome; see the https://github.com/spring-projects/spring-security/blob/main/CONTRIBUTING.adoc[contributor guidelines] for details.
-
-== License
-Spring Security is Open Source software released under the
-https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].

README.markdown

@@ -0,0 +1,147 @@
+# Introduction
+
+Spring's project pages are based on [Jekyll](https://jekyllrb.com) and [GitHub Pages](https://pages.github.com/). This means that each project's website is stored within the project repo, in a special branch called "gh-pages". In order to keep everything looking similar across the many individual Spring projects, common elements of the Jekyll site layout, css, etc are stored in [a shared gh-pages repository](https://github.com/spring-projects/gh-pages). If you're seeing this README in the gh-pages branch of an actual Spring project, that's because this file, along with all the other common files get merged periodically into each project.
+
+This approach may sound a little funky (and it is), but it's way better than the misery of Git submodules. In fact, it's actually pretty easy. If you're just getting started, then follow the directions immediately below. If you're needing a refresher on how to keep things up to date, then head to the section at the bottom on "keeping up to date".
+
+> ***Note:*** Github changed their rendering (a lot) in April 2016. If you are seeing pages build failures since that time, then you probably need to merge some changes from this upstream. Follow the instructions below, and for testing locally use rubiy 2.x and don't forget to `bundle exec ...` everything.
+
+
+
+# How to start a new `gh-pages` project page
+
+From within your Spring project's git checkout directory:
+
+### Create and checkout the gh-pages branch
+
+    git checkout --orphan gh-pages
+
+### Remove all files
+
+    git rm -rf `git ls-files` && rm -rf *
+
+### Add the gh-pages-upstream remote
+
+    git remote add gh-pages-upstream https://github.com/spring-projects/gh-pages.git
+
+### Pull in the common site infrastructure
+
+    git pull gh-pages-upstream gh-pages
+
+
+## Edit `_config.yml`
+
+You'll need to tweak a few settings in `_config.yml`, sitting in the root directory. Edit this file and follow the instructions within. It should be self explanatory; you'll see that there are lots of instances of "spring-framework" as a project name. You should replace these with your own project's information as appropriate.
+
+
+## Create the project home page
+
+### What kind of project are you?
+
+At this point, you just need to give your project a home page. There are pre-fab samples included in the `_sample-pages` directory:
+
+    $ ls -1 _sample-pages
+    documentation.md
+    project_group.html
+    project.html
+    vaniall.md
+
+At this point you need to make a decision: is your project a "grouping project", like Spring Data, acting as a parent for one or more child projects? If so, you should choose `project_group.html` in the following step. Otherwise, if you're dealing with an individual, concrete Spring project, e.g. Spring Data JPA, or Spring Security OAuth, you should choose `project.html`. The `documentation.md` can be used when you want to expose README.md files on your site.
+
+### Copy the sample page to `index.html`
+
+Based on your choice above, copy the correct sample page to `index.html`, e.g.:
+
+    $ cp _sample-pages/project.html index.html
+
+or
+
+    $ cp _sample-pages/project_group.html index.html
+
+
+## Edit the content of your home page
+
+### Edit the YAML front matter
+
+Open up `index.html` in your favorite text editor. Within, you'll find "YAML front matter" at the top of the file, i.e. everything between the triple dashes that look like `---`. This section contains some basic metadata, and—if you've copied the `project.html` sample—also contains a custom section of information for your project "badges". These are icons that will render in the sidebar of your project page.
+
+Edit the URLs and other values in the YAML front matter as appropriate. This should be self-explanatory.
+
+> **Tip**: If a particular "badge" (e.g. Sonar) does not apply to your project, just delete that entry from the YAML.
+
+### Understand the use of "captures" and "includes"
+
+Next, you'll see a series of `{% capture variable_name %}` blocks that look like this:
+
+    {% capture billboard_description %}
+    ...
+    {% endcapture %}
+
+At the end of the file you'll see a `{% include %}` directive that looks like this:
+
+    {% include project_page.html %}
+
+That `include` directive is the most important part. It brings in `project_page.html`, which will actually be responsible for rendering the page content.
+
+The net effect is that you have one simple place to edit actual page content, and the actual rendering and placement of that content is handled for you by the include.
+
+Ideally, you shouldn't have to touch any other files besides `_config.yml` and `index.html`, but of course if you need to you always can.
+
+### Replace the filler text with copy specific to your project
+
+Of course the next step is simply to change the prose within each `{% capture %}` block to read as you want it to. It's just Markdown, so do as you please with that in mind. Note that you'll want to move on to the next step to view the site locally before you get too far into the editing process; this will allow you view your changes live as you make them.
+
+
+## View the site locally
+
+Assuming you're already within your project's clone directory, and you've already checked out the `gh-pages` branch, follow these simple directions to view your site locally:
+
+### Install jekyll if you have not already
+
+> **Note:** Jekyll 3.0.4 is a known good version, and it is specifically referred to in `Gemfile.lock` so you have to use `bundle` (not `gem install ...`) to install it:
+
+    gem install bundler
+    bundle
+
+### Run jekyll
+
+Use the `--watch` flag to pick up changes to files as you make them, allowing you a nice edit-and-refresh workflow.
+
+    bundle exec jekyll serve --watch
+
+> **Important:** Because the `baseurl` is set explicitly within your project's `_config.yml` file, you'll need to fully-qualify the URL to view your project. For example, if your project is named "spring-xyz", your URL when running Jekyll locally will be <http://localhost:4000/spring-xyz/>. Don't forget the trailing slash! You'll get a 404 without it.
+
+
+## Commit your changes
+
+Once you're satisified with your edits, commit your changes and push the `gh-pages` pages up to your project's `origin` remote.
+
+    git commit -m "Initialize project page"
+    git push --set-upstream origin gh-pages
+    git push
+
+
+## View your site live on the web
+
+That's it! After not more than a few minutes, you should be able to see your site at https://spring-projects.github.io/{your-spring-project}
+
+
+# How to keep common gh-pages content up to date
+
+Once you've set up your project's gh-pages infrastructure above, you'll get notified whenever
+changes are made to the shared gh-pages project. Actually, _your project_ will get notified,
+because a webhook configured on the gh-pages project will fire that ultimately creates a new
+issue in your project's GH Issues.
+> Yeah, it would have been nice to do proper pull requests instead of issues, but this arrangement
+with gh-pages branches and upstreams isn't based on forking. That means pull requests are no can do.
+This also means that if your project doesn't have issues turned on, you won't get notified! So you
+might consider doing that if you haven't already.
+
+In any case, whether or not you get notified via the issue coming in from the webhook, sync'ing
+up to the latest from the shared gh-pages project is easy enough:
+
+> This assumes you've got the `gh-pages-upstream` remote set up, per the instructions in sections
+above.
+
+    git checkout gh-pages
+    git pull --no-ff gh-pages-upstream gh-pages

RELEASE.adoc

@@ -1,266 +0,0 @@
-= Release Process
-
-The release process for Spring Security is entirely automated via the https://github.com/spring-io/spring-security-release-tools/blob/main/release-plugin/README.adoc[Spring Security Release Plugin] and https://github.com/spring-io/spring-security-release-tools/tree/main/.github/workflows[reusable workflows].
-The following table outlines the steps that are taken by the automation.
-
-WARNING: The `5.8.x` branch does not have all of the improvements from the `6.x.x` branches. See "Status (5.8.x)" for which steps are still manual.
-
-In case of a failure, you can follow the links below to read about each step, which includes instructions for performing the step manually if applicable.
-See <<frequently-asked-questions,FAQ>> for troubleshooting tips.
-
-[cols="1,1,1"]
-|===
-| Step | Status (5.8.x) | Status (6.0.x+)
-
-| <<update-dependencies>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<check-all-issues-are-closed>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<update-release-version>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<tag-release>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<push-release-commit>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<build-locally>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<update-release-notes-on-github>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<update-version-on-project-page>>
-| :x: manual
-| :white_check_mark: automated
-
-| <<close-create-milestone,Close milestone>>
-| :x: manual
-| :white_check_mark: automated
-
-| <<announce-release-on-slack>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<update-to-next-development-version>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<close-create-milestone,Create milestone>>
-| :white_check_mark: automated
-| :white_check_mark: automated
-
-| <<announce-release-on-other-channels>>
-| :x: manual
-| :x: manual
-|===
-
-[#update-dependencies]
-== Update dependencies
-
-Dependency versions are managed in the file xref:./gradle/libs.versions.toml[libs.versions.toml] and are automatically updated by xref:./.github/dependabot.yml[dependabot].
-
-[#check-all-issues-are-closed]
-== Check all issues are closed
-
-The first step of a release is to check if there are any open issues remaining in a milestone.
-
-NOTE: A scheduled release will not proceed if there are any open issues.
-
-TIP: If you need to prevent a release from occurring automatically, the easiest way to block a release is to add an unresolved issue to the milestone.
-
-The https://github.com/spring-io/spring-security-release-tools/blob/main/release-plugin/README.adoc#checkMilestoneHasNoOpenIssues[`checkMilestoneHasOpenIssues`] command will check if there are any open issues for the release.
-Before running the command manually, replace the following values:
-
-* `<next-version>` - Replace with the title of the milestone you are releasing now (i.e. 5.5.0-RC1)
-* `<github-personal-access-token>` - Replace with a https://github.com/settings/tokens[GitHub personal access token] that has a scope of `public_repo`. This is optional since you are unlikely to reach the rate limit for such a simple check.
-
-[source,bash]
-----
-./gradlew checkMilestoneHasOpenIssues -PnextVersion=<next-version> -PgitHubAccessToken=<github-personal-access-token>
-----
-
-Alternatively, you can manually check using the https://github.com/spring-projects/spring-security/milestones[milestones] page.
-
-[#update-release-version]
-== Update release version
-
-If all issues for the release are <<check-all-issues-are-closed,closed>>, the version number is automatically updated using the milestone title.
-When performing this step manually, update the version number in `gradle.properties` for the release (for example `5.5.0`) and commit the change using the message "Release x.y.z".
-
-[#tag-release]
-== Tag release
-
-The release will automatically be tagged using the milestone title.
-It is not required to tag manually.
-However, you can perform this step manually by running the following command:
-
-[source,bash]
-----
-git tag 5.5.0
-----
-
-[#push-release-commit]
-== Push release commit
-
-During a scheduled release, the release commit will automatically be pushed to trigger a build.
-If performing this step manually, you can push the commit and tag and GitHub actions will build and deploy the artifacts with the following command:
-
-[source,bash]
-----
-git push --atomic origin main 5.5.0
-----
-
-The build will automatically wait for artifacts to be released to Maven Central.
-You can get notified manually when uploading is complete by running the following:
-
-[source,bash]
-----
-./scripts/release/wait-for-done.sh 5.5.0
-----
-
-[#build-locally]
-== Build
-
-All checks will automatically be performed by the build prior to uploading the artifacts to Maven Central.
-If something goes wrong, you can run the build locally using:
-
-[source,bash]
-----
-./gradlew check
-----
-
-[#update-release-notes-on-github]
-== Update release notes on GitHub
-
-Once the release has been uploaded to Maven Central, release notes will automatically be generated and a GitHub release will be created.
-To do this manually, you can use the https://github.com/spring-io/spring-security-release-tools/blob/main/release-plugin/README.adoc#generateChangelog[`generateChangelog`] command to generate the release notes by replacing:
-
-* `<next-version>` - Replace with the milestone you are releasing now (i.e. 5.5.0)
-
-[source,bash]
-----
-./gradlew generateChangelog -PnextVersion=<next-version>
-----
-
-Then copy the release notes to your clipboard (your mileage may vary with the following command):
-
-[source,bash]
-----
-cat build/changelog/release-notes.md | xclip -selection clipboard
-----
-
-Finally, create the
-https://github.com/spring-projects/spring-security/releases[release on
-GitHub], associate it with the tag, and paste the generated notes.
-
-Alternatively, you can run the https://github.com/spring-io/spring-security-release-tools/blob/main/release-plugin/README.adoc#createGitHubRelease[`createGitHubRelease`] command to perform these steps automatically, replacing:
-
-* `<next-version>` - Replace with the milestone you are releasing now (i.e. 5.5.0)
-* `<branch>` - The name of the branch to be tagged (if the release commit has not already been tagged)
-* `<github-personal-access-token>` - Replace with a https://github.com/settings/tokens[GitHub personal access token] that has a scope of `write:org`
-
-[source,bash]
-----
-./gradlew createGitHubRelease -PnextVersion=<next-version> -Pbranch=<branch> -PcreateRelease=true -PgitHubAccessToken=<github-personal-access-token>
-----
-
-[#update-version-on-project-page]
-== Update version on project page
-
-The build will automatically update the project versions on https://spring.io/projects/spring-security#learn.
-To do this manually, you can use the https://github.com/spring-io/spring-security-release-tools/blob/main/release-plugin/README.adoc#createSaganRelease[`createSaganRelease`] and https://github.com/spring-io/spring-security-release-tools/blob/main/release-plugin/README.adoc#deleteSaganRelease[`deleteSaganRelease`] commands using the following parameters:
-
-* `<next-version>` - Replace with the milestone you are releasing now (i.e. 5.5.0)
-* `<previous-version>` - Replace with the previous release which will be removed from the listed versions (i.e. 5.5.0-RC1)
-* `<github-personal-access-token>` - Replace with a https://github.com/settings/tokens[GitHub personal access token] that has a scope of `read:org` as https://spring.io/restdocs/index.html#authentication[documented for spring.io api]
-
-[source,bash]
-----
-./gradlew createSaganRelease deleteSaganRelease -PnextVersion=<next-version> -PpreviousVersion=<previous-version> -PgitHubAccessToken=<github-personal-access-token>
-----
-
-Alternatively, you can log into Contentful and update the versions manually on the Spring Security project page.
-
-[#close-create-milestone]
-== Close / Create milestone
-
-The release milestone will be automatically closed once the release is complete.
-To proceed manually, perform the following steps:
-
-1. Visit https://github.com/spring-projects/spring-security/milestones[GitHub
-Milestones] and create a new milestone for the next release version
-2. Move any open issues from the existing milestone you just released to the new milestone
-3. Close the milestone for the release
-
-NOTE: Remember that scheduled releases <<check-all-issues-are-closed,will not proceed>> if there are still open issues in the milestone.
-
-[#announce-release-on-slack]
-== Announce release on Slack
-
-The release will automatically be announced on Slack.
-If proceeding manually, announce the release on Slack in the channel https://pivotal.slack.com/messages/spring-release[#spring-release], including the keyword `+spring-security-announcing+` in the message.
-Something like:
-
-....
-spring-security-announcing `5.5.0` is available now
-....
-
-[#update-to-next-development-version]
-== Update to next development version
-
-After the release is complete and artifacts have been uploaded to Maven Central, the build will automatically update to the next development version, commit and push.
-If proceeding manually, update the version in `gradle.properties` to the next `+SNAPSHOT+` version with the commit message "Next development version" and then push.
-
-[#announce-release-on-other-channels]
-== Announce release on other channels
-
-* Create a blog post on Contentful
-* Tweet from https://twitter.com/springsecurity[@SpringSecurity]
-
-[[frequently-asked-questions]]
-== Frequently Asked Questions
-
-*When should I update dependencies manually?* Dependencies should be updated at the latest the end of the week prior to the release. This is usually the Friday following the 2nd Monday of the month (counting from the first week with a Monday). When in doubt, check the https://github.com/spring-projects/spring-security/milestones[milestones] page for release due dates.
-
-*When do scheduled releases occur?* Automated releases are scheduled to occur at *3:15 PM UTC* on the *3rd Monday of the month* (counting from the first week with a Monday).
-
-[NOTE]
-The scheduled release process currently runs every Monday but only releases when a release is due. See the performed checks below for more information.
-
-The automated release process occurs on the following branches:
-
-* `main`
-* `6.2.x`
-* `6.1.x`
-* `6.0.x` (commercial only)
-* `5.8.x`
-
-For each of the above branches, the automated process performs the following checks before proceeding with the release:
-
-1. _Check if the milestone is due today._ This check compares the current (SNAPSHOT) version of the branch with available milestones and chooses the first match (sorted alphabetically). If the due date on the matched milestone is *not* today, the process stops.
-2. _Check if all issues are closed._ This check uses the milestone from the previous step and looks for open issues. If any open issues are found, the process stops.
-
-[IMPORTANT]
-You should ensure all issues are closed or moved to another milestone prior to a scheduled release.
-
-If the above checks pass, the version number is updated (in `gradle.properties`) and a commit is pushed to trigger the CI process.
-
-*How do I trigger a release manually?* You can trigger a release manually in two ways:
-
-1. Trigger a release for a particular branch via https://github.com/spring-projects/spring-security/actions/workflows/update-scheduled-release-version.yml[`update-scheduled-release-version.yml`] on the desired branch. The above checks are performed for that branch, and the release will proceed if all checks pass. _This is the recommended way to trigger a release that did not pass the above checks during a regularly scheduled release._
-2. Trigger releases for all branches via https://github.com/spring-projects/spring-security/actions/workflows/release-scheduler.yml[`release-scheduler.yml`] on the `main` branch. The above checks are performed for each branch, and only releases that pass all checks will proceed.
-
-*When should additional manual steps be performed?* All other automated steps listed above occur during the normal CI process. Additional manual steps can be performed at any time once the builds pass and releases are finished.
-
-*What if something goes wrong?* If the normal CI process fails, you can retry by re-running the failed jobs with the "Re-run failed jobs" option in GitHub Actions. If changes are required, you should revert the "Release x.y.z" commit, delete the tag, and proceed manually.

_config.yml

@@ -0,0 +1,47 @@
+### Global gh-pages pre-amble
+safe: true
+lsi: false
+highlighter: rouge
+markdown: kramdown
+encoding: UTF-8
+github: [metadata]
+kramdown:
+  input: GFM
+  hard_wrap: false
+  smart_quotes: ["apos", "apos", "quot", "quot"]
+gems:
+  - jekyll-coffeescript
+  - jekyll-paginate
+
+### The following properties will change on a project-by-project basis
+
+# Context path in the remote website (usually /<project>), will be prepended to absolute URLs for static resources
+baseurl: /spring-security
+
+# Name of the project for display in places like page titles
+name: Spring Security
+
+# ID of the project in the metadata API at spring.io (if this is not a
+# valid project ID the javascript widgets in the home page will not work)
+project: spring-security
+
+# Project github URL
+github_repo_url: https://github.com/spring-projects/spring-security
+
+## Custom properties
+guides_base_url: https://docs.spring.io/spring-security/site/docs/current/guides/html5/
+
+# If you want to include a custom pom.xml or gradle template set these value to true and add _include files
+custom_pom_template: false
+custom_gradle_template: false
+
+# If you want to include a custom pom.xml or gradle template set these value to true and add _include files
+custom_pom_template: false
+custom_gradle_template: false
+
+
+### The following properties are constant for most projects
+
+main_site_url: https://spring.io
+projects_site_url: https://projects.spring.io
+questions_url: https://spring.io/questions

_includes/badges.html

@@ -0,0 +1,16 @@
+{% if page.badges.twitter %}
+<div class="project-sub-link">
+    <a href="https://twitter.com/{{ page.badges.twitter }}">
+        <div class="spring-icon project-badges twitter" title="Twitter">
+        </div>
+    </a>
+</div>
+{% endif %}
+{% for badge in page.badges.custom %}
+<div class="project-sub-link">
+    <a href="{{ badge.url }}">
+        <div class="spring-icon project-badges {{ badge.icon }}" title="{{ badge.name }}">
+        </div>
+    </a>
+</div>
+{% endfor %}

_includes/billboard.html

@@ -0,0 +1,38 @@
+<div class="billboard--wrapper project-header--wrapper">
+    <div class="billboard--container">
+        <div class="project-icon">
+        </div>
+        <div class="container-fluid">
+            <div class="row-fluid">
+                <div class="span8 billboard--area">
+                    <div class="content--title">
+{% capture breadcrumb %}
+[Projects]({{ site.projects_site_url }}){% if parent_link %} : {{ parent_link }}{% endif %}
+{% endcapture %}
+{{ breadcrumb | markdownify }}
+                    </div>
+
+                    <div class="project--title">{{ site.name }}
+                        <div class="project--links--container">
+                            <a href="{{ site.github_repo_url }}" class="project-link">
+                                <i class="icon-github"></i>
+                            </a>
+{% if site.forum %}
+                            <a href="{{ site.forum }}" class="project-link project-link-forum">
+                                <div class="spring-icon spring-icon-forum">
+                                </div>
+                            </a>
+{% endif %}
+                        </div>
+                    </div>
+
+                    <div class="project--description">
+{{ billboard_description | markdownify }}
+                    </div>
+
+                    {{ billboard_quickstart_button }}
+                </div>
+            </div>
+        </div>
+    </div>
+</div>

_includes/build.gradle

@@ -0,0 +1,4 @@
+dependencies {
+    compile '{@= groupId @}:spring-security-web:{@= version @}'
+    compile '{@= groupId @}:spring-security-config:{@= version @}'
+}

_includes/documentation.html

@@ -0,0 +1,2 @@
+<div class="js-documentation-widget">
+</div>

_includes/download_widget.md

@@ -0,0 +1,19 @@
+<div id="download-widget">
+    <div class="row-fluid download-widget--container">
+        <div class="download-widget--header js-item-dropdown-widget--wrapper">
+            <div class="download-widget--title">
+Download
+            </div>
+        <div data-download-widget-controls style="display: inline-block"></div>
+    </div>
+    <div class="download-widget--body">
+        <p>The recommended way to get started using <code>{{ site.project }}</code> in
+        your project is with a dependency management system &ndash; the snippet below can
+        be copied and pasted into your build. Need help? See our getting started guides
+        on building with <a href="https://spring.io/guides/gs/maven/">Maven</a> and
+        <a href="https://spring.io/guides/gs/gradle/">Gradle</a>.
+        </p>
+        <div class="js-download-maven-widget"></div>
+        </div>
+    </div>
+</div>

_includes/page.html

@@ -0,0 +1,128 @@
+<head>
+    <title>{{ site.name }}</title>
+
+    <link rel="icon" type="image/png" href="{{site.baseurl}}/favicon.png" />
+
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/bootstrap/css/bootstrap.min.css" />
+    <link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Varela+Round|Montserrat:400,700" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/font-awesome/css/font-awesome.min.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/bootstrap/css/bootstrap-select.css" />
+
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/main.css.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/typography.css.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/icons.css.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/projects.css.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/buttons.css.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/guide.css.css" />
+    <link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/highlight.css.css" />
+
+    {{ head_links }}
+
+    <script src="{{site.baseurl}}/js/jquery.js"></script>
+    <script src="{{site.baseurl}}/bootstrap/js/bootstrap.min.js"></script>
+    <script src="{{site.baseurl}}/bootstrap/js/bootstrap-select.js"></script>
+
+    <script src="{{site.baseurl}}/js/underscore.js"></script>
+    <script src="{{site.baseurl}}/js/backbone.js"></script>
+    <script src="{{site.baseurl}}/js/projectDocumentationWidget.js"></script>
+    <script src="{{site.baseurl}}/js/application.js"></script>
+    <script src="{{site.baseurl}}/js/clipboard.min.js"></script>
+    <script>
+        var apiBaseUrl  = "{{ site.main_site_url }}",
+            projectId   = "{{ site.project }}",
+            siteBaseUrl = "{{ site.baseurl }}";
+    </script>
+    <script src="{{site.baseurl}}/js/copySnippets.js"></script>
+    <meta name="google-site-verification" content="7qGntFPD9lWAVCtUu5U77v4l68PsTHf6xpzgjQv2j2M" />
+    <script>
+        var _gaq = _gaq || [];
+        var pluginUrl = '//www.google-analytics.com/plugins/ga/inpage_linkid.js';
+        _gaq.push(
+            ['_require', 'inpage_linkid', pluginUrl],
+            ['_setAccount', 'UA-2728886-22'],
+            ['_trackPageview'],
+            ['b._require', 'inpage_linkid', pluginUrl],
+            ['b._setAccount', 'UA-2728886-19'],
+            ['b._trackPageview']
+        );
+        (function() {
+            var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+            ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+            var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+        })();
+    </script>
+
+    {{ head }}
+
+</head>
+
+<body>
+    <header class="navbar header--navbar">
+        <div class="navbar-inner">
+            <div class="container-fluid">
+                <div class="spring-logo--container">
+                    <a class="spring-logo" href="{{site.main_site_url}}"><span></span></a>
+                </div>
+                <ul class="nav pull-right">
+                    <li class="navbar-link"><a href="{{site.main_site_url}}/docs">Docs</a>
+                    </li>
+                    <li class="navbar-link"><a
+                        href="{{site.main_site_url}}/guides">Guides</a></li>
+                    <li class="navbar-link active"><a
+                        href="{{site.main_site_url}}/projects">Projects</a></li>
+                    <li class="navbar-link"><a href="{{site.main_site_url}}/blog">Blog</a>
+                    </li>
+                    <li class="navbar-link"><a href="{{site.questions_url}}">Questions</a>
+                    </li>
+                    <li class="navbar-link nav-search"><i
+                        class="icon-search navbar-search--icon js-search-input-open"></i>
+                        <div class="search-input-close js-search-input-close">x</div></li>
+                </ul>
+            </div>
+        </div>
+        <div class="search-dropdown--container js-search-dropdown">
+            <div class="container-fluid">
+                <div class="search-form--container">
+                    <form class="form-inline form-search"
+                        action="{{site.main_site_url}}/search">
+                        <input type="search"
+                            class="search-query search-form--form js-search-input"
+                            placeholder="Search for documention, guides, and posts..."
+                            name="q" />
+                        <button class="search-form--submit">
+                            <i class="icon-search"></i>
+                        </button>
+                    </form>
+                </div>
+            </div>
+        </div>
+    </header>
+
+    <div class="body--container">{{ content }}</div>
+
+    <footer class="footer">
+        <div class="container-fluid">
+            <div class="row-fluid">
+                <div class="span8">
+                    <div class="navbar">
+                        <div class="container">
+                            <ul class="nav">
+                                <li><a href="{{site.main_site_url}}/team">Team</a></li>
+                                <li><a href="{{site.main_site_url}}/services">Services</a></li>
+                                <li><a href="{{site.main_site_url}}/tools">Tools</a></li>
+                            </ul>
+                        </div>
+                    </div>
+                    &copy; <script> var d = new Date();
+                    document.write(d.getFullYear());</script> <a href="https://www.pivotal.io">Pivotal Software</a>, Inc. All Rights Reserved.
+                    <a href="https://pivotal.io/terms-of-use">Terms of Use</a> and
+                    <a href="https://pivotal.io/privacy-policy">Privacy</a>
+                </div>
+            </div>
+        </div>
+    </footer>
+    <div id="scrim"></div>
+
+    {{ end_content }}
+
+</body>

_includes/pom.xml

@@ -0,0 +1,24 @@
+<dependencies>
+    <dependency>
+        <groupId>{@= groupId @}</groupId>
+        <artifactId>spring-security-web</artifactId>
+        <version>{@= version @}</version>
+    </dependency>
+    <dependency>
+        <groupId>{@= groupId @}</groupId>
+        <artifactId>spring-security-config</artifactId>
+        <version>{@= version @}</version>
+    </dependency>
+</dependencies>
+{@ if (repository) { @}
+<repositories>
+    <repository>
+        <id>{@= repository.id @}</id>
+        <name>{@= repository.name @}</name>
+        <url>{@= repository.url @}</url>
+        <snapshots>
+            <enabled>{@= repository.snapshotsEnabled @}</enabled>
+        </snapshots>
+    </repository>
+</repositories>{@ } @}
+

_includes/project_block.md

@@ -0,0 +1,6 @@
+<div class="project--container">
+	<a href="{{include.site_url}}">
+		<div class="project--title">{{include.project_title}}</div>
+		<p class="project--description">{{include.project_description}}</p>
+	</a>
+</div>

_includes/project_group_page.html

@@ -0,0 +1,11 @@
+{% capture content %}
+{% include billboard.html %}
+<div class="project-body--wrapper">
+    <div class="project-body--container">
+        <div class="projects--wrapper project-aggregator">
+{{ main_content | markdownify }}
+        </div>
+    </div>
+</div>
+{% endcapture %}
+{% include page.html %}

_includes/project_page.html

@@ -0,0 +1,29 @@
+{% capture billboard_quickstart_button %}
+<a class="btn btn-black uppercase project-quickstart-btn" href="#quick-start">Quick Start</a>
+{% endcapture %}
+{% capture content %}
+{% include billboard.html %}
+<div class="github-fork-ribbon--container">
+<a href="{{ site.github_repo_url }}"><img style="position: absolute; top: 0; right: 0; border: 0;" src="{{site.baseurl}}/img/forkme.png" alt="Fork me on GitHub"></a>
+</div>
+<div class="project-body--wrapper">
+    <div class="project-body--container">
+        <div class="container-fluid">
+            <div class="row-fluid">
+                <div class="span8">
+                    <div class="project-body--section">
+                        {{ main_content | markdownify }}
+                    </div>
+                </div>
+                <div class="span4">
+                    {% include project_sidebar.html %}
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+{% endcapture %}
+{% capture end_content %}
+{% include widget_templates.html %}
+{% endcapture %}
+{% include page.html %}

_includes/project_sidebar.html

@@ -0,0 +1,9 @@
+{% include documentation.html %}
+<div class="right-pane-widget--container no-top-border">
+    <div class="project-sub-link--wrapper">
+        {% include badges.html %}
+    </div>
+</div>
+<div class="right-pane-widget--container no-top-border project-sidebar-resource--wrapper">
+    {{ related_resources | markdownify }}
+</div>

_includes/widget_templates.html

@@ -0,0 +1,136 @@
+<script type="text/html" id="project-documentation-widget-template">
+    <div class="right-pane-widget--container no-top-border project-documentation--container">
+        <div class="item-dropdown-widget">
+            <div class="item-dropdown--title">{@= name @}</div>
+            <div class="item--dropdown">
+                <div class="item--body">
+                    <div class="item--body-title">
+                        <div class="item--left-column">Release</div>
+                        <div class="item--right-column">Documentation</div>
+                    </div>
+                    {@ _.each(releases, function(release) { @}
+                    <div class="item--body--version">
+                        <div class="item--left-column">
+                            <p>{@= release.versionDisplayName @}</p>
+                            {@ if(release.current) { @}
+                                <div class="spring-icon spring-icon-current-version"></div>
+                            {@ } @}
+                            <div class="spring-icon {@= release.statusIconClass() @}"></div>
+                        </div>
+                        <div class="item--right-column">
+                            {@ if (release.refDocUrl !== '') { @}
+                                <a href='{@= release.refDocUrl @}' class="docs-link reference-link">Reference</a>
+                            {@ }; @}
+                            {@ if (release.apiDocUrl !== '') { @}
+                                <a href='{@= release.apiDocUrl @}' class="docs-link api-link">API</a>
+                            {@ }; @}
+                        </div>
+                    </div>
+                    {@ }); @}
+                </div>
+            </div>
+        </div>
+    </div>
+</script>
+
+<script type="text/html" id="project-download-widget-controls-template">
+    <div class="js-download-widget-selector">
+        <select class='selector selectpicker'>
+            {@ _.each(releases, function(release, index) { @}
+            <option value="{@= index @}"
+                    data-content="
+                        <span>{@= release.versionDisplayName @}</span>
+                        {@ if(release.current) { @}
+                            <div class='spring-icon spring-icon-current-version'></div>
+                        {@ } @}
+                        <div class='spring-icon {@= release.statusIconClass() @}'/>"
+                    data-current="{@= release.current @}">
+                ()
+            </option>
+            {@ }); @}
+        </select>
+    </div>
+
+    <div class="item-slider-widget js-item-slider--wrapper">
+        <div class="item-slider--container">
+            <div class="item--slider js-item--slider"></div>
+            <div class="item js-active js-item" data-snippet-type='maven'>
+                Maven
+            </div>
+            <div class="item js-item" data-snippet-type='gradle'>
+                Gradle
+            </div>
+        </div>
+    </div>
+
+</script>
+
+
+{% if site.custom_pom_template %}
+{% capture maven_pom_template %}
+{% include pom.xml %}
+{% endcapture %}
+{% else %}
+{% capture maven_pom_template %}
+<dependencies>
+    <dependency>
+        <groupId>{@= groupId @}</groupId>
+        <artifactId>{@= artifactId @}</artifactId>
+        <version>{@= version @}</version>
+    </dependency>
+</dependencies>
+{% endcapture %}
+{% endif %}
+
+<script type="text/html" id="project-download-maven-widget-template">
+{% highlight xml %}
+{{ maven_pom_template }}
+{% endhighlight %}
+</script>
+
+<script type="text/html" id="project-repository-maven-widget-template">
+{% highlight xml %}
+<repositories>
+    <repository>
+        <id>{@= repository.id @}</id>
+        <name>{@= repository.name @}</name>
+        <url>{@= repository.url @}</url>
+        <snapshots>
+            <enabled>{@= repository.snapshotsEnabled @}</enabled>
+        </snapshots>
+    </repository>
+</repositories>
+{% endhighlight %}
+</script>
+
+{% if site.custom_gradle_template %}
+{% capture gradle_template %}
+{% include build.gradle %}
+{% endcapture %}
+{% else %}
+{% capture gradle_template %}
+dependencies {
+    compile '{@= groupId @}:{@= artifactId @}:{@= version @}'
+}
+{% endcapture %}
+{% endif %}
+
+<script type="text/html" id="project-download-gradle-widget-template">
+{% highlight groovy %}
+{{ gradle_template }}
+{% endhighlight %}
+</script>
+
+<script type="text/html" id="project-repository-gradle-widget-template">
+{% highlight groovy %}
+repositories {
+    maven {
+        url '{@= repository.url @}'
+    }
+}
+{% endhighlight %}
+</script>
+
+<script type="text/html" id="project-download-zip-widget-template">
+This is a zip url
+</script>

_layouts/documentation_page.html

@@ -0,0 +1,29 @@
+---
+---
+<!DOCTYPE HTML>
+<html lang="en-US">
+
+{% capture head_links %}
+<link rel="stylesheet" type="text/css" href="{{site.baseurl}}/css/documentation.css" />
+{% endcapture %}
+
+{% capture content %}
+<div class="project-body--wrapper" id="quick-start">
+    <div class="project-body--container">
+        <div class="container-fluid">
+            <div class="row-fluid">
+                <div class="span12">
+                    <div class="project-body--section">
+{{ content }}
+                    </div>
+                </div>
+            </div>
+        </div>
+    </div>
+</div>
+{% endcapture %}
+
+
+
+{% include page.html %}
+</html>

_sample-pages/documentation.md

@@ -0,0 +1,44 @@
+---
+layout: documentation_page
+---
+
+# My Project ReadMe
+This would be taken from the project
+
+
+## Sub Heading
+Birth, a very small stage in a vast cosmic
+arena extraordinary claims require extraordinary evidence! Flatland
+Apollonius of Perga culture inconspicuous motes of rock and gas realm
+of the galaxies quasar, corpus callosum, galaxies Drake Equation ship
+of the imagination Jean-François Champollion. Galaxies Hypatia!
+Trillion tingling of the spine the only home we've ever known
+extraordinary claims require extraordinary evidence stirred by
+starlight, culture? Flatland Tunguska event finite but unbounded
+corpus callosum!
+
+Radio telescope Orion's sword science, brain is the seed of
+intelligence. Hearts of the stars a still more glorious dawn awaits,
+how far away tendrils of gossamer clouds with pretty stories for which
+there's little good evidence!
+
+Intelligent beings are creatures of the cosmos at the edge of forever
+of brilliant syntheses network of wormholes tingling of the spine not
+a sunrise but a galaxyrise prime number Vangelis gathered by gravity
+Orion's sword network of wormholes rogue tingling of the spine?
+
+```java
+public static void main() {
+	// long long long long long long long long long long long long long long long long long long long long long long long 
+}
+```
+
+## Features
+
+* Implementation of CRUD methods for JPA Entities
+* Dynamic query generation from query method names
+* Transparent triggering of JPA NamedQueries by query methods
+* Implementation domain base classes providing basic properties
+* Support for transparent auditing (created, last changed)
+* Possibility to integrate custom repository code
+* Easy Spring integration with custom namespace

_sample-pages/project.html

@@ -0,0 +1,128 @@
+---
+# The name of your project
+title: Spring Data JPA
+
+badges:
+
+  # Specify your project's twitter handle, if any. Delete if none.
+  twitter: SpringData
+
+  # Customize your project's badges. Delete any entries that do not apply.
+  custom:
+    - name: Source (GitHub)
+      url:  https://github.com/spring-projects/spring-data-jpa
+      icon: github
+
+    - name: Issues (JIRA)
+      url:  https://jira.springsource.org/browse/DATAJPA
+      icon: tracking
+
+    - name: CI (Bamboo)
+      url:  https://build.springsource.org/browse/SPRINGDATAJPA
+      icon: ci
+
+    - name: Forum
+      url:  https://forum.spring.io/forum/spring-projects/data
+      icon: forum
+
+    - name: StackOverflow
+      url:  https://stackoverflow.com/questions/tagged/spring-data-jpa
+      icon: stackoverflow
+
+    - name: Metrics (SonarQube)
+      url:  https://sonar.springsource.org/dashboard/index/org.springframework.data:spring-data-jpa
+      icon: metrics
+
+---
+<!DOCTYPE HTML>
+<html lang="en-US">
+
+<!-- Specify the parent of this project (or delete if none) to influence the rendering of the breadcrumb -->
+{% capture parent_link %}
+[Spring Parent]({{ site.projects_site_url }}/spring-parent)
+{% endcapture %}
+
+
+{% capture billboard_description %}
+
+**PROJECT DESCRIPTION** Corpus callosum,
+[the carbon](#) in our apple pies a mote of dust suspended in a
+sunbeam. Muse about! Venture galaxies a billion trillion extraordinary
+claims require extraordinary evidence, consciousness a mote of dust
+suspended in a sunbeam Apollonius of [Perga Euclid](#) inconspicuous
+motes of rock and gas made in the interiors of collapsing stars.
+
+{% endcapture %}
+
+{% capture main_content %}
+
+**INTRODUCTORY PARAGRAPHS** Birth, a very small stage in a vast cosmic
+arena extraordinary claims require extraordinary evidence! Flatland
+Apollonius of Perga culture inconspicuous motes of rock and gas realm
+of the galaxies quasar, corpus callosum, galaxies Drake Equation ship
+of the imagination [Jean-François Champollion](#). Galaxies Hypatia!
+Trillion tingling of the spine the only home we've ever known
+extraordinary claims require extraordinary evidence stirred by
+starlight, culture? Flatland Tunguska event finite but unbounded
+corpus callosum!
+
+## Features
+
+* Feature 1
+* [Feature 2](#)
+* Feature 3
+* Feature 4
+* ...
+
+<span id="quick-start"></span>
+
+## Quick Start
+
+{% include download_widget.md %}
+
+
+```java
+package foo;
+
+import foo;
+
+public class SearchController {
+
+    @Foo
+    public SearchController(SearchService searchService) {
+        this.searchService = searchService;
+    }
+
+    public static void main(String[] args) {
+        // This is just a test to see how a very long line works with our project css
+    }
+}
+```
+
+{% endcapture %}
+
+{% capture related_resources %}
+
+### Sample Projects
+
+* [Project Name 1](#)
+* [Project name 2](#)
+* [Project name nth](#)
+
+### Getting Started Guides
+
+* [GSG 1]({{site.main_site_url}}/guides/gs/rest-service)
+* [GSG 2]({{site.main_site_url}}/guides/gs/other-guide-2)
+* [GSG n]({{site.main_site_url}}/guides/gs/other-guide-3)
+
+### Tutorials
+
+* [Tutorial 1]({{site.main_site_url}}/guides/tutorials/rest)
+* [Tutorial 2]({{site.main_site_url}}/guides/tutorials/other-2)
+* [Tutorial n]({{site.main_site_url}}/guides/tutorials/other-3)
+
+{% endcapture %}
+
+
+{% include project_page.html %}
+</html>

_sample-pages/project_group.html

@@ -0,0 +1,59 @@
+---
+---
+<!DOCTYPE HTML>
+<html lang="en-US">
+{% capture billboard_description %}
+Spring Data makes it easier to build Spring-powered applications that use new data access
+technologies such as non-relational databases, map-reduce frameworks, and cloud based data services
+as well as provide improved support for relational database technologies.
+Spring Data is an umbrella open source project which contains many subprojects that are specific
+to a given database. The projects are developed by working together with many of the companies
+and developers that are behind these exciting technologies.
+{% endcapture %}
+
+{% capture main_content %}
+
+{% capture project_description %}
+Hearts of the stars brain is the seed of intelligence consciousness extraplanetary shores of the cosmic ocean! As a patch of light paroxysm of global death? Inconspicuous motes of rock and gas.
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/sprinframework" project_title="Spring Framework" project_description=project_description %}
+
+{% capture project_description %}
+This is Apache Hadoop Hadoop!
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/spring_hadoop" project_title="Apache Hadoop" project_description=project_description %}
+
+{% capture project_description %}
+Hearts of the stars brain is the seed of intelligence consciousness extraplanetary shores of the cosmic ocean! As a patch of light paroxysm of global death? Inconspicuous motes of rock and gas.
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/sprinframework" project_title="Spring Framework" project_description=project_description %}
+
+{% capture project_description %}
+This is Apache Hadoop Hadoop!
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/spring_hadoop" project_title="Apache Hadoop" project_description=project_description %}
+
+{% capture project_description %}
+Hearts of the stars brain is the seed of intelligence consciousness extraplanetary shores of the cosmic ocean! As a patch of light paroxysm of global death? Inconspicuous motes of rock and gas.
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/sprinframework" project_title="Spring Framework" project_description=project_description %}
+
+{% capture project_description %}
+This is Apache Hadoop Hadoop!
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/spring_hadoop" project_title="Apache Hadoop" project_description=project_description %}
+
+{% capture project_description %}
+Hearts of the stars brain is the seed of intelligence consciousness extraplanetary shores of the cosmic ocean! As a patch of light paroxysm of global death? Inconspicuous motes of rock and gas.
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/sprinframework" project_title="Spring Framework" project_description=project_description %}
+
+{% capture project_description %}
+This is Apache Hadoop Hadoop!
+{% endcapture %}
+{% include project_block.md site_url="https://www.spring.io" repo_url="https://github.com/spring_hadoop" project_title="Apache Hadoop" project_description=project_description %}
+
+{% endcapture %}
+
+{% include project_group_page.html %}
+</html>

_sample-pages/vanilla.md

@@ -0,0 +1,36 @@
+---
+layout: default
+title: Page Title Here
+---
+<!DOCTYPE HTML>
+<html lang="en-US">
+**INTRODUCTORY PARAGRAPHS** Birth, a very small stage in a vast cosmic
+arena extraordinary claims require extraordinary evidence! Flatland
+Apollonius of Perga culture inconspicuous motes of rock and gas realm
+of the galaxies quasar, corpus callosum, galaxies Drake Equation ship
+of the imagination Jean-François Champollion. Galaxies Hypatia!
+Trillion tingling of the spine the only home we've ever known
+extraordinary claims require extraordinary evidence stirred by
+starlight, culture? Flatland Tunguska event finite but unbounded
+corpus callosum!
+
+Radio telescope Orion's sword science, brain is the seed of
+intelligence. Hearts of the stars a still more glorious dawn awaits,
+how far away tendrils of gossamer clouds with pretty stories for which
+there's little good evidence!
+
+Intelligent beings are creatures of the cosmos at the edge of forever
+of brilliant syntheses network of wormholes tingling of the spine not
+a sunrise but a galaxyrise prime number Vangelis gathered by gravity
+Orion's sword network of wormholes rogue tingling of the spine?
+
+## Features
+
+* Implementation of CRUD methods for JPA Entities
+* Dynamic query generation from query method names
+* Transparent triggering of JPA NamedQueries by query methods
+* Implementation domain base classes providing basic properties
+* Support for transparent auditing (created, last changed)
+* Possibility to integrate custom repository code
+* Easy Spring integration with custom namespace
+</html>

acl/spring-security-acl.gradle

@@ -1,23 +0,0 @@
-apply plugin: 'io.spring.convention.spring-module'
-
-dependencies {
-	management platform(project(":spring-security-dependencies"))
-	api project(':spring-security-core')
-	api 'org.springframework:spring-aop'
-	api 'org.springframework:spring-context'
-	api 'org.springframework:spring-core'
-	api 'org.springframework:spring-jdbc'
-	api 'org.springframework:spring-tx'
-
-	testImplementation "org.assertj:assertj-core"
-	testImplementation "org.junit.jupiter:junit-jupiter-api"
-	testImplementation "org.junit.jupiter:junit-jupiter-params"
-	testImplementation "org.junit.jupiter:junit-jupiter-engine"
-	testImplementation "org.mockito:mockito-core"
-	testImplementation "org.mockito:mockito-junit-jupiter"
-	testImplementation 'org.springframework:spring-beans'
-	testImplementation 'org.springframework:spring-context-support'
-	testImplementation "org.springframework:spring-test"
-
-	testRuntimeOnly 'org.hsqldb:hsqldb'
-}

acl/src/main/java/org/springframework/security/acls/AclEntryVoter.java

@@ -1,241 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls;
-
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.List;
-
-import org.aopalliance.intercept.MethodInvocation;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.security.access.AuthorizationServiceException;
-import org.springframework.security.access.ConfigAttribute;
-import org.springframework.security.access.vote.AbstractAclVoter;
-import org.springframework.security.acls.domain.ObjectIdentityRetrievalStrategyImpl;
-import org.springframework.security.acls.domain.SidRetrievalStrategyImpl;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityRetrievalStrategy;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.SidRetrievalStrategy;
-import org.springframework.security.core.Authentication;
-import org.springframework.util.Assert;
-import org.springframework.util.ObjectUtils;
-import org.springframework.util.StringUtils;
-
-/**
- * <p>
- * Given a domain object instance passed as a method argument, ensures the principal has
- * appropriate permission as indicated by the {@link AclService}.
- * <p>
- * The <tt>AclService</tt> is used to retrieve the access control list (ACL) permissions
- * associated with a domain object instance for the current <tt>Authentication</tt>
- * object.
- * <p>
- * The voter will vote if any {@link ConfigAttribute#getAttribute()} matches the
- * {@link #processConfigAttribute}. The provider will then locate the first method
- * argument of type {@link #processDomainObjectClass}. Assuming that method argument is
- * non-null, the provider will then lookup the ACLs from the <code>AclManager</code> and
- * ensure the principal is {@link Acl#isGranted(List, List, boolean)} when presenting the
- * {@link #requirePermission} array to that method.
- * <p>
- * If the method argument is <tt>null</tt>, the voter will abstain from voting. If the
- * method argument could not be found, an {@link AuthorizationServiceException} will be
- * thrown.
- * <p>
- * In practical terms users will typically setup a number of <tt>AclEntryVoter</tt>s. Each
- * will have a different {@link #setProcessDomainObjectClass processDomainObjectClass},
- * {@link #processConfigAttribute} and {@link #requirePermission} combination. For
- * example, a small application might employ the following instances of
- * <tt>AclEntryVoter</tt>:
- * <ul>
- * <li>Process domain object class <code>BankAccount</code>, configuration attribute
- * <code>VOTE_ACL_BANK_ACCONT_READ</code>, require permission
- * <code>BasePermission.READ</code></li>
- * <li>Process domain object class <code>BankAccount</code>, configuration attribute
- * <code>VOTE_ACL_BANK_ACCOUNT_WRITE</code>, require permission list
- * <code>BasePermission.WRITE</code> and <code>BasePermission.CREATE</code> (allowing the
- * principal to have <b>either</b> of these two permissions)</li>
- * <li>Process domain object class <code>Customer</code>, configuration attribute
- * <code>VOTE_ACL_CUSTOMER_READ</code>, require permission
- * <code>BasePermission.READ</code></li>
- * <li>Process domain object class <code>Customer</code>, configuration attribute
- * <code>VOTE_ACL_CUSTOMER_WRITE</code>, require permission list
- * <code>BasePermission.WRITE</code> and <code>BasePermission.CREATE</code></li>
- * </ul>
- * Alternatively, you could have used a common superclass or interface for the
- * {@link #processDomainObjectClass} if both <code>BankAccount</code> and
- * <code>Customer</code> had common parents.
- *
- * <p>
- * If the principal does not have sufficient permissions, the voter will vote to deny
- * access.
- *
- * <p>
- * All comparisons and prefixes are case sensitive.
- *
- * @author Ben Alex
- */
-public class AclEntryVoter extends AbstractAclVoter {
-
-	private static final Log logger = LogFactory.getLog(AclEntryVoter.class);
-
-	private final AclService aclService;
-
-	private final String processConfigAttribute;
-
-	private final List<Permission> requirePermission;
-
-	private ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy = new ObjectIdentityRetrievalStrategyImpl();
-
-	private SidRetrievalStrategy sidRetrievalStrategy = new SidRetrievalStrategyImpl();
-
-	private String internalMethod;
-
-	public AclEntryVoter(AclService aclService, String processConfigAttribute, Permission[] requirePermission) {
-		Assert.notNull(processConfigAttribute, "A processConfigAttribute is mandatory");
-		Assert.notNull(aclService, "An AclService is mandatory");
-		Assert.isTrue(!ObjectUtils.isEmpty(requirePermission), "One or more requirePermission entries is mandatory");
-		this.aclService = aclService;
-		this.processConfigAttribute = processConfigAttribute;
-		this.requirePermission = Arrays.asList(requirePermission);
-	}
-
-	/**
-	 * Optionally specifies a method of the domain object that will be used to obtain a
-	 * contained domain object. That contained domain object will be used for the ACL
-	 * evaluation. This is useful if a domain object contains a parent that an ACL
-	 * evaluation should be targeted for, instead of the child domain object (which
-	 * perhaps is being created and as such does not yet have any ACL permissions)
-	 * @return <code>null</code> to use the domain object, or the name of a method (that
-	 * requires no arguments) that should be invoked to obtain an <code>Object</code>
-	 * which will be the domain object used for ACL evaluation
-	 */
-	protected String getInternalMethod() {
-		return this.internalMethod;
-	}
-
-	public void setInternalMethod(String internalMethod) {
-		this.internalMethod = internalMethod;
-	}
-
-	protected String getProcessConfigAttribute() {
-		return this.processConfigAttribute;
-	}
-
-	public void setObjectIdentityRetrievalStrategy(ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy) {
-		Assert.notNull(objectIdentityRetrievalStrategy, "ObjectIdentityRetrievalStrategy required");
-		this.objectIdentityRetrievalStrategy = objectIdentityRetrievalStrategy;
-	}
-
-	public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
-		Assert.notNull(sidRetrievalStrategy, "SidRetrievalStrategy required");
-		this.sidRetrievalStrategy = sidRetrievalStrategy;
-	}
-
-	@Override
-	public boolean supports(ConfigAttribute attribute) {
-		return (attribute.getAttribute() != null) && attribute.getAttribute().equals(getProcessConfigAttribute());
-	}
-
-	@Override
-	public int vote(Authentication authentication, MethodInvocation object, Collection<ConfigAttribute> attributes) {
-		for (ConfigAttribute attr : attributes) {
-			if (!supports(attr)) {
-				continue;
-			}
-
-			// Need to make an access decision on this invocation
-			// Attempt to locate the domain object instance to process
-			Object domainObject = getDomainObjectInstance(object);
-
-			// If domain object is null, vote to abstain
-			if (domainObject == null) {
-				logger.debug("Voting to abstain - domainObject is null");
-				return ACCESS_ABSTAIN;
-			}
-
-			// Evaluate if we are required to use an inner domain object
-			if (StringUtils.hasText(this.internalMethod)) {
-				domainObject = invokeInternalMethod(domainObject);
-			}
-
-			// Obtain the OID applicable to the domain object
-			ObjectIdentity objectIdentity = this.objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
-
-			// Obtain the SIDs applicable to the principal
-			List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
-
-			Acl acl;
-
-			try {
-				// Lookup only ACLs for SIDs we're interested in
-				acl = this.aclService.readAclById(objectIdentity, sids);
-			}
-			catch (NotFoundException ex) {
-				logger.debug("Voting to deny access - no ACLs apply for this principal");
-				return ACCESS_DENIED;
-			}
-
-			try {
-				if (acl.isGranted(this.requirePermission, sids, false)) {
-					logger.debug("Voting to grant access");
-					return ACCESS_GRANTED;
-				}
-				logger.debug("Voting to deny access - ACLs returned, but insufficient permissions for this principal");
-				return ACCESS_DENIED;
-			}
-			catch (NotFoundException ex) {
-				logger.debug("Voting to deny access - no ACLs apply for this principal");
-				return ACCESS_DENIED;
-			}
-		}
-
-		// No configuration attribute matched, so abstain
-		return ACCESS_ABSTAIN;
-	}
-
-	private Object invokeInternalMethod(Object domainObject) {
-		try {
-			Class<?> domainObjectType = domainObject.getClass();
-			Method method = domainObjectType.getMethod(this.internalMethod, new Class[0]);
-			return method.invoke(domainObject);
-		}
-		catch (NoSuchMethodException ex) {
-			throw new AuthorizationServiceException("Object of class '" + domainObject.getClass()
-					+ "' does not provide the requested internalMethod: " + this.internalMethod);
-		}
-		catch (IllegalAccessException ex) {
-			logger.debug("IllegalAccessException", ex);
-			throw new AuthorizationServiceException(
-					"Problem invoking internalMethod: " + this.internalMethod + " for object: " + domainObject);
-		}
-		catch (InvocationTargetException ex) {
-			logger.debug("InvocationTargetException", ex);
-			throw new AuthorizationServiceException(
-					"Problem invoking internalMethod: " + this.internalMethod + " for object: " + domainObject);
-		}
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/AclPermissionCacheOptimizer.java

@@ -1,82 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.log.LogMessage;
-import org.springframework.security.access.PermissionCacheOptimizer;
-import org.springframework.security.acls.domain.ObjectIdentityRetrievalStrategyImpl;
-import org.springframework.security.acls.domain.SidRetrievalStrategyImpl;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityRetrievalStrategy;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.SidRetrievalStrategy;
-import org.springframework.security.core.Authentication;
-
-/**
- * Batch loads ACLs for collections of objects to allow optimised filtering.
- *
- * @author Luke Taylor
- * @since 3.1
- */
-public class AclPermissionCacheOptimizer implements PermissionCacheOptimizer {
-
-	private final Log logger = LogFactory.getLog(getClass());
-
-	private final AclService aclService;
-
-	private SidRetrievalStrategy sidRetrievalStrategy = new SidRetrievalStrategyImpl();
-
-	private ObjectIdentityRetrievalStrategy oidRetrievalStrategy = new ObjectIdentityRetrievalStrategyImpl();
-
-	public AclPermissionCacheOptimizer(AclService aclService) {
-		this.aclService = aclService;
-	}
-
-	@Override
-	public void cachePermissionsFor(Authentication authentication, Collection<?> objects) {
-		if (objects.isEmpty()) {
-			return;
-		}
-		List<ObjectIdentity> oidsToCache = new ArrayList<>(objects.size());
-		for (Object domainObject : objects) {
-			if (domainObject != null) {
-				ObjectIdentity oid = this.oidRetrievalStrategy.getObjectIdentity(domainObject);
-				oidsToCache.add(oid);
-			}
-		}
-		List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
-		this.logger.debug(LogMessage.of(() -> "Eagerly loading Acls for " + oidsToCache.size() + " objects"));
-		this.aclService.readAclsById(oidsToCache, sids);
-	}
-
-	public void setObjectIdentityRetrievalStrategy(ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy) {
-		this.oidRetrievalStrategy = objectIdentityRetrievalStrategy;
-	}
-
-	public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
-		this.sidRetrievalStrategy = sidRetrievalStrategy;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/AclPermissionEvaluator.java

@@ -1,155 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls;
-
-import java.io.Serializable;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Locale;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.log.LogMessage;
-import org.springframework.security.access.PermissionEvaluator;
-import org.springframework.security.acls.domain.DefaultPermissionFactory;
-import org.springframework.security.acls.domain.ObjectIdentityRetrievalStrategyImpl;
-import org.springframework.security.acls.domain.PermissionFactory;
-import org.springframework.security.acls.domain.SidRetrievalStrategyImpl;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityGenerator;
-import org.springframework.security.acls.model.ObjectIdentityRetrievalStrategy;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.SidRetrievalStrategy;
-import org.springframework.security.core.Authentication;
-
-/**
- * Used by Spring Security's expression-based access control implementation to evaluate
- * permissions for a particular object using the ACL module. Similar in behaviour to
- * {@link org.springframework.security.acls.AclEntryVoter AclEntryVoter}.
- *
- * @author Luke Taylor
- * @since 3.0
- */
-public class AclPermissionEvaluator implements PermissionEvaluator {
-
-	private final Log logger = LogFactory.getLog(getClass());
-
-	private final AclService aclService;
-
-	private ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy = new ObjectIdentityRetrievalStrategyImpl();
-
-	private ObjectIdentityGenerator objectIdentityGenerator = new ObjectIdentityRetrievalStrategyImpl();
-
-	private SidRetrievalStrategy sidRetrievalStrategy = new SidRetrievalStrategyImpl();
-
-	private PermissionFactory permissionFactory = new DefaultPermissionFactory();
-
-	public AclPermissionEvaluator(AclService aclService) {
-		this.aclService = aclService;
-	}
-
-	/**
-	 * Determines whether the user has the given permission(s) on the domain object using
-	 * the ACL configuration. If the domain object is null, returns false (this can always
-	 * be overridden using a null check in the expression itself).
-	 */
-	@Override
-	public boolean hasPermission(Authentication authentication, Object domainObject, Object permission) {
-		if (domainObject == null) {
-			return false;
-		}
-		ObjectIdentity objectIdentity = this.objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
-		return checkPermission(authentication, objectIdentity, permission);
-	}
-
-	@Override
-	public boolean hasPermission(Authentication authentication, Serializable targetId, String targetType,
-			Object permission) {
-		ObjectIdentity objectIdentity = this.objectIdentityGenerator.createObjectIdentity(targetId, targetType);
-		return checkPermission(authentication, objectIdentity, permission);
-	}
-
-	private boolean checkPermission(Authentication authentication, ObjectIdentity oid, Object permission) {
-		// Obtain the SIDs applicable to the principal
-		List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
-		List<Permission> requiredPermission = resolvePermission(permission);
-		this.logger.debug(LogMessage.of(() -> "Checking permission '" + permission + "' for object '" + oid + "'"));
-		try {
-			// Lookup only ACLs for SIDs we're interested in
-			Acl acl = this.aclService.readAclById(oid, sids);
-			if (acl.isGranted(requiredPermission, sids, false)) {
-				this.logger.debug("Access is granted");
-				return true;
-			}
-			this.logger.debug("Returning false - ACLs returned, but insufficient permissions for this principal");
-		}
-		catch (NotFoundException nfe) {
-			this.logger.debug("Returning false - no ACLs apply for this principal");
-		}
-		return false;
-	}
-
-	List<Permission> resolvePermission(Object permission) {
-		if (permission instanceof Integer) {
-			return Arrays.asList(this.permissionFactory.buildFromMask((Integer) permission));
-		}
-		if (permission instanceof Permission) {
-			return Arrays.asList((Permission) permission);
-		}
-		if (permission instanceof Permission[]) {
-			return Arrays.asList((Permission[]) permission);
-		}
-		if (permission instanceof String permString) {
-			Permission p = buildPermission(permString);
-			if (p != null) {
-				return Arrays.asList(p);
-			}
-		}
-		throw new IllegalArgumentException("Unsupported permission: " + permission);
-	}
-
-	private Permission buildPermission(String permString) {
-		try {
-			return this.permissionFactory.buildFromName(permString);
-		}
-		catch (IllegalArgumentException notfound) {
-			return this.permissionFactory.buildFromName(permString.toUpperCase(Locale.ENGLISH));
-		}
-	}
-
-	public void setObjectIdentityRetrievalStrategy(ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy) {
-		this.objectIdentityRetrievalStrategy = objectIdentityRetrievalStrategy;
-	}
-
-	public void setObjectIdentityGenerator(ObjectIdentityGenerator objectIdentityGenerator) {
-		this.objectIdentityGenerator = objectIdentityGenerator;
-	}
-
-	public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
-		this.sidRetrievalStrategy = sidRetrievalStrategy;
-	}
-
-	public void setPermissionFactory(PermissionFactory permissionFactory) {
-		this.permissionFactory = permissionFactory;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/AbstractAclProvider.java

@@ -1,124 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.afterinvocation;
-
-import java.util.List;
-
-import org.springframework.security.access.AfterInvocationProvider;
-import org.springframework.security.access.ConfigAttribute;
-import org.springframework.security.acls.domain.ObjectIdentityRetrievalStrategyImpl;
-import org.springframework.security.acls.domain.SidRetrievalStrategyImpl;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityRetrievalStrategy;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.SidRetrievalStrategy;
-import org.springframework.security.core.Authentication;
-import org.springframework.util.Assert;
-import org.springframework.util.ObjectUtils;
-
-/**
- * Abstract {@link AfterInvocationProvider} which provides commonly-used ACL-related
- * services.
- *
- * @author Ben Alex
- */
-public abstract class AbstractAclProvider implements AfterInvocationProvider {
-
-	protected final AclService aclService;
-
-	protected String processConfigAttribute;
-
-	protected Class<?> processDomainObjectClass = Object.class;
-
-	protected ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy = new ObjectIdentityRetrievalStrategyImpl();
-
-	protected SidRetrievalStrategy sidRetrievalStrategy = new SidRetrievalStrategyImpl();
-
-	protected final List<Permission> requirePermission;
-
-	public AbstractAclProvider(AclService aclService, String processConfigAttribute,
-			List<Permission> requirePermission) {
-		Assert.hasText(processConfigAttribute, "A processConfigAttribute is mandatory");
-		Assert.notNull(aclService, "An AclService is mandatory");
-		Assert.isTrue(!ObjectUtils.isEmpty(requirePermission), "One or more requirePermission entries is mandatory");
-		this.aclService = aclService;
-		this.processConfigAttribute = processConfigAttribute;
-		this.requirePermission = requirePermission;
-	}
-
-	protected Class<?> getProcessDomainObjectClass() {
-		return this.processDomainObjectClass;
-	}
-
-	protected boolean hasPermission(Authentication authentication, Object domainObject) {
-		// Obtain the OID applicable to the domain object
-		ObjectIdentity objectIdentity = this.objectIdentityRetrievalStrategy.getObjectIdentity(domainObject);
-
-		// Obtain the SIDs applicable to the principal
-		List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
-
-		try {
-			// Lookup only ACLs for SIDs we're interested in
-			Acl acl = this.aclService.readAclById(objectIdentity, sids);
-			return acl.isGranted(this.requirePermission, sids, false);
-		}
-		catch (NotFoundException ex) {
-			return false;
-		}
-	}
-
-	public void setObjectIdentityRetrievalStrategy(ObjectIdentityRetrievalStrategy objectIdentityRetrievalStrategy) {
-		Assert.notNull(objectIdentityRetrievalStrategy, "ObjectIdentityRetrievalStrategy required");
-		this.objectIdentityRetrievalStrategy = objectIdentityRetrievalStrategy;
-	}
-
-	protected void setProcessConfigAttribute(String processConfigAttribute) {
-		Assert.hasText(processConfigAttribute, "A processConfigAttribute is mandatory");
-		this.processConfigAttribute = processConfigAttribute;
-	}
-
-	public void setProcessDomainObjectClass(Class<?> processDomainObjectClass) {
-		Assert.notNull(processDomainObjectClass, "processDomainObjectClass cannot be set to null");
-		this.processDomainObjectClass = processDomainObjectClass;
-	}
-
-	public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
-		Assert.notNull(sidRetrievalStrategy, "SidRetrievalStrategy required");
-		this.sidRetrievalStrategy = sidRetrievalStrategy;
-	}
-
-	@Override
-	public boolean supports(ConfigAttribute attribute) {
-		return this.processConfigAttribute.equals(attribute.getAttribute());
-	}
-
-	/**
-	 * This implementation supports any type of class, because it does not query the
-	 * presented secure object.
-	 * @param clazz the secure object
-	 * @return always <code>true</code>
-	 */
-	@Override
-	public boolean supports(Class<?> clazz) {
-		return true;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/AclEntryAfterInvocationCollectionFilteringProvider.java

@@ -1,120 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.afterinvocation;
-
-import java.util.Collection;
-import java.util.List;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.log.LogMessage;
-import org.springframework.security.access.AccessDeniedException;
-import org.springframework.security.access.AuthorizationServiceException;
-import org.springframework.security.access.ConfigAttribute;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.core.Authentication;
-
-/**
- * <p>
- * Given a <code>Collection</code> of domain object instances returned from a secure
- * object invocation, remove any <code>Collection</code> elements the principal does not
- * have appropriate permission to access as defined by the {@link AclService}.
- * <p>
- * The <code>AclService</code> is used to retrieve the access control list (ACL)
- * permissions associated with each <code>Collection</code> domain object instance element
- * for the current <code>Authentication</code> object.
- * <p>
- * This after invocation provider will fire if any {@link ConfigAttribute#getAttribute()}
- * matches the {@link #processConfigAttribute}. The provider will then lookup the ACLs
- * from the <code>AclService</code> and ensure the principal is
- * {@link org.springframework.security.acls.model.Acl#isGranted(List, List, boolean)
- * Acl.isGranted()} when presenting the {@link #requirePermission} array to that method.
- * <p>
- * If the principal does not have permission, that element will not be included in the
- * returned <code>Collection</code>.
- * <p>
- * Often users will setup a <code>BasicAclEntryAfterInvocationProvider</code> with a
- * {@link #processConfigAttribute} of <code>AFTER_ACL_COLLECTION_READ</code> and a
- * {@link #requirePermission} of <code>BasePermission.READ</code>. These are also the
- * defaults.
- * <p>
- * If the provided <code>returnObject</code> is <code>null</code>, a <code>null</code>
- * <code>Collection</code> will be returned. If the provided <code>returnObject</code> is
- * not a <code>Collection</code>, an {@link AuthorizationServiceException} will be thrown.
- * <p>
- * All comparisons and prefixes are case sensitive.
- *
- * @author Ben Alex
- * @author Paulo Neves
- */
-public class AclEntryAfterInvocationCollectionFilteringProvider extends AbstractAclProvider {
-
-	protected static final Log logger = LogFactory.getLog(AclEntryAfterInvocationCollectionFilteringProvider.class);
-
-	public AclEntryAfterInvocationCollectionFilteringProvider(AclService aclService,
-			List<Permission> requirePermission) {
-		super(aclService, "AFTER_ACL_COLLECTION_READ", requirePermission);
-	}
-
-	@Override
-	@SuppressWarnings("unchecked")
-	public Object decide(Authentication authentication, Object object, Collection<ConfigAttribute> config,
-			Object returnedObject) throws AccessDeniedException {
-		if (returnedObject == null) {
-			logger.debug("Return object is null, skipping");
-			return null;
-		}
-
-		for (ConfigAttribute attr : config) {
-			if (!this.supports(attr)) {
-				continue;
-			}
-
-			// Need to process the Collection for this invocation
-			Filterer filterer = getFilterer(returnedObject);
-
-			// Locate unauthorised Collection elements
-			for (Object domainObject : filterer) {
-				// Ignore nulls or entries which aren't instances of the configured domain
-				// object class
-				if (domainObject == null || !getProcessDomainObjectClass().isAssignableFrom(domainObject.getClass())) {
-					continue;
-				}
-				if (!hasPermission(authentication, domainObject)) {
-					filterer.remove(domainObject);
-					logger.debug(LogMessage.of(() -> "Principal is NOT authorised for element: " + domainObject));
-				}
-			}
-			return filterer.getFilteredObject();
-		}
-		return returnedObject;
-	}
-
-	private Filterer getFilterer(Object returnedObject) {
-		if (returnedObject instanceof Collection) {
-			return new CollectionFilterer((Collection) returnedObject);
-		}
-		if (returnedObject.getClass().isArray()) {
-			return new ArrayFilterer((Object[]) returnedObject);
-		}
-		throw new AuthorizationServiceException("A Collection or an array (or null) was required as the "
-				+ "returnedObject, but the returnedObject was: " + returnedObject);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/AclEntryAfterInvocationProvider.java

@@ -1,118 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.afterinvocation;
-
-import java.util.Collection;
-import java.util.List;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.context.MessageSource;
-import org.springframework.context.MessageSourceAware;
-import org.springframework.context.support.MessageSourceAccessor;
-import org.springframework.security.access.AccessDeniedException;
-import org.springframework.security.access.ConfigAttribute;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.core.Authentication;
-import org.springframework.security.core.SpringSecurityMessageSource;
-
-/**
- * Given a domain object instance returned from a secure object invocation, ensures the
- * principal has appropriate permission as defined by the {@link AclService}.
- * <p>
- * The <code>AclService</code> is used to retrieve the access control list (ACL)
- * permissions associated with a domain object instance for the current
- * <code>Authentication</code> object.
- * <p>
- * This after invocation provider will fire if any {@link ConfigAttribute#getAttribute()}
- * matches the {@link #processConfigAttribute}. The provider will then lookup the ACLs
- * from the <tt>AclService</tt> and ensure the principal is
- * {@link org.springframework.security.acls.model.Acl#isGranted(List, List, boolean)
- * Acl.isGranted(List, List, boolean)} when presenting the {@link #requirePermission}
- * array to that method.
- * <p>
- * Often users will set up an <code>AclEntryAfterInvocationProvider</code> with a
- * {@link #processConfigAttribute} of <code>AFTER_ACL_READ</code> and a
- * {@link #requirePermission} of <code>BasePermission.READ</code>. These are also the
- * defaults.
- * <p>
- * If the principal does not have sufficient permissions, an
- * <code>AccessDeniedException</code> will be thrown.
- * <p>
- * If the provided <tt>returnedObject</tt> is <code>null</code>, permission will always be
- * granted and <code>null</code> will be returned.
- * <p>
- * All comparisons and prefixes are case sensitive.
- */
-public class AclEntryAfterInvocationProvider extends AbstractAclProvider implements MessageSourceAware {
-
-	protected static final Log logger = LogFactory.getLog(AclEntryAfterInvocationProvider.class);
-
-	protected MessageSourceAccessor messages = SpringSecurityMessageSource.getAccessor();
-
-	public AclEntryAfterInvocationProvider(AclService aclService, List<Permission> requirePermission) {
-		this(aclService, "AFTER_ACL_READ", requirePermission);
-	}
-
-	public AclEntryAfterInvocationProvider(AclService aclService, String processConfigAttribute,
-			List<Permission> requirePermission) {
-		super(aclService, processConfigAttribute, requirePermission);
-	}
-
-	@Override
-	public Object decide(Authentication authentication, Object object, Collection<ConfigAttribute> config,
-			Object returnedObject) throws AccessDeniedException {
-
-		if (returnedObject == null) {
-			// AclManager interface contract prohibits nulls
-			// As they have permission to null/nothing, grant access
-			logger.debug("Return object is null, skipping");
-			return null;
-		}
-
-		if (!getProcessDomainObjectClass().isAssignableFrom(returnedObject.getClass())) {
-			logger.debug("Return object is not applicable for this provider, skipping");
-			return returnedObject;
-		}
-
-		for (ConfigAttribute attr : config) {
-			if (!this.supports(attr)) {
-				continue;
-			}
-
-			// Need to make an access decision on this invocation
-			if (hasPermission(authentication, returnedObject)) {
-				return returnedObject;
-			}
-
-			logger.debug("Denying access");
-			throw new AccessDeniedException(this.messages.getMessage("AclEntryAfterInvocationProvider.noPermission",
-					new Object[] { authentication.getName(), returnedObject },
-					"Authentication {0} has NO permissions to the domain object {1}"));
-		}
-
-		return returnedObject;
-	}
-
-	@Override
-	public void setMessageSource(MessageSource messageSource) {
-		this.messages = new MessageSourceAccessor(messageSource);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/ArrayFilterer.java

@@ -1,103 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.afterinvocation;
-
-import java.lang.reflect.Array;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.NoSuchElementException;
-import java.util.Set;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.log.LogMessage;
-
-/**
- * A filter used to filter arrays.
- *
- * @author Ben Alex
- * @author Paulo Neves
- */
-class ArrayFilterer<T> implements Filterer<T> {
-
-	protected static final Log logger = LogFactory.getLog(ArrayFilterer.class);
-
-	private final Set<T> removeList;
-
-	private final T[] list;
-
-	ArrayFilterer(T[] list) {
-		this.list = list;
-		// Collect the removed objects to a HashSet so that
-		// it is fast to lookup them when a filtered array
-		// is constructed.
-		this.removeList = new HashSet<>();
-	}
-
-	@Override
-	@SuppressWarnings("unchecked")
-	public T[] getFilteredObject() {
-		// Recreate an array of same type and filter the removed objects.
-		int originalSize = this.list.length;
-		int sizeOfResultingList = originalSize - this.removeList.size();
-		T[] filtered = (T[]) Array.newInstance(this.list.getClass().getComponentType(), sizeOfResultingList);
-		for (int i = 0, j = 0; i < this.list.length; i++) {
-			T object = this.list[i];
-			if (!this.removeList.contains(object)) {
-				filtered[j] = object;
-				j++;
-			}
-		}
-		logger.debug(LogMessage.of(() -> "Original array contained " + originalSize + " elements; now contains "
-				+ sizeOfResultingList + " elements"));
-		return filtered;
-	}
-
-	@Override
-	public Iterator<T> iterator() {
-		return new ArrayFiltererIterator();
-	}
-
-	@Override
-	public void remove(T object) {
-		this.removeList.add(object);
-	}
-
-	/**
-	 * Iterator for {@link ArrayFilterer} elements.
-	 */
-	private class ArrayFiltererIterator implements Iterator<T> {
-
-		private int index = 0;
-
-		@Override
-		public boolean hasNext() {
-			return this.index < ArrayFilterer.this.list.length;
-		}
-
-		@Override
-		public T next() {
-			if (hasNext()) {
-				return ArrayFilterer.this.list[this.index++];
-			}
-			throw new NoSuchElementException();
-		}
-
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/CollectionFilterer.java

@@ -1,78 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.afterinvocation;
-
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.Set;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.log.LogMessage;
-
-/**
- * A filter used to filter Collections.
- *
- * @author Ben Alex
- * @author Paulo Neves
- */
-class CollectionFilterer<T> implements Filterer<T> {
-
-	protected static final Log logger = LogFactory.getLog(CollectionFilterer.class);
-
-	private final Collection<T> collection;
-
-	private final Set<T> removeList;
-
-	CollectionFilterer(Collection<T> collection) {
-		this.collection = collection;
-		// We create a Set of objects to be removed from the Collection,
-		// as ConcurrentModificationException prevents removal during
-		// iteration, and making a new Collection to be returned is
-		// problematic as the original Collection implementation passed
-		// to the method may not necessarily be re-constructable (as
-		// the Collection(collection) constructor is not guaranteed and
-		// manually adding may lose sort order or other capabilities)
-		this.removeList = new HashSet<>();
-	}
-
-	@Override
-	public Object getFilteredObject() {
-		// Now the Iterator has ended, remove Objects from Collection
-		Iterator<T> removeIter = this.removeList.iterator();
-		int originalSize = this.collection.size();
-		while (removeIter.hasNext()) {
-			this.collection.remove(removeIter.next());
-		}
-		logger.debug(LogMessage.of(() -> "Original collection contained " + originalSize + " elements; now contains "
-				+ this.collection.size() + " elements"));
-		return this.collection;
-	}
-
-	@Override
-	public Iterator<T> iterator() {
-		return this.collection.iterator();
-	}
-
-	@Override
-	public void remove(T object) {
-		this.removeList.add(object);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/Filterer.java

@@ -1,48 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.afterinvocation;
-
-import java.util.Iterator;
-
-/**
- * Filterer strategy interface.
- *
- * @author Ben Alex
- * @author Paulo Neves
- */
-interface Filterer<T> extends Iterable<T> {
-
-	/**
-	 * Gets the filtered collection or array.
-	 * @return the filtered collection or array
-	 */
-	Object getFilteredObject();
-
-	/**
-	 * Returns an iterator over the filtered collection or array.
-	 * @return an Iterator
-	 */
-	@Override
-	Iterator<T> iterator();
-
-	/**
-	 * Removes the given object from the resulting list.
-	 * @param object the object to be removed
-	 */
-	void remove(T object);
-
-}

acl/src/main/java/org/springframework/security/acls/afterinvocation/package-info.java

@@ -1,21 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * After-invocation providers for collection and array filtering. Consider using a
- * {@code PostFilter} annotation in preference.
- */
-package org.springframework.security.acls.afterinvocation;

acl/src/main/java/org/springframework/security/acls/domain/AbstractPermission.java

@@ -1,85 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Permission;
-
-/**
- * Provides an abstract superclass for {@link Permission} implementations.
- *
- * @author Ben Alex
- * @since 2.0.3
- */
-public abstract class AbstractPermission implements Permission {
-
-	protected final char code;
-
-	protected int mask;
-
-	/**
-	 * Sets the permission mask and uses the '*' character to represent active bits when
-	 * represented as a bit pattern string.
-	 * @param mask the integer bit mask for the permission
-	 */
-	protected AbstractPermission(int mask) {
-		this.mask = mask;
-		this.code = '*';
-	}
-
-	/**
-	 * Sets the permission mask and uses the specified character for active bits.
-	 * @param mask the integer bit mask for the permission
-	 * @param code the character to print for each active bit in the mask (see
-	 * {@link Permission#getPattern()})
-	 */
-	protected AbstractPermission(int mask, char code) {
-		this.mask = mask;
-		this.code = code;
-	}
-
-	@Override
-	public final boolean equals(Object obj) {
-		if (obj == null) {
-			return false;
-		}
-		if (!(obj instanceof Permission other)) {
-			return false;
-		}
-		return (this.mask == other.getMask());
-	}
-
-	@Override
-	public final int hashCode() {
-		return this.mask;
-	}
-
-	@Override
-	public final String toString() {
-		return this.getClass().getSimpleName() + "[" + getPattern() + "=" + this.mask + "]";
-	}
-
-	@Override
-	public final int getMask() {
-		return this.mask;
-	}
-
-	@Override
-	public String getPattern() {
-		return AclFormattingUtils.printBinary(this.mask, this.code);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/AccessControlEntryImpl.java

@@ -1,192 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.io.Serializable;
-
-import org.springframework.security.acls.model.AccessControlEntry;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AuditableAccessControlEntry;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.util.Assert;
-
-/**
- * An immutable default implementation of <code>AccessControlEntry</code>.
- *
- * @author Ben Alex
- */
-public class AccessControlEntryImpl implements AccessControlEntry, AuditableAccessControlEntry {
-
-	private final Acl acl;
-
-	private Permission permission;
-
-	private final Serializable id;
-
-	private final Sid sid;
-
-	private boolean auditFailure = false;
-
-	private boolean auditSuccess = false;
-
-	private final boolean granting;
-
-	public AccessControlEntryImpl(Serializable id, Acl acl, Sid sid, Permission permission, boolean granting,
-			boolean auditSuccess, boolean auditFailure) {
-		Assert.notNull(acl, "Acl required");
-		Assert.notNull(sid, "Sid required");
-		Assert.notNull(permission, "Permission required");
-		this.id = id;
-		this.acl = acl; // can be null
-		this.sid = sid;
-		this.permission = permission;
-		this.granting = granting;
-		this.auditSuccess = auditSuccess;
-		this.auditFailure = auditFailure;
-	}
-
-	@Override
-	public boolean equals(Object arg0) {
-		if (!(arg0 instanceof AccessControlEntryImpl)) {
-			return false;
-		}
-		AccessControlEntryImpl other = (AccessControlEntryImpl) arg0;
-		if (this.acl == null) {
-			if (other.getAcl() != null) {
-				return false;
-			}
-			// Both this.acl and rhs.acl are null and thus equal
-		}
-		else {
-			// this.acl is non-null
-			if (other.getAcl() == null) {
-				return false;
-			}
-
-			// Both this.acl and rhs.acl are non-null, so do a comparison
-			if (this.acl.getObjectIdentity() == null) {
-				if (other.acl.getObjectIdentity() != null) {
-					return false;
-				}
-				// Both this.acl and rhs.acl are null and thus equal
-			}
-			else {
-				// Both this.acl.objectIdentity and rhs.acl.objectIdentity are non-null
-				if (!this.acl.getObjectIdentity().equals(other.getAcl().getObjectIdentity())) {
-					return false;
-				}
-			}
-		}
-		if (this.id == null) {
-			if (other.id != null) {
-				return false;
-			}
-			// Both this.id and rhs.id are null and thus equal
-		}
-		else {
-			// this.id is non-null
-			if (other.id == null) {
-				return false;
-			}
-			// Both this.id and rhs.id are non-null
-			if (!this.id.equals(other.id)) {
-				return false;
-			}
-		}
-		if ((this.auditFailure != other.isAuditFailure()) || (this.auditSuccess != other.isAuditSuccess())
-				|| (this.granting != other.isGranting()) || !this.permission.equals(other.getPermission())
-				|| !this.sid.equals(other.getSid())) {
-			return false;
-		}
-		return true;
-	}
-
-	@Override
-	public int hashCode() {
-		int result = this.permission.hashCode();
-		result = 31 * result + ((this.id != null) ? this.id.hashCode() : 0);
-		result = 31 * result + (this.sid.hashCode());
-		result = 31 * result + (this.auditFailure ? 1 : 0);
-		result = 31 * result + (this.auditSuccess ? 1 : 0);
-		result = 31 * result + (this.granting ? 1 : 0);
-		return result;
-	}
-
-	@Override
-	public Acl getAcl() {
-		return this.acl;
-	}
-
-	@Override
-	public Serializable getId() {
-		return this.id;
-	}
-
-	@Override
-	public Permission getPermission() {
-		return this.permission;
-	}
-
-	@Override
-	public Sid getSid() {
-		return this.sid;
-	}
-
-	@Override
-	public boolean isAuditFailure() {
-		return this.auditFailure;
-	}
-
-	@Override
-	public boolean isAuditSuccess() {
-		return this.auditSuccess;
-	}
-
-	@Override
-	public boolean isGranting() {
-		return this.granting;
-	}
-
-	void setAuditFailure(boolean auditFailure) {
-		this.auditFailure = auditFailure;
-	}
-
-	void setAuditSuccess(boolean auditSuccess) {
-		this.auditSuccess = auditSuccess;
-	}
-
-	void setPermission(Permission permission) {
-		Assert.notNull(permission, "Permission required");
-		this.permission = permission;
-	}
-
-	@Override
-	public String toString() {
-		StringBuilder sb = new StringBuilder();
-		sb.append("AccessControlEntryImpl[");
-		sb.append("id: ").append(this.id).append("; ");
-		sb.append("granting: ").append(this.granting).append("; ");
-		sb.append("sid: ").append(this.sid).append("; ");
-		sb.append("permission: ").append(this.permission).append("; ");
-		sb.append("auditSuccess: ").append(this.auditSuccess).append("; ");
-		sb.append("auditFailure: ").append(this.auditFailure);
-		sb.append("]");
-		return sb.toString();
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/AclAuthorizationStrategy.java

@@ -1,37 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Acl;
-
-/**
- * Strategy used by {@link AclImpl} to determine whether a principal is permitted to call
- * adminstrative methods on the <code>AclImpl</code>.
- *
- * @author Ben Alex
- */
-public interface AclAuthorizationStrategy {
-
-	int CHANGE_OWNERSHIP = 0;
-
-	int CHANGE_AUDITING = 1;
-
-	int CHANGE_GENERAL = 2;
-
-	void securityCheck(Acl acl, int changeType);
-
-}

acl/src/main/java/org/springframework/security/acls/domain/AclAuthorizationStrategyImpl.java

@@ -1,165 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.util.Arrays;
-import java.util.List;
-import java.util.Set;
-
-import org.springframework.security.access.AccessDeniedException;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.SidRetrievalStrategy;
-import org.springframework.security.core.Authentication;
-import org.springframework.security.core.GrantedAuthority;
-import org.springframework.security.core.authority.AuthorityUtils;
-import org.springframework.security.core.context.SecurityContext;
-import org.springframework.security.core.context.SecurityContextHolder;
-import org.springframework.security.core.context.SecurityContextHolderStrategy;
-import org.springframework.util.Assert;
-
-/**
- * Default implementation of {@link AclAuthorizationStrategy}.
- * <p>
- * Permission will be granted if at least one of the following conditions is true for the
- * current principal.
- * <ul>
- * <li>is the owner (as defined by the ACL).</li>
- * <li>holds the relevant system-wide {@link GrantedAuthority} injected into the
- * constructor.</li>
- * <li>has {@link BasePermission#ADMINISTRATION} permission (as defined by the ACL).</li>
- * </ul>
- *
- * @author Ben Alex
- */
-public class AclAuthorizationStrategyImpl implements AclAuthorizationStrategy {
-
-	private SecurityContextHolderStrategy securityContextHolderStrategy = SecurityContextHolder
-		.getContextHolderStrategy();
-
-	private final GrantedAuthority gaGeneralChanges;
-
-	private final GrantedAuthority gaModifyAuditing;
-
-	private final GrantedAuthority gaTakeOwnership;
-
-	private SidRetrievalStrategy sidRetrievalStrategy = new SidRetrievalStrategyImpl();
-
-	/**
-	 * Constructor. The only mandatory parameter relates to the system-wide
-	 * {@link GrantedAuthority} instances that can be held to always permit ACL changes.
-	 * @param auths the <code>GrantedAuthority</code>s that have special permissions
-	 * (index 0 is the authority needed to change ownership, index 1 is the authority
-	 * needed to modify auditing details, index 2 is the authority needed to change other
-	 * ACL and ACE details) (required)
-	 * <p>
-	 * Alternatively, a single value can be supplied for all three permissions.
-	 */
-	public AclAuthorizationStrategyImpl(GrantedAuthority... auths) {
-		Assert.isTrue(auths != null && (auths.length == 3 || auths.length == 1),
-				"One or three GrantedAuthority instances required");
-		if (auths.length == 3) {
-			this.gaTakeOwnership = auths[0];
-			this.gaModifyAuditing = auths[1];
-			this.gaGeneralChanges = auths[2];
-		}
-		else {
-			this.gaTakeOwnership = auths[0];
-			this.gaModifyAuditing = auths[0];
-			this.gaGeneralChanges = auths[0];
-		}
-	}
-
-	@Override
-	public void securityCheck(Acl acl, int changeType) {
-		SecurityContext context = this.securityContextHolderStrategy.getContext();
-		if ((context == null) || (context.getAuthentication() == null)
-				|| !context.getAuthentication().isAuthenticated()) {
-			throw new AccessDeniedException("Authenticated principal required to operate with ACLs");
-		}
-		Authentication authentication = context.getAuthentication();
-		// Check if authorized by virtue of ACL ownership
-		Sid currentUser = createCurrentUser(authentication);
-		if (currentUser.equals(acl.getOwner())
-				&& ((changeType == CHANGE_GENERAL) || (changeType == CHANGE_OWNERSHIP))) {
-			return;
-		}
-
-		// Iterate this principal's authorities to determine right
-		Set<String> authorities = AuthorityUtils.authorityListToSet(authentication.getAuthorities());
-		if (acl.getOwner() instanceof GrantedAuthoritySid
-				&& authorities.contains(((GrantedAuthoritySid) acl.getOwner()).getGrantedAuthority())) {
-			return;
-		}
-
-		// Not authorized by ACL ownership; try via adminstrative permissions
-		GrantedAuthority requiredAuthority = getRequiredAuthority(changeType);
-
-		if (authorities.contains(requiredAuthority.getAuthority())) {
-			return;
-		}
-
-		// Try to get permission via ACEs within the ACL
-		List<Sid> sids = this.sidRetrievalStrategy.getSids(authentication);
-		if (acl.isGranted(Arrays.asList(BasePermission.ADMINISTRATION), sids, false)) {
-			return;
-		}
-
-		throw new AccessDeniedException(
-				"Principal does not have required ACL permissions to perform requested operation");
-	}
-
-	private GrantedAuthority getRequiredAuthority(int changeType) {
-		if (changeType == CHANGE_AUDITING) {
-			return this.gaModifyAuditing;
-		}
-		if (changeType == CHANGE_GENERAL) {
-			return this.gaGeneralChanges;
-		}
-		if (changeType == CHANGE_OWNERSHIP) {
-			return this.gaTakeOwnership;
-		}
-		throw new IllegalArgumentException("Unknown change type");
-	}
-
-	/**
-	 * Creates a principal-like sid from the authentication information.
-	 * @param authentication the authentication information that can provide principal and
-	 * thus the sid's id will be dependant on the value inside
-	 * @return a sid with the ID taken from the authentication information
-	 */
-	protected Sid createCurrentUser(Authentication authentication) {
-		return new PrincipalSid(authentication);
-	}
-
-	public void setSidRetrievalStrategy(SidRetrievalStrategy sidRetrievalStrategy) {
-		Assert.notNull(sidRetrievalStrategy, "SidRetrievalStrategy required");
-		this.sidRetrievalStrategy = sidRetrievalStrategy;
-	}
-
-	/**
-	 * Sets the {@link SecurityContextHolderStrategy} to use. The default action is to use
-	 * the {@link SecurityContextHolderStrategy} stored in {@link SecurityContextHolder}.
-	 *
-	 * @since 5.8
-	 */
-	public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy) {
-		Assert.notNull(securityContextHolderStrategy, "securityContextHolderStrategy cannot be null");
-		this.securityContextHolderStrategy = securityContextHolderStrategy;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/AclFormattingUtils.java

@@ -1,99 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Permission;
-import org.springframework.util.Assert;
-
-/**
- * Utility methods for displaying ACL information.
- *
- * @author Ben Alex
- */
-public abstract class AclFormattingUtils {
-
-	public static String demergePatterns(String original, String removeBits) {
-		Assert.notNull(original, "Original string required");
-		Assert.notNull(removeBits, "Bits To Remove string required");
-		Assert.isTrue(original.length() == removeBits.length(),
-				"Original and Bits To Remove strings must be identical length");
-		char[] replacement = new char[original.length()];
-		for (int i = 0; i < original.length(); i++) {
-			if (removeBits.charAt(i) == Permission.RESERVED_OFF) {
-				replacement[i] = original.charAt(i);
-			}
-			else {
-				replacement[i] = Permission.RESERVED_OFF;
-			}
-		}
-		return new String(replacement);
-	}
-
-	public static String mergePatterns(String original, String extraBits) {
-		Assert.notNull(original, "Original string required");
-		Assert.notNull(extraBits, "Extra Bits string required");
-		Assert.isTrue(original.length() == extraBits.length(),
-				"Original and Extra Bits strings must be identical length");
-		char[] replacement = new char[extraBits.length()];
-		for (int i = 0; i < extraBits.length(); i++) {
-			if (extraBits.charAt(i) == Permission.RESERVED_OFF) {
-				replacement[i] = original.charAt(i);
-			}
-			else {
-				replacement[i] = extraBits.charAt(i);
-			}
-		}
-		return new String(replacement);
-	}
-
-	/**
-	 * Returns a representation of the active bits in the presented mask, with each active
-	 * bit being denoted by character '*'.
-	 * <p>
-	 * Inactive bits will be denoted by character {@link Permission#RESERVED_OFF}.
-	 * @param i the integer bit mask to print the active bits for
-	 * @return a 32-character representation of the bit mask
-	 */
-	public static String printBinary(int i) {
-		return printBinary(i, '*', Permission.RESERVED_OFF);
-	}
-
-	/**
-	 * Returns a representation of the active bits in the presented mask, with each active
-	 * bit being denoted by the passed character.
-	 * <p>
-	 * Inactive bits will be denoted by character {@link Permission#RESERVED_OFF}.
-	 * @param mask the integer bit mask to print the active bits for
-	 * @param code the character to print when an active bit is detected
-	 * @return a 32-character representation of the bit mask
-	 */
-	public static String printBinary(int mask, char code) {
-		Assert.doesNotContain(Character.toString(code), Character.toString(Permission.RESERVED_ON),
-				() -> Permission.RESERVED_ON + " is a reserved character code");
-		Assert.doesNotContain(Character.toString(code), Character.toString(Permission.RESERVED_OFF),
-				() -> Permission.RESERVED_OFF + " is a reserved character code");
-		return printBinary(mask, Permission.RESERVED_ON, Permission.RESERVED_OFF).replace(Permission.RESERVED_ON, code);
-	}
-
-	private static String printBinary(int i, char on, char off) {
-		String s = Integer.toBinaryString(i);
-		String pattern = Permission.THIRTY_TWO_RESERVED_OFF;
-		String temp2 = pattern.substring(0, pattern.length() - s.length()) + s;
-		return temp2.replace('0', off).replace('1', on);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/AclImpl.java

@@ -1,340 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.io.Serializable;
-import java.util.ArrayList;
-import java.util.List;
-
-import org.springframework.security.acls.model.AccessControlEntry;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AuditableAcl;
-import org.springframework.security.acls.model.MutableAcl;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.OwnershipAcl;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.PermissionGrantingStrategy;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.UnloadedSidException;
-import org.springframework.util.Assert;
-import org.springframework.util.ObjectUtils;
-
-/**
- * Base implementation of <code>Acl</code>.
- *
- * @author Ben Alex
- */
-public class AclImpl implements Acl, MutableAcl, AuditableAcl, OwnershipAcl {
-
-	private Acl parentAcl;
-
-	private transient AclAuthorizationStrategy aclAuthorizationStrategy;
-
-	private transient PermissionGrantingStrategy permissionGrantingStrategy;
-
-	private final List<AccessControlEntry> aces = new ArrayList<>();
-
-	private ObjectIdentity objectIdentity;
-
-	private Serializable id;
-
-	// OwnershipAcl
-	private Sid owner;
-
-	// includes all SIDs the WHERE clause covered, even if there was no ACE for a SID
-	private List<Sid> loadedSids = null;
-
-	private boolean entriesInheriting = true;
-
-	/**
-	 * Minimal constructor, which should be used
-	 * {@link org.springframework.security.acls.model.MutableAclService#createAcl(ObjectIdentity)}
-	 * .
-	 * @param objectIdentity the object identity this ACL relates to (required)
-	 * @param id the primary key assigned to this ACL (required)
-	 * @param aclAuthorizationStrategy authorization strategy (required)
-	 * @param auditLogger audit logger (required)
-	 */
-	public AclImpl(ObjectIdentity objectIdentity, Serializable id, AclAuthorizationStrategy aclAuthorizationStrategy,
-			AuditLogger auditLogger) {
-		Assert.notNull(objectIdentity, "Object Identity required");
-		Assert.notNull(id, "Id required");
-		Assert.notNull(aclAuthorizationStrategy, "AclAuthorizationStrategy required");
-		Assert.notNull(auditLogger, "AuditLogger required");
-		this.objectIdentity = objectIdentity;
-		this.id = id;
-		this.aclAuthorizationStrategy = aclAuthorizationStrategy;
-		this.permissionGrantingStrategy = new DefaultPermissionGrantingStrategy(auditLogger);
-	}
-
-	/**
-	 * Full constructor, which should be used by persistence tools that do not provide
-	 * field-level access features.
-	 * @param objectIdentity the object identity this ACL relates to
-	 * @param id the primary key assigned to this ACL
-	 * @param aclAuthorizationStrategy authorization strategy
-	 * @param grantingStrategy the {@code PermissionGrantingStrategy} which will be used
-	 * by the {@code isGranted()} method
-	 * @param parentAcl the parent (may be may be {@code null})
-	 * @param loadedSids the loaded SIDs if only a subset were loaded (may be {@code null}
-	 * )
-	 * @param entriesInheriting if ACEs from the parent should inherit into this ACL
-	 * @param owner the owner (required)
-	 */
-	public AclImpl(ObjectIdentity objectIdentity, Serializable id, AclAuthorizationStrategy aclAuthorizationStrategy,
-			PermissionGrantingStrategy grantingStrategy, Acl parentAcl, List<Sid> loadedSids, boolean entriesInheriting,
-			Sid owner) {
-		Assert.notNull(objectIdentity, "Object Identity required");
-		Assert.notNull(id, "Id required");
-		Assert.notNull(aclAuthorizationStrategy, "AclAuthorizationStrategy required");
-		Assert.notNull(owner, "Owner required");
-		this.objectIdentity = objectIdentity;
-		this.id = id;
-		this.aclAuthorizationStrategy = aclAuthorizationStrategy;
-		this.parentAcl = parentAcl; // may be null
-		this.loadedSids = loadedSids; // may be null
-		this.entriesInheriting = entriesInheriting;
-		this.owner = owner;
-		this.permissionGrantingStrategy = grantingStrategy;
-	}
-
-	/**
-	 * Private no-argument constructor for use by reflection-based persistence tools along
-	 * with field-level access.
-	 */
-	@SuppressWarnings("unused")
-	private AclImpl() {
-	}
-
-	@Override
-	public void deleteAce(int aceIndex) throws NotFoundException {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_GENERAL);
-		verifyAceIndexExists(aceIndex);
-		synchronized (this.aces) {
-			this.aces.remove(aceIndex);
-		}
-	}
-
-	private void verifyAceIndexExists(int aceIndex) {
-		if (aceIndex < 0) {
-			throw new NotFoundException("aceIndex must be greater than or equal to zero");
-		}
-		if (aceIndex >= this.aces.size()) {
-			throw new NotFoundException("aceIndex must refer to an index of the AccessControlEntry list. "
-					+ "List size is " + this.aces.size() + ", index was " + aceIndex);
-		}
-	}
-
-	@Override
-	public void insertAce(int atIndexLocation, Permission permission, Sid sid, boolean granting)
-			throws NotFoundException {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_GENERAL);
-		Assert.notNull(permission, "Permission required");
-		Assert.notNull(sid, "Sid required");
-		if (atIndexLocation < 0) {
-			throw new NotFoundException("atIndexLocation must be greater than or equal to zero");
-		}
-		if (atIndexLocation > this.aces.size()) {
-			throw new NotFoundException(
-					"atIndexLocation must be less than or equal to the size of the AccessControlEntry collection");
-		}
-		AccessControlEntryImpl ace = new AccessControlEntryImpl(null, this, sid, permission, granting, false, false);
-		synchronized (this.aces) {
-			this.aces.add(atIndexLocation, ace);
-		}
-	}
-
-	@Override
-	public List<AccessControlEntry> getEntries() {
-		// Can safely return AccessControlEntry directly, as they're immutable outside the
-		// ACL package
-		return new ArrayList<>(this.aces);
-	}
-
-	@Override
-	public Serializable getId() {
-		return this.id;
-	}
-
-	@Override
-	public ObjectIdentity getObjectIdentity() {
-		return this.objectIdentity;
-	}
-
-	@Override
-	public boolean isEntriesInheriting() {
-		return this.entriesInheriting;
-	}
-
-	/**
-	 * Delegates to the {@link PermissionGrantingStrategy}.
-	 * @throws UnloadedSidException if the passed SIDs are unknown to this ACL because the
-	 * ACL was only loaded for a subset of SIDs
-	 * @see DefaultPermissionGrantingStrategy
-	 */
-	@Override
-	public boolean isGranted(List<Permission> permission, List<Sid> sids, boolean administrativeMode)
-			throws NotFoundException, UnloadedSidException {
-		Assert.notEmpty(permission, "Permissions required");
-		Assert.notEmpty(sids, "SIDs required");
-		if (!this.isSidLoaded(sids)) {
-			throw new UnloadedSidException("ACL was not loaded for one or more SID");
-		}
-		return this.permissionGrantingStrategy.isGranted(this, permission, sids, administrativeMode);
-	}
-
-	@Override
-	public boolean isSidLoaded(List<Sid> sids) {
-		// If loadedSides is null, this indicates all SIDs were loaded
-		// Also return true if the caller didn't specify a SID to find
-		if ((this.loadedSids == null) || (sids == null) || (sids.size() == 0)) {
-			return true;
-		}
-
-		// This ACL applies to a SID subset only. Iterate to check it applies.
-		for (Sid sid : sids) {
-			boolean found = false;
-			for (Sid loadedSid : this.loadedSids) {
-				if (sid.equals(loadedSid)) {
-					// this SID is OK
-					found = true;
-					break; // out of loadedSids for loop
-				}
-			}
-			if (!found) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	@Override
-	public void setEntriesInheriting(boolean entriesInheriting) {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_GENERAL);
-		this.entriesInheriting = entriesInheriting;
-	}
-
-	@Override
-	public void setOwner(Sid newOwner) {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_OWNERSHIP);
-		Assert.notNull(newOwner, "Owner required");
-		this.owner = newOwner;
-	}
-
-	@Override
-	public Sid getOwner() {
-		return this.owner;
-	}
-
-	@Override
-	public void setParent(Acl newParent) {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_GENERAL);
-		Assert.isTrue(newParent == null || !newParent.equals(this), "Cannot be the parent of yourself");
-		this.parentAcl = newParent;
-	}
-
-	@Override
-	public Acl getParentAcl() {
-		return this.parentAcl;
-	}
-
-	@Override
-	public void updateAce(int aceIndex, Permission permission) throws NotFoundException {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_GENERAL);
-		verifyAceIndexExists(aceIndex);
-		synchronized (this.aces) {
-			AccessControlEntryImpl ace = (AccessControlEntryImpl) this.aces.get(aceIndex);
-			ace.setPermission(permission);
-		}
-	}
-
-	@Override
-	public void updateAuditing(int aceIndex, boolean auditSuccess, boolean auditFailure) {
-		this.aclAuthorizationStrategy.securityCheck(this, AclAuthorizationStrategy.CHANGE_AUDITING);
-		verifyAceIndexExists(aceIndex);
-		synchronized (this.aces) {
-			AccessControlEntryImpl ace = (AccessControlEntryImpl) this.aces.get(aceIndex);
-			ace.setAuditSuccess(auditSuccess);
-			ace.setAuditFailure(auditFailure);
-		}
-	}
-
-	@Override
-	public boolean equals(Object obj) {
-		if (obj == this) {
-			return true;
-		}
-		if (obj == null || !(obj instanceof AclImpl)) {
-			return false;
-		}
-		AclImpl other = (AclImpl) obj;
-		boolean result = true;
-		result = result && this.aces.equals(other.aces);
-		result = result && ObjectUtils.nullSafeEquals(this.parentAcl, other.parentAcl);
-		result = result && ObjectUtils.nullSafeEquals(this.objectIdentity, other.objectIdentity);
-		result = result && ObjectUtils.nullSafeEquals(this.id, other.id);
-		result = result && ObjectUtils.nullSafeEquals(this.owner, other.owner);
-		result = result && this.entriesInheriting == other.entriesInheriting;
-		result = result && ObjectUtils.nullSafeEquals(this.loadedSids, other.loadedSids);
-		return result;
-	}
-
-	@Override
-	public int hashCode() {
-		int result = (this.parentAcl != null) ? this.parentAcl.hashCode() : 0;
-		result = 31 * result + this.aclAuthorizationStrategy.hashCode();
-		result = 31 * result
-				+ ((this.permissionGrantingStrategy != null) ? this.permissionGrantingStrategy.hashCode() : 0);
-		result = 31 * result + ((this.aces != null) ? this.aces.hashCode() : 0);
-		result = 31 * result + this.objectIdentity.hashCode();
-		result = 31 * result + this.id.hashCode();
-		result = 31 * result + ((this.owner != null) ? this.owner.hashCode() : 0);
-		result = 31 * result + ((this.loadedSids != null) ? this.loadedSids.hashCode() : 0);
-		result = 31 * result + (this.entriesInheriting ? 1 : 0);
-		return result;
-	}
-
-	@Override
-	public String toString() {
-		StringBuilder sb = new StringBuilder();
-		sb.append("AclImpl[");
-		sb.append("id: ").append(this.id).append("; ");
-		sb.append("objectIdentity: ").append(this.objectIdentity).append("; ");
-		sb.append("owner: ").append(this.owner).append("; ");
-		int count = 0;
-		for (AccessControlEntry ace : this.aces) {
-			count++;
-			if (count == 1) {
-				sb.append("\n");
-			}
-			sb.append(ace).append("\n");
-		}
-		if (count == 0) {
-			sb.append("no ACEs; ");
-		}
-		sb.append("inheriting: ").append(this.entriesInheriting).append("; ");
-		sb.append("parent: ").append((this.parentAcl == null) ? "Null" : this.parentAcl.getObjectIdentity().toString());
-		sb.append("; ");
-		sb.append("aclAuthorizationStrategy: ").append(this.aclAuthorizationStrategy).append("; ");
-		sb.append("permissionGrantingStrategy: ").append(this.permissionGrantingStrategy);
-		sb.append("]");
-		return sb.toString();
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/AuditLogger.java

@@ -1,30 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.AccessControlEntry;
-
-/**
- * Used by <code>AclImpl</code> to log audit events.
- *
- * @author Ben Alex
- */
-public interface AuditLogger {
-
-	void logIfNeeded(boolean granted, AccessControlEntry ace);
-
-}

acl/src/main/java/org/springframework/security/acls/domain/BasePermission.java

@@ -1,51 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Permission;
-
-/**
- * A set of standard permissions.
- *
- * <p>
- * You may subclass this class to add additional permissions, or use this class as a guide
- * for creating your own permission classes.
- * </p>
- *
- * @author Ben Alex
- */
-public class BasePermission extends AbstractPermission {
-
-	public static final Permission READ = new BasePermission(1 << 0, 'R'); // 1
-
-	public static final Permission WRITE = new BasePermission(1 << 1, 'W'); // 2
-
-	public static final Permission CREATE = new BasePermission(1 << 2, 'C'); // 4
-
-	public static final Permission DELETE = new BasePermission(1 << 3, 'D'); // 8
-
-	public static final Permission ADMINISTRATION = new BasePermission(1 << 4, 'A'); // 16
-
-	protected BasePermission(int mask) {
-		super(mask);
-	}
-
-	protected BasePermission(int mask, char code) {
-		super(mask, code);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/ConsoleAuditLogger.java

@@ -1,44 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.AccessControlEntry;
-import org.springframework.security.acls.model.AuditableAccessControlEntry;
-import org.springframework.util.Assert;
-
-/**
- * A basic implementation of {@link AuditLogger}.
- *
- * @author Ben Alex
- */
-public class ConsoleAuditLogger implements AuditLogger {
-
-	@Override
-	public void logIfNeeded(boolean granted, AccessControlEntry ace) {
-		Assert.notNull(ace, "AccessControlEntry required");
-		if (ace instanceof AuditableAccessControlEntry) {
-			AuditableAccessControlEntry auditableAce = (AuditableAccessControlEntry) ace;
-			if (granted && auditableAce.isAuditSuccess()) {
-				System.out.println("GRANTED due to ACE: " + ace);
-			}
-			else if (!granted && auditableAce.isAuditFailure()) {
-				System.out.println("DENIED due to ACE: " + ace);
-			}
-		}
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/CumulativePermission.java

@@ -1,62 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Permission;
-
-/**
- * Represents a <code>Permission</code> that is constructed at runtime from other
- * permissions.
- *
- * <p>
- * Methods return <code>this</code>, in order to facilitate method chaining.
- * </p>
- *
- * @author Ben Alex
- */
-public class CumulativePermission extends AbstractPermission {
-
-	private String pattern = THIRTY_TWO_RESERVED_OFF;
-
-	public CumulativePermission() {
-		super(0, ' ');
-	}
-
-	public CumulativePermission clear(Permission permission) {
-		this.mask &= ~permission.getMask();
-		this.pattern = AclFormattingUtils.demergePatterns(this.pattern, permission.getPattern());
-		return this;
-	}
-
-	public CumulativePermission clear() {
-		this.mask = 0;
-		this.pattern = THIRTY_TWO_RESERVED_OFF;
-		return this;
-	}
-
-	public CumulativePermission set(Permission permission) {
-		this.mask |= permission.getMask();
-		this.pattern = AclFormattingUtils.mergePatterns(this.pattern, permission.getPattern());
-		return this;
-	}
-
-	@Override
-	public String getPattern() {
-		return this.pattern;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/DefaultPermissionFactory.java

@@ -1,153 +0,0 @@
-/*
- * Copyright 2002-2018 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.lang.reflect.Field;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.springframework.security.acls.model.Permission;
-import org.springframework.util.Assert;
-
-/**
- * Default implementation of {@link PermissionFactory}.
- * <p>
- * Used as a strategy by classes which wish to map integer masks and permission names to
- * <tt>Permission</tt> instances for use with the ACL implementation.
- * <p>
- * Maintains a registry of permission names and masks to <tt>Permission</tt> instances.
- *
- * @author Ben Alex
- * @author Luke Taylor
- * @since 2.0.3
- */
-public class DefaultPermissionFactory implements PermissionFactory {
-
-	private final Map<Integer, Permission> registeredPermissionsByInteger = new HashMap<>();
-
-	private final Map<String, Permission> registeredPermissionsByName = new HashMap<>();
-
-	/**
-	 * Registers the <tt>Permission</tt> fields from the <tt>BasePermission</tt> class.
-	 */
-	public DefaultPermissionFactory() {
-		registerPublicPermissions(BasePermission.class);
-	}
-
-	/**
-	 * Registers the <tt>Permission</tt> fields from the supplied class.
-	 */
-	public DefaultPermissionFactory(Class<? extends Permission> permissionClass) {
-		registerPublicPermissions(permissionClass);
-	}
-
-	/**
-	 * Registers a map of named <tt>Permission</tt> instances.
-	 * @param namedPermissions the map of <tt>Permission</tt>s, keyed by name.
-	 */
-	public DefaultPermissionFactory(Map<String, ? extends Permission> namedPermissions) {
-		for (String name : namedPermissions.keySet()) {
-			registerPermission(namedPermissions.get(name), name);
-		}
-	}
-
-	/**
-	 * Registers the public static fields of type {@link Permission} for a give class.
-	 * <p>
-	 * These permissions will be registered under the name of the field. See
-	 * {@link BasePermission} for an example.
-	 * @param clazz a {@link Permission} class with public static fields to register
-	 */
-	protected void registerPublicPermissions(Class<? extends Permission> clazz) {
-		Assert.notNull(clazz, "Class required");
-		Field[] fields = clazz.getFields();
-		for (Field field : fields) {
-			try {
-				Object fieldValue = field.get(null);
-				if (Permission.class.isAssignableFrom(fieldValue.getClass())) {
-					// Found a Permission static field
-					Permission perm = (Permission) fieldValue;
-					String permissionName = field.getName();
-					registerPermission(perm, permissionName);
-				}
-			}
-			catch (Exception ex) {
-			}
-		}
-	}
-
-	protected void registerPermission(Permission perm, String permissionName) {
-		Assert.notNull(perm, "Permission required");
-		Assert.hasText(permissionName, "Permission name required");
-		Integer mask = perm.getMask();
-
-		// Ensure no existing Permission uses this integer or code
-		Assert.isTrue(!this.registeredPermissionsByInteger.containsKey(mask),
-				() -> "An existing Permission already provides mask " + mask);
-		Assert.isTrue(!this.registeredPermissionsByName.containsKey(permissionName),
-				() -> "An existing Permission already provides name '" + permissionName + "'");
-
-		// Register the new Permission
-		this.registeredPermissionsByInteger.put(mask, perm);
-		this.registeredPermissionsByName.put(permissionName, perm);
-	}
-
-	@Override
-	public Permission buildFromMask(int mask) {
-		if (this.registeredPermissionsByInteger.containsKey(mask)) {
-			// The requested mask has an exact match against a statically-defined
-			// Permission, so return it
-			return this.registeredPermissionsByInteger.get(mask);
-		}
-
-		// To get this far, we have to use a CumulativePermission
-		CumulativePermission permission = new CumulativePermission();
-		for (int i = 0; i < 32; i++) {
-			int permissionToCheck = 1 << i;
-			if ((mask & permissionToCheck) == permissionToCheck) {
-				Permission p = this.registeredPermissionsByInteger.get(permissionToCheck);
-				Assert.state(p != null,
-						() -> "Mask '" + permissionToCheck + "' does not have a corresponding static Permission");
-				permission.set(p);
-			}
-		}
-		return permission;
-	}
-
-	@Override
-	public Permission buildFromName(String name) {
-		Permission p = this.registeredPermissionsByName.get(name);
-		Assert.notNull(p, "Unknown permission '" + name + "'");
-		return p;
-	}
-
-	@Override
-	public List<Permission> buildFromNames(List<String> names) {
-		if ((names == null) || (names.size() == 0)) {
-			return Collections.emptyList();
-		}
-		List<Permission> permissions = new ArrayList<>(names.size());
-		for (String name : names) {
-			permissions.add(buildFromName(name));
-		}
-		return permissions;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/DefaultPermissionGrantingStrategy.java

@@ -1,151 +0,0 @@
-/*
- * Copyright 2002-2018 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.util.List;
-
-import org.springframework.security.acls.model.AccessControlEntry;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.PermissionGrantingStrategy;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.util.Assert;
-
-public class DefaultPermissionGrantingStrategy implements PermissionGrantingStrategy {
-
-	private final transient AuditLogger auditLogger;
-
-	/**
-	 * Creates an instance with the logger which will be used to record granting and
-	 * denial of requested permissions.
-	 */
-	public DefaultPermissionGrantingStrategy(AuditLogger auditLogger) {
-		Assert.notNull(auditLogger, "auditLogger cannot be null");
-		this.auditLogger = auditLogger;
-	}
-
-	/**
-	 * Determines authorization. The order of the <code>permission</code> and
-	 * <code>sid</code> arguments is <em>extremely important</em>! The method will iterate
-	 * through each of the <code>permission</code>s in the order specified. For each
-	 * iteration, all of the <code>sid</code>s will be considered, again in the order they
-	 * are presented. A search will then be performed for the first
-	 * {@link AccessControlEntry} object that directly matches that
-	 * <code>permission:sid</code> combination. When the <em>first full match</em> is
-	 * found (ie an ACE that has the SID currently being searched for and the exact
-	 * permission bit mask being search for), the grant or deny flag for that ACE will
-	 * prevail. If the ACE specifies to grant access, the method will return
-	 * <code>true</code>. If the ACE specifies to deny access, the loop will stop and the
-	 * next <code>permission</code> iteration will be performed. If each permission
-	 * indicates to deny access, the first deny ACE found will be considered the reason
-	 * for the failure (as it was the first match found, and is therefore the one most
-	 * logically requiring changes - although not always). If absolutely no matching ACE
-	 * was found at all for any permission, the parent ACL will be tried (provided that
-	 * there is a parent and {@link Acl#isEntriesInheriting()} is <code>true</code>. The
-	 * parent ACL will also scan its parent and so on. If ultimately no matching ACE is
-	 * found, a <code>NotFoundException</code> will be thrown and the caller will need to
-	 * decide how to handle the permission check. Similarly, if any of the SID arguments
-	 * presented to the method were not loaded by the ACL,
-	 * <code>UnloadedSidException</code> will be thrown.
-	 * @param permission the exact permissions to scan for (order is important)
-	 * @param sids the exact SIDs to scan for (order is important)
-	 * @param administrativeMode if <code>true</code> denotes the query is for
-	 * administrative purposes and no auditing will be undertaken
-	 * @return <code>true</code> if one of the permissions has been granted,
-	 * <code>false</code> if one of the permissions has been specifically revoked
-	 * @throws NotFoundException if an exact ACE for one of the permission bit masks and
-	 * SID combination could not be found
-	 */
-	@Override
-	public boolean isGranted(Acl acl, List<Permission> permission, List<Sid> sids, boolean administrativeMode)
-			throws NotFoundException {
-		List<AccessControlEntry> aces = acl.getEntries();
-		AccessControlEntry firstRejection = null;
-		for (Permission p : permission) {
-			for (Sid sid : sids) {
-				// Attempt to find exact match for this permission mask and SID
-				boolean scanNextSid = true;
-				for (AccessControlEntry ace : aces) {
-					if (isGranted(ace, p) && ace.getSid().equals(sid)) {
-						// Found a matching ACE, so its authorization decision will
-						// prevail
-						if (ace.isGranting()) {
-							// Success
-							if (!administrativeMode) {
-								this.auditLogger.logIfNeeded(true, ace);
-							}
-							return true;
-						}
-
-						// Failure for this permission, so stop search
-						// We will see if they have a different permission
-						// (this permission is 100% rejected for this SID)
-						if (firstRejection == null) {
-							// Store first rejection for auditing reasons
-							firstRejection = ace;
-						}
-						scanNextSid = false; // helps break the loop
-
-						break; // exit aces loop
-					}
-				}
-				if (!scanNextSid) {
-					break; // exit SID for loop (now try next permission)
-				}
-			}
-		}
-
-		if (firstRejection != null) {
-			// We found an ACE to reject the request at this point, as no
-			// other ACEs were found that granted a different permission
-			if (!administrativeMode) {
-				this.auditLogger.logIfNeeded(false, firstRejection);
-			}
-			return false;
-		}
-
-		// No matches have been found so far
-		if (acl.isEntriesInheriting() && (acl.getParentAcl() != null)) {
-			// We have a parent, so let them try to find a matching ACE
-			return acl.getParentAcl().isGranted(permission, sids, false);
-		}
-
-		// We either have no parent, or we're the uppermost parent
-		throw new NotFoundException("Unable to locate a matching ACE for passed permissions and SIDs");
-	}
-
-	/**
-	 * Compares an ACE Permission to the given Permission. By default, we compare the
-	 * Permission masks for exact match. Subclasses of this strategy can override this
-	 * behavior and implement more sophisticated comparisons, e.g. a bitwise comparison
-	 * for ACEs that grant access. <pre>{@code
-	 * if (ace.isGranting() && p.getMask() != 0) {
-	 *    return (ace.getPermission().getMask() & p.getMask()) != 0;
-	 * } else {
-	 *    return ace.getPermission().getMask() == p.getMask();
-	 * }
-	 * }</pre>
-	 * @param ace the ACE from the Acl holding the mask.
-	 * @param p the Permission we are checking against.
-	 * @return true, if the respective masks are considered to be equal.
-	 */
-	protected boolean isGranted(AccessControlEntry ace, Permission p) {
-		return ace.getPermission().getMask() == p.getMask();
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/GrantedAuthoritySid.java

@@ -1,73 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.core.GrantedAuthority;
-import org.springframework.util.Assert;
-
-/**
- * Represents a <code>GrantedAuthority</code> as a <code>Sid</code>.
- * <p>
- * This is a basic implementation that simply uses the <code>String</code>-based principal
- * for <code>Sid</code> comparison. More complex principal objects may wish to provide an
- * alternative <code>Sid</code> implementation that uses some other identifier.
- * </p>
- *
- * @author Ben Alex
- */
-public class GrantedAuthoritySid implements Sid {
-
-	private final String grantedAuthority;
-
-	public GrantedAuthoritySid(String grantedAuthority) {
-		Assert.hasText(grantedAuthority, "GrantedAuthority required");
-		this.grantedAuthority = grantedAuthority;
-	}
-
-	public GrantedAuthoritySid(GrantedAuthority grantedAuthority) {
-		Assert.notNull(grantedAuthority, "GrantedAuthority required");
-		Assert.notNull(grantedAuthority.getAuthority(),
-				"This Sid is only compatible with GrantedAuthoritys that provide a non-null getAuthority()");
-		this.grantedAuthority = grantedAuthority.getAuthority();
-	}
-
-	@Override
-	public boolean equals(Object object) {
-		if ((object == null) || !(object instanceof GrantedAuthoritySid)) {
-			return false;
-		}
-		// Delegate to getGrantedAuthority() to perform actual comparison (both should be
-		// identical)
-		return ((GrantedAuthoritySid) object).getGrantedAuthority().equals(this.getGrantedAuthority());
-	}
-
-	@Override
-	public int hashCode() {
-		return this.getGrantedAuthority().hashCode();
-	}
-
-	public String getGrantedAuthority() {
-		return this.grantedAuthority;
-	}
-
-	@Override
-	public String toString() {
-		return "GrantedAuthoritySid[" + this.grantedAuthority + "]";
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/IdentityUnavailableException.java

@@ -1,44 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-/**
- * Thrown if an ACL identity could not be extracted from an object.
- *
- * @author Ben Alex
- */
-public class IdentityUnavailableException extends RuntimeException {
-
-	/**
-	 * Constructs an <code>IdentityUnavailableException</code> with the specified message.
-	 * @param msg the detail message
-	 */
-	public IdentityUnavailableException(String msg) {
-		super(msg);
-	}
-
-	/**
-	 * Constructs an <code>IdentityUnavailableException</code> with the specified message
-	 * and root cause.
-	 * @param msg the detail message
-	 * @param cause root cause
-	 */
-	public IdentityUnavailableException(String msg, Throwable cause) {
-		super(msg, cause);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/ObjectIdentityImpl.java

@@ -1,150 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.io.Serializable;
-import java.lang.reflect.Method;
-
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
-
-/**
- * Simple implementation of {@link ObjectIdentity}.
- * <p>
- * Uses <code>String</code>s to store the identity of the domain object instance. Also
- * offers a constructor that uses reflection to build the identity information.
- *
- * @author Ben Alex
- */
-public class ObjectIdentityImpl implements ObjectIdentity {
-
-	private final String type;
-
-	private Serializable identifier;
-
-	public ObjectIdentityImpl(String type, Serializable identifier) {
-		Assert.hasText(type, "Type required");
-		Assert.notNull(identifier, "identifier required");
-		this.identifier = identifier;
-		this.type = type;
-	}
-
-	/**
-	 * Constructor which uses the name of the supplied class as the <tt>type</tt>
-	 * property.
-	 */
-	public ObjectIdentityImpl(Class<?> javaType, Serializable identifier) {
-		Assert.notNull(javaType, "Java Type required");
-		Assert.notNull(identifier, "identifier required");
-		this.type = javaType.getName();
-		this.identifier = identifier;
-	}
-
-	/**
-	 * Creates the <code>ObjectIdentityImpl</code> based on the passed object instance.
-	 * The passed object must provide a <code>getId()</code> method, otherwise an
-	 * exception will be thrown.
-	 * <p>
-	 * The class name of the object passed will be considered the {@link #type}, so if
-	 * more control is required, a different constructor should be used.
-	 * @param object the domain object instance to create an identity for.
-	 * @throws IdentityUnavailableException if identity could not be extracted
-	 */
-	public ObjectIdentityImpl(Object object) throws IdentityUnavailableException {
-		Assert.notNull(object, "object cannot be null");
-		Class<?> typeClass = ClassUtils.getUserClass(object.getClass());
-		this.type = typeClass.getName();
-		Object result = invokeGetIdMethod(object, typeClass);
-		Assert.notNull(result, "getId() is required to return a non-null value");
-		Assert.isInstanceOf(Serializable.class, result, "Getter must provide a return value of type Serializable");
-		this.identifier = (Serializable) result;
-	}
-
-	private Object invokeGetIdMethod(Object object, Class<?> typeClass) {
-		try {
-			Method method = typeClass.getMethod("getId", new Class[] {});
-			return method.invoke(object);
-		}
-		catch (Exception ex) {
-			throw new IdentityUnavailableException("Could not extract identity from object " + object, ex);
-		}
-	}
-
-	/**
-	 * Important so caching operates properly.
-	 * <p>
-	 * Considers an object of the same class equal if it has the same
-	 * <code>classname</code> and <code>id</code> properties.
-	 * <p>
-	 * Numeric identities (Integer and Long values) are considered equal if they are
-	 * numerically equal. Other serializable types are evaluated using a simple equality.
-	 * @param obj object to compare
-	 * @return <code>true</code> if the presented object matches this object
-	 */
-	@Override
-	public boolean equals(Object obj) {
-		if (obj == null || !(obj instanceof ObjectIdentityImpl)) {
-			return false;
-		}
-		ObjectIdentityImpl other = (ObjectIdentityImpl) obj;
-		if (this.identifier instanceof Number && other.identifier instanceof Number) {
-			// Integers and Longs with same value should be considered equal
-			if (((Number) this.identifier).longValue() != ((Number) other.identifier).longValue()) {
-				return false;
-			}
-		}
-		else {
-			// Use plain equality for other serializable types
-			if (!this.identifier.equals(other.identifier)) {
-				return false;
-			}
-		}
-		return this.type.equals(other.type);
-	}
-
-	@Override
-	public Serializable getIdentifier() {
-		return this.identifier;
-	}
-
-	@Override
-	public String getType() {
-		return this.type;
-	}
-
-	/**
-	 * Important so caching operates properly.
-	 * @return the hash
-	 */
-	@Override
-	public int hashCode() {
-		int result = this.type.hashCode();
-		result = 31 * result + this.identifier.hashCode();
-		return result;
-	}
-
-	@Override
-	public String toString() {
-		StringBuilder sb = new StringBuilder();
-		sb.append(this.getClass().getName()).append("[");
-		sb.append("Type: ").append(this.type);
-		sb.append("; Identifier: ").append(this.identifier).append("]");
-		return sb.toString();
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/ObjectIdentityRetrievalStrategyImpl.java

@@ -1,44 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.io.Serializable;
-
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityGenerator;
-import org.springframework.security.acls.model.ObjectIdentityRetrievalStrategy;
-
-/**
- * Basic implementation of {@link ObjectIdentityRetrievalStrategy} and
- * <tt>ObjectIdentityGenerator</tt> that uses the constructors of
- * {@link ObjectIdentityImpl} to create the {@link ObjectIdentity}.
- *
- * @author Ben Alex
- */
-public class ObjectIdentityRetrievalStrategyImpl implements ObjectIdentityRetrievalStrategy, ObjectIdentityGenerator {
-
-	@Override
-	public ObjectIdentity getObjectIdentity(Object domainObject) {
-		return new ObjectIdentityImpl(domainObject);
-	}
-
-	@Override
-	public ObjectIdentity createObjectIdentity(Serializable id, String type) {
-		return new ObjectIdentityImpl(type, id);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/PermissionFactory.java

@@ -1,44 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.util.List;
-
-import org.springframework.security.acls.model.Permission;
-
-/**
- * Provides a simple mechanism to retrieve {@link Permission} instances from integer
- * masks.
- *
- * @author Ben Alex
- * @since 2.0.3
- */
-public interface PermissionFactory {
-
-	/**
-	 * Dynamically creates a <code>CumulativePermission</code> or
-	 * <code>BasePermission</code> representing the active bits in the passed mask.
-	 * @param mask to build
-	 * @return a Permission representing the requested object
-	 */
-	Permission buildFromMask(int mask);
-
-	Permission buildFromName(String name);
-
-	List<Permission> buildFromNames(List<String> names);
-
-}

acl/src/main/java/org/springframework/security/acls/domain/PrincipalSid.java

@@ -1,72 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.core.Authentication;
-import org.springframework.util.Assert;
-
-/**
- * Represents an <code>Authentication.getPrincipal()</code> as a <code>Sid</code>.
- * <p>
- * This is a basic implementation that simply uses the <code>String</code>-based principal
- * for <code>Sid</code> comparison. More complex principal objects may wish to provide an
- * alternative <code>Sid</code> implementation that uses some other identifier.
- * </p>
- *
- * @author Ben Alex
- */
-public class PrincipalSid implements Sid {
-
-	private final String principal;
-
-	public PrincipalSid(String principal) {
-		Assert.hasText(principal, "Principal required");
-		this.principal = principal;
-	}
-
-	public PrincipalSid(Authentication authentication) {
-		Assert.notNull(authentication, "Authentication required");
-		Assert.notNull(authentication.getPrincipal(), "Principal required");
-		this.principal = authentication.getName();
-	}
-
-	@Override
-	public boolean equals(Object object) {
-		if ((object == null) || !(object instanceof PrincipalSid)) {
-			return false;
-		}
-		// Delegate to getPrincipal() to perform actual comparison (both should be
-		// identical)
-		return ((PrincipalSid) object).getPrincipal().equals(this.getPrincipal());
-	}
-
-	@Override
-	public int hashCode() {
-		return this.getPrincipal().hashCode();
-	}
-
-	public String getPrincipal() {
-		return this.principal;
-	}
-
-	@Override
-	public String toString() {
-		return "PrincipalSid[" + this.principal + "]";
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/SidRetrievalStrategyImpl.java

@@ -1,66 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-
-import org.springframework.security.access.hierarchicalroles.NullRoleHierarchy;
-import org.springframework.security.access.hierarchicalroles.RoleHierarchy;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.SidRetrievalStrategy;
-import org.springframework.security.core.Authentication;
-import org.springframework.security.core.GrantedAuthority;
-import org.springframework.util.Assert;
-
-/**
- * Basic implementation of {@link SidRetrievalStrategy} that creates a {@link Sid} for the
- * principal, as well as every granted authority the principal holds. Can optionally have
- * a <tt>RoleHierarchy</tt> injected in order to determine the extended list of
- * authorities that the principal is assigned.
- * <p>
- * The returned array will always contain the {@link PrincipalSid} before any
- * {@link GrantedAuthoritySid} elements.
- *
- * @author Ben Alex
- */
-public class SidRetrievalStrategyImpl implements SidRetrievalStrategy {
-
-	private RoleHierarchy roleHierarchy = new NullRoleHierarchy();
-
-	public SidRetrievalStrategyImpl() {
-	}
-
-	public SidRetrievalStrategyImpl(RoleHierarchy roleHierarchy) {
-		Assert.notNull(roleHierarchy, "RoleHierarchy must not be null");
-		this.roleHierarchy = roleHierarchy;
-	}
-
-	@Override
-	public List<Sid> getSids(Authentication authentication) {
-		Collection<? extends GrantedAuthority> authorities = this.roleHierarchy
-			.getReachableGrantedAuthorities(authentication.getAuthorities());
-		List<Sid> sids = new ArrayList<>(authorities.size() + 1);
-		sids.add(new PrincipalSid(authentication));
-		for (GrantedAuthority authority : authorities) {
-			sids.add(new GrantedAuthoritySid(authority));
-		}
-		return sids;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/SpringCacheBasedAclCache.java

@@ -1,128 +0,0 @@
-/*
- * Copyright 2002-2013 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.domain;
-
-import java.io.Serializable;
-
-import org.springframework.cache.Cache;
-import org.springframework.security.acls.model.AclCache;
-import org.springframework.security.acls.model.MutableAcl;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.PermissionGrantingStrategy;
-import org.springframework.security.util.FieldUtils;
-import org.springframework.util.Assert;
-
-/**
- * Simple implementation of {@link org.springframework.security.acls.model.AclCache} that
- * delegates to {@link Cache} implementation.
- * <p>
- * Designed to handle the transient fields in
- * {@link org.springframework.security.acls.domain.AclImpl}. Note that this implementation
- * assumes all {@link org.springframework.security.acls.domain.AclImpl} instances share
- * the same {@link org.springframework.security.acls.model.PermissionGrantingStrategy} and
- * {@link org.springframework.security.acls.domain.AclAuthorizationStrategy} instances.
- *
- * @author Marten Deinum
- * @since 3.2
- */
-public class SpringCacheBasedAclCache implements AclCache {
-
-	private final Cache cache;
-
-	private PermissionGrantingStrategy permissionGrantingStrategy;
-
-	private AclAuthorizationStrategy aclAuthorizationStrategy;
-
-	public SpringCacheBasedAclCache(Cache cache, PermissionGrantingStrategy permissionGrantingStrategy,
-			AclAuthorizationStrategy aclAuthorizationStrategy) {
-		Assert.notNull(cache, "Cache required");
-		Assert.notNull(permissionGrantingStrategy, "PermissionGrantingStrategy required");
-		Assert.notNull(aclAuthorizationStrategy, "AclAuthorizationStrategy required");
-		this.cache = cache;
-		this.permissionGrantingStrategy = permissionGrantingStrategy;
-		this.aclAuthorizationStrategy = aclAuthorizationStrategy;
-	}
-
-	@Override
-	public void evictFromCache(Serializable pk) {
-		Assert.notNull(pk, "Primary key (identifier) required");
-		MutableAcl acl = getFromCache(pk);
-		if (acl != null) {
-			this.cache.evict(acl.getId());
-			this.cache.evict(acl.getObjectIdentity());
-		}
-	}
-
-	@Override
-	public void evictFromCache(ObjectIdentity objectIdentity) {
-		Assert.notNull(objectIdentity, "ObjectIdentity required");
-		MutableAcl acl = getFromCache(objectIdentity);
-		if (acl != null) {
-			this.cache.evict(acl.getId());
-			this.cache.evict(acl.getObjectIdentity());
-		}
-	}
-
-	@Override
-	public MutableAcl getFromCache(ObjectIdentity objectIdentity) {
-		Assert.notNull(objectIdentity, "ObjectIdentity required");
-		return getFromCache((Object) objectIdentity);
-	}
-
-	@Override
-	public MutableAcl getFromCache(Serializable pk) {
-		Assert.notNull(pk, "Primary key (identifier) required");
-		return getFromCache((Object) pk);
-	}
-
-	@Override
-	public void putInCache(MutableAcl acl) {
-		Assert.notNull(acl, "Acl required");
-		Assert.notNull(acl.getObjectIdentity(), "ObjectIdentity required");
-		Assert.notNull(acl.getId(), "ID required");
-		if ((acl.getParentAcl() != null) && (acl.getParentAcl() instanceof MutableAcl)) {
-			putInCache((MutableAcl) acl.getParentAcl());
-		}
-		this.cache.put(acl.getObjectIdentity(), acl);
-		this.cache.put(acl.getId(), acl);
-	}
-
-	private MutableAcl getFromCache(Object key) {
-		Cache.ValueWrapper element = this.cache.get(key);
-		if (element == null) {
-			return null;
-		}
-		return initializeTransientFields((MutableAcl) element.get());
-	}
-
-	private MutableAcl initializeTransientFields(MutableAcl value) {
-		if (value instanceof AclImpl) {
-			FieldUtils.setProtectedFieldValue("aclAuthorizationStrategy", value, this.aclAuthorizationStrategy);
-			FieldUtils.setProtectedFieldValue("permissionGrantingStrategy", value, this.permissionGrantingStrategy);
-		}
-		if (value.getParentAcl() != null) {
-			initializeTransientFields((MutableAcl) value.getParentAcl());
-		}
-		return value;
-	}
-
-	@Override
-	public void clearCache() {
-		this.cache.clear();
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/domain/package-info.java

@@ -1,20 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * Basic implementation of access control lists (ACLs) interfaces.
- */
-package org.springframework.security.acls.domain;

acl/src/main/java/org/springframework/security/acls/jdbc/AclClassIdUtils.java

@@ -1,168 +0,0 @@
-/*
- * Copyright 2002-2018 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.jdbc;
-
-import java.io.Serializable;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.util.UUID;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.convert.ConversionFailedException;
-import org.springframework.core.convert.ConversionService;
-import org.springframework.core.convert.TypeDescriptor;
-import org.springframework.core.convert.converter.Converter;
-import org.springframework.core.convert.support.GenericConversionService;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.util.Assert;
-
-/**
- * Utility class for helping convert database representations of
- * {@link ObjectIdentity#getIdentifier()} into the correct Java type as specified by
- * <code>acl_class.class_id_type</code>.
- *
- * @author paulwheeler
- */
-class AclClassIdUtils {
-
-	private static final String DEFAULT_CLASS_ID_TYPE_COLUMN_NAME = "class_id_type";
-
-	private static final Log log = LogFactory.getLog(AclClassIdUtils.class);
-
-	private ConversionService conversionService;
-
-	AclClassIdUtils() {
-		GenericConversionService genericConversionService = new GenericConversionService();
-		genericConversionService.addConverter(String.class, Long.class, new StringToLongConverter());
-		genericConversionService.addConverter(String.class, UUID.class, new StringToUUIDConverter());
-		this.conversionService = genericConversionService;
-	}
-
-	AclClassIdUtils(ConversionService conversionService) {
-		Assert.notNull(conversionService, "conversionService must not be null");
-		this.conversionService = conversionService;
-	}
-
-	/**
-	 * Converts the raw type from the database into the right Java type. For most
-	 * applications the 'raw type' will be Long, for some applications it could be String.
-	 * @param identifier The identifier from the database
-	 * @param resultSet Result set of the query
-	 * @return The identifier in the appropriate target Java type. Typically Long or UUID.
-	 * @throws SQLException
-	 */
-	Serializable identifierFrom(Serializable identifier, ResultSet resultSet) throws SQLException {
-		if (isString(identifier) && hasValidClassIdType(resultSet)
-				&& canConvertFromStringTo(classIdTypeFrom(resultSet))) {
-			return convertFromStringTo((String) identifier, classIdTypeFrom(resultSet));
-		}
-		// Assume it should be a Long type
-		return convertToLong(identifier);
-	}
-
-	private boolean hasValidClassIdType(ResultSet resultSet) {
-		try {
-			return classIdTypeFrom(resultSet) != null;
-		}
-		catch (SQLException ex) {
-			log.debug("Unable to obtain the class id type", ex);
-			return false;
-		}
-	}
-
-	private <T extends Serializable> Class<T> classIdTypeFrom(ResultSet resultSet) throws SQLException {
-		return classIdTypeFrom(resultSet.getString(DEFAULT_CLASS_ID_TYPE_COLUMN_NAME));
-	}
-
-	private <T extends Serializable> Class<T> classIdTypeFrom(String className) {
-		if (className == null) {
-			return null;
-		}
-		try {
-			return (Class) Class.forName(className);
-		}
-		catch (ClassNotFoundException ex) {
-			log.debug("Unable to find class id type on classpath", ex);
-			return null;
-		}
-	}
-
-	private <T> boolean canConvertFromStringTo(Class<T> targetType) {
-		return this.conversionService.canConvert(String.class, targetType);
-	}
-
-	private <T extends Serializable> T convertFromStringTo(String identifier, Class<T> targetType) {
-		return this.conversionService.convert(identifier, targetType);
-	}
-
-	/**
-	 * Converts to a {@link Long}, attempting to use the {@link ConversionService} if
-	 * available.
-	 * @param identifier The identifier
-	 * @return Long version of the identifier
-	 * @throws NumberFormatException if the string cannot be parsed to a long.
-	 * @throws org.springframework.core.convert.ConversionException if a conversion
-	 * exception occurred
-	 * @throws IllegalArgumentException if targetType is null
-	 */
-	private Long convertToLong(Serializable identifier) {
-		if (this.conversionService.canConvert(identifier.getClass(), Long.class)) {
-			return this.conversionService.convert(identifier, Long.class);
-		}
-		return Long.valueOf(identifier.toString());
-	}
-
-	private boolean isString(Serializable object) {
-		return object.getClass().isAssignableFrom(String.class);
-	}
-
-	void setConversionService(ConversionService conversionService) {
-		Assert.notNull(conversionService, "conversionService must not be null");
-		this.conversionService = conversionService;
-	}
-
-	private static class StringToLongConverter implements Converter<String, Long> {
-
-		@Override
-		public Long convert(String identifierAsString) {
-			if (identifierAsString == null) {
-				throw new ConversionFailedException(TypeDescriptor.valueOf(String.class),
-						TypeDescriptor.valueOf(Long.class), null, null);
-
-			}
-			return Long.parseLong(identifierAsString);
-		}
-
-	}
-
-	private static class StringToUUIDConverter implements Converter<String, UUID> {
-
-		@Override
-		public UUID convert(String identifierAsString) {
-			if (identifierAsString == null) {
-				throw new ConversionFailedException(TypeDescriptor.valueOf(String.class),
-						TypeDescriptor.valueOf(UUID.class), null, null);
-
-			}
-			return UUID.fromString(identifierAsString);
-		}
-
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/jdbc/BasicLookupStrategy.java

@@ -1,678 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006, 2017 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.jdbc;
-
-import java.io.Serializable;
-import java.lang.reflect.Field;
-import java.sql.PreparedStatement;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-import javax.sql.DataSource;
-
-import org.springframework.core.convert.ConversionException;
-import org.springframework.core.convert.ConversionService;
-import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.jdbc.core.ResultSetExtractor;
-import org.springframework.security.acls.domain.AccessControlEntryImpl;
-import org.springframework.security.acls.domain.AclAuthorizationStrategy;
-import org.springframework.security.acls.domain.AclImpl;
-import org.springframework.security.acls.domain.AuditLogger;
-import org.springframework.security.acls.domain.DefaultPermissionFactory;
-import org.springframework.security.acls.domain.DefaultPermissionGrantingStrategy;
-import org.springframework.security.acls.domain.GrantedAuthoritySid;
-import org.springframework.security.acls.domain.ObjectIdentityRetrievalStrategyImpl;
-import org.springframework.security.acls.domain.PermissionFactory;
-import org.springframework.security.acls.domain.PrincipalSid;
-import org.springframework.security.acls.model.AccessControlEntry;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AclCache;
-import org.springframework.security.acls.model.MutableAcl;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityGenerator;
-import org.springframework.security.acls.model.Permission;
-import org.springframework.security.acls.model.PermissionGrantingStrategy;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.acls.model.UnloadedSidException;
-import org.springframework.security.util.FieldUtils;
-import org.springframework.util.Assert;
-
-/**
- * Performs lookups in a manner that is compatible with ANSI SQL.
- * <p>
- * NB: This implementation does attempt to provide reasonably optimised lookups - within
- * the constraints of a normalised database and standard ANSI SQL features. If you are
- * willing to sacrifice either of these constraints (e.g. use a particular database
- * feature such as hierarchical queries or materalized views, or reduce normalisation) you
- * are likely to achieve better performance. In such situations you will need to provide
- * your own custom <code>LookupStrategy</code>. This class does not support subclassing,
- * as it is likely to change in future releases and therefore subclassing is unsupported.
- * <p>
- * There are two SQL queries executed, one in the <tt>lookupPrimaryKeys</tt> method and
- * one in <tt>lookupObjectIdentities</tt>. These are built from the same select and "order
- * by" clause, using a different where clause in each case. In order to use custom schema
- * or column names, each of these SQL clauses can be customized, but they must be
- * consistent with each other and with the expected result set generated by the default
- * values.
- *
- * @author Ben Alex
- */
-public class BasicLookupStrategy implements LookupStrategy {
-
-	private static final String DEFAULT_SELECT_CLAUSE_COLUMNS = "select acl_object_identity.object_id_identity, "
-			+ "acl_entry.ace_order,  " + "acl_object_identity.id as acl_id, " + "acl_object_identity.parent_object, "
-			+ "acl_object_identity.entries_inheriting, " + "acl_entry.id as ace_id, " + "acl_entry.mask,  "
-			+ "acl_entry.granting,  " + "acl_entry.audit_success, " + "acl_entry.audit_failure,  "
-			+ "acl_sid.principal as ace_principal, " + "acl_sid.sid as ace_sid,  "
-			+ "acli_sid.principal as acl_principal, " + "acli_sid.sid as acl_sid, " + "acl_class.class ";
-
-	private static final String DEFAULT_SELECT_CLAUSE_ACL_CLASS_ID_TYPE_COLUMN = ", acl_class.class_id_type  ";
-
-	private static final String DEFAULT_SELECT_CLAUSE_FROM = "from acl_object_identity "
-			+ "left join acl_sid acli_sid on acli_sid.id = acl_object_identity.owner_sid "
-			+ "left join acl_class on acl_class.id = acl_object_identity.object_id_class   "
-			+ "left join acl_entry on acl_object_identity.id = acl_entry.acl_object_identity "
-			+ "left join acl_sid on acl_entry.sid = acl_sid.id  " + "where ( ";
-
-	public static final String DEFAULT_SELECT_CLAUSE = DEFAULT_SELECT_CLAUSE_COLUMNS + DEFAULT_SELECT_CLAUSE_FROM;
-
-	public static final String DEFAULT_ACL_CLASS_ID_SELECT_CLAUSE = DEFAULT_SELECT_CLAUSE_COLUMNS
-			+ DEFAULT_SELECT_CLAUSE_ACL_CLASS_ID_TYPE_COLUMN + DEFAULT_SELECT_CLAUSE_FROM;
-
-	private static final String DEFAULT_LOOKUP_KEYS_WHERE_CLAUSE = "(acl_object_identity.id = ?)";
-
-	private static final String DEFAULT_LOOKUP_IDENTITIES_WHERE_CLAUSE = "(acl_object_identity.object_id_identity = ? and acl_class.class = ?)";
-
-	public static final String DEFAULT_ORDER_BY_CLAUSE = ") order by acl_object_identity.object_id_identity"
-			+ " asc, acl_entry.ace_order asc";
-
-	private final AclAuthorizationStrategy aclAuthorizationStrategy;
-
-	private ObjectIdentityGenerator objectIdentityGenerator;
-
-	private PermissionFactory permissionFactory = new DefaultPermissionFactory();
-
-	private final AclCache aclCache;
-
-	private final PermissionGrantingStrategy grantingStrategy;
-
-	private final JdbcTemplate jdbcTemplate;
-
-	private int batchSize = 50;
-
-	private final Field fieldAces = FieldUtils.getField(AclImpl.class, "aces");
-
-	private final Field fieldAcl = FieldUtils.getField(AccessControlEntryImpl.class, "acl");
-
-	// SQL Customization fields
-	private String selectClause = DEFAULT_SELECT_CLAUSE;
-
-	private String lookupPrimaryKeysWhereClause = DEFAULT_LOOKUP_KEYS_WHERE_CLAUSE;
-
-	private String lookupObjectIdentitiesWhereClause = DEFAULT_LOOKUP_IDENTITIES_WHERE_CLAUSE;
-
-	private String orderByClause = DEFAULT_ORDER_BY_CLAUSE;
-
-	private AclClassIdUtils aclClassIdUtils;
-
-	/**
-	 * Constructor accepting mandatory arguments
-	 * @param dataSource to access the database
-	 * @param aclCache the cache where fully-loaded elements can be stored
-	 * @param aclAuthorizationStrategy authorization strategy (required)
-	 */
-	public BasicLookupStrategy(DataSource dataSource, AclCache aclCache,
-			AclAuthorizationStrategy aclAuthorizationStrategy, AuditLogger auditLogger) {
-		this(dataSource, aclCache, aclAuthorizationStrategy, new DefaultPermissionGrantingStrategy(auditLogger));
-	}
-
-	/**
-	 * Creates a new instance
-	 * @param dataSource to access the database
-	 * @param aclCache the cache where fully-loaded elements can be stored
-	 * @param aclAuthorizationStrategy authorization strategy (required)
-	 * @param grantingStrategy the PermissionGrantingStrategy
-	 */
-	public BasicLookupStrategy(DataSource dataSource, AclCache aclCache,
-			AclAuthorizationStrategy aclAuthorizationStrategy, PermissionGrantingStrategy grantingStrategy) {
-		Assert.notNull(dataSource, "DataSource required");
-		Assert.notNull(aclCache, "AclCache required");
-		Assert.notNull(aclAuthorizationStrategy, "AclAuthorizationStrategy required");
-		Assert.notNull(grantingStrategy, "grantingStrategy required");
-		this.jdbcTemplate = new JdbcTemplate(dataSource);
-		this.aclCache = aclCache;
-		this.aclAuthorizationStrategy = aclAuthorizationStrategy;
-		this.grantingStrategy = grantingStrategy;
-		this.objectIdentityGenerator = new ObjectIdentityRetrievalStrategyImpl();
-		this.aclClassIdUtils = new AclClassIdUtils();
-		this.fieldAces.setAccessible(true);
-		this.fieldAcl.setAccessible(true);
-	}
-
-	private String computeRepeatingSql(String repeatingSql, int requiredRepetitions) {
-		Assert.isTrue(requiredRepetitions > 0, "requiredRepetitions must be > 0");
-		String startSql = this.selectClause;
-		String endSql = this.orderByClause;
-		StringBuilder sqlStringBldr = new StringBuilder(
-				startSql.length() + endSql.length() + requiredRepetitions * (repeatingSql.length() + 4));
-		sqlStringBldr.append(startSql);
-		for (int i = 1; i <= requiredRepetitions; i++) {
-			sqlStringBldr.append(repeatingSql);
-			if (i != requiredRepetitions) {
-				sqlStringBldr.append(" or ");
-			}
-		}
-		sqlStringBldr.append(endSql);
-		return sqlStringBldr.toString();
-	}
-
-	@SuppressWarnings("unchecked")
-	private List<AccessControlEntryImpl> readAces(AclImpl acl) {
-		try {
-			return (List<AccessControlEntryImpl>) this.fieldAces.get(acl);
-		}
-		catch (IllegalAccessException ex) {
-			throw new IllegalStateException("Could not obtain AclImpl.aces field", ex);
-		}
-	}
-
-	private void setAclOnAce(AccessControlEntryImpl ace, AclImpl acl) {
-		try {
-			this.fieldAcl.set(ace, acl);
-		}
-		catch (IllegalAccessException ex) {
-			throw new IllegalStateException("Could not or set AclImpl on AccessControlEntryImpl fields", ex);
-		}
-	}
-
-	private void setAces(AclImpl acl, List<AccessControlEntryImpl> aces) {
-		try {
-			this.fieldAces.set(acl, aces);
-		}
-		catch (IllegalAccessException ex) {
-			throw new IllegalStateException("Could not set AclImpl entries", ex);
-		}
-	}
-
-	/**
-	 * Locates the primary key IDs specified in "findNow", adding AclImpl instances with
-	 * StubAclParents to the "acls" Map.
-	 * @param acls the AclImpls (with StubAclParents)
-	 * @param findNow Long-based primary keys to retrieve
-	 * @param sids
-	 */
-	private void lookupPrimaryKeys(final Map<Serializable, Acl> acls, final Set<Long> findNow, final List<Sid> sids) {
-		Assert.notNull(acls, "ACLs are required");
-		Assert.notEmpty(findNow, "Items to find now required");
-		String sql = computeRepeatingSql(this.lookupPrimaryKeysWhereClause, findNow.size());
-		Set<Long> parentsToLookup = this.jdbcTemplate.query(sql, (ps) -> setKeys(ps, findNow),
-				new ProcessResultSet(acls, sids));
-		// Lookup the parents, now that our JdbcTemplate has released the database
-		// connection (SEC-547)
-		if (parentsToLookup.size() > 0) {
-			lookupPrimaryKeys(acls, parentsToLookup, sids);
-		}
-	}
-
-	private void setKeys(PreparedStatement ps, Set<Long> findNow) throws SQLException {
-		int i = 0;
-		for (Long toFind : findNow) {
-			i++;
-			ps.setLong(i, toFind);
-		}
-	}
-
-	/**
-	 * The main method.
-	 * <p>
-	 * WARNING: This implementation completely disregards the "sids" argument! Every item
-	 * in the cache is expected to contain all SIDs. If you have serious performance needs
-	 * (e.g. a very large number of SIDs per object identity), you'll probably want to
-	 * develop a custom {@link LookupStrategy} implementation instead.
-	 * <p>
-	 * The implementation works in batch sizes specified by {@link #batchSize}.
-	 * @param objects the identities to lookup (required)
-	 * @param sids the SIDs for which identities are required (ignored by this
-	 * implementation)
-	 * @return a <tt>Map</tt> where keys represent the {@link ObjectIdentity} of the
-	 * located {@link Acl} and values are the located {@link Acl} (never <tt>null</tt>
-	 * although some entries may be missing; this method should not throw
-	 * {@link NotFoundException}, as a chain of {@link LookupStrategy}s may be used to
-	 * automatically create entries if required)
-	 */
-	@Override
-	public final Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects, List<Sid> sids) {
-		Assert.isTrue(this.batchSize >= 1, "BatchSize must be >= 1");
-		Assert.notEmpty(objects, "Objects to lookup required");
-		// Map<ObjectIdentity,Acl>
-		// contains FULLY loaded Acl objects
-		Map<ObjectIdentity, Acl> result = new HashMap<>();
-		Set<ObjectIdentity> currentBatchToLoad = new HashSet<>();
-		for (int i = 0; i < objects.size(); i++) {
-			final ObjectIdentity oid = objects.get(i);
-			boolean aclFound = false;
-			// Check we don't already have this ACL in the results
-			if (result.containsKey(oid)) {
-				aclFound = true;
-			}
-			// Check cache for the present ACL entry
-			if (!aclFound) {
-				Acl acl = this.aclCache.getFromCache(oid);
-				// Ensure any cached element supports all the requested SIDs
-				// (they should always, as our base impl doesn't filter on SID)
-				if (acl != null) {
-					Assert.state(acl.isSidLoaded(sids),
-							"Error: SID-filtered element detected when implementation does not perform SID filtering "
-									+ "- have you added something to the cache manually?");
-					result.put(acl.getObjectIdentity(), acl);
-					aclFound = true;
-				}
-			}
-			// Load the ACL from the database
-			if (!aclFound) {
-				currentBatchToLoad.add(oid);
-			}
-			// Is it time to load from JDBC the currentBatchToLoad?
-			if ((currentBatchToLoad.size() == this.batchSize) || ((i + 1) == objects.size())) {
-				if (currentBatchToLoad.size() > 0) {
-					Map<ObjectIdentity, Acl> loadedBatch = lookupObjectIdentities(currentBatchToLoad, sids);
-					// Add loaded batch (all elements 100% initialized) to results
-					result.putAll(loadedBatch);
-					// Add the loaded batch to the cache
-					for (Acl loadedAcl : loadedBatch.values()) {
-						this.aclCache.putInCache((AclImpl) loadedAcl);
-					}
-					currentBatchToLoad.clear();
-				}
-			}
-		}
-		return result;
-	}
-
-	/**
-	 * Looks up a batch of <code>ObjectIdentity</code>s directly from the database.
-	 * <p>
-	 * The caller is responsible for optimization issues, such as selecting the identities
-	 * to lookup, ensuring the cache doesn't contain them already, and adding the returned
-	 * elements to the cache etc.
-	 * <p>
-	 * This subclass is required to return fully valid <code>Acl</code>s, including
-	 * properly-configured parent ACLs.
-	 */
-	private Map<ObjectIdentity, Acl> lookupObjectIdentities(final Collection<ObjectIdentity> objectIdentities,
-			List<Sid> sids) {
-		Assert.notEmpty(objectIdentities, "Must provide identities to lookup");
-
-		// contains Acls with StubAclParents
-		Map<Serializable, Acl> acls = new HashMap<>();
-
-		// Make the "acls" map contain all requested objectIdentities
-		// (including markers to each parent in the hierarchy)
-		String sql = computeRepeatingSql(this.lookupObjectIdentitiesWhereClause, objectIdentities.size());
-
-		Set<Long> parentsToLookup = this.jdbcTemplate.query(sql,
-				(ps) -> setupLookupObjectIdentitiesStatement(ps, objectIdentities), new ProcessResultSet(acls, sids));
-
-		// Lookup the parents, now that our JdbcTemplate has released the database
-		// connection (SEC-547)
-		if (parentsToLookup.size() > 0) {
-			lookupPrimaryKeys(acls, parentsToLookup, sids);
-		}
-
-		// Finally, convert our "acls" containing StubAclParents into true Acls
-		Map<ObjectIdentity, Acl> resultMap = new HashMap<>();
-		for (Acl inputAcl : acls.values()) {
-			Assert.isInstanceOf(AclImpl.class, inputAcl, "Map should have contained an AclImpl");
-			Assert.isInstanceOf(Long.class, ((AclImpl) inputAcl).getId(), "Acl.getId() must be Long");
-			Acl result = convert(acls, (Long) ((AclImpl) inputAcl).getId());
-			resultMap.put(result.getObjectIdentity(), result);
-		}
-
-		return resultMap;
-	}
-
-	private void setupLookupObjectIdentitiesStatement(PreparedStatement ps, Collection<ObjectIdentity> objectIdentities)
-			throws SQLException {
-		int i = 0;
-		for (ObjectIdentity oid : objectIdentities) {
-			// Determine prepared statement values for this iteration
-			String type = oid.getType();
-
-			// No need to check for nulls, as guaranteed non-null by
-			// ObjectIdentity.getIdentifier() interface contract
-			String identifier = oid.getIdentifier().toString();
-
-			// Inject values
-			ps.setString((2 * i) + 1, identifier);
-			ps.setString((2 * i) + 2, type);
-			i++;
-		}
-	}
-
-	/**
-	 * The final phase of converting the <code>Map</code> of <code>AclImpl</code>
-	 * instances which contain <code>StubAclParent</code>s into proper, valid
-	 * <code>AclImpl</code>s with correct ACL parents.
-	 * @param inputMap the unconverted <code>AclImpl</code>s
-	 * @param currentIdentity the current<code>Acl</code> that we wish to convert (this
-	 * may be
-	 */
-	private AclImpl convert(Map<Serializable, Acl> inputMap, Long currentIdentity) {
-		Assert.notEmpty(inputMap, "InputMap required");
-		Assert.notNull(currentIdentity, "CurrentIdentity required");
-
-		// Retrieve this Acl from the InputMap
-		Acl uncastAcl = inputMap.get(currentIdentity);
-		Assert.isInstanceOf(AclImpl.class, uncastAcl, "The inputMap contained a non-AclImpl");
-
-		AclImpl inputAcl = (AclImpl) uncastAcl;
-
-		Acl parent = inputAcl.getParentAcl();
-
-		if ((parent != null) && parent instanceof StubAclParent) {
-			// Lookup the parent
-			StubAclParent stubAclParent = (StubAclParent) parent;
-			parent = convert(inputMap, stubAclParent.getId());
-		}
-
-		// Now we have the parent (if there is one), create the true AclImpl
-		AclImpl result = new AclImpl(inputAcl.getObjectIdentity(), inputAcl.getId(), this.aclAuthorizationStrategy,
-				this.grantingStrategy, parent, null, inputAcl.isEntriesInheriting(), inputAcl.getOwner());
-
-		// Copy the "aces" from the input to the destination
-
-		// Obtain the "aces" from the input ACL
-		List<AccessControlEntryImpl> aces = readAces(inputAcl);
-
-		// Create a list in which to store the "aces" for the "result" AclImpl instance
-		List<AccessControlEntryImpl> acesNew = new ArrayList<>();
-
-		// Iterate over the "aces" input and replace each nested
-		// AccessControlEntryImpl.getAcl() with the new "result" AclImpl instance
-		// This ensures StubAclParent instances are removed, as per SEC-951
-		for (AccessControlEntryImpl ace : aces) {
-			setAclOnAce(ace, result);
-			acesNew.add(ace);
-		}
-
-		// Finally, now that the "aces" have been converted to have the "result" AclImpl
-		// instance, modify the "result" AclImpl instance
-		setAces(result, acesNew);
-
-		return result;
-	}
-
-	/**
-	 * Creates a particular implementation of {@link Sid} depending on the arguments.
-	 * @param sid the name of the sid representing its unique identifier. In typical ACL
-	 * database schema it's located in table {@code acl_sid} table, {@code sid} column.
-	 * @param isPrincipal whether it's a user or granted authority like role
-	 * @return the instance of Sid with the {@code sidName} as an identifier
-	 */
-	protected Sid createSid(boolean isPrincipal, String sid) {
-		if (isPrincipal) {
-			return new PrincipalSid(sid);
-		}
-		return new GrantedAuthoritySid(sid);
-	}
-
-	/**
-	 * Sets the {@code PermissionFactory} instance which will be used to convert loaded
-	 * permission data values to {@code Permission}s. A {@code DefaultPermissionFactory}
-	 * will be used by default.
-	 * @param permissionFactory
-	 */
-	public final void setPermissionFactory(PermissionFactory permissionFactory) {
-		this.permissionFactory = permissionFactory;
-	}
-
-	public final void setBatchSize(int batchSize) {
-		this.batchSize = batchSize;
-	}
-
-	/**
-	 * The SQL for the select clause. If customizing in order to modify column names,
-	 * schema etc, the other SQL customization fields must also be set to match.
-	 * @param selectClause the select clause, which defaults to
-	 * {@link #DEFAULT_SELECT_CLAUSE}.
-	 */
-	public final void setSelectClause(String selectClause) {
-		this.selectClause = selectClause;
-	}
-
-	/**
-	 * The SQL for the where clause used in the <tt>lookupPrimaryKey</tt> method.
-	 */
-	public final void setLookupPrimaryKeysWhereClause(String lookupPrimaryKeysWhereClause) {
-		this.lookupPrimaryKeysWhereClause = lookupPrimaryKeysWhereClause;
-	}
-
-	/**
-	 * The SQL for the where clause used in the <tt>lookupObjectIdentities</tt> method.
-	 */
-	public final void setLookupObjectIdentitiesWhereClause(String lookupObjectIdentitiesWhereClause) {
-		this.lookupObjectIdentitiesWhereClause = lookupObjectIdentitiesWhereClause;
-	}
-
-	/**
-	 * The SQL for the "order by" clause used in both queries.
-	 */
-	public final void setOrderByClause(String orderByClause) {
-		this.orderByClause = orderByClause;
-	}
-
-	public final void setAclClassIdSupported(boolean aclClassIdSupported) {
-		if (aclClassIdSupported) {
-			Assert.isTrue(this.selectClause.equals(DEFAULT_SELECT_CLAUSE),
-					"Cannot set aclClassIdSupported and override the select clause; "
-							+ "just override the select clause");
-			this.selectClause = DEFAULT_ACL_CLASS_ID_SELECT_CLAUSE;
-		}
-	}
-
-	public final void setObjectIdentityGenerator(ObjectIdentityGenerator objectIdentityGenerator) {
-		Assert.notNull(objectIdentityGenerator, "objectIdentityGenerator cannot be null");
-		this.objectIdentityGenerator = objectIdentityGenerator;
-	}
-
-	public final void setConversionService(ConversionService conversionService) {
-		this.aclClassIdUtils = new AclClassIdUtils(conversionService);
-	}
-
-	private class ProcessResultSet implements ResultSetExtractor<Set<Long>> {
-
-		private final Map<Serializable, Acl> acls;
-
-		private final List<Sid> sids;
-
-		ProcessResultSet(Map<Serializable, Acl> acls, List<Sid> sids) {
-			Assert.notNull(acls, "ACLs cannot be null");
-			this.acls = acls;
-			this.sids = sids; // can be null
-		}
-
-		/**
-		 * Implementation of {@link ResultSetExtractor#extractData(ResultSet)}. Creates an
-		 * {@link Acl} for each row in the {@link ResultSet} and ensures it is in member
-		 * field <tt>acls</tt>. Any {@link Acl} with a parent will have the parents id
-		 * returned in a set. The returned set of ids may requires further processing.
-		 * @param rs The {@link ResultSet} to be processed
-		 * @return a list of parent IDs remaining to be looked up (may be empty, but never
-		 * <tt>null</tt>)
-		 * @throws SQLException
-		 */
-		@Override
-		public Set<Long> extractData(ResultSet rs) throws SQLException {
-			Set<Long> parentIdsToLookup = new HashSet<>(); // Set of parent_id Longs
-
-			while (rs.next()) {
-				// Convert current row into an Acl (albeit with a StubAclParent)
-				convertCurrentResultIntoObject(this.acls, rs);
-
-				// Figure out if this row means we need to lookup another parent
-				long parentId = rs.getLong("parent_object");
-
-				if (parentId != 0) {
-					// See if it's already in the "acls"
-					if (this.acls.containsKey(parentId)) {
-						continue; // skip this while iteration
-					}
-
-					// Now try to find it in the cache
-					MutableAcl cached = BasicLookupStrategy.this.aclCache.getFromCache(parentId);
-					if ((cached == null) || !cached.isSidLoaded(this.sids)) {
-						parentIdsToLookup.add(parentId);
-					}
-					else {
-						// Pop into the acls map, so our convert method doesn't
-						// need to deal with an unsynchronized AclCache
-						this.acls.put(cached.getId(), cached);
-					}
-				}
-			}
-
-			// Return the parents left to lookup to the caller
-			return parentIdsToLookup;
-		}
-
-		/**
-		 * Accepts the current <code>ResultSet</code> row, and converts it into an
-		 * <code>AclImpl</code> that contains a <code>StubAclParent</code>
-		 * @param acls the Map we should add the converted Acl to
-		 * @param rs the ResultSet focused on a current row
-		 * @throws SQLException if something goes wrong converting values
-		 * @throws ConversionException if can't convert to the desired Java type
-		 */
-		private void convertCurrentResultIntoObject(Map<Serializable, Acl> acls, ResultSet rs) throws SQLException {
-			Long id = rs.getLong("acl_id");
-
-			// If we already have an ACL for this ID, just create the ACE
-			Acl acl = acls.get(id);
-
-			if (acl == null) {
-				// Make an AclImpl and pop it into the Map
-
-				// If the Java type is a String, check to see if we can convert it to the
-				// target id type, e.g. UUID.
-				Serializable identifier = (Serializable) rs.getObject("object_id_identity");
-				identifier = BasicLookupStrategy.this.aclClassIdUtils.identifierFrom(identifier, rs);
-				ObjectIdentity objectIdentity = BasicLookupStrategy.this.objectIdentityGenerator
-					.createObjectIdentity(identifier, rs.getString("class"));
-
-				Acl parentAcl = null;
-				long parentAclId = rs.getLong("parent_object");
-
-				if (parentAclId != 0) {
-					parentAcl = new StubAclParent(parentAclId);
-				}
-
-				boolean entriesInheriting = rs.getBoolean("entries_inheriting");
-				Sid owner = createSid(rs.getBoolean("acl_principal"), rs.getString("acl_sid"));
-
-				acl = new AclImpl(objectIdentity, id, BasicLookupStrategy.this.aclAuthorizationStrategy,
-						BasicLookupStrategy.this.grantingStrategy, parentAcl, null, entriesInheriting, owner);
-
-				acls.put(id, acl);
-			}
-
-			// Add an extra ACE to the ACL (ORDER BY maintains the ACE list order)
-			// It is permissible to have no ACEs in an ACL (which is detected by a null
-			// ACE_SID)
-			if (rs.getString("ace_sid") != null) {
-				Long aceId = rs.getLong("ace_id");
-				Sid recipient = createSid(rs.getBoolean("ace_principal"), rs.getString("ace_sid"));
-
-				int mask = rs.getInt("mask");
-				Permission permission = BasicLookupStrategy.this.permissionFactory.buildFromMask(mask);
-				boolean granting = rs.getBoolean("granting");
-				boolean auditSuccess = rs.getBoolean("audit_success");
-				boolean auditFailure = rs.getBoolean("audit_failure");
-
-				AccessControlEntryImpl ace = new AccessControlEntryImpl(aceId, acl, recipient, permission, granting,
-						auditSuccess, auditFailure);
-
-				// Field acesField = FieldUtils.getField(AclImpl.class, "aces");
-				List<AccessControlEntryImpl> aces = readAces((AclImpl) acl);
-
-				// Add the ACE if it doesn't already exist in the ACL.aces field
-				if (!aces.contains(ace)) {
-					aces.add(ace);
-				}
-			}
-		}
-
-	}
-
-	private static class StubAclParent implements Acl {
-
-		private final Long id;
-
-		StubAclParent(Long id) {
-			this.id = id;
-		}
-
-		Long getId() {
-			return this.id;
-		}
-
-		@Override
-		public List<AccessControlEntry> getEntries() {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-		@Override
-		public ObjectIdentity getObjectIdentity() {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-		@Override
-		public Sid getOwner() {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-		@Override
-		public Acl getParentAcl() {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-		@Override
-		public boolean isEntriesInheriting() {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-		@Override
-		public boolean isGranted(List<Permission> permission, List<Sid> sids, boolean administrativeMode)
-				throws NotFoundException, UnloadedSidException {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-		@Override
-		public boolean isSidLoaded(List<Sid> sids) {
-			throw new UnsupportedOperationException("Stub only");
-		}
-
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/jdbc/JdbcAclService.java

@@ -1,181 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006, 2017, 2018 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.jdbc;
-
-import java.io.Serializable;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.util.Collections;
-import java.util.List;
-import java.util.Map;
-
-import javax.sql.DataSource;
-
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
-import org.springframework.core.convert.ConversionService;
-import org.springframework.jdbc.core.JdbcOperations;
-import org.springframework.jdbc.core.JdbcTemplate;
-import org.springframework.security.acls.domain.ObjectIdentityRetrievalStrategyImpl;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AclService;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.ObjectIdentityGenerator;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.util.Assert;
-
-/**
- * Simple JDBC-based implementation of <code>AclService</code>.
- * <p>
- * Requires the "dirty" flags in {@link org.springframework.security.acls.domain.AclImpl}
- * and {@link org.springframework.security.acls.domain.AccessControlEntryImpl} to be set,
- * so that the implementation can detect changed parameters easily.
- *
- * @author Ben Alex
- */
-public class JdbcAclService implements AclService {
-
-	protected static final Log log = LogFactory.getLog(JdbcAclService.class);
-
-	private static final String DEFAULT_SELECT_ACL_CLASS_COLUMNS = "class.class as class";
-
-	private static final String DEFAULT_SELECT_ACL_CLASS_COLUMNS_WITH_ID_TYPE = DEFAULT_SELECT_ACL_CLASS_COLUMNS
-			+ ", class.class_id_type as class_id_type";
-
-	private static final String DEFAULT_SELECT_ACL_WITH_PARENT_SQL = "select obj.object_id_identity as obj_id, "
-			+ DEFAULT_SELECT_ACL_CLASS_COLUMNS
-			+ " from acl_object_identity obj, acl_object_identity parent, acl_class class "
-			+ "where obj.parent_object = parent.id and obj.object_id_class = class.id "
-			+ "and parent.object_id_identity = ? and parent.object_id_class = ("
-			+ "select id FROM acl_class where acl_class.class = ?)";
-
-	private static final String DEFAULT_SELECT_ACL_WITH_PARENT_SQL_WITH_CLASS_ID_TYPE = "select obj.object_id_identity as obj_id, "
-			+ DEFAULT_SELECT_ACL_CLASS_COLUMNS_WITH_ID_TYPE
-			+ " from acl_object_identity obj, acl_object_identity parent, acl_class class "
-			+ "where obj.parent_object = parent.id and obj.object_id_class = class.id "
-			+ "and parent.object_id_identity = ? and parent.object_id_class = ("
-			+ "select id FROM acl_class where acl_class.class = ?)";
-
-	protected final JdbcOperations jdbcOperations;
-
-	private final LookupStrategy lookupStrategy;
-
-	private boolean aclClassIdSupported;
-
-	private String findChildrenSql = DEFAULT_SELECT_ACL_WITH_PARENT_SQL;
-
-	private AclClassIdUtils aclClassIdUtils;
-
-	private ObjectIdentityGenerator objectIdentityGenerator;
-
-	public JdbcAclService(DataSource dataSource, LookupStrategy lookupStrategy) {
-		this(new JdbcTemplate(dataSource), lookupStrategy);
-	}
-
-	public JdbcAclService(JdbcOperations jdbcOperations, LookupStrategy lookupStrategy) {
-		Assert.notNull(jdbcOperations, "JdbcOperations required");
-		Assert.notNull(lookupStrategy, "LookupStrategy required");
-		this.jdbcOperations = jdbcOperations;
-		this.lookupStrategy = lookupStrategy;
-		this.aclClassIdUtils = new AclClassIdUtils();
-		this.objectIdentityGenerator = new ObjectIdentityRetrievalStrategyImpl();
-	}
-
-	@Override
-	public List<ObjectIdentity> findChildren(ObjectIdentity parentIdentity) {
-		Object[] args = { parentIdentity.getIdentifier().toString(), parentIdentity.getType() };
-		List<ObjectIdentity> objects = this.jdbcOperations.query(this.findChildrenSql, args,
-				(rs, rowNum) -> mapObjectIdentityRow(rs));
-		return (!objects.isEmpty()) ? objects : null;
-	}
-
-	private ObjectIdentity mapObjectIdentityRow(ResultSet rs) throws SQLException {
-		String javaType = rs.getString("class");
-		Serializable identifier = (Serializable) rs.getObject("obj_id");
-		identifier = this.aclClassIdUtils.identifierFrom(identifier, rs);
-		return this.objectIdentityGenerator.createObjectIdentity(identifier, javaType);
-	}
-
-	@Override
-	public Acl readAclById(ObjectIdentity object, List<Sid> sids) throws NotFoundException {
-		Map<ObjectIdentity, Acl> map = readAclsById(Collections.singletonList(object), sids);
-		Assert.isTrue(map.containsKey(object),
-				() -> "There should have been an Acl entry for ObjectIdentity " + object);
-		return map.get(object);
-	}
-
-	@Override
-	public Acl readAclById(ObjectIdentity object) throws NotFoundException {
-		return readAclById(object, null);
-	}
-
-	@Override
-	public Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects) throws NotFoundException {
-		return readAclsById(objects, null);
-	}
-
-	@Override
-	public Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects, List<Sid> sids)
-			throws NotFoundException {
-		Map<ObjectIdentity, Acl> result = this.lookupStrategy.readAclsById(objects, sids);
-		// Check every requested object identity was found (throw NotFoundException if
-		// needed)
-		for (ObjectIdentity oid : objects) {
-			if (!result.containsKey(oid)) {
-				throw new NotFoundException("Unable to find ACL information for object identity '" + oid + "'");
-			}
-		}
-		return result;
-	}
-
-	/**
-	 * Allows customization of the SQL query used to find child object identities.
-	 * @param findChildrenSql
-	 */
-	public void setFindChildrenQuery(String findChildrenSql) {
-		this.findChildrenSql = findChildrenSql;
-	}
-
-	public void setAclClassIdSupported(boolean aclClassIdSupported) {
-		this.aclClassIdSupported = aclClassIdSupported;
-		if (aclClassIdSupported) {
-			// Change the default children select if it hasn't been overridden
-			if (this.findChildrenSql.equals(DEFAULT_SELECT_ACL_WITH_PARENT_SQL)) {
-				this.findChildrenSql = DEFAULT_SELECT_ACL_WITH_PARENT_SQL_WITH_CLASS_ID_TYPE;
-			}
-			else {
-				log.debug("Find children statement has already been overridden, so not overridding the default");
-			}
-		}
-	}
-
-	public void setConversionService(ConversionService conversionService) {
-		this.aclClassIdUtils = new AclClassIdUtils(conversionService);
-	}
-
-	public void setObjectIdentityGenerator(ObjectIdentityGenerator objectIdentityGenerator) {
-		Assert.notNull(objectIdentityGenerator, "objectIdentityGenerator cannot be null");
-		this.objectIdentityGenerator = objectIdentityGenerator;
-	}
-
-	protected boolean isAclClassIdSupported() {
-		return this.aclClassIdSupported;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/jdbc/JdbcMutableAclService.java

@@ -1,491 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006, 2017, 2018 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.jdbc;
-
-import java.sql.PreparedStatement;
-import java.sql.SQLException;
-import java.util.List;
-
-import javax.sql.DataSource;
-
-import org.springframework.dao.DataAccessException;
-import org.springframework.jdbc.core.BatchPreparedStatementSetter;
-import org.springframework.security.acls.domain.AccessControlEntryImpl;
-import org.springframework.security.acls.domain.GrantedAuthoritySid;
-import org.springframework.security.acls.domain.ObjectIdentityImpl;
-import org.springframework.security.acls.domain.PrincipalSid;
-import org.springframework.security.acls.model.AccessControlEntry;
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.AclCache;
-import org.springframework.security.acls.model.AlreadyExistsException;
-import org.springframework.security.acls.model.ChildrenExistException;
-import org.springframework.security.acls.model.MutableAcl;
-import org.springframework.security.acls.model.MutableAclService;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.Sid;
-import org.springframework.security.core.Authentication;
-import org.springframework.security.core.context.SecurityContextHolder;
-import org.springframework.security.core.context.SecurityContextHolderStrategy;
-import org.springframework.transaction.support.TransactionSynchronizationManager;
-import org.springframework.util.Assert;
-
-/**
- * Provides a base JDBC implementation of {@link MutableAclService}.
- * <p>
- * The default settings are for HSQLDB. If you are using a different database you will
- * probably need to set the {@link #setSidIdentityQuery(String) sidIdentityQuery} and
- * {@link #setClassIdentityQuery(String) classIdentityQuery} properties appropriately. The
- * other queries, SQL inserts and updates can also be customized to accomodate schema
- * variations, but must produce results consistent with those expected by the defaults.
- * <p>
- * See the appendix of the Spring Security reference manual for more information on the
- * expected schema and how it is used. Information on using PostgreSQL is also included.
- *
- * @author Ben Alex
- * @author Johannes Zlattinger
- */
-public class JdbcMutableAclService extends JdbcAclService implements MutableAclService {
-
-	private static final String DEFAULT_INSERT_INTO_ACL_CLASS = "insert into acl_class (class) values (?)";
-
-	private static final String DEFAULT_INSERT_INTO_ACL_CLASS_WITH_ID = "insert into acl_class (class, class_id_type) values (?, ?)";
-
-	private SecurityContextHolderStrategy securityContextHolderStrategy = SecurityContextHolder
-		.getContextHolderStrategy();
-
-	private boolean foreignKeysInDatabase = true;
-
-	private final AclCache aclCache;
-
-	private String deleteEntryByObjectIdentityForeignKey = "delete from acl_entry where acl_object_identity=?";
-
-	private String deleteObjectIdentityByPrimaryKey = "delete from acl_object_identity where id=?";
-
-	private String classIdentityQuery = "call identity()";
-
-	private String sidIdentityQuery = "call identity()";
-
-	private String insertClass = DEFAULT_INSERT_INTO_ACL_CLASS;
-
-	private String insertEntry = "insert into acl_entry "
-			+ "(acl_object_identity, ace_order, sid, mask, granting, audit_success, audit_failure)"
-			+ "values (?, ?, ?, ?, ?, ?, ?)";
-
-	private String insertObjectIdentity = "insert into acl_object_identity "
-			+ "(object_id_class, object_id_identity, owner_sid, entries_inheriting) " + "values (?, ?, ?, ?)";
-
-	private String insertSid = "insert into acl_sid (principal, sid) values (?, ?)";
-
-	private String selectClassPrimaryKey = "select id from acl_class where class=?";
-
-	private String selectObjectIdentityPrimaryKey = "select acl_object_identity.id from acl_object_identity, acl_class "
-			+ "where acl_object_identity.object_id_class = acl_class.id and acl_class.class=? "
-			+ "and acl_object_identity.object_id_identity = ?";
-
-	private String selectSidPrimaryKey = "select id from acl_sid where principal=? and sid=?";
-
-	private String updateObjectIdentity = "update acl_object_identity set "
-			+ "parent_object = ?, owner_sid = ?, entries_inheriting = ?" + " where id = ?";
-
-	public JdbcMutableAclService(DataSource dataSource, LookupStrategy lookupStrategy, AclCache aclCache) {
-		super(dataSource, lookupStrategy);
-		Assert.notNull(aclCache, "AclCache required");
-		this.aclCache = aclCache;
-	}
-
-	@Override
-	public MutableAcl createAcl(ObjectIdentity objectIdentity) throws AlreadyExistsException {
-		Assert.notNull(objectIdentity, "Object Identity required");
-
-		// Check this object identity hasn't already been persisted
-		if (retrieveObjectIdentityPrimaryKey(objectIdentity) != null) {
-			throw new AlreadyExistsException("Object identity '" + objectIdentity + "' already exists");
-		}
-
-		// Need to retrieve the current principal, in order to know who "owns" this ACL
-		// (can be changed later on)
-		Authentication auth = this.securityContextHolderStrategy.getContext().getAuthentication();
-		PrincipalSid sid = new PrincipalSid(auth);
-
-		// Create the acl_object_identity row
-		createObjectIdentity(objectIdentity, sid);
-
-		// Retrieve the ACL via superclass (ensures cache registration, proper retrieval
-		// etc)
-		Acl acl = readAclById(objectIdentity);
-		Assert.isInstanceOf(MutableAcl.class, acl, "MutableAcl should be been returned");
-
-		return (MutableAcl) acl;
-	}
-
-	/**
-	 * Creates a new row in acl_entry for every ACE defined in the passed MutableAcl
-	 * object.
-	 * @param acl containing the ACEs to insert
-	 */
-	protected void createEntries(final MutableAcl acl) {
-		if (acl.getEntries().isEmpty()) {
-			return;
-		}
-		this.jdbcOperations.batchUpdate(this.insertEntry, new BatchPreparedStatementSetter() {
-
-			@Override
-			public int getBatchSize() {
-				return acl.getEntries().size();
-			}
-
-			@Override
-			public void setValues(PreparedStatement stmt, int i) throws SQLException {
-				AccessControlEntry entry_ = acl.getEntries().get(i);
-				Assert.isTrue(entry_ instanceof AccessControlEntryImpl, "Unknown ACE class");
-				AccessControlEntryImpl entry = (AccessControlEntryImpl) entry_;
-
-				stmt.setLong(1, (Long) acl.getId());
-				stmt.setInt(2, i);
-				stmt.setLong(3, createOrRetrieveSidPrimaryKey(entry.getSid(), true));
-				stmt.setInt(4, entry.getPermission().getMask());
-				stmt.setBoolean(5, entry.isGranting());
-				stmt.setBoolean(6, entry.isAuditSuccess());
-				stmt.setBoolean(7, entry.isAuditFailure());
-			}
-
-		});
-	}
-
-	/**
-	 * Creates an entry in the acl_object_identity table for the passed ObjectIdentity.
-	 * The Sid is also necessary, as acl_object_identity has defined the sid column as
-	 * non-null.
-	 * @param object to represent an acl_object_identity for
-	 * @param owner for the SID column (will be created if there is no acl_sid entry for
-	 * this particular Sid already)
-	 */
-	protected void createObjectIdentity(ObjectIdentity object, Sid owner) {
-		Long sidId = createOrRetrieveSidPrimaryKey(owner, true);
-		Long classId = createOrRetrieveClassPrimaryKey(object.getType(), true, object.getIdentifier().getClass());
-		this.jdbcOperations.update(this.insertObjectIdentity, classId, object.getIdentifier().toString(), sidId,
-				Boolean.TRUE);
-	}
-
-	/**
-	 * Retrieves the primary key from {@code acl_class}, creating a new row if needed and
-	 * the {@code allowCreate} property is {@code true}.
-	 * @param type to find or create an entry for (often the fully-qualified class name)
-	 * @param allowCreate true if creation is permitted if not found
-	 * @return the primary key or null if not found
-	 */
-	protected Long createOrRetrieveClassPrimaryKey(String type, boolean allowCreate, Class idType) {
-		List<Long> classIds = this.jdbcOperations.queryForList(this.selectClassPrimaryKey, new Object[] { type },
-				Long.class);
-
-		if (!classIds.isEmpty()) {
-			return classIds.get(0);
-		}
-
-		if (allowCreate) {
-			if (!isAclClassIdSupported()) {
-				this.jdbcOperations.update(this.insertClass, type);
-			}
-			else {
-				this.jdbcOperations.update(this.insertClass, type, idType.getCanonicalName());
-			}
-			Assert.isTrue(TransactionSynchronizationManager.isSynchronizationActive(), "Transaction must be running");
-			return this.jdbcOperations.queryForObject(this.classIdentityQuery, Long.class);
-		}
-
-		return null;
-	}
-
-	/**
-	 * Retrieves the primary key from acl_sid, creating a new row if needed and the
-	 * allowCreate property is true.
-	 * @param sid to find or create
-	 * @param allowCreate true if creation is permitted if not found
-	 * @return the primary key or null if not found
-	 * @throws IllegalArgumentException if the <tt>Sid</tt> is not a recognized
-	 * implementation.
-	 */
-	protected Long createOrRetrieveSidPrimaryKey(Sid sid, boolean allowCreate) {
-		Assert.notNull(sid, "Sid required");
-		if (sid instanceof PrincipalSid) {
-			String sidName = ((PrincipalSid) sid).getPrincipal();
-			return createOrRetrieveSidPrimaryKey(sidName, true, allowCreate);
-		}
-		if (sid instanceof GrantedAuthoritySid) {
-			String sidName = ((GrantedAuthoritySid) sid).getGrantedAuthority();
-			return createOrRetrieveSidPrimaryKey(sidName, false, allowCreate);
-		}
-		throw new IllegalArgumentException("Unsupported implementation of Sid");
-	}
-
-	/**
-	 * Retrieves the primary key from acl_sid, creating a new row if needed and the
-	 * allowCreate property is true.
-	 * @param sidName name of Sid to find or to create
-	 * @param sidIsPrincipal whether it's a user or granted authority like role
-	 * @param allowCreate true if creation is permitted if not found
-	 * @return the primary key or null if not found
-	 */
-	protected Long createOrRetrieveSidPrimaryKey(String sidName, boolean sidIsPrincipal, boolean allowCreate) {
-		List<Long> sidIds = this.jdbcOperations.queryForList(this.selectSidPrimaryKey,
-				new Object[] { sidIsPrincipal, sidName }, Long.class);
-		if (!sidIds.isEmpty()) {
-			return sidIds.get(0);
-		}
-		if (allowCreate) {
-			this.jdbcOperations.update(this.insertSid, sidIsPrincipal, sidName);
-			Assert.isTrue(TransactionSynchronizationManager.isSynchronizationActive(), "Transaction must be running");
-			return this.jdbcOperations.queryForObject(this.sidIdentityQuery, Long.class);
-		}
-		return null;
-	}
-
-	@Override
-	public void deleteAcl(ObjectIdentity objectIdentity, boolean deleteChildren) throws ChildrenExistException {
-		Assert.notNull(objectIdentity, "Object Identity required");
-		Assert.notNull(objectIdentity.getIdentifier(), "Object Identity doesn't provide an identifier");
-		if (deleteChildren) {
-			List<ObjectIdentity> children = findChildren(objectIdentity);
-			if (children != null) {
-				for (ObjectIdentity child : children) {
-					deleteAcl(child, true);
-				}
-			}
-		}
-		else {
-			if (!this.foreignKeysInDatabase) {
-				// We need to perform a manual verification for what a FK would normally
-				// do. We generally don't do this, in the interests of deadlock management
-				List<ObjectIdentity> children = findChildren(objectIdentity);
-				if (children != null) {
-					throw new ChildrenExistException(
-							"Cannot delete '" + objectIdentity + "' (has " + children.size() + " children)");
-				}
-			}
-		}
-
-		Long oidPrimaryKey = retrieveObjectIdentityPrimaryKey(objectIdentity);
-
-		// Delete this ACL's ACEs in the acl_entry table
-		deleteEntries(oidPrimaryKey);
-
-		// Delete this ACL's acl_object_identity row
-		deleteObjectIdentity(oidPrimaryKey);
-
-		// Clear the cache
-		this.aclCache.evictFromCache(objectIdentity);
-	}
-
-	/**
-	 * Deletes all ACEs defined in the acl_entry table belonging to the presented
-	 * ObjectIdentity primary key.
-	 * @param oidPrimaryKey the rows in acl_entry to delete
-	 */
-	protected void deleteEntries(Long oidPrimaryKey) {
-		this.jdbcOperations.update(this.deleteEntryByObjectIdentityForeignKey, oidPrimaryKey);
-	}
-
-	/**
-	 * Deletes a single row from acl_object_identity that is associated with the presented
-	 * ObjectIdentity primary key.
-	 * <p>
-	 * We do not delete any entries from acl_class, even if no classes are using that
-	 * class any longer. This is a deadlock avoidance approach.
-	 * @param oidPrimaryKey to delete the acl_object_identity
-	 */
-	protected void deleteObjectIdentity(Long oidPrimaryKey) {
-		// Delete the acl_object_identity row
-		this.jdbcOperations.update(this.deleteObjectIdentityByPrimaryKey, oidPrimaryKey);
-	}
-
-	/**
-	 * Retrieves the primary key from the acl_object_identity table for the passed
-	 * ObjectIdentity. Unlike some other methods in this implementation, this method will
-	 * NOT create a row (use {@link #createObjectIdentity(ObjectIdentity, Sid)} instead).
-	 * @param oid to find
-	 * @return the object identity or null if not found
-	 */
-	protected Long retrieveObjectIdentityPrimaryKey(ObjectIdentity oid) {
-		try {
-			return this.jdbcOperations.queryForObject(this.selectObjectIdentityPrimaryKey, Long.class, oid.getType(),
-					oid.getIdentifier().toString());
-		}
-		catch (DataAccessException notFound) {
-			return null;
-		}
-	}
-
-	/**
-	 * This implementation will simply delete all ACEs in the database and recreate them
-	 * on each invocation of this method. A more comprehensive implementation might use
-	 * dirty state checking, or more likely use ORM capabilities for create, update and
-	 * delete operations of {@link MutableAcl}.
-	 */
-	@Override
-	public MutableAcl updateAcl(MutableAcl acl) throws NotFoundException {
-		Assert.notNull(acl.getId(), "Object Identity doesn't provide an identifier");
-
-		// Delete this ACL's ACEs in the acl_entry table
-		deleteEntries(retrieveObjectIdentityPrimaryKey(acl.getObjectIdentity()));
-
-		// Create this ACL's ACEs in the acl_entry table
-		createEntries(acl);
-
-		// Change the mutable columns in acl_object_identity
-		updateObjectIdentity(acl);
-
-		// Clear the cache, including children
-		clearCacheIncludingChildren(acl.getObjectIdentity());
-
-		// Retrieve the ACL via superclass (ensures cache registration, proper retrieval
-		// etc)
-		return (MutableAcl) super.readAclById(acl.getObjectIdentity());
-	}
-
-	private void clearCacheIncludingChildren(ObjectIdentity objectIdentity) {
-		Assert.notNull(objectIdentity, "ObjectIdentity required");
-		List<ObjectIdentity> children = findChildren(objectIdentity);
-		if (children != null) {
-			for (ObjectIdentity child : children) {
-				clearCacheIncludingChildren(child);
-			}
-		}
-		this.aclCache.evictFromCache(objectIdentity);
-	}
-
-	/**
-	 * Updates an existing acl_object_identity row, with new information presented in the
-	 * passed MutableAcl object. Also will create an acl_sid entry if needed for the Sid
-	 * that owns the MutableAcl.
-	 * @param acl to modify (a row must already exist in acl_object_identity)
-	 * @throws NotFoundException if the ACL could not be found to update.
-	 */
-	protected void updateObjectIdentity(MutableAcl acl) {
-		Long parentId = null;
-		if (acl.getParentAcl() != null) {
-			Assert.isInstanceOf(ObjectIdentityImpl.class, acl.getParentAcl().getObjectIdentity(),
-					"Implementation only supports ObjectIdentityImpl");
-			ObjectIdentityImpl oii = (ObjectIdentityImpl) acl.getParentAcl().getObjectIdentity();
-			parentId = retrieveObjectIdentityPrimaryKey(oii);
-		}
-		Assert.notNull(acl.getOwner(), "Owner is required in this implementation");
-		Long ownerSid = createOrRetrieveSidPrimaryKey(acl.getOwner(), true);
-		int count = this.jdbcOperations.update(this.updateObjectIdentity, parentId, ownerSid, acl.isEntriesInheriting(),
-				acl.getId());
-		if (count != 1) {
-			throw new NotFoundException("Unable to locate ACL to update");
-		}
-	}
-
-	/**
-	 * Sets the query that will be used to retrieve the identity of a newly created row in
-	 * the <tt>acl_class</tt> table.
-	 * @param classIdentityQuery the query, which should return the identifier. Defaults
-	 * to <tt>call identity()</tt>
-	 */
-	public void setClassIdentityQuery(String classIdentityQuery) {
-		Assert.hasText(classIdentityQuery, "New classIdentityQuery query is required");
-		this.classIdentityQuery = classIdentityQuery;
-	}
-
-	/**
-	 * Sets the query that will be used to retrieve the identity of a newly created row in
-	 * the <tt>acl_sid</tt> table.
-	 * @param sidIdentityQuery the query, which should return the identifier. Defaults to
-	 * <tt>call identity()</tt>
-	 */
-	public void setSidIdentityQuery(String sidIdentityQuery) {
-		Assert.hasText(sidIdentityQuery, "New sidIdentityQuery query is required");
-		this.sidIdentityQuery = sidIdentityQuery;
-	}
-
-	public void setDeleteEntryByObjectIdentityForeignKeySql(String deleteEntryByObjectIdentityForeignKey) {
-		this.deleteEntryByObjectIdentityForeignKey = deleteEntryByObjectIdentityForeignKey;
-	}
-
-	public void setDeleteObjectIdentityByPrimaryKeySql(String deleteObjectIdentityByPrimaryKey) {
-		this.deleteObjectIdentityByPrimaryKey = deleteObjectIdentityByPrimaryKey;
-	}
-
-	public void setInsertClassSql(String insertClass) {
-		this.insertClass = insertClass;
-	}
-
-	public void setInsertEntrySql(String insertEntry) {
-		this.insertEntry = insertEntry;
-	}
-
-	public void setInsertObjectIdentitySql(String insertObjectIdentity) {
-		this.insertObjectIdentity = insertObjectIdentity;
-	}
-
-	public void setInsertSidSql(String insertSid) {
-		this.insertSid = insertSid;
-	}
-
-	public void setClassPrimaryKeyQuery(String selectClassPrimaryKey) {
-		this.selectClassPrimaryKey = selectClassPrimaryKey;
-	}
-
-	public void setObjectIdentityPrimaryKeyQuery(String selectObjectIdentityPrimaryKey) {
-		this.selectObjectIdentityPrimaryKey = selectObjectIdentityPrimaryKey;
-	}
-
-	public void setSidPrimaryKeyQuery(String selectSidPrimaryKey) {
-		this.selectSidPrimaryKey = selectSidPrimaryKey;
-	}
-
-	public void setUpdateObjectIdentity(String updateObjectIdentity) {
-		this.updateObjectIdentity = updateObjectIdentity;
-	}
-
-	/**
-	 * @param foreignKeysInDatabase if false this class will perform additional FK
-	 * constrain checking, which may cause deadlocks (the default is true, so deadlocks
-	 * are avoided but the database is expected to enforce FKs)
-	 */
-	public void setForeignKeysInDatabase(boolean foreignKeysInDatabase) {
-		this.foreignKeysInDatabase = foreignKeysInDatabase;
-	}
-
-	@Override
-	public void setAclClassIdSupported(boolean aclClassIdSupported) {
-		super.setAclClassIdSupported(aclClassIdSupported);
-		if (aclClassIdSupported) {
-			// Change the default insert if it hasn't been overridden
-			if (this.insertClass.equals(DEFAULT_INSERT_INTO_ACL_CLASS)) {
-				this.insertClass = DEFAULT_INSERT_INTO_ACL_CLASS_WITH_ID;
-			}
-			else {
-				log.debug("Insert class statement has already been overridden, so not overridding the default");
-			}
-		}
-	}
-
-	/**
-	 * Sets the {@link SecurityContextHolderStrategy} to use. The default action is to use
-	 * the {@link SecurityContextHolderStrategy} stored in {@link SecurityContextHolder}.
-	 *
-	 * @since 5.8
-	 */
-	public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy) {
-		Assert.notNull(securityContextHolderStrategy, "securityContextHolderStrategy cannot be null");
-		this.securityContextHolderStrategy = securityContextHolderStrategy;
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/jdbc/LookupStrategy.java

@@ -1,47 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.jdbc;
-
-import java.util.List;
-import java.util.Map;
-
-import org.springframework.security.acls.model.Acl;
-import org.springframework.security.acls.model.NotFoundException;
-import org.springframework.security.acls.model.ObjectIdentity;
-import org.springframework.security.acls.model.Sid;
-
-/**
- * Performs lookups for {@link org.springframework.security.acls.model.AclService}.
- *
- * @author Ben Alex
- */
-public interface LookupStrategy {
-
-	/**
-	 * Perform database-specific optimized lookup.
-	 * @param objects the identities to lookup (required)
-	 * @param sids the SIDs for which identities are required (may be <tt>null</tt> -
-	 * implementations may elect not to provide SID optimisations)
-	 * @return a <tt>Map</tt> where keys represent the {@link ObjectIdentity} of the
-	 * located {@link Acl} and values are the located {@link Acl} (never <tt>null</tt>
-	 * although some entries may be missing; this method should not throw
-	 * {@link NotFoundException}, as a chain of {@link LookupStrategy}s may be used to
-	 * automatically create entries if required)
-	 */
-	Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects, List<Sid> sids);
-
-}

acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java

@@ -1,20 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * JDBC-based persistence of ACL information
- */
-package org.springframework.security.acls.jdbc;

acl/src/main/java/org/springframework/security/acls/model/AccessControlEntry.java

@@ -1,52 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-import java.io.Serializable;
-
-/**
- * Represents an individual permission assignment within an {@link Acl}.
- *
- * <p>
- * Instances MUST be immutable, as they are returned by <code>Acl</code> and should not
- * allow client modification.
- * </p>
- *
- * @author Ben Alex
- */
-public interface AccessControlEntry extends Serializable {
-
-	Acl getAcl();
-
-	/**
-	 * Obtains an identifier that represents this ACE.
-	 * @return the identifier, or <code>null</code> if unsaved
-	 */
-	Serializable getId();
-
-	Permission getPermission();
-
-	Sid getSid();
-
-	/**
-	 * Indicates the permission is being granted to the relevant Sid. If false, indicates
-	 * the permission is being revoked/blocked.
-	 * @return true if being granted, false otherwise
-	 */
-	boolean isGranting();
-
-}

acl/src/main/java/org/springframework/security/acls/model/Acl.java

@@ -1,194 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-import java.io.Serializable;
-import java.util.List;
-
-/**
- * Represents an access control list (ACL) for a domain object.
- *
- * <p>
- * An <tt>Acl</tt> represents all ACL entries for a given domain object. In order to avoid
- * needing references to the domain object itself, this interface handles indirection
- * between a domain object and an ACL object identity via the
- * {@link org.springframework.security.acls.model.ObjectIdentity} interface.
- * </p>
- *
- * <p>
- * Implementing classes may elect to return instances that represent
- * {@link org.springframework.security.acls.model.Permission} information for either some
- * OR all {@link org.springframework.security.acls.model.Sid} instances. Therefore, an
- * instance may NOT necessarily contain ALL <tt>Sid</tt>s for a given domain object.
- * </p>
- *
- * @author Ben Alex
- */
-public interface Acl extends Serializable {
-
-	/**
-	 * Returns all of the entries represented by the present <tt>Acl</tt>. Entries
-	 * associated with the <tt>Acl</tt> parents are not returned.
-	 *
-	 * <p>
-	 * This method is typically used for administrative purposes.
-	 * </p>
-	 *
-	 * <p>
-	 * The order that entries appear in the array is important for methods declared in the
-	 * {@link MutableAcl} interface. Furthermore, some implementations MAY use ordering as
-	 * part of advanced permission checking.
-	 * </p>
-	 *
-	 * <p>
-	 * Do <em>NOT</em> use this method for making authorization decisions. Instead use
-	 * {@link #isGranted(List, List, boolean)}.
-	 * </p>
-	 *
-	 * <p>
-	 * This method must operate correctly even if the <tt>Acl</tt> only represents a
-	 * subset of <tt>Sid</tt>s. The caller is responsible for correctly handling the
-	 * result if only a subset of <tt>Sid</tt>s is represented.
-	 * </p>
-	 * @return the list of entries represented by the <tt>Acl</tt>, or <tt>null</tt> if
-	 * there are no entries presently associated with this <tt>Acl</tt>.
-	 */
-	List<AccessControlEntry> getEntries();
-
-	/**
-	 * Obtains the domain object this <tt>Acl</tt> provides entries for. This is immutable
-	 * once an <tt>Acl</tt> is created.
-	 * @return the object identity (never <tt>null</tt>)
-	 */
-	ObjectIdentity getObjectIdentity();
-
-	/**
-	 * Determines the owner of the <tt>Acl</tt>. The meaning of ownership varies by
-	 * implementation and is unspecified.
-	 * @return the owner (may be <tt>null</tt> if the implementation does not use
-	 * ownership concepts)
-	 */
-	Sid getOwner();
-
-	/**
-	 * A domain object may have a parent for the purpose of ACL inheritance. If there is a
-	 * parent, its ACL can be accessed via this method. In turn, the parent's parent
-	 * (grandparent) can be accessed and so on.
-	 *
-	 * <p>
-	 * This method solely represents the presence of a navigation hierarchy between the
-	 * parent <tt>Acl</tt> and this <tt>Acl</tt>. For actual inheritance to take place,
-	 * the {@link #isEntriesInheriting()} must also be <tt>true</tt>.
-	 * </p>
-	 *
-	 * <p>
-	 * This method must operate correctly even if the <tt>Acl</tt> only represents a
-	 * subset of <tt>Sid</tt>s. The caller is responsible for correctly handling the
-	 * result if only a subset of <tt>Sid</tt>s is represented.
-	 * </p>
-	 * @return the parent <tt>Acl</tt> (may be <tt>null</tt> if this <tt>Acl</tt> does not
-	 * have a parent)
-	 */
-	Acl getParentAcl();
-
-	/**
-	 * Indicates whether the ACL entries from the {@link #getParentAcl()} should flow down
-	 * into the current <tt>Acl</tt>.
-	 * <p>
-	 * The mere link between an <tt>Acl</tt> and a parent <tt>Acl</tt> on its own is
-	 * insufficient to cause ACL entries to inherit down. This is because a domain object
-	 * may wish to have entirely independent entries, but maintain the link with the
-	 * parent for navigation purposes. Thus, this method denotes whether or not the
-	 * navigation relationship also extends to the actual inheritance of entries.
-	 * </p>
-	 * @return <tt>true</tt> if parent ACL entries inherit into the current <tt>Acl</tt>
-	 */
-	boolean isEntriesInheriting();
-
-	/**
-	 * This is the actual authorization logic method, and must be used whenever ACL
-	 * authorization decisions are required.
-	 *
-	 * <p>
-	 * An array of <tt>Sid</tt>s are presented, representing security identifies of the
-	 * current principal. In addition, an array of <tt>Permission</tt>s is presented which
-	 * will have one or more bits set in order to indicate the permissions needed for an
-	 * affirmative authorization decision. An array is presented because holding
-	 * <em>any</em> of the <tt>Permission</tt>s inside the array will be sufficient for an
-	 * affirmative authorization.
-	 * </p>
-	 *
-	 * <p>
-	 * The actual approach used to make authorization decisions is left to the
-	 * implementation and is not specified by this interface. For example, an
-	 * implementation <em>MAY</em> search the current ACL in the order the ACL entries
-	 * have been stored. If a single entry is found that has the same active bits as are
-	 * shown in a passed <tt>Permission</tt>, that entry's grant or deny state may
-	 * determine the authorization decision. If the case of a deny state, the deny
-	 * decision will only be relevant if all other <tt>Permission</tt>s passed in the
-	 * array have also been unsuccessfully searched. If no entry is found that match the
-	 * bits in the current ACL, provided that {@link #isEntriesInheriting()} is
-	 * <tt>true</tt>, the authorization decision may be passed to the parent ACL. If there
-	 * is no matching entry, the implementation MAY throw an exception, or make a
-	 * predefined authorization decision.
-	 * </p>
-	 *
-	 * <p>
-	 * This method must operate correctly even if the <tt>Acl</tt> only represents a
-	 * subset of <tt>Sid</tt>s, although the implementation is permitted to throw one of
-	 * the signature-defined exceptions if the method is called requesting an
-	 * authorization decision for a {@link Sid} that was never loaded in this <tt>Acl</tt>
-	 * .
-	 * </p>
-	 * @param permission the permission or permissions required (at least one entry
-	 * required)
-	 * @param sids the security identities held by the principal (at least one entry
-	 * required)
-	 * @param administrativeMode if <tt>true</tt> denotes the query is for administrative
-	 * purposes and no logging or auditing (if supported by the implementation) should be
-	 * undertaken
-	 * @return <tt>true</tt> if authorization is granted
-	 * @throws NotFoundException MUST be thrown if an implementation cannot make an
-	 * authoritative authorization decision, usually because there is no ACL information
-	 * for this particular permission and/or SID
-	 * @throws UnloadedSidException thrown if the <tt>Acl</tt> does not have details for
-	 * one or more of the <tt>Sid</tt>s passed as arguments
-	 */
-	boolean isGranted(List<Permission> permission, List<Sid> sids, boolean administrativeMode)
-			throws NotFoundException, UnloadedSidException;
-
-	/**
-	 * For efficiency reasons an <tt>Acl</tt> may be loaded and <em>not</em> contain
-	 * entries for every <tt>Sid</tt> in the system. If an <tt>Acl</tt> has been loaded
-	 * and does not represent every <tt>Sid</tt>, all methods of the <tt>Acl</tt> can only
-	 * be used within the limited scope of the <tt>Sid</tt> instances it actually
-	 * represents.
-	 * <p>
-	 * It is normal to load an <tt>Acl</tt> for only particular <tt>Sid</tt>s if read-only
-	 * authorization decisions are being made. However, if user interface reporting or
-	 * modification of <tt>Acl</tt>s are desired, an <tt>Acl</tt> should be loaded with
-	 * all <tt>Sid</tt>s. This method denotes whether or not the specified <tt>Sid</tt>s
-	 * have been loaded or not.
-	 * </p>
-	 * @param sids one or more security identities the caller is interest in knowing
-	 * whether this <tt>Sid</tt> supports
-	 * @return <tt>true</tt> if every passed <tt>Sid</tt> is represented by this
-	 * <tt>Acl</tt> instance
-	 */
-	boolean isSidLoaded(List<Sid> sids);
-
-}

acl/src/main/java/org/springframework/security/acls/model/AclCache.java

@@ -1,42 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-import java.io.Serializable;
-
-import org.springframework.security.acls.jdbc.JdbcAclService;
-
-/**
- * A caching layer for {@link JdbcAclService}.
- *
- * @author Ben Alex
- */
-public interface AclCache {
-
-	void evictFromCache(Serializable pk);
-
-	void evictFromCache(ObjectIdentity objectIdentity);
-
-	MutableAcl getFromCache(ObjectIdentity objectIdentity);
-
-	MutableAcl getFromCache(Serializable pk);
-
-	void putInCache(MutableAcl acl);
-
-	void clearCache();
-
-}

acl/src/main/java/org/springframework/security/acls/model/AclDataAccessException.java

@@ -1,46 +0,0 @@
-/*
- * Copyright 2002-2016 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-/**
- * Abstract base class for Acl data operations.
- *
- * @author Luke Taylor
- * @since 3.0
- */
-public abstract class AclDataAccessException extends RuntimeException {
-
-	/**
-	 * Constructs an <code>AclDataAccessException</code> with the specified message and
-	 * root cause.
-	 * @param msg the detail message
-	 * @param cause the root cause
-	 */
-	public AclDataAccessException(String msg, Throwable cause) {
-		super(msg, cause);
-	}
-
-	/**
-	 * Constructs an <code>AclDataAccessException</code> with the specified message and no
-	 * root cause.
-	 * @param msg the detail message
-	 */
-	public AclDataAccessException(String msg) {
-		super(msg);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/model/AclService.java

@@ -1,103 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-import java.util.List;
-import java.util.Map;
-
-/**
- * Provides retrieval of {@link Acl} instances.
- *
- * @author Ben Alex
- */
-public interface AclService {
-
-	/**
-	 * Locates all object identities that use the specified parent. This is useful for
-	 * administration tools.
-	 * @param parentIdentity to locate children of
-	 * @return the children (or <tt>null</tt> if none were found)
-	 */
-	List<ObjectIdentity> findChildren(ObjectIdentity parentIdentity);
-
-	/**
-	 * Same as {@link #readAclsById(List)} except it returns only a single Acl.
-	 * <p>
-	 * This method should not be called as it does not leverage the underlying
-	 * implementation's potential ability to filter <tt>Acl</tt> entries based on a
-	 * {@link Sid} parameter.
-	 * </p>
-	 * @param object to locate an {@link Acl} for
-	 * @return the {@link Acl} for the requested {@link ObjectIdentity} (never
-	 * <tt>null</tt>)
-	 * @throws NotFoundException if an {@link Acl} was not found for the requested
-	 * {@link ObjectIdentity}
-	 */
-	Acl readAclById(ObjectIdentity object) throws NotFoundException;
-
-	/**
-	 * Same as {@link #readAclsById(List, List)} except it returns only a single Acl.
-	 * @param object to locate an {@link Acl} for
-	 * @param sids the security identities for which {@link Acl} information is required
-	 * (may be <tt>null</tt> to denote all entries)
-	 * @return the {@link Acl} for the requested {@link ObjectIdentity} (never
-	 * <tt>null</tt>)
-	 * @throws NotFoundException if an {@link Acl} was not found for the requested
-	 * {@link ObjectIdentity}
-	 */
-	Acl readAclById(ObjectIdentity object, List<Sid> sids) throws NotFoundException;
-
-	/**
-	 * Obtains all the <tt>Acl</tt>s that apply for the passed <tt>Object</tt>s.
-	 * <p>
-	 * The returned map is keyed on the passed objects, with the values being the
-	 * <tt>Acl</tt> instances. Any unknown objects will not have a map key.
-	 * </p>
-	 * @param objects the objects to find {@link Acl} information for
-	 * @return a map with exactly one element for each {@link ObjectIdentity} passed as an
-	 * argument (never <tt>null</tt>)
-	 * @throws NotFoundException if an {@link Acl} was not found for each requested
-	 * {@link ObjectIdentity}
-	 */
-	Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects) throws NotFoundException;
-
-	/**
-	 * Obtains all the <tt>Acl</tt>s that apply for the passed <tt>Object</tt>s, but only
-	 * for the security identifies passed.
-	 * <p>
-	 * Implementations <em>MAY</em> provide a subset of the ACLs via this method although
-	 * this is NOT a requirement. This is intended to allow performance optimisations
-	 * within implementations. Callers should therefore use this method in preference to
-	 * the alternative overloaded version which does not have performance optimisation
-	 * opportunities.
-	 * </p>
-	 * <p>
-	 * The returned map is keyed on the passed objects, with the values being the
-	 * <tt>Acl</tt> instances. Any unknown objects (or objects for which the interested
-	 * <tt>Sid</tt>s do not have entries) will not have a map key.
-	 * </p>
-	 * @param objects the objects to find {@link Acl} information for
-	 * @param sids the security identities for which {@link Acl} information is required
-	 * (may be <tt>null</tt> to denote all entries)
-	 * @return a map with exactly one element for each {@link ObjectIdentity} passed as an
-	 * argument (never <tt>null</tt>)
-	 * @throws NotFoundException if an {@link Acl} was not found for each requested
-	 * {@link ObjectIdentity}
-	 */
-	Map<ObjectIdentity, Acl> readAclsById(List<ObjectIdentity> objects, List<Sid> sids) throws NotFoundException;
-
-}

acl/src/main/java/org/springframework/security/acls/model/AlreadyExistsException.java

@@ -1,44 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-/**
- * Thrown if an <code>Acl</code> entry already exists for the object.
- *
- * @author Ben Alex
- */
-public class AlreadyExistsException extends AclDataAccessException {
-
-	/**
-	 * Constructs an <code>AlreadyExistsException</code> with the specified message.
-	 * @param msg the detail message
-	 */
-	public AlreadyExistsException(String msg) {
-		super(msg);
-	}
-
-	/**
-	 * Constructs an <code>AlreadyExistsException</code> with the specified message and
-	 * root cause.
-	 * @param msg the detail message
-	 * @param cause root cause
-	 */
-	public AlreadyExistsException(String msg, Throwable cause) {
-		super(msg, cause);
-	}
-
-}

acl/src/main/java/org/springframework/security/acls/model/AuditableAccessControlEntry.java

@@ -1,30 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-/**
- * Represents an ACE that provides auditing information.
- *
- * @author Ben Alex
- */
-public interface AuditableAccessControlEntry extends AccessControlEntry {
-
-	boolean isAuditFailure();
-
-	boolean isAuditSuccess();
-
-}

acl/src/main/java/org/springframework/security/acls/model/AuditableAcl.java

@@ -1,28 +0,0 @@
-/*
- * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.security.acls.model;
-
-/**
- * A mutable ACL that provides audit capabilities.
- *
- * @author Ben Alex
- */
-public interface AuditableAcl extends MutableAcl {
-
-	void updateAuditing(int aceIndex, boolean auditSuccess, boolean auditFailure);
-
-}