org.nuxeo.ecm.automation.client.adapters

Class DocumentSecurityService

java.lang.Object

org.nuxeo.ecm.automation.client.adapters.DocumentSecurityService

public class DocumentSecurityService
extends Object

Author:

david

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_PERMISSIONS_OP Add permissions operation identifier.
static String	INHERITED_ACL Inherited ACL identidier.
static String	LOCAL_ACL Local ACL identifier.
static String	REMOVE_GROUP_PERMISSIONS_OP Remove group (inherited / local) of permissions operation identifier.
static String	REMOVE_PERMISSIONS_OP Remove permissions operation identifier.
protected Session	session Client session.

Constructor Summary

Constructors

Constructor and Description
DocumentSecurityService(Session session) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Document	addPermissions(Document document, DocumentPermissions permissions, String acl, boolean blockInheritance) Adds permissions in given ACL blocking or not inheritance.
Session	getSession() Getter for session.
Document	removeGroupPermissions(DocRef docRef, String acl) Remove given ACL on document, i.e. inherited or local ACL.
Document	removePermissions(DocRef docRef, DocumentPermissions permissions, List<String> userNames, String acl, boolean removeAll, boolean blockInheritance) Removes ACEs in given ACL, blocking or not inheritance: - if removeAll is true, removes all ACEs of given ACL - if userNames is set, removes all ACEs of given users.

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL_ACL

public static final String LOCAL_ACL

Local ACL identifier.

See Also:

Constant Field Values

INHERITED_ACL

public static final String INHERITED_ACL

Inherited ACL identidier.

See Also:

Constant Field Values

ADD_PERMISSIONS_OP

public static final String ADD_PERMISSIONS_OP

Add permissions operation identifier.

See Also:

Constant Field Values

REMOVE_PERMISSIONS_OP

public static final String REMOVE_PERMISSIONS_OP

Remove permissions operation identifier.

See Also:

Constant Field Values

REMOVE_GROUP_PERMISSIONS_OP

public static final String REMOVE_GROUP_PERMISSIONS_OP

Remove group (inherited / local) of permissions operation identifier.

See Also:

Constant Field Values

session

protected Session session

Client session.

Constructor Detail

DocumentSecurityService

public DocumentSecurityService(Session session)

Constructor.

Method Detail

getSession

public Session getSession()

Getter for session.

Returns:

session

addPermissions

public Document addPermissions(Document document,
                      DocumentPermissions permissions,
                      String acl,
                      boolean blockInheritance)
                        throws Exception

Adds permissions in given ACL blocking or not inheritance.

Parameters:

document -

permissions -

blockInheritance -

Returns:

document

Throws:

Exception

removePermissions

public Document removePermissions(DocRef docRef,
                         DocumentPermissions permissions,
                         List<String> userNames,
                         String acl,
                         boolean removeAll,
                         boolean blockInheritance)
                           throws Exception

Removes ACEs in given ACL, blocking or not inheritance: - if removeAll is true, removes all ACEs of given ACL - if userNames is set, removes all ACEs of given users.

Parameters:

docRef -

permissions -

userNames -

acl -

removeAll -

blockInheritance -

Returns:

document

Throws:

Exception

removeGroupPermissions

public Document removeGroupPermissions(DocRef docRef,
                              String acl)
                                throws Exception

Remove given ACL on document, i.e. inherited or local ACL.

Parameters:

docRef -

acl -

Returns:

document

Throws:

Exception