org.apache.olingo.server.core.serializer.json

Class ODataJsonSerializer

java.lang.Object

org.apache.olingo.server.core.serializer.json.ODataJsonSerializer

All Implemented Interfaces:

ODataSerializer

public class ODataJsonSerializer
extends Object
implements ODataSerializer

Field Summary

Fields inherited from interface org.apache.olingo.server.api.serializer.ODataSerializer

DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
ODataJsonSerializer(ContentType contentType)
ODataJsonSerializer(ContentType contentType, IConstants constants)

Method Summary

Modifier and Type	Method and Description
protected ContextURL	checkContextURL(ContextURL contextURL)
SerializerResult	complex(ServiceMetadata metadata, EdmComplexType type, Property property, ComplexSerializerOptions options) Writes complex-type instance data into an InputStream.
SerializerResult	complexCollection(ServiceMetadata metadata, EdmComplexType type, Property property, ComplexSerializerOptions options) Writes data of a collection of complex-type instances into an InputStream.
SerializerResult	entity(ServiceMetadata metadata, EdmEntityType entityType, Entity entity, EntitySerializerOptions options) Writes entity data into an InputStream.
SerializerResult	entityCollection(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollection entitySet, EntityCollectionSerializerOptions options) Writes entity-collection data into an InputStream.
void	entityCollectionIntoStream(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollectionObject entitySet, EntityCollectionSerializerOptions options, OutputStream outputStream)
SerializerStreamResult	entityCollectionStreamed(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollectionObject entities, EntityCollectionSerializerOptions options) Writes entity-collection data into an InputStream.
SerializerResult	error(ODataServerError error) Writes an ODataError into an InputStream.
protected String	getEntityId(Entity entity, EdmEntityType entityType, String name) Get the ascii representation of the entity id or thrown an SerializerException if id is null.
SerializerResult	metadataDocument(ServiceMetadata serviceMetadata) Writes the metadata document into an InputStream.
SerializerResult	primitive(ServiceMetadata metadata, EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options) Writes primitive-type instance data into an InputStream.
SerializerResult	primitiveCollection(ServiceMetadata metadata, EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options) Writes data of a collection of primitive-type instances into an InputStream.
SerializerResult	reference(ServiceMetadata metadata, EdmEntitySet edmEntitySet, Entity entity, ReferenceSerializerOptions options) Writes a single entity reference into an InputStream.
SerializerResult	referenceCollection(ServiceMetadata metadata, EdmEntitySet edmEntitySet, AbstractEntityCollection entityCollection, ReferenceCollectionSerializerOptions options) Writes entity-collection references into an InputStream.
protected EdmComplexType	resolveComplexType(ServiceMetadata metadata, EdmComplexType baseType, String derivedTypeName)
protected EdmEntityType	resolveEntityType(ServiceMetadata metadata, EdmEntityType baseType, String derivedTypeName)
SerializerResult	serviceDocument(ServiceMetadata metadata, String serviceRoot) Writes the service document into an InputStream.
protected void	writeComplexValue(ServiceMetadata metadata, EdmComplexType type, List<Property> properties, Set<List<String>> selectedPaths, com.fasterxml.jackson.core.JsonGenerator json, Set<List<String>> expandedPaths, Linked linked, ExpandOption expand, String complexPropName)
protected void	writeContextURL(ContextURL contextURL, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeEntity(ServiceMetadata metadata, EdmEntityType entityType, Entity entity, ContextURL contextURL, ExpandOption expand, Integer toDepth, SelectOption select, boolean onlyReference, Set<String> ancestors, String name, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeEntitySet(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollectionObject entitySet, ExpandOption expand, Integer toDepth, SelectOption select, boolean onlyReference, Set<String> ancestors, String name, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeExpandedNavigationProperty(ServiceMetadata metadata, EdmNavigationProperty property, Link navigationLink, ExpandOption innerExpand, Integer toDepth, SelectOption innerSelect, CountOption innerCount, boolean writeOnlyCount, boolean writeOnlyRef, Set<String> ancestors, String name, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeExpandedStreamProperties(ServiceMetadata metadata, EdmStructuredType type, Linked linked, ExpandOption expand, Integer toDepth, Set<String> ancestors, String name, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeGeoValue(String name, EdmPrimitiveType type, Geospatial geoValue, Boolean isNullable, com.fasterxml.jackson.core.JsonGenerator json, SRID parentSrid) Writes a geospatial value following the GeoJSON specification defined in RFC 7946.
protected void	writeInlineCount(String propertyName, Integer count, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeMetadataETag(ServiceMetadata metadata, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeNavigationProperties(ServiceMetadata metadata, EdmStructuredType type, Linked linked, ExpandOption expand, Integer toDepth, Set<String> ancestors, String name, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeNextLink(AbstractEntityCollectionObject entitySet, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writePrimitiveValue(String name, EdmPrimitiveType type, Object primitiveValue, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode, com.fasterxml.jackson.core.JsonGenerator json)
protected void	writeProperties(ServiceMetadata metadata, EdmStructuredType type, List<Property> properties, SelectOption select, com.fasterxml.jackson.core.JsonGenerator json, Linked linked, ExpandOption expand)
protected void	writeProperty(ServiceMetadata metadata, EdmProperty edmProperty, Property property, Set<List<String>> selectedPaths, com.fasterxml.jackson.core.JsonGenerator json, Set<List<String>> expandedPaths, Linked linked, ExpandOption expand)

Methods inherited from class java.lang.Object

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

Constructor Detail

ODataJsonSerializer

public ODataJsonSerializer(ContentType contentType)

ODataJsonSerializer

public ODataJsonSerializer(ContentType contentType,
                           IConstants constants)

Method Detail

serviceDocument

public SerializerResult serviceDocument(ServiceMetadata metadata,
                                        String serviceRoot)
                                 throws SerializerException

Description copied from interface: ODataSerializer

Writes the service document into an InputStream.

Specified by:

serviceDocument in interface ODataSerializer

Parameters:

metadata - the metadata information for the service

serviceRoot - the service-root URI of this OData service

Throws:

SerializerException

metadataDocument

public SerializerResult metadataDocument(ServiceMetadata serviceMetadata)
                                  throws SerializerException

Description copied from interface: ODataSerializer

Writes the metadata document into an InputStream.

Specified by:

metadataDocument in interface ODataSerializer

Parameters:

serviceMetadata - the metadata information for the service

Throws:

SerializerException

error

public SerializerResult error(ODataServerError error)
                       throws SerializerException

Description copied from interface: ODataSerializer

Writes an ODataError into an InputStream.

Specified by:

error in interface ODataSerializer

Parameters:

error - the main error

Throws:

SerializerException

entityCollection

public SerializerResult entityCollection(ServiceMetadata metadata,
                                         EdmEntityType entityType,
                                         AbstractEntityCollection entitySet,
                                         EntityCollectionSerializerOptions options)
                                  throws SerializerException

Description copied from interface: ODataSerializer

Writes entity-collection data into an InputStream.

Specified by:

entityCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

entityType - the EdmEntityType

entitySet - the data of the entity set

options - options for the serializer

Throws:

SerializerException

entityCollectionStreamed

public SerializerStreamResult entityCollectionStreamed(ServiceMetadata metadata,
                                                       EdmEntityType entityType,
                                                       AbstractEntityCollectionObject entities,
                                                       EntityCollectionSerializerOptions options)
                                                throws SerializerException

Description copied from interface: ODataSerializer

Writes entity-collection data into an InputStream.

Specified by:

entityCollectionStreamed in interface ODataSerializer

Parameters:

metadata - metadata for the service

entityType - the EdmEntityType

entities - the data of the entity set

options - options for the serializer

Throws:

SerializerException

entityCollectionIntoStream

public void entityCollectionIntoStream(ServiceMetadata metadata,
                                       EdmEntityType entityType,
                                       AbstractEntityCollectionObject entitySet,
                                       EntityCollectionSerializerOptions options,
                                       OutputStream outputStream)
                                throws SerializerException

Throws:

SerializerException

entity

public SerializerResult entity(ServiceMetadata metadata,
                               EdmEntityType entityType,
                               Entity entity,
                               EntitySerializerOptions options)
                        throws SerializerException

Description copied from interface: ODataSerializer

Writes entity data into an InputStream.

Specified by:

entity in interface ODataSerializer

Parameters:

metadata - metadata for the service

entityType - the EdmEntityType

entity - the data of the entity

options - options for the serializer

Throws:

SerializerException

checkContextURL

protected ContextURL checkContextURL(ContextURL contextURL)
                              throws SerializerException

Throws:

SerializerException

writeEntitySet

protected void writeEntitySet(ServiceMetadata metadata,
                              EdmEntityType entityType,
                              AbstractEntityCollectionObject entitySet,
                              ExpandOption expand,
                              Integer toDepth,
                              SelectOption select,
                              boolean onlyReference,
                              Set<String> ancestors,
                              String name,
                              com.fasterxml.jackson.core.JsonGenerator json)
                       throws IOException,
                              SerializerException,
                              org.apache.commons.codec.DecoderException

Throws:

IOException

SerializerException

org.apache.commons.codec.DecoderException

getEntityId

protected String getEntityId(Entity entity,
                             EdmEntityType entityType,
                             String name)
                      throws SerializerException

Get the ascii representation of the entity id or thrown an SerializerException if id is null.

Parameters:

entity - the entity

entityType -

name -

Returns:

ascii representation of the entity id

Throws:

SerializerException

writeEntity

protected void writeEntity(ServiceMetadata metadata,
                           EdmEntityType entityType,
                           Entity entity,
                           ContextURL contextURL,
                           ExpandOption expand,
                           Integer toDepth,
                           SelectOption select,
                           boolean onlyReference,
                           Set<String> ancestors,
                           String name,
                           com.fasterxml.jackson.core.JsonGenerator json)
                    throws IOException,
                           SerializerException,
                           org.apache.commons.codec.DecoderException

Throws:

IOException

SerializerException

org.apache.commons.codec.DecoderException

resolveEntityType

protected EdmEntityType resolveEntityType(ServiceMetadata metadata,
                                          EdmEntityType baseType,
                                          String derivedTypeName)
                                   throws SerializerException

Throws:

SerializerException

resolveComplexType

protected EdmComplexType resolveComplexType(ServiceMetadata metadata,
                                            EdmComplexType baseType,
                                            String derivedTypeName)
                                     throws SerializerException

Throws:

SerializerException

writeProperties

protected void writeProperties(ServiceMetadata metadata,
                               EdmStructuredType type,
                               List<Property> properties,
                               SelectOption select,
                               com.fasterxml.jackson.core.JsonGenerator json,
                               Linked linked,
                               ExpandOption expand)
                        throws IOException,
                               SerializerException,
                               org.apache.commons.codec.DecoderException

Throws:

IOException

SerializerException

org.apache.commons.codec.DecoderException

writeNavigationProperties

protected void writeNavigationProperties(ServiceMetadata metadata,
                                         EdmStructuredType type,
                                         Linked linked,
                                         ExpandOption expand,
                                         Integer toDepth,
                                         Set<String> ancestors,
                                         String name,
                                         com.fasterxml.jackson.core.JsonGenerator json)
                                  throws SerializerException,
                                         IOException,
                                         org.apache.commons.codec.DecoderException

Throws:

SerializerException

IOException

org.apache.commons.codec.DecoderException

writeExpandedStreamProperties

protected void writeExpandedStreamProperties(ServiceMetadata metadata,
                                             EdmStructuredType type,
                                             Linked linked,
                                             ExpandOption expand,
                                             Integer toDepth,
                                             Set<String> ancestors,
                                             String name,
                                             com.fasterxml.jackson.core.JsonGenerator json)
                                      throws SerializerException,
                                             IOException,
                                             org.apache.commons.codec.DecoderException

Throws:

SerializerException

IOException

org.apache.commons.codec.DecoderException

writeExpandedNavigationProperty

protected void writeExpandedNavigationProperty(ServiceMetadata metadata,
                                               EdmNavigationProperty property,
                                               Link navigationLink,
                                               ExpandOption innerExpand,
                                               Integer toDepth,
                                               SelectOption innerSelect,
                                               CountOption innerCount,
                                               boolean writeOnlyCount,
                                               boolean writeOnlyRef,
                                               Set<String> ancestors,
                                               String name,
                                               com.fasterxml.jackson.core.JsonGenerator json)
                                        throws IOException,
                                               SerializerException,
                                               org.apache.commons.codec.DecoderException

Throws:

IOException

SerializerException

org.apache.commons.codec.DecoderException

writeProperty

protected void writeProperty(ServiceMetadata metadata,
                             EdmProperty edmProperty,
                             Property property,
                             Set<List<String>> selectedPaths,
                             com.fasterxml.jackson.core.JsonGenerator json,
                             Set<List<String>> expandedPaths,
                             Linked linked,
                             ExpandOption expand)
                      throws IOException,
                             SerializerException,
                             org.apache.commons.codec.DecoderException

Throws:

IOException

SerializerException

org.apache.commons.codec.DecoderException

writePrimitiveValue

protected void writePrimitiveValue(String name,
                                   EdmPrimitiveType type,
                                   Object primitiveValue,
                                   Boolean isNullable,
                                   Integer maxLength,
                                   Integer precision,
                                   Integer scale,
                                   Boolean isUnicode,
                                   com.fasterxml.jackson.core.JsonGenerator json)
                            throws EdmPrimitiveTypeException,
                                   IOException

Throws:

EdmPrimitiveTypeException

IOException

writeGeoValue

protected void writeGeoValue(String name,
                             EdmPrimitiveType type,
                             Geospatial geoValue,
                             Boolean isNullable,
                             com.fasterxml.jackson.core.JsonGenerator json,
                             SRID parentSrid)
                      throws EdmPrimitiveTypeException,
                             IOException,
                             SerializerException

Writes a geospatial value following the GeoJSON specification defined in RFC 7946.

Throws:

EdmPrimitiveTypeException

IOException

SerializerException

writeComplexValue

protected void writeComplexValue(ServiceMetadata metadata,
                                 EdmComplexType type,
                                 List<Property> properties,
                                 Set<List<String>> selectedPaths,
                                 com.fasterxml.jackson.core.JsonGenerator json,
                                 Set<List<String>> expandedPaths,
                                 Linked linked,
                                 ExpandOption expand,
                                 String complexPropName)
                          throws IOException,
                                 SerializerException,
                                 org.apache.commons.codec.DecoderException

Throws:

IOException

SerializerException

org.apache.commons.codec.DecoderException

primitive

public SerializerResult primitive(ServiceMetadata metadata,
                                  EdmPrimitiveType type,
                                  Property property,
                                  PrimitiveSerializerOptions options)
                           throws SerializerException

Description copied from interface: ODataSerializer

Writes primitive-type instance data into an InputStream.

Specified by:

primitive in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - primitive type

property - property value

options - options for the serializer

Throws:

SerializerException

complex

public SerializerResult complex(ServiceMetadata metadata,
                                EdmComplexType type,
                                Property property,
                                ComplexSerializerOptions options)
                         throws SerializerException

Description copied from interface: ODataSerializer

Writes complex-type instance data into an InputStream.

Specified by:

complex in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - complex type

property - property value

options - options for the serializer

Throws:

SerializerException

primitiveCollection

public SerializerResult primitiveCollection(ServiceMetadata metadata,
                                            EdmPrimitiveType type,
                                            Property property,
                                            PrimitiveSerializerOptions options)
                                     throws SerializerException

Description copied from interface: ODataSerializer

Writes data of a collection of primitive-type instances into an InputStream.

Specified by:

primitiveCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - primitive type

property - property value

options - options for the serializer

Throws:

SerializerException

complexCollection

public SerializerResult complexCollection(ServiceMetadata metadata,
                                          EdmComplexType type,
                                          Property property,
                                          ComplexSerializerOptions options)
                                   throws SerializerException

Description copied from interface: ODataSerializer

Writes data of a collection of complex-type instances into an InputStream.

Specified by:

complexCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - complex type

property - property value

options - options for the serializer

Throws:

SerializerException

reference

public SerializerResult reference(ServiceMetadata metadata,
                                  EdmEntitySet edmEntitySet,
                                  Entity entity,
                                  ReferenceSerializerOptions options)
                           throws SerializerException

Description copied from interface: ODataSerializer

Writes a single entity reference into an InputStream.

Specified by:

reference in interface ODataSerializer

Parameters:

metadata - metadata for the service

edmEntitySet - EdmEntitySet

entity - data of the entity

options - ReferenceSerializerOptions

Throws:

SerializerException

referenceCollection

public SerializerResult referenceCollection(ServiceMetadata metadata,
                                            EdmEntitySet edmEntitySet,
                                            AbstractEntityCollection entityCollection,
                                            ReferenceCollectionSerializerOptions options)
                                     throws SerializerException

Description copied from interface: ODataSerializer

Writes entity-collection references into an InputStream.

Specified by:

referenceCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

edmEntitySet - EdmEntitySet

entityCollection - data of the entity collection

options - ReferenceCollectionSerializerOptions

Throws:

SerializerException

writeContextURL

protected void writeContextURL(ContextURL contextURL,
                               com.fasterxml.jackson.core.JsonGenerator json)
                        throws IOException

Throws:

IOException

writeMetadataETag

protected void writeMetadataETag(ServiceMetadata metadata,
                                 com.fasterxml.jackson.core.JsonGenerator json)
                          throws IOException

Throws:

IOException

writeInlineCount

protected void writeInlineCount(String propertyName,
                                Integer count,
                                com.fasterxml.jackson.core.JsonGenerator json)
                         throws IOException

Throws:

IOException

writeNextLink

protected void writeNextLink(AbstractEntityCollectionObject entitySet,
                             com.fasterxml.jackson.core.JsonGenerator json)
                      throws IOException

Throws:

IOException