info.magnolia.module.delta

Class AddUsersPermissionTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.AbstractRepositoryTask

info.magnolia.module.delta.NodeVisitorTask

info.magnolia.module.delta.AddUsersPermissionTask

All Implemented Interfaces:

Task

public class AddUsersPermissionTask
extends NodeVisitorTask

A task to add a permission to all users under provided path.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_PATH_REPLACEMENT

Fields inherited from class info.magnolia.module.delta.AbstractTask

DO_NOTHING

Constructor Summary

Constructors

Constructor and Description
AddUsersPermissionTask(String taskName, String pathToUsers, String workspace, String workspacePath, long permission) Deprecated. since 5.5.3, use AddUsersPermissionTask(String, String, String, String, long, NodeNameHelper)
AddUsersPermissionTask(String taskName, String pathToUsers, String workspace, String workspacePath, long permission, NodeNameHelper nodeNameHelper)

Method Summary

Modifier and Type	Method and Description
AddUsersPermissionTask	exclude(String... excludedUserNames)
protected boolean	nodeMatches(javax.jcr.Node node) Implement this method to define which nodes should subsequently be operated upon.
protected void	operateOnNode(InstallContext installContext, javax.jcr.Node user) Implement this method to apply changes to each of the nodes that are matched by NodeVisitorTask.nodeMatches(Node).

Methods inherited from class info.magnolia.module.delta.NodeVisitorTask

doExecute, getFilteringPredicate

Methods inherited from class info.magnolia.module.delta.AbstractRepositoryTask

execute

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

USER_PATH_REPLACEMENT

public static final String USER_PATH_REPLACEMENT

See Also:

Constant Field Values

Constructor Detail

AddUsersPermissionTask

public AddUsersPermissionTask(String taskName,
                              String pathToUsers,
                              String workspace,
                              String workspacePath,
                              long permission,
                              NodeNameHelper nodeNameHelper)

Parameters:

pathToUsers - path pointing to subtree (or a single user) in users workspace

workspace - workspace to add permission for

workspacePath - path in workspace to add permission for, string ${USER_PATH} will be replaced with path to user to whom is the permission added

permission - permission value, see Permission

nodeNameHelper - instance of NodeNameHelper

AddUsersPermissionTask

@Deprecated
public AddUsersPermissionTask(String taskName,
                                          String pathToUsers,
                                          String workspace,
                                          String workspacePath,
                                          long permission)

Deprecated. since 5.5.3, use AddUsersPermissionTask(String, String, String, String, long, NodeNameHelper)

Method Detail

exclude

public AddUsersPermissionTask exclude(String... excludedUserNames)

nodeMatches

protected boolean nodeMatches(javax.jcr.Node node)

Description copied from class: NodeVisitorTask

Implement this method to define which nodes should subsequently be operated upon.

This will be called for every visited node in that task, and serves a similar purpose as a JCR query statement.

Specified by:

nodeMatches in class NodeVisitorTask

Parameters:

node - the JCR node that is currently being visited

Returns:

true if the node should be operated upon, false otherwise

See Also:

NodeVisitorTask.operateOnNode(InstallContext, Node)

operateOnNode

protected void operateOnNode(InstallContext installContext,
                             javax.jcr.Node user)

Description copied from class: NodeVisitorTask

Implement this method to apply changes to each of the nodes that are matched by NodeVisitorTask.nodeMatches(Node).

This is typically where the update logic goes, in a similar fashion as the QueryTask.

Specified by:

operateOnNode in class NodeVisitorTask

Parameters:

installContext - the current install context

user - the JCR node that should be operated upon

See Also:

QueryTask.operateOnNode(InstallContext, Node)