Package org.nuxeo.template.serializer.service

Interface TemplateSerializerService

All Known Implementing Classes:

TemplateSerializerServiceImpl

public interface TemplateSerializerService

Service Exposing serializer and deserializer used to manipulate template rendering data to be injected in the rendition context. Here are the current service usage :

• API request => Inline context preparation : see in RenderWithTemplateOperation
• Inline context preparation => store into the TemplateBasedDocument
• Context defined on Template creation => store into the TemplateSourceDocument
• And finally before rendition to collect data from TemplateSource and TemplateBased to generate the global context

You can create your own Serializer contributing to the extension point and call it on the API request. For instance, if you want to send json instead XML.

Since:

11.1

Method Summary

Modifier and Type	Method	Description
default List<TemplateInput>	deserializeXML(String content)	Convenient method to deserialize XML content using the 'xml' TemplateSerializer..
TemplateSerializer	getSerializer(String id)	Returns the TemplateSerializer with the given id.
default String	serializeXML(List<TemplateInput> params)	Convenient method to serialize params to XML using the 'xml' TemplateSerializer.

Method Details

getSerializer

TemplateSerializer getSerializer(String id)

Returns the TemplateSerializer with the given id.

If no TemplateSerializer is found, return the 'default' one.

Throws:

NuxeoException - if no id or 'default' TemplateSerializer found

serializeXML

default String serializeXML(List<TemplateInput> params)

Convenient method to serialize params to XML using the 'xml' TemplateSerializer.

deserializeXML

default List<TemplateInput> deserializeXML(String content)

Convenient method to deserialize XML content using the 'xml' TemplateSerializer..