EN · DE · RU · FR · ES
← Index · ← File index · ← Prev · Next → · 📄 source

#610: UserRight.java

projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java Java class, projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java 219 lines · 122 code · 71 comments · 26 blank
Purpose: Source file: projectforge/business/user/UserRight.java. UserRight.java is part of the ProjectForge open-source project management application.

Source (first 100 lines)

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2026 Micromata GmbH, Germany (www.micromata.com)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.business.user;

import org.projectforge.framework.DisplayNameCapable;
import org.projectforge.framework.persistence.api.IUserRightId;
import org.projectforge.framework.persistence.user.entities.GroupDO;
import org.projectforge.framework.persistence.user.entities.PFUserDO;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

public abstract class UserRight implements Serializable, DisplayNameCapable {
  private static final long serialVersionUID = -4356329396089081134L;

  private final IUserRightId id;

  protected UserRightValue[] values;

  protected UserRightCategory category = UserRightCategory.MISC;

  protected UserRight dependsOn;

  public UserRight(final IUserRightId id, final UserRightCategory category) {
    this.id = id;
    this.category = category;
  }

  public UserRight(final IUserRightId id, final UserRightCategory category, final UserRightValue... values) {
    this(id, category);
    this.values = values;
  }

  public UserRight(final IUserRightId id, final UserRightCategory category, final UserRight dependsOn) {
    this(id, category, dependsOn, new UserRightValue[]{UserRightValue.FALSE, UserRightValue.TRUE});
  }

  /**
   * @param id
   * @param dependsOn
   * @param values    FALSE, TRUE at default.
   */
  public UserRight(final IUserRightId id, final UserRightCategory category, final UserRight dependsOn,
                   final UserRightValue... values) {
    this(id, category);
    this.dependsOn = dependsOn;
    this.values = values;
  }

  public IUserRightId getId() {
    return id;
  }

  /**
   * Available values {TRUE, FALSE} at default.
   *
   * @return
   */
  public UserRightValue[] getValues() {
    return values;
  }

