Package org.nuxeo.ecm.core.io.marshallers.json.enrichers

Class AbstractJsonEnricher<EntityType>

java.lang.Object

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

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

Type Parameters:

EntityType - The Java type whose the generated JSON will be enriched.

All Implemented Interfaces:

Marshaller<Enriched<EntityType>>, Writer<Enriched<EntityType>>

Direct Known Subclasses:

ACLJsonEnricher, AuditJsonEnricher, BasePermissionsJsonEnricher, BlobAppLinksJsonEnricher, BlobPreviewJsonEnricher, BreadcrumbJsonEnricher, ChildrenJsonEnricher, CollectionsJsonEnricher, ContextualParametersJsonEnricher, DocumentUrlJsonEnricher, FavoritesJsonEnricher, FirstAccessibleAncestorJsonEnricher, HasContentJsonEnricher, HasFolderishChildJsonEnricher, HighlightJsonEnricher, NotificationsJsonEnricher, PendingTasksJsonEnricher, PreviewJsonEnricher, PublicationJsonEnricher, RenditionJsonEnricher, RunnableWorkflowJsonEnricher, RunningWorkflowJsonEnricher, SubtypesJsonEnricher, SubtypesJsonEnricher, TagsJsonEnricher, ThumbnailJsonEnricher, UserProfileEnricher, UserVisiblePermissionsJsonEnricher, WOPIJsonEnricher

public abstract class AbstractJsonEnricher<EntityType>
extends AbstractJsonWriter<Enriched<EntityType>>

Base class to write ExtensibleEntityJsonWriter's enricher.

Since:

7.2

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENTITY_ENRICHER_NAME
protected static com.fasterxml.jackson.databind.ObjectMapper	MAPPER

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

ctx, registry

Constructor Summary

Constructors

Constructor	Description
AbstractJsonEnricher(String name)

Method Summary

Modifier and Type	Method	Description
boolean	accept(Class<?> clazz, Type genericType, javax.ws.rs.core.MediaType mediatype)	Checks if this marshaller can handle the marshalling request.
protected String	safeReadBuffer(com.fasterxml.jackson.databind.util.TokenBuffer tb)
abstract void	write(com.fasterxml.jackson.core.JsonGenerator jg, EntityType enriched)	When implementing this method, the provided JsonGenerator expect you write a field name and a field value (or many).
void	write(Enriched<EntityType> enrichable, com.fasterxml.jackson.core.JsonGenerator jg)	Implement this method to writes the entity in the provided JsonGenerator.

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

ENTITY_ENRICHER_NAME

public static final String ENTITY_ENRICHER_NAME

See Also:

Constant Field Values

MAPPER

protected static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

Constructor Detail

AbstractJsonEnricher

public AbstractJsonEnricher(String name)

Method Detail

accept

public boolean accept(Class<?> clazz,
                      Type genericType,
                      javax.ws.rs.core.MediaType mediatype)

Description copied from interface: Marshaller

Checks if this marshaller can handle the marshalling request.

Please note it's useless to check that clazz is an instance of EntityType or if generic type and entity type are compatible (unlike JAX-RS which just checks the clazz, not the generic type). It's also useless to check Supports is compatible with mediatype. This is already done by the MarshallerRegistry

This method implementation can use injected properties. So you can check the current RenderingContext to accept or reject a marshalling request.

Specified by:

accept in interface Marshaller<EntityType>

Overrides:

accept in class AbstractJsonWriter<Enriched<EntityType>>

Parameters:

clazz - The type to marshall.

genericType - The generic type to marshall.

mediatype - The managed mimetype.

Returns:

true if this converter handle the request, false otherwise.

write

public void write(Enriched<EntityType> enrichable,
                  com.fasterxml.jackson.core.JsonGenerator jg)

Description copied from class: AbstractJsonWriter

Implement this method to writes the entity in the provided JsonGenerator.

This method implementation can use injected properties.

The JsonGenerator's flushing is done by this abstract class, it's also not not necessary to flush it. Do not close the provided JsonGenerator. It may be used is another marshaller calling this one.

Specified by:

write in class AbstractJsonWriter<Enriched<EntityType>>

Parameters:

enrichable - The entity to marshall as Json.

jg - The JsonGenerator used to produce Json output.

safeReadBuffer

protected String safeReadBuffer(com.fasterxml.jackson.databind.util.TokenBuffer tb)

write

public abstract void write(com.fasterxml.jackson.core.JsonGenerator jg,
                           EntityType enriched)
                    throws IOException

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

Parameters:

jg - The JsonGenerator to use.

enriched - The enriched entity.

Throws:

IOException

Since:

7.2