org.nuxeo.ecm.platform.usermanager.io

Class NuxeoPrincipalJsonWriter

java.lang.Object

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

org.nuxeo.ecm.core.io.marshallers.json.ExtensibleEntityJsonWriter<NuxeoPrincipal>

org.nuxeo.ecm.platform.usermanager.io.NuxeoPrincipalJsonWriter

All Implemented Interfaces:

Marshaller<NuxeoPrincipal>, Writer<NuxeoPrincipal>

@Setup(mode=SINGLETON,
       priority=2000)
public class NuxeoPrincipalJsonWriter
extends ExtensibleEntityJsonWriter<NuxeoPrincipal>

Convert NuxeoPrincipal to Json.

This marshaller is enrichable: register class implementing AbstractJsonEnricher and managing NuxeoPrincipal.

This marshaller is also extensible: extend it and simply override ExtensibleEntityJsonWriter#extend(NuxeoPrincipal, JsonWriter).

Format is:

 {
   "entity-type":"user",
   "id":"USERNAME",
   "properties":{   <- depending on the user schema / format is managed by {@link DocumentPropertyJsonWriter}
     "firstName":"FIRSTNAME",
     "lastName":"LASTNAME",
     "username":"USERNAME",
     "email":"user@mail.com",
     "company":"COMPANY",
     "password":"", <- ALWAYS EMPTY
     "groups":[
       "GROUP1 NAME OF THE USER",
       "GROUP2 NAME OF THE USER",
       ...
     ]
   },
   "extendedGroups":[
     {
       "name":"GROUP1NAME",
       "label":"GROUP1 DISPLAY NAME",
       "url":"GROUP1 URL"
     },
     ...
   ],
   "isAdministrator":true|false,
   "isAnonymous":false|false
             <-- contextParameters if there are enrichers activated
             <-- additional property provided by extend() method
 }
 

Since:

7.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_TYPE

Constructor Summary

Constructors

Constructor and Description
NuxeoPrincipalJsonWriter()

Method Summary

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

write

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

accept, write

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_TYPE

public static final String ENTITY_TYPE

See Also:

Constant Field Values

Constructor Detail

NuxeoPrincipalJsonWriter

public NuxeoPrincipalJsonWriter()