Package org.nuxeo.user.preferences.io

Class DocumentUserPreferencesJsonEnricher

java.lang.Object

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

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

org.nuxeo.user.preferences.io.DocumentUserPreferencesJsonEnricher

All Implemented Interfaces:

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

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

Enrich DocumentModel Json.

Add current user's preferences on the DocumentModel.

Enabled if parameter enrichers-document=userPreferences is present.

Format is:

 {
   "entity-type":"document",
   ...
   "contextParameters": {
     "userPreferences": {
       "entity-type": "userPreferences",
       "preferences": {
         "key1": "value1",
         "key2": "value2"
       }
   }
 }
 

Since:

2025.16

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

ENTITY_ENRICHER_NAME, MAPPER

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

ctx, registry

Constructor Summary

Constructors

Constructor	Description
DocumentUserPreferencesJsonEnricher()

Method Summary

Modifier and Type	Method	Description
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).

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

accept, safeReadBuffer, write

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

getGenerator, write, writeEntity, writeEntity, writeEntityArrayField, writeEntityArrayField, writeEntityField, writeNumberFieldIfNotNull, writeObjectFieldIfNotEmpty, writeObjectFieldIfNotNull, writeSerializable, writeSerializableField, writeSerializableListField, writeSerializableMapField, writeStringFieldIfNotNull, writeTemporalField

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

DocumentUserPreferencesJsonEnricher

public DocumentUserPreferencesJsonEnricher()

Method Details

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