Skip to content

Show info about missing permission on AccessForbiddenException #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rogersteblerbsi wants to merge 2 commits into
base: releases/26.2
Choose a base branch
from
+8 −5
Open

Show info about missing permission on AccessForbiddenException #416

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee34f98
Show info about missing permission on AccessForbiddenException
rogersteblerbsi Jun 25, 2026
05c2ec1
round 2
rogersteblerbsi Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ...ipse.scout.docs.snippets/src/main/java/org/eclipse/scout/docs/snippets/AccessSnippet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2010, 2024 BSI Business Systems Integration AG
* Copyright (c) 2010, 2026 BSI Business Systems Integration AG
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
Expand All @@ -22,7 +22,6 @@

public class AccessSnippet {


//tag::ReadCompanyPermission[]
public static class ReadCompanyPermission extends AbstractPermission {
@Serial
Expand Down Expand Up @@ -55,8 +54,9 @@ public String getAccessCheckFailedMessage() {
protected void snippets() {

//tag::ACCESS_A[]
if (ACCESS.check(new ReadCompanyPermission())) { // <1>
throw new AccessForbiddenException(TEXTS.get("YouAreNotAllowedToReadThisData"));
if (!ACCESS.check(new ReadCompanyPermission())) { // <1>
throw new AccessForbiddenException(TEXTS.get("YouAreNotAllowedToReadThisData"))
.withPermission(ReadCompanyPermission.class);

@matthiaso matthiaso Jun 30, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also change documentation here:

scout.docs/docs/modules/technical-guide/pages/common-concepts/security.adoc

Lines 186 to 193 in 2f4d9af

[source,java,indent=0]
----
include::common:example$org.eclipse.scout.docs.snippets/src/main/java/org/eclipse/scout/docs/snippets/AccessSnippet.java[tags=ACCESS_A]
----
<1> Checks permission against granted permissions of current user.
<2> Checks permission and if this check fails, throw an `AccessForbiddenException` with a default message.
We can define a default access check failed message for a permission.

And add migration notes for users?

}

ACCESS.checkAndThrow(new ReadCompanyPermission()); // <2>
Expand Down Expand Up @@ -142,6 +142,5 @@ else if (!m_companyId.equals(other.m_companyId)) {
protected interface ICompanyService {

boolean isOwnCompany(UUID companyId);

}
}