Repository: olingo-odata4 Updated Branches: refs/heads/master a75743601 -> d3fad1b16
[OLINGO-935] API for EDM-assisted serializer Signed-off-by: Christian Amend <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/be1228c8 Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/be1228c8 Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/be1228c8 Branch: refs/heads/master Commit: be1228c82163d95c2f5375730131828f84560e6d Parents: a757436 Author: Klaus Straubinger <[email protected]> Authored: Wed Jul 27 10:07:51 2016 +0200 Committer: Christian Amend <[email protected]> Committed: Wed Jul 27 10:13:33 2016 +0200 ---------------------------------------------------------------------- .../org/apache/olingo/server/api/OData.java | 9 + .../api/serializer/EdmAssistedSerializer.java | 40 +++ .../EdmAssistedSerializerOptions.java | 58 +++++ .../apache/olingo/server/core/ODataImpl.java | 12 +- .../json/EdmAssistedJsonSerializer.java | 14 +- .../json/EdmAssistedJsonSerializerTest.java | 254 +++++++++---------- 6 files changed, 251 insertions(+), 136 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/be1228c8/lib/server-api/src/main/java/org/apache/olingo/server/api/OData.java ---------------------------------------------------------------------- diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/OData.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/OData.java index 112f934..f72803b 100644 --- a/lib/server-api/src/main/java/org/apache/olingo/server/api/OData.java +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/OData.java @@ -34,6 +34,7 @@ import org.apache.olingo.server.api.deserializer.ODataDeserializer; import org.apache.olingo.server.api.etag.ETagHelper; import org.apache.olingo.server.api.etag.ServiceMetadataETagSupport; import org.apache.olingo.server.api.prefer.Preferences; +import org.apache.olingo.server.api.serializer.EdmAssistedSerializer; import org.apache.olingo.server.api.serializer.FixedFormatSerializer; import org.apache.olingo.server.api.serializer.ODataSerializer; import org.apache.olingo.server.api.serializer.SerializerException; @@ -175,4 +176,12 @@ public abstract class OData { * @return a debug-response helper */ public abstract DebugResponseHelper createDebugResponseHelper(String debugFormat); + + /** + * Creates a new serializer object capable of working without EDM information + * for rendering content in the specified format. + * @param contentType a content type supported by Olingo + */ + public abstract EdmAssistedSerializer createEdmAssistedSerializer(final ContentType contentType) + throws SerializerException; } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/be1228c8/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializer.java ---------------------------------------------------------------------- diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializer.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializer.java new file mode 100644 index 0000000..5545610 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializer.java @@ -0,0 +1,40 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.olingo.server.api.serializer; + +import org.apache.olingo.commons.api.data.AbstractEntityCollection; +import org.apache.olingo.commons.api.edm.EdmEntityType; +import org.apache.olingo.server.api.ServiceMetadata; + +/** EDM-assisted serializer */ +public interface EdmAssistedSerializer { + + /** + * Writes entity-collection data into an InputStream. + * Information from the EDM is used in addition to information from the data and preferred, + * but the serializer works without any EDM information as well. + * Linked data is always written as expanded items (so closed reference loops have to be avoided). + * @param metadata metadata for the service + * @param referencedEntityType the {@link EdmEntityType} or <code>null</code> if not available + * @param entityCollection the data of the entity collection + * @param options options for the serializer + */ + SerializerResult entityCollection(ServiceMetadata metadata, EdmEntityType referencedEntityType, + AbstractEntityCollection entityCollection, EdmAssistedSerializerOptions options) throws SerializerException; +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/be1228c8/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.java ---------------------------------------------------------------------- diff --git a/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.java b/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.java new file mode 100644 index 0000000..b6a0906 --- /dev/null +++ b/lib/server-api/src/main/java/org/apache/olingo/server/api/serializer/EdmAssistedSerializerOptions.java @@ -0,0 +1,58 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.olingo.server.api.serializer; + +import org.apache.olingo.commons.api.data.ContextURL; + +/** Options for the EDM-assisted serializer. */ +public class EdmAssistedSerializerOptions { + + private ContextURL contextURL; + + /** Gets the {@link ContextURL}. */ + public ContextURL getContextURL() { + return contextURL; + } + + /** Initializes the options builder. */ + public static Builder with() { + return new Builder(); + } + + /** Builder of serializer options. */ + public static final class Builder { + + private final EdmAssistedSerializerOptions options; + + private Builder() { + options = new EdmAssistedSerializerOptions(); + } + + /** Sets the {@link ContextURL}. */ + public Builder contextURL(final ContextURL contextURL) { + options.contextURL = contextURL; + return this; + } + + /** Builds the OData serializer options. */ + public EdmAssistedSerializerOptions build() { + return options; + } + } +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/be1228c8/lib/server-core/src/main/java/org/apache/olingo/server/core/ODataImpl.java ---------------------------------------------------------------------- diff --git a/lib/server-core/src/main/java/org/apache/olingo/server/core/ODataImpl.java b/lib/server-core/src/main/java/org/apache/olingo/server/core/ODataImpl.java index 37b59aa..08693aa 100644 --- a/lib/server-core/src/main/java/org/apache/olingo/server/core/ODataImpl.java +++ b/lib/server-core/src/main/java/org/apache/olingo/server/core/ODataImpl.java @@ -38,6 +38,7 @@ import org.apache.olingo.server.api.deserializer.ODataDeserializer; import org.apache.olingo.server.api.etag.ETagHelper; import org.apache.olingo.server.api.etag.ServiceMetadataETagSupport; import org.apache.olingo.server.api.prefer.Preferences; +import org.apache.olingo.server.api.serializer.EdmAssistedSerializer; import org.apache.olingo.server.api.serializer.FixedFormatSerializer; import org.apache.olingo.server.api.serializer.ODataSerializer; import org.apache.olingo.server.api.serializer.SerializerException; @@ -50,6 +51,7 @@ import org.apache.olingo.server.core.deserializer.xml.ODataXmlDeserializer; import org.apache.olingo.server.core.etag.ETagHelperImpl; import org.apache.olingo.server.core.prefer.PreferencesImpl; import org.apache.olingo.server.core.serializer.FixedFormatSerializerImpl; +import org.apache.olingo.server.core.serializer.json.EdmAssistedJsonSerializer; import org.apache.olingo.server.core.serializer.json.ODataJsonSerializer; import org.apache.olingo.server.core.serializer.xml.ODataXmlSerializer; import org.apache.olingo.server.core.uri.UriHelperImpl; @@ -87,6 +89,15 @@ public class ODataImpl extends OData { } @Override + public EdmAssistedSerializer createEdmAssistedSerializer(final ContentType contentType) throws SerializerException { + if (contentType.isCompatible(ContentType.APPLICATION_JSON)) { + return new EdmAssistedJsonSerializer(contentType); + } + throw new SerializerException("Unsupported format: " + contentType.toContentTypeString(), + SerializerException.MessageKeys.UNSUPPORTED_FORMAT, contentType.toContentTypeString()); + } + + @Override public ODataHttpHandler createHandler(final ServiceMetadata serviceMetadata) { return new ODataHttpHandlerImpl(this, serviceMetadata); } @@ -165,5 +176,4 @@ public class ODataImpl extends OData { // TODO: Support more debug formats return new DebugResponseHelperImpl(debugFormat); } - } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/be1228c8/lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializer.java ---------------------------------------------------------------------- diff --git a/lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializer.java b/lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializer.java index 8d15957..66cc15c 100644 --- a/lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializer.java +++ b/lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializer.java @@ -47,6 +47,8 @@ import org.apache.olingo.commons.api.format.ContentType; import org.apache.olingo.commons.core.edm.EdmTypeInfo; import org.apache.olingo.commons.core.edm.primitivetype.EdmPrimitiveTypeFactory; import org.apache.olingo.server.api.ServiceMetadata; +import org.apache.olingo.server.api.serializer.EdmAssistedSerializer; +import org.apache.olingo.server.api.serializer.EdmAssistedSerializerOptions; import org.apache.olingo.server.api.serializer.SerializerException; import org.apache.olingo.server.api.serializer.SerializerException.MessageKeys; import org.apache.olingo.server.api.serializer.SerializerResult; @@ -58,7 +60,7 @@ import org.apache.olingo.server.core.serializer.utils.ContextURLBuilder; import com.fasterxml.jackson.core.JsonFactory; import com.fasterxml.jackson.core.JsonGenerator; -public class EdmAssistedJsonSerializer { +public class EdmAssistedJsonSerializer implements EdmAssistedSerializer { private static final String IO_EXCEPTION_TEXT = "An I/O exception occurred."; @@ -70,14 +72,16 @@ public class EdmAssistedJsonSerializer { this.isODataMetadataNone = ContentTypeHelper.isODataMetadataNone(contentType); } + @Override public SerializerResult entityCollection(final ServiceMetadata metadata, final EdmEntityType entityType, - final AbstractEntityCollection entityCollection, final ContextURL contextURL) throws SerializerException { - return serialize(metadata, entityType, entityCollection, contextURL); + final AbstractEntityCollection entityCollection, final EdmAssistedSerializerOptions options) + throws SerializerException { + return serialize(metadata, entityType, entityCollection, options == null ? null : options.getContextURL()); } public SerializerResult entity(final ServiceMetadata metadata, final EdmEntityType entityType, final Entity entity, - final ContextURL contextURL) throws SerializerException { - return serialize(metadata, entityType, entity, contextURL); + final EdmAssistedSerializerOptions options) throws SerializerException { + return serialize(metadata, entityType, entity, options == null ? null : options.getContextURL()); } protected SerializerResult serialize(final ServiceMetadata metadata, final EdmEntityType entityType, http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/be1228c8/lib/server-test/src/test/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializerTest.java ---------------------------------------------------------------------- diff --git a/lib/server-test/src/test/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializerTest.java b/lib/server-test/src/test/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializerTest.java index d6f4e73..030a5eb 100644 --- a/lib/server-test/src/test/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializerTest.java +++ b/lib/server-test/src/test/java/org/apache/olingo/server/core/serializer/json/EdmAssistedJsonSerializerTest.java @@ -18,6 +18,7 @@ */ package org.apache.olingo.server.core.serializer.json; +import java.io.IOException; import java.math.BigDecimal; import java.net.URI; import java.util.Arrays; @@ -27,9 +28,9 @@ import java.util.TimeZone; import java.util.UUID; import org.apache.commons.io.IOUtils; +import org.apache.olingo.commons.api.data.AbstractEntityCollection; import org.apache.olingo.commons.api.data.ComplexValue; import org.apache.olingo.commons.api.data.ContextURL; -import org.apache.olingo.commons.api.data.ContextURL.Suffix; import org.apache.olingo.commons.api.data.Entity; import org.apache.olingo.commons.api.data.EntityCollection; import org.apache.olingo.commons.api.data.Link; @@ -41,6 +42,8 @@ import org.apache.olingo.commons.api.edmx.EdmxReference; import org.apache.olingo.commons.api.format.ContentType; import org.apache.olingo.server.api.OData; import org.apache.olingo.server.api.ServiceMetadata; +import org.apache.olingo.server.api.serializer.EdmAssistedSerializer; +import org.apache.olingo.server.api.serializer.EdmAssistedSerializerOptions; import org.apache.olingo.server.api.serializer.SerializerException; import org.apache.olingo.server.tecsvc.MetadataETagSupport; import org.apache.olingo.server.tecsvc.provider.EdmTechProvider; @@ -52,46 +55,38 @@ public class EdmAssistedJsonSerializerTest { private static final ServiceMetadata metadata = oData.createServiceMetadata( new EdmTechProvider(), Collections.<EdmxReference> emptyList(), null); private static final EdmEntityContainer entityContainer = metadata.getEdm().getEntityContainer(); - private final EdmAssistedJsonSerializer serializer = new EdmAssistedJsonSerializer(ContentType.JSON); + private final EdmAssistedSerializer serializer; + + public EdmAssistedJsonSerializerTest() throws SerializerException { + serializer = oData.createEdmAssistedSerializer(ContentType.JSON); + } @Test - public void entity() throws Exception { + public void entityCollectionSimple() throws Exception { Entity entity = new Entity(); entity.setId(null); entity.addProperty(new Property(null, "Property1", ValueType.PRIMITIVE, 1.25F)); - final String resultString = IOUtils.toString( - serializer.entity(metadata, null, entity, - ContextURL.with().entitySetOrSingletonOrType("EntitySet").selectList("Property1") - .suffix(Suffix.ENTITY) - .build()) - .getContent()); - final String expectedResult = - "{\"@odata.context\":\"$metadata#EntitySet(Property1)/$entity\"," - + "\"@odata.id\":null," - + "\"[email protected]\":\"Single\",\"Property1\":1.25" - + "}"; - Assert.assertEquals(expectedResult, resultString); + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add(entity); + Assert.assertEquals("{\"@odata.context\":\"$metadata#EntitySet(Property1)\"," + + "\"value\":[{\"@odata.id\":null,\"[email protected]\":\"Single\",\"Property1\":1.25}]}", + serialize(serializer, metadata, null, entityCollection, null)); } @Test - public void entityWithEdm() throws Exception { + public void entityCollectionWithEdm() throws Exception { final EdmEntitySet entitySet = entityContainer.getEntitySet("ESTwoPrim"); Entity entity = new Entity(); entity.setId(null); entity.addProperty(new Property(null, "PropertyInt16", ValueType.PRIMITIVE, (short) 1)) .addProperty(new Property(null, "PropertyString", ValueType.PRIMITIVE, "test")) .addProperty(new Property(null, "AdditionalProperty", ValueType.PRIMITIVE, (byte) 42)); - final String resultString = IOUtils.toString( - serializer.entity(metadata, entitySet.getEntityType(), entity, - ContextURL.with().entitySet(entitySet).suffix(Suffix.ENTITY).build()) - .getContent()); - final String expectedResult = - "{\"@odata.context\":\"$metadata#ESTwoPrim/$entity\"," - + "\"@odata.id\":null," + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add(entity); + Assert.assertEquals("{\"@odata.context\":\"$metadata#ESTwoPrim\",\"value\":[{\"@odata.id\":null," + "\"PropertyInt16\":1,\"PropertyString\":\"test\"," - + "\"[email protected]\":\"SByte\",\"AdditionalProperty\":42" - + "}"; - Assert.assertEquals(expectedResult, resultString); + + "\"[email protected]\":\"SByte\",\"AdditionalProperty\":42}]}", + serialize(serializer, metadata, entitySet, entityCollection, null)); } @Test @@ -111,25 +106,17 @@ public class EdmAssistedJsonSerializerTest { entityCollection.getEntities().add(entity); entityCollection.setCount(2); entityCollection.setNext(URI.create("nextLink")); - final String resultString = IOUtils.toString( - serializer.entityCollection(metadata, null, entityCollection, - ContextURL.with().entitySetOrSingletonOrType("EntitySet") - .selectList("Property0,Property1,Property2,Property3,Property4") - .build()) - .getContent()); - final String expectedResult = + Assert.assertEquals( "{\"@odata.context\":\"$metadata#EntitySet(Property0,Property1,Property2,Property3,Property4)\"," - + "\"@odata.count\":2," - + "\"value\":[{\"@odata.id\":null," - + "\"Property0\":null," - + "\"[email protected]\":\"Int32\",\"Property1\":1," - + "\"[email protected]\":\"Date\",\"Property2\":\"2000-02-29\"," - + "\"[email protected]\":\"DateTimeOffset\",\"Property3\":\"2000-02-29T00:00:00Z\"," - + "\"[email protected]\":\"#Collection(Boolean)\",\"Property4\":[true,false,null]" - + "}]," - + "\"@odata.nextLink\":\"nextLink\"" - + "}"; - Assert.assertEquals(expectedResult, resultString); + + "\"@odata.count\":2," + + "\"value\":[{\"@odata.id\":null," + + "\"Property0\":null," + + "\"[email protected]\":\"Int32\",\"Property1\":1," + + "\"[email protected]\":\"Date\",\"Property2\":\"2000-02-29\"," + + "\"[email protected]\":\"DateTimeOffset\",\"Property3\":\"2000-02-29T00:00:00Z\"," + + "\"[email protected]\":\"#Collection(Boolean)\",\"Property4\":[true,false,null]}]," + + "\"@odata.nextLink\":\"nextLink\"}", + serialize(serializer, metadata, null, entityCollection, null)); } @Test @@ -147,14 +134,10 @@ public class EdmAssistedJsonSerializerTest { + "\"[email protected]\":\"Int64\",\"Property1\":\"-9223372036854775808\"," + "\"[email protected]\":\"Decimal\",\"Property2\":\"922337203.6854775807\"," + "\"[email protected]\":\"Byte\",\"Property3\":20}]}", - IOUtils.toString( - new EdmAssistedJsonSerializer( - ContentType.create(ContentType.JSON, ContentType.PARAMETER_IEEE754_COMPATIBLE, "true")) - .entityCollection(metadata, null, entityCollection, - ContextURL.with().entitySetOrSingletonOrType("EntitySet") - .selectList("Property1,Property2,Property3") - .build()) - .getContent())); + serialize( + oData.createEdmAssistedSerializer( + ContentType.create(ContentType.JSON, ContentType.PARAMETER_IEEE754_COMPATIBLE, "true")), + metadata, null, entityCollection, null)); } @Test @@ -174,23 +157,17 @@ public class EdmAssistedJsonSerializerTest { entity.addProperty(new Property("Namespace.ComplexType", "Property2", ValueType.COMPLEX, complexValue)); EntityCollection entityCollection = new EntityCollection(); entityCollection.getEntities().add(entity); - final String resultString = IOUtils.toString( - serializer.entityCollection(metadata, null, entityCollection, - ContextURL.with().entitySetOrSingletonOrType("EntitySet").selectList("Property1,Property2").build()) - .getContent()); - final String expectedResult = "{\"@odata.context\":\"$metadata#EntitySet(Property1,Property2)\"," + Assert.assertEquals("{\"@odata.context\":\"$metadata#EntitySet(Property1,Property2)\"," + "\"value\":[{\"@odata.id\":null," + "\"[email protected]\":\"Int64\",\"Property1\":1," - + "\"Property2\":{" - + "\"@odata.type\":\"#Namespace.ComplexType\"," + + "\"Property2\":{\"@odata.type\":\"#Namespace.ComplexType\"," + "\"[email protected]\":\"Decimal\",\"Inner1\":0.00010," - + "\"[email protected]\":\"TimeOfDay\",\"Inner2\":\"13:00:59.999\"" - + "}}]}"; - Assert.assertEquals(expectedResult, resultString); + + "\"[email protected]\":\"TimeOfDay\",\"Inner2\":\"13:00:59.999\"}}]}", + serialize(serializer, metadata, null, entityCollection, null)); } @Test - public void entityWithComplexCollection() throws Exception { + public void entityCollectionWithComplexCollection() throws Exception { final EdmEntitySet entitySet = entityContainer.getEntitySet("ESMixPrimCollComp"); ComplexValue complexValue1 = new ComplexValue(); complexValue1.getValue().add(new Property(null, "PropertyInt16", ValueType.PRIMITIVE, 1)); @@ -201,35 +178,30 @@ public class EdmAssistedJsonSerializerTest { ComplexValue complexValue3 = new ComplexValue(); complexValue3.getValue().add(new Property(null, "PropertyInt16", ValueType.PRIMITIVE, 3)); complexValue3.getValue().add(new Property(null, "PropertyString", ValueType.PRIMITIVE, "three")); - final Entity entity = new Entity() + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add(new Entity() .addProperty(new Property(null, "CollPropertyComp", ValueType.COLLECTION_COMPLEX, - Arrays.asList(complexValue1, complexValue2, complexValue3))); - final String resultString = IOUtils.toString( - serializer.entity(metadata, entitySet.getEntityType(), entity, - ContextURL.with().entitySet(entitySet).selectList("CollPropertyComp").build()) - .getContent()); - final String expectedResult = "{\"@odata.context\":\"$metadata#ESMixPrimCollComp(CollPropertyComp)\"," - + "\"@odata.id\":null," + Arrays.asList(complexValue1, complexValue2, complexValue3)))); + Assert.assertEquals("{\"@odata.context\":\"$metadata#ESMixPrimCollComp(CollPropertyComp)\"," + + "\"value\":[{\"@odata.id\":null," + "\"CollPropertyComp\":[" + "{\"PropertyInt16\":1,\"PropertyString\":\"one\"}," + "{\"PropertyInt16\":2,\"PropertyString\":\"two\"}," - + "{\"PropertyInt16\":3,\"PropertyString\":\"three\"}]}"; - Assert.assertEquals(expectedResult, resultString); + + "{\"PropertyInt16\":3,\"PropertyString\":\"three\"}]}]}", + serialize(serializer, metadata, entitySet, entityCollection, "CollPropertyComp")); } @Test - public void entityWithEmptyCollection() throws Exception { + public void entityCollectionWithEmptyCollection() throws Exception { final EdmEntitySet entitySet = entityContainer.getEntitySet("ESMixPrimCollComp"); - final Entity entity = new Entity() + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add(new Entity() .addProperty(new Property(null, "CollPropertyString", ValueType.COLLECTION_PRIMITIVE, - Collections.emptyList())); + Collections.emptyList()))); Assert.assertEquals( "{\"@odata.context\":\"$metadata#ESMixPrimCollComp(CollPropertyString)\"," - + "\"@odata.id\":null,\"CollPropertyString\":[]}", - IOUtils.toString( - serializer.entity(metadata, entitySet.getEntityType(), entity, - ContextURL.with().entitySet(entitySet).selectList("CollPropertyString").build()) - .getContent())); + + "\"value\":[{\"@odata.id\":null,\"CollPropertyString\":[]}]}", + serialize(serializer, metadata, entitySet, entityCollection, "CollPropertyString")); } @Test @@ -248,20 +220,13 @@ public class EdmAssistedJsonSerializerTest { entity.getNavigationLinks().add(link); EntityCollection entityCollection = new EntityCollection(); entityCollection.getEntities().add(entity); - final String resultString = IOUtils.toString( - serializer.entityCollection(metadata, null, entityCollection, - ContextURL.with().entitySetOrSingletonOrType("EntitySet") - .selectList("Property1,NavigationProperty(Related1)").build()) - .getContent()); - final String expectedResult = - "{\"@odata.context\":\"$metadata#EntitySet(Property1,NavigationProperty(Related1))\"," + Assert.assertEquals("{\"@odata.context\":\"$metadata#EntitySet(Property1,NavigationProperty(Related1))\"," + "\"value\":[{\"@odata.id\":null," + "\"[email protected]\":\"Int16\",\"Property1\":1," + "\"NavigationProperty\":[" + "{\"@odata.id\":null,\"[email protected]\":\"Double\",\"Related1\":1.5}," - + "{\"@odata.id\":null,\"[email protected]\":\"Double\",\"Related1\":2.75}" - + "]}]}"; - Assert.assertEquals(expectedResult, resultString); + + "{\"@odata.id\":null,\"[email protected]\":\"Double\",\"Related1\":2.75}]}]}", + serialize(serializer, metadata, null, entityCollection, "Property1,NavigationProperty(Related1)")); } @Test @@ -277,17 +242,12 @@ public class EdmAssistedJsonSerializerTest { link.setTitle("NavPropertyETAllPrimOne"); link.setInlineEntity(target); entity.getNavigationLinks().add(link); - final String resultString = IOUtils.toString( - serializer.entity(metadata, entitySet.getEntityType(), entity, - ContextURL.with().entitySet(entitySet).suffix(Suffix.ENTITY).build()) - .getContent()); - final String expectedResult = - "{\"@odata.context\":\"$metadata#ESTwoPrim/$entity\"," - + "\"@odata.id\":null," + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add(entity); + Assert.assertEquals("{\"@odata.context\":\"$metadata#ESTwoPrim\",\"value\":[{\"@odata.id\":null," + "\"PropertyInt16\":42,\"PropertyString\":\"test\"," - + "\"NavPropertyETAllPrimOne\":{\"@odata.id\":null,\"PropertyInt16\":2,\"PropertyByte\":3}" - + "}"; - Assert.assertEquals(expectedResult, resultString); + + "\"NavPropertyETAllPrimOne\":{\"@odata.id\":null,\"PropertyInt16\":2,\"PropertyByte\":3}}]}", + serialize(serializer, metadata, entitySet, entityCollection, null)); } @Test @@ -304,64 +264,70 @@ public class EdmAssistedJsonSerializerTest { entity.setMediaContentSource(URI.create("media")); entity.addProperty(new Property(null, "Property1", ValueType.PRIMITIVE, UUID.fromString("12345678-ABCD-1234-CDEF-123456789012"))); - final ContextURL contextURL = ContextURL.with().entitySetOrSingletonOrType("EntitySet").selectList("Property1") - .suffix(Suffix.ENTITY).build(); - final String resultString = IOUtils.toString(serializer.entity(metadata, null, entity, contextURL).getContent()); - final String expectedResult = - "{\"@odata.context\":\"$metadata#EntitySet(Property1)/$entity\"," - + "\"@odata.metadataEtag\":\"W/\\\"42\\\"\"," + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add(entity); + Assert.assertEquals("{\"@odata.context\":\"$metadata#EntitySet(Property1)\"," + + "\"@odata.metadataEtag\":\"W/\\\"42\\\"\",\"value\":[{" + "\"@odata.etag\":\"W/\\\"1000\\\"\"," + "\"@odata.type\":\"#Namespace.EntityType\"," + "\"@odata.id\":\"ID\"," + "\"[email protected]\":\"Guid\",\"Property1\":\"12345678-abcd-1234-cdef-123456789012\"," + "\"@odata.editLink\":\"editLink\"," - + "\"@odata.mediaReadLink\":\"editLink/$value\"" - + "}"; - Assert.assertEquals(expectedResult, resultString); + + "\"@odata.mediaReadLink\":\"editLink/$value\"}]}", + serialize(serializer, metadata, null, entityCollection, null)); - Assert.assertEquals("{\"Property1\":\"12345678-abcd-1234-cdef-123456789012\"}", - IOUtils.toString(new EdmAssistedJsonSerializer(ContentType.JSON_NO_METADATA) - .entity(metadata, null, entity, contextURL).getContent())); + Assert.assertEquals("{\"value\":[{\"Property1\":\"12345678-abcd-1234-cdef-123456789012\"}]}", + serialize(oData.createEdmAssistedSerializer(ContentType.JSON_NO_METADATA), metadata, + null, entityCollection, null)); } @Test(expected = SerializerException.class) public void enumType() throws Exception { - serializer.entity(metadata, null, - new Entity().addProperty(new Property(null, "Property1", ValueType.ENUM, 42)), null); + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( + new Entity().addProperty(new Property(null, "Property1", ValueType.ENUM, 42))); + serializer.entityCollection(metadata, null, entityCollection, null); } @Test(expected = SerializerException.class) public void collectionEnumType() throws Exception { - serializer.entity(metadata, null, - new Entity().addProperty(new Property(null, "Property1", ValueType.COLLECTION_ENUM, Arrays.asList(42))), - null); + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( + new Entity().addProperty(new Property(null, "Property1", ValueType.COLLECTION_ENUM, Arrays.asList(42)))); + serializer.entityCollection(metadata, null, entityCollection, null); } @Test(expected = SerializerException.class) public void geoType() throws Exception { - serializer.entity(metadata, null, - new Entity().addProperty(new Property(null, "Property1", ValueType.GEOSPATIAL, 1)), null); + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( + new Entity().addProperty(new Property(null, "Property1", ValueType.GEOSPATIAL, 1))); + serializer.entityCollection(metadata, null, entityCollection, null); } @Test(expected = SerializerException.class) public void unsupportedType() throws Exception { - serializer.entity(metadata, null, - new Entity().addProperty(new Property(null, "Property1", ValueType.PRIMITIVE, TimeZone.getDefault())), - null); + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( + new Entity().addProperty(new Property(null, "Property1", ValueType.PRIMITIVE, TimeZone.getDefault()))); + serializer.entityCollection(metadata, null, entityCollection, null); } @Test(expected = SerializerException.class) public void wrongValueForType() throws Exception { - serializer.entity(metadata, null, - new Entity().addProperty(new Property("Edm.SByte", "Property1", ValueType.PRIMITIVE, "-1")), - null); + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( + new Entity().addProperty(new Property("Edm.SByte", "Property1", ValueType.PRIMITIVE, "-1"))); + serializer.entityCollection(metadata, null, entityCollection, null); } @Test(expected = SerializerException.class) public void wrongValueForPropertyFacet() throws Exception { - serializer.entity(metadata, entityContainer.getEntitySet("ESAllPrim").getEntityType(), + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( new Entity().addProperty( - new Property(null, "PropertyDecimal", ValueType.PRIMITIVE, BigDecimal.ONE.scaleByPowerOfTen(-11))), + new Property(null, "PropertyDecimal", ValueType.PRIMITIVE, BigDecimal.ONE.scaleByPowerOfTen(-11)))); + serializer.entityCollection(metadata, entityContainer.getEntitySet("ESAllPrim").getEntityType(), entityCollection, null); } @@ -373,10 +339,38 @@ public class EdmAssistedJsonSerializerTest { ComplexValue complexValue = new ComplexValue(); complexValue.getValue().add(new Property(null, "PropertyComp", ValueType.COMPLEX, innerComplexValue)); - serializer.entity(metadata, entityContainer.getEntitySet("ESKeyNav").getEntityType(), + EntityCollection entityCollection = new EntityCollection(); + entityCollection.getEntities().add( new Entity().addProperty( new Property(null, "CollPropertyComp", ValueType.COLLECTION_COMPLEX, - Collections.singletonList(complexValue))), + Collections.singletonList(complexValue)))); + serializer.entityCollection(metadata, entityContainer.getEntitySet("ESKeyNav").getEntityType(), entityCollection, null); } + + private String serialize(final EdmAssistedSerializer serializer, final ServiceMetadata metadata, + final EdmEntitySet edmEntitySet, final AbstractEntityCollection entityCollection, final String selectList) + throws SerializerException, IOException { + ContextURL.Builder contextURLBuilder = ContextURL.with(); + contextURLBuilder = edmEntitySet == null ? + contextURLBuilder.entitySetOrSingletonOrType("EntitySet") : + contextURLBuilder.entitySet(edmEntitySet); + if (selectList == null) { + if (edmEntitySet == null) { + StringBuilder names = new StringBuilder(); + for (final Property property : entityCollection.iterator().next().getProperties()) { + names.append(names.length() > 0 ? ',' : "").append(property.getName()); + } + contextURLBuilder = contextURLBuilder.selectList(names.toString()); + } + } else { + contextURLBuilder = contextURLBuilder.selectList(selectList); + } + return IOUtils.toString( + serializer.entityCollection(metadata, + edmEntitySet == null ? null : edmEntitySet.getEntityType(), + entityCollection, + EdmAssistedSerializerOptions.with().contextURL(contextURLBuilder.build()).build()) + .getContent()); + } }