  /**
   * For some users and right combinations it's possible, that the user has an access value at default because he's
   * member of a group with a single right. <br/>
   *
   * @param user
   * @return true if all available values for the user matches automatically, otherwise false (this right seems to be
   * configurable for the given user in the UserEditForm).
   */
  public boolean isConfigurable(final PFUserDO user, final Collection<GroupDO> userGroups) {
    if (values == null) {
      return false;
    }
    final UserRightValue[] availableValues = getAvailableValues(user, userGroups);
    if (availableValues == null || availableValues.length <= 1) {
      return false;

Git History

868d6abb7 2025 -> 2026
63081666f Source file headers: 2024-> 2025.
b6092df09 Copyright 2023 -> 2024
ab45d51fa Copyright 2001-2022 -> 2001-2023.
5f9658941 UserRight.isConfigurable/getAvailableValues/matches(UserGroupCache, ...) -> isConfigurable/...(..., Collection...) UserGroovyRight removed.

868d6abb7

2025 -> 2026
868d6abb75cd191a892911ac8e45058932cf9074
diff --git a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
index 8f44a66bc..c2192b929 100644
--- a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
+++ b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
@@ -3,7 +3,7 @@
 // Project ProjectForge Community Edition
 //         www.projectforge.org
 //
-// Copyright (C) 2001-2025 Micromata GmbH, Germany (www.micromata.com)
+// Copyright (C) 2001-2026 Micromata GmbH, Germany (www.micromata.com)
 //
 // ProjectForge is dual-licensed.
 //

63081666f

Source file headers: 2024-> 2025.
63081666f620fb87315f01b817e560e0b2f6a33a
diff --git a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
index 4ca0656f0..8f44a66bc 100644
--- a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
+++ b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
@@ -3,7 +3,7 @@
 // Project ProjectForge Community Edition
 //         www.projectforge.org
 //
-// Copyright (C) 2001-2024 Micromata GmbH, Germany (www.micromata.com)
+// Copyright (C) 2001-2025 Micromata GmbH, Germany (www.micromata.com)
 //
 // ProjectForge is dual-licensed.
 //

b6092df09

Copyright 2023 -> 2024
b6092df0927c4a3b161e888445f31dcab57493f2
diff --git a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
index c48cd83ef..4ca0656f0 100644
--- a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
+++ b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
@@ -3,7 +3,7 @@
 // Project ProjectForge Community Edition
 //         www.projectforge.org
 //
-// Copyright (C) 2001-2023 Micromata GmbH, Germany (www.micromata.com)
+// Copyright (C) 2001-2024 Micromata GmbH, Germany (www.micromata.com)
 //
 // ProjectForge is dual-licensed.
 //

ab45d51fa

Copyright 2001-2022 -> 2001-2023.
ab45d51fa419ede6174b31d69987f96d4b841ff9
diff --git a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
index dd2b57847..c48cd83ef 100644
--- a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
+++ b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
@@ -3,7 +3,7 @@
 // Project ProjectForge Community Edition
 //         www.projectforge.org
 //
-// Copyright (C) 2001-2022 Micromata GmbH, Germany (www.micromata.com)
+// Copyright (C) 2001-2023 Micromata GmbH, Germany (www.micromata.com)
 //
 // ProjectForge is dual-licensed.
 //

5f9658941

UserRight.isConfigurable/getAvailableValues/matches(UserGroupCache, ...) -> isConfigurable/...(..., Collection...) UserGroovyRight removed.
5f96589418cc9445e8a09ed5abd80ab9b184748e
diff --git a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
index 6c5644eb4..dd2b57847 100644
--- a/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
+++ b/projectforge-business/src/main/java/org/projectforge/business/user/UserRight.java
@@ -87,16 +87,15 @@ public abstract class UserRight implements Serializable, DisplayNameCapable {
    * For some users and right combinations it's possible, that the user has an access value at default because he's
    * member of a group with a single right. <br/>
    *
-   * @param userGroupCache
    * @param user
    * @return true if all available values for the user matches automatically, otherwise false (this right seems to be
    * configurable for the given user in the UserEditForm).
    */
-  public boolean isConfigurable(final UserGroupCache userGroupCache, final PFUserDO user) {
+  public boolean isConfigurable(final PFUserDO user, final Collection<GroupDO> userGroups) {
     if (values == null) {
       return false;
     }
-    final UserRightValue[] availableValues = getAvailableValues(userGroupCache, user);
+    final UserRightValue[] availableValues = getAvailableValues(user, userGroups);
     if (availableValues == null || availableValues.length <= 1) {
       return false;
     }
@@ -104,11 +103,11 @@ public abstract class UserRight implements Serializable, DisplayNameCapable {
       if (value == UserRightValue.FALSE) {
         continue; // Should not be configurable.
       }
-      if (!matches(userGroupCache, user, value)) {
+      if (!matches(user, userGroups, value)) {
         final UserRightValue[] includedByValues = value.includedBy();
         if (includedByValues != null) {
           for (final UserRightValue includedByValue : includedByValues) {
-            if (matches(userGroupCache, user, includedByValue)) {
+            if (matches(user, userGroups, includedByValue)) {
               // This available value is automatically set for the user, so the right seems to be not configurable:
               break;
             }
@@ -126,16 +125,14 @@ public abstract class UserRight implements Serializable, DisplayNameCapable {
    * Get all right values which are potentially available for the user. If the user value stored in the user data is not
    * part of available values then the AccessChecker returns that the user has no right.
    *
-   * @param userGroupCache
    * @param user
    * @return
    */
-  public UserRightValue[] getAvailableValues(final UserGroupCache userGroupCache, final PFUserDO user) {
+  public UserRightValue[] getAvailableValues(final PFUserDO user, final Collection<GroupDO> userGroups) {
     if (values == null) {
       return null;
     }
     final List<UserRightValue> list = new ArrayList<>();
-    final Collection<GroupDO> userGroups = userGroupCache.getUserGroupDOs(user);
     for (final UserRightValue value : values) {
       if (isAvailable(user, userGroups, value)) {
         list.add(value);
@@ -162,7 +159,7 @@ public abstract class UserRight implements Serializable, DisplayNameCapable {
 
   /**
    * @param assignedGroups