org.nuxeo.ecm.permissions

Class ACLJsonEnricher

java.lang.Object

org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter<Enriched<EntityType>>

org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher<DocumentModel>

org.nuxeo.ecm.permissions.ACLJsonEnricher

All Implemented Interfaces:

Marshaller<Enriched<DocumentModel>>, Writer<Enriched<DocumentModel>>

@Setup(mode=SINGLETON,
       priority=2000)
public class ACLJsonEnricher
extends AbstractJsonEnricher<DocumentModel>

Enrich DocumentModel Json.

Add DocumentModel's ACP as json attachment.

Enable if parameter enrichers-document=acls is present.

Format is:

 
 {
   "entity-type":"document",
   ...
   "contextParameters": {
     "acls": [
       {
         "name": "inherited",
         "aces" :[
           {
             "username": "administrators",
             "permission": "Everything",
             "granted": true,
             "creator": "Administrator",
             "begin": "2014-10-19T09:16:30.291Z",
             "end": "2016-10-19T09:16:30.291Z"
             "notify": true // optional
             "comment": "" // optional
           },
           ...
         ]
       },
       ...
     ]
   }
 }
 

{@code username} and {@code creator} property can be fetched with fetch.acls=username or fetch.acls=creator.

Additional ACE fields (such as notify and notification comment) can be written by using fetch.acls=extended.

Since:

7.2

See Also:

NuxeoPrincipalJsonWriter, NuxeoGroupJsonWriter

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPATIBILITY_CONFIGURATION_PARAM
static String	CREATOR_PROPERTY
static String	EXTENDED_ACLS_PROPERTY
static String	NAME
static String	USERNAME_PROPERTY

Fields inherited from class org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher

ENTITY_ENRICHER_NAME

Fields inherited from class org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter

ctx, registry

Constructor Summary

Constructors

Constructor and Description
ACLJsonEnricher()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Serializable>	computeAdditionalFields(DocumentModel doc, String aclName, String aceId)
protected String	computeDirectoryId(DocumentModel doc, String aclName, String aceId)
void	write(com.fasterxml.jackson.core.JsonGenerator jg, DocumentModel document) When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).
protected void	writeACEsField(com.fasterxml.jackson.core.JsonGenerator jg, String fieldName, ACL acl, DocumentModel document)
protected void	writePrincipalOrGroup(String propertyName, String value, com.fasterxml.jackson.core.JsonGenerator jg)

Methods inherited from class org.nuxeo.ecm.core.io.marshallers.json.enrichers.AbstractJsonEnricher

accept, write

Methods inherited from class org.nuxeo.ecm.core.io.marshallers.json.AbstractJsonWriter

getGenerator, write, writeEntity, writeEntity, writeEntityField, writeSerializable, writeSerializableField, writeSerializableListField, writeSerializableMapField

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

USERNAME_PROPERTY

public static final String USERNAME_PROPERTY

See Also:

Constant Field Values

CREATOR_PROPERTY

public static final String CREATOR_PROPERTY

See Also:

Constant Field Values

EXTENDED_ACLS_PROPERTY

public static final String EXTENDED_ACLS_PROPERTY

See Also:

Constant Field Values

COMPATIBILITY_CONFIGURATION_PARAM

public static final String COMPATIBILITY_CONFIGURATION_PARAM

See Also:

Constant Field Values

Constructor Detail

ACLJsonEnricher

public ACLJsonEnricher()

Method Detail

write

public void write(com.fasterxml.jackson.core.JsonGenerator jg,
                  DocumentModel document)
           throws IOException

Description copied from class: AbstractJsonEnricher

When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).

Specified by:

write in class AbstractJsonEnricher<DocumentModel>

Parameters:

jg - The JsonGenerator to use.

document - The enriched entity.

Throws:

IOException

writeACEsField

protected void writeACEsField(com.fasterxml.jackson.core.JsonGenerator jg,
                              String fieldName,
                              ACL acl,
                              DocumentModel document)
                       throws IOException

Throws:

IOException

writePrincipalOrGroup

protected void writePrincipalOrGroup(String propertyName,
                                     String value,
                                     com.fasterxml.jackson.core.JsonGenerator jg)
                              throws IOException

Throws:

IOException

computeAdditionalFields

protected Map<String,Serializable> computeAdditionalFields(DocumentModel doc,
                                                           String aclName,
                                                           String aceId)

computeDirectoryId

protected String computeDirectoryId(DocumentModel doc,
                                    String aclName,
                                    String aceId)