org.nuxeo.ecm.automation.core.operations.document

Class AddPermission

java.lang.Object

org.nuxeo.ecm.automation.core.operations.document.AddPermission

public class AddPermission
extends Object

Operation that adds a permission to a given ACL for a given user.

Since:

5.7.3

Field Summary

Fields

Modifier and Type	Field and Description
protected String	aclName
static String	ALLOW_VIRTUAL_USER Configuration property name, which defines whether virtual user (non-existent user) is allowed in Nuxeo automation.
protected Calendar	begin
protected boolean	blockInheritance
protected String	comment
static String	COMMENT_KEY
protected String	email
protected Calendar	end
static String	ID
protected boolean	notify
static String	NOTIFY_KEY
protected String	permission
protected CoreSession	session
protected String	user Deprecated. since 10.3, use users instead.
protected List<String>	users

Constructor Summary

Constructors

Constructor and Description
AddPermission()

Method Summary

Modifier and Type	Method and Description
protected void	addPermission(DocumentModel doc)
protected void	ensureUserListIsUsed() Method to help deprecating user parameter.
DocumentModel	run(DocumentModel doc)
DocumentModel	run(DocumentRef docRef)
protected void	validateParameters()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

NOTIFY_KEY

public static final String NOTIFY_KEY

See Also:

Constant Field Values

COMMENT_KEY

public static final String COMMENT_KEY

See Also:

Constant Field Values

ALLOW_VIRTUAL_USER

public static final String ALLOW_VIRTUAL_USER

Configuration property name, which defines whether virtual user (non-existent user) is allowed in Nuxeo automation. If allowed, Nuxeo server will not check the user existence during automation execution. Set this property to true if you use Nuxeo computed user or computed group.

Since:

9.1

See Also:

Constant Field Values

session

protected CoreSession session

users

protected List<String> users

Since:

10.3

user

@Deprecated
protected String user

Deprecated. since 10.3, use users instead.

email

protected String email

Since:

8.1

permission

protected String permission

aclName

protected String aclName

begin

protected Calendar begin

end

protected Calendar end

blockInheritance

protected boolean blockInheritance

notify

protected boolean notify

comment

protected String comment

Constructor Detail

AddPermission

public AddPermission()

Method Detail

run

public DocumentModel run(DocumentModel doc)

run

public DocumentModel run(DocumentRef docRef)

addPermission

protected void addPermission(DocumentModel doc)

validateParameters

protected void validateParameters()

ensureUserListIsUsed

protected void ensureUserListIsUsed()

Method to help deprecating user parameter.