Class ContextualParametersJsonEnricher
- 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.core.io.marshallers.json.enrichers.ContextualParametersJsonEnricher
-
- All Implemented Interfaces:
Marshaller<Enriched<DocumentModel>>
,Writer<Enriched<DocumentModel>>
@Setup(mode=SINGLETON, priority=2000) public class ContextualParametersJsonEnricher extends AbstractJsonEnricher<DocumentModel>
EnrichDocumentModel
Json.Add custom key/value information as json attachment.
Enable if parameter enrichers-document=contextualParameters.
Format is:
{ "entity-type":"document", ... "contextParameters": { "KEY": "VALUE" <- key/value pairs come from context parameter "contextualParameters" - a Map<String, String> is expected. } }
- Since:
- 7.2
-
-
Field Summary
Fields Modifier and Type Field Description static 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 ContextualParametersJsonEnricher()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
write(com.fasterxml.jackson.core.JsonGenerator jg, DocumentModel enriched)
When implementing this method, the providedJsonGenerator
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, writeEntityField, writeSerializable, writeSerializableField, writeSerializableListField, writeSerializableMapField
-
-
-
-
Field Detail
-
NAME
public static final String NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContextualParametersJsonEnricher
public ContextualParametersJsonEnricher()
-
-
Method Detail
-
write
public void write(com.fasterxml.jackson.core.JsonGenerator jg, DocumentModel enriched) throws IOException
Description copied from class:AbstractJsonEnricher
When implementing this method, the providedJsonGenerator
expect you write a field name and a field value (or many).- Specified by:
write
in classAbstractJsonEnricher<DocumentModel>
- Parameters:
jg
- TheJsonGenerator
to use.enriched
- The enriched entity.- Throws:
IOException
-
-