Skip to content
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

Jump to bottom

rename mode to scope #10520 #10521

Merged
merged 1 commit into from
Apr 23, 2024
Merged

rename mode to scope #10520 #10521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions modules/core/core-api/src/main/java/com/enonic/xp/content/ApplyContentPermissionsParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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();
Expand All @@ -53,9 +53,9 @@ public boolean isOverwriteChildPermissions()
return false;
}

public ApplyPermissionsMode getMode()
public ApplyPermissionsScope getScope()
{
return applyPermissionsMode;
return applyPermissionsScope;
}

public AccessControlList getPermissions()
Expand Down Expand Up @@ -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;

Expand All @@ -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;
}

Expand Down
14 changes: 7 additions & 7 deletions modules/core/core-api/src/main/java/com/enonic/xp/node/ApplyNodePermissionsParams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public final class ApplyNodePermissionsParams

private final AccessControlList removePermissions;

private final ApplyPermissionsMode mode;
private final ApplyPermissionsScope scope;

private final ApplyPermissionsListener listener;

Expand All @@ -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();
Expand Down Expand Up @@ -73,9 +73,9 @@ public boolean isOverwriteChildPermissions()
return false;
}

public ApplyPermissionsMode getMode()
public ApplyPermissionsScope getScope()
{
return mode;
return scope;
}

public ApplyPermissionsListener getListener()
Expand All @@ -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;

Expand Down Expand Up @@ -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;
}

Expand Down
2 changes: 1 addition & 1 deletion .../enonic/xp/node/ApplyPermissionsMode.java → ...enonic/xp/node/ApplyPermissionsScope.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.enonic.xp.node;

public enum ApplyPermissionsMode
public enum ApplyPermissionsScope
{
SINGLE, TREE, CHILDREN
}
7 changes: 4 additions & 3 deletions .../core/core-api/src/test/java/com/enonic/xp/content/ApplyContentPermissionsParamsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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()
{
Expand All @@ -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() );
}
Expand Down
3 changes: 1 addition & 2 deletions ...content/src/main/java/com/enonic/xp/core/impl/content/ApplyContentPermissionsCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ) );

Expand Down
2 changes: 1 addition & 1 deletion ...ore-content/src/main/java/com/enonic/xp/core/impl/content/ContentAuditLogSupportImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 )
{
Expand Down
6 changes: 3 additions & 3 deletions ...ore/core-repo/src/main/java/com/enonic/xp/repo/impl/node/ApplyNodePermissionsCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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 );

Expand Down Expand Up @@ -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 );

Expand Down
6 changes: 3 additions & 3 deletions ...ore/core-security/src/main/java/com/enonic/xp/core/impl/security/SecurityServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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 );
}

Expand Down
5 changes: 3 additions & 2 deletions ...ore/src/test/java/com/enonic/xp/core/content/ContentServiceImplTest_applyPermissions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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();

Expand Down
22 changes: 11 additions & 11 deletions ...est/itest-core/src/test/java/com/enonic/xp/core/node/ApplyNodePermissionsCommandTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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();

Expand Down