rename mode to scope #10520 (#10521)

enonic · Apr 23, 2024 · 5df7e96 · 5df7e96
1 parent 01cbf4d
commit 5df7e96
Show file tree

Hide file tree

Showing 18 changed files with 75 additions and 74 deletions.
diff --git a/modules/core/core-api/src/main/java/com/enonic/xp/content/ApplyContentPermissionsParams.java b/modules/core/core-api/src/main/java/com/enonic/xp/content/ApplyContentPermissionsParams.java
@@ -3,7 +3,7 @@
 import com.google.common.base.Preconditions;
 
 import com.enonic.xp.annotation.PublicApi;
-import com.enonic.xp.node.ApplyPermissionsMode;
+import com.enonic.xp.node.ApplyPermissionsScope;
 import com.enonic.xp.security.acl.AccessControlList;
 
 import static java.util.Objects.requireNonNull;
@@ -20,14 +20,14 @@ public final class ApplyContentPermissionsParams
 
     private final AccessControlList removePermissions;
 
-    private final ApplyPermissionsMode applyPermissionsMode;
+    private final ApplyPermissionsScope applyPermissionsScope;
 
     private final ApplyPermissionsListener listener;
 
     private ApplyContentPermissionsParams( Builder builder )
     {
         contentId = requireNonNull( builder.contentId );
-        applyPermissionsMode = requireNonNullElse( builder.applyPermissionsMode, ApplyPermissionsMode.SINGLE );
+        applyPermissionsScope = requireNonNullElse( builder.applyPermissionsScope, ApplyPermissionsScope.SINGLE );
         permissions = builder.permissions.build();
         addPermissions = builder.addPermissions.build();
         removePermissions = builder.removePermissions.build();
@@ -53,9 +53,9 @@ public boolean isOverwriteChildPermissions()
         return false;
     }
 
-    public ApplyPermissionsMode getMode()
+    public ApplyPermissionsScope getScope()
     {
-        return applyPermissionsMode;
+        return applyPermissionsScope;
     }
 
     public AccessControlList getPermissions()
@@ -94,7 +94,7 @@ public static final class Builder
 
         private final AccessControlList.Builder removePermissions = AccessControlList.create();
 
-        private ApplyPermissionsMode applyPermissionsMode;
+        private ApplyPermissionsScope applyPermissionsScope;
 
         private ApplyPermissionsListener listener;
 
@@ -114,9 +114,9 @@ public Builder overwriteChildPermissions( final boolean overwriteChildPermission
             return this;
         }
 
-        public Builder applyPermissionsMode( final ApplyPermissionsMode applyPermissionsMode )
+        public Builder applyPermissionsScope( final ApplyPermissionsScope applyPermissionsScope )
         {
-            this.applyPermissionsMode = applyPermissionsMode;
+            this.applyPermissionsScope = applyPermissionsScope;
             return this;
         }
 

diff --git a/modules/core/core-api/src/main/java/com/enonic/xp/node/ApplyNodePermissionsParams.java b/modules/core/core-api/src/main/java/com/enonic/xp/node/ApplyNodePermissionsParams.java
@@ -22,7 +22,7 @@ public final class ApplyNodePermissionsParams
 
     private final AccessControlList removePermissions;
 
-    private final ApplyPermissionsMode mode;
+    private final ApplyPermissionsScope scope;
 
     private final ApplyPermissionsListener listener;
 
@@ -31,7 +31,7 @@ public final class ApplyNodePermissionsParams
     private ApplyNodePermissionsParams( Builder builder )
     {
         nodeId = Objects.requireNonNull( builder.nodeId );
-        mode = Objects.requireNonNullElse( builder.mode, ApplyPermissionsMode.SINGLE );
+        scope = Objects.requireNonNullElse( builder.scope, ApplyPermissionsScope.SINGLE );
         permissions = builder.permissions.build();
         addPermissions = builder.addPermissions.build();
         removePermissions = builder.removePermissions.build();
@@ -73,9 +73,9 @@ public boolean isOverwriteChildPermissions()
         return false;
     }
 
-    public ApplyPermissionsMode getMode()
+    public ApplyPermissionsScope getScope()
     {
-        return mode;
+        return scope;
     }
 
     public ApplyPermissionsListener getListener()
@@ -98,7 +98,7 @@ public static final class Builder
 
         private final AccessControlList.Builder removePermissions = AccessControlList.create();
 
-        private ApplyPermissionsMode mode;
+        private ApplyPermissionsScope scope;
 
         private ApplyPermissionsListener listener;
 
@@ -147,9 +147,9 @@ public Builder overwriteChildPermissions( final boolean overwriteChildPermission
             return this;
         }
 
-        public Builder mode( final ApplyPermissionsMode mode )
+        public Builder scope( final ApplyPermissionsScope scope )
         {
-            this.mode = mode;
+            this.scope = scope;
             return this;
         }
 

diff --git a/.../enonic/xp/node/ApplyPermissionsMode.java → ...enonic/xp/node/ApplyPermissionsScope.java b/.../enonic/xp/node/ApplyPermissionsMode.java → ...enonic/xp/node/ApplyPermissionsScope.java
@@ -1,6 +1,6 @@
 package com.enonic.xp.node;
 
-public enum ApplyPermissionsMode
+public enum ApplyPermissionsScope
 {
     SINGLE, TREE, CHILDREN
 }
diff --git a/.../core/core-api/src/test/java/com/enonic/xp/content/ApplyContentPermissionsParamsTest.java b/.../core/core-api/src/test/java/com/enonic/xp/content/ApplyContentPermissionsParamsTest.java
@@ -2,7 +2,7 @@
 
 import org.junit.jupiter.api.Test;
 
-import com.enonic.xp.node.ApplyPermissionsMode;
+import com.enonic.xp.node.ApplyPermissionsScope;
 import com.enonic.xp.security.acl.AccessControlList;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -14,7 +14,8 @@ public class ApplyContentPermissionsParamsTest
     public void testCreate()
     {
         final ApplyContentPermissionsParams params = ApplyContentPermissionsParams.create()
-            .contentId( ContentId.from( "id1" ) ).applyPermissionsMode( ApplyPermissionsMode.TREE )
+            .contentId( ContentId.from( "id1" ) )
+            .applyPermissionsScope( ApplyPermissionsScope.TREE )
             .permissions( AccessControlList.create().build() )
             .applyContentPermissionsListener( new ApplyPermissionsListener()
             {
@@ -39,7 +40,7 @@ public void notEnoughRights( final int count )
             .build();
 
         assertEquals( ContentId.from( "id1" ), params.getContentId() );
-        assertEquals( ApplyPermissionsMode.TREE, params.getMode() );
+        assertEquals( ApplyPermissionsScope.TREE, params.getScope() );
         assertEquals( AccessControlList.create().build(), params.getPermissions() );
         assertNotNull( params.getListener() );
     }

diff --git a/...content/src/main/java/com/enonic/xp/core/impl/content/ApplyContentPermissionsCommand.java b/...content/src/main/java/com/enonic/xp/core/impl/content/ApplyContentPermissionsCommand.java
@@ -39,8 +39,7 @@ ApplyContentPermissionsResult execute()
         final ApplyNodePermissionsParams.Builder applyNodePermissionsBuilder = ApplyNodePermissionsParams.create()
             .nodeId( nodeId )
             .permissions( params.getPermissions() )
-            .addPermissions( params.getAddPermissions() )
-            .removePermissions( params.getRemovePermissions() ).mode( params.getMode() )
+            .addPermissions( params.getAddPermissions() ).removePermissions( params.getRemovePermissions() ).scope( params.getScope() )
             .applyPermissionsListener( params.getListener() )
             .addBranches( Branches.from( ContentConstants.BRANCH_MASTER ) );
 

diff --git a/...ore-content/src/main/java/com/enonic/xp/core/impl/content/ContentAuditLogSupportImpl.java b/...ore-content/src/main/java/com/enonic/xp/core/impl/content/ContentAuditLogSupportImpl.java
@@ -519,7 +519,7 @@ private void doApplyPermissions( final ApplyContentPermissionsParams params, fin
         final PropertySet resultSet = data.addSet( "result" );
 
         paramsSet.addString( "contentId", nullToNull( params.getContentId() ) );
-        paramsSet.addString( "mode", params.getMode().toString() );
+        paramsSet.addString( "scope", params.getScope().toString() );
 
         if ( params.getPermissions() != null )
         {

diff --git a/...ore/core-repo/src/main/java/com/enonic/xp/repo/impl/node/ApplyNodePermissionsCommand.java b/...ore/core-repo/src/main/java/com/enonic/xp/repo/impl/node/ApplyNodePermissionsCommand.java
@@ -16,7 +16,7 @@
 import com.enonic.xp.context.ContextBuilder;
 import com.enonic.xp.node.ApplyNodePermissionsParams;
 import com.enonic.xp.node.ApplyNodePermissionsResult;
-import com.enonic.xp.node.ApplyPermissionsMode;
+import com.enonic.xp.node.ApplyPermissionsScope;
 import com.enonic.xp.node.Node;
 import com.enonic.xp.node.NodeBranchEntry;
 import com.enonic.xp.node.NodeId;
@@ -104,7 +104,7 @@ private void doApplyPermissions( final NodeId nodeId, final AccessControlList pe
     {
         NodeVersionData updatedPersistedNode;
 
-        if ( ApplyPermissionsMode.CHILDREN == params.getMode() && params.getNodeId().equals( nodeId ) )
+        if ( ApplyPermissionsScope.CHILDREN == params.getScope() && params.getNodeId().equals( nodeId ) )
         {
             final Node persistedNode = doGetById( nodeId );
 
@@ -178,7 +178,7 @@ private void doApplyOnChildren( final AccessControlList permissions, final NodeV
         for ( Node child : children )
         {
             final PermissionsMergingStrategy mergingStrategy =
-                ApplyPermissionsMode.SINGLE == params.getMode() ? PermissionsMergingStrategy.MERGE : PermissionsMergingStrategy.OVERWRITE;
+                ApplyPermissionsScope.SINGLE == params.getScope() ? PermissionsMergingStrategy.MERGE : PermissionsMergingStrategy.OVERWRITE;
 
             final AccessControlList childPermissions = mergingStrategy.mergePermissions( child.getPermissions(), permissions );
 

diff --git a/...ore/core-security/src/main/java/com/enonic/xp/core/impl/security/SecurityServiceImpl.java b/...ore/core-security/src/main/java/com/enonic/xp/core/impl/security/SecurityServiceImpl.java
@@ -29,7 +29,7 @@
 import com.enonic.xp.data.ValueFactory;
 import com.enonic.xp.index.IndexPath;
 import com.enonic.xp.node.ApplyNodePermissionsParams;
-import com.enonic.xp.node.ApplyPermissionsMode;
+import com.enonic.xp.node.ApplyPermissionsScope;
 import com.enonic.xp.node.CreateNodeParams;
 import com.enonic.xp.node.DeleteNodeParams;
 import com.enonic.xp.node.FindNodesByParentParams;
@@ -988,7 +988,7 @@ public IdProvider createIdProvider( final CreateIdProviderParams createIdProvide
                                         .build() );
 
                 final ApplyNodePermissionsParams applyPermissions =
-                    ApplyNodePermissionsParams.create().nodeId( rootNode.id() ).mode( ApplyPermissionsMode.SINGLE ).build();
+                    ApplyNodePermissionsParams.create().nodeId( rootNode.id() ).scope( ApplyPermissionsScope.SINGLE ).build();
                 nodeService.applyPermissions( applyPermissions );
 
                 return idProviderNode;
@@ -1061,7 +1061,7 @@ public IdProvider updateIdProvider( final UpdateIdProviderParams updateIdProvide
                 setNodePermissions( groupsNode.id(), groupsNodePermissions );
 
                 final ApplyNodePermissionsParams applyPermissions =
-                    ApplyNodePermissionsParams.create().nodeId( idProviderNode.id() ).mode( ApplyPermissionsMode.SINGLE ).build();
+                    ApplyNodePermissionsParams.create().nodeId( idProviderNode.id() ).scope( ApplyPermissionsScope.SINGLE ).build();
                 nodeService.applyPermissions( applyPermissions );
             }
 

diff --git a/...ore/src/test/java/com/enonic/xp/core/content/ContentServiceImplTest_applyPermissions.java b/...ore/src/test/java/com/enonic/xp/core/content/ContentServiceImplTest_applyPermissions.java
@@ -17,7 +17,7 @@
 import com.enonic.xp.content.PushContentParams;
 import com.enonic.xp.context.ContextAccessor;
 import com.enonic.xp.data.PropertyTree;
-import com.enonic.xp.node.ApplyPermissionsMode;
+import com.enonic.xp.node.ApplyPermissionsScope;
 import com.enonic.xp.node.NodeNotFoundException;
 import com.enonic.xp.schema.content.ContentTypeName;
 import com.enonic.xp.security.acl.AccessControlEntry;
@@ -107,7 +107,8 @@ public void no_rights()
         final ApplyPermissionsListener listener = mock( ApplyPermissionsListener.class );
 
         final ApplyContentPermissionsParams applyParams = ApplyContentPermissionsParams.create()
-            .contentId( content.getId() ).applyPermissionsMode( ApplyPermissionsMode.TREE )
+            .contentId( content.getId() )
+            .applyPermissionsScope( ApplyPermissionsScope.TREE )
             .applyContentPermissionsListener( listener )
             .build();
 

diff --git a/...est/itest-core/src/test/java/com/enonic/xp/core/node/ApplyNodePermissionsCommandTest.java b/...est/itest-core/src/test/java/com/enonic/xp/core/node/ApplyNodePermissionsCommandTest.java
@@ -14,7 +14,7 @@
 import com.enonic.xp.core.AbstractNodeTest;
 import com.enonic.xp.node.ApplyNodePermissionsParams;
 import com.enonic.xp.node.ApplyNodePermissionsResult;
-import com.enonic.xp.node.ApplyPermissionsMode;
+import com.enonic.xp.node.ApplyPermissionsScope;
 import com.enonic.xp.node.CreateNodeParams;
 import com.enonic.xp.node.CreateRootNodeParams;
 import com.enonic.xp.node.Node;
@@ -88,7 +88,7 @@ void with_children()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( createdNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.TREE )
+                                                                                    .scope( ApplyPermissionsScope.TREE )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .permissions( AccessControlList.create()
@@ -126,7 +126,7 @@ void only_children()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( createdNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.CHILDREN )
+                                                                                    .scope( ApplyPermissionsScope.CHILDREN )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .permissions( AccessControlList.create()
@@ -167,7 +167,7 @@ void modified()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( createdNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.TREE )
+                                                                                    .scope( ApplyPermissionsScope.TREE )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .permissions( AccessControlList.create()
@@ -207,7 +207,7 @@ void switched()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( childNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.TREE )
+                                                                                    .scope( ApplyPermissionsScope.TREE )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .permissions( AccessControlList.create()
@@ -244,7 +244,8 @@ void from_master_to_draft()
             .branch( ContentConstants.BRANCH_MASTER )
             .build()
             .callWith( () -> nodeService.applyPermissions( ApplyNodePermissionsParams.create()
-                                                               .nodeId( createdNode.id() ).mode( ApplyPermissionsMode.TREE )
+                                                               .nodeId( createdNode.id() )
+                                                               .scope( ApplyPermissionsScope.TREE )
                                                                .addBranches( Branches.from( ContentConstants.BRANCH_DRAFT ) )
                                                                .permissions( AccessControlList.create()
                                                                                  .add( AccessControlEntry.create()
@@ -335,7 +336,7 @@ void add_and_remove()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( createdNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.TREE )
+                                                                                    .scope( ApplyPermissionsScope.TREE )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .addPermissions( AccessControlList.create()
@@ -389,7 +390,7 @@ void add_to_existing()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( createdNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.TREE )
+                                                                                    .scope( ApplyPermissionsScope.TREE )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .addPermissions( AccessControlList.create()
@@ -424,7 +425,7 @@ void remove_all_on_empty()
 
         final ApplyNodePermissionsResult result = nodeService.applyPermissions( ApplyNodePermissionsParams.create()
                                                                                     .nodeId( createdNode.id() )
-                                                                                    .mode( ApplyPermissionsMode.TREE )
+                                                                                    .scope( ApplyPermissionsScope.TREE )
                                                                                     .addBranches(
                                                                                         Branches.from( ContentConstants.BRANCH_MASTER ) )
                                                                                     .addPermissions( AccessControlList.create()
@@ -490,8 +491,7 @@ private void applyPermissionsWithOverwrite()
         refresh();
 
         final ApplyNodePermissionsParams params = ApplyNodePermissionsParams.create()
-            .nodeId( topNode.id() )
-            .permissions( topNode.getPermissions() ).mode( ApplyPermissionsMode.TREE )
+            .nodeId( topNode.id() ).permissions( topNode.getPermissions() ).scope( ApplyPermissionsScope.TREE )
             .applyPermissionsListener( mock( ApplyPermissionsListener.class ) )
             .build();