You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@olingo.apache.org by ch...@apache.org on 2015/10/22 10:40:08 UTC
[25/48] olingo-odata4 git commit: [OLINGO-713] Added Media Entities
tutorial
[OLINGO-713] Added Media Entities tutorial
Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo
Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/16f5c55d
Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/16f5c55d
Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/16f5c55d
Branch: refs/heads/olingo786
Commit: 16f5c55ddf18ae612c6d4f423980ce38dc7abf9b
Parents: f90ed1b
Author: Christian Holzer <c....@sap.com>
Authored: Wed Oct 7 15:00:22 2015 +0200
Committer: Christian Holzer <c....@sap.com>
Committed: Tue Oct 13 14:29:00 2015 +0200
----------------------------------------------------------------------
.../myservice/mynamespace/data/Storage.java | 96 +++-
.../mynamespace/service/DemoEdmProvider.java | 48 +-
.../service/DemoEntityProcessor.java | 87 +++-
samples/tutorials/p10_media/pom.xml | 85 ++++
.../myservice/mynamespace/data/Storage.java | 480 +++++++++++++++++++
.../mynamespace/service/DemoEdmProvider.java | 239 +++++++++
.../service/DemoEntityCollectionProcessor.java | 150 ++++++
.../service/DemoEntityProcessor.java | 327 +++++++++++++
.../service/DemoPrimitiveProcessor.java | 146 ++++++
.../java/myservice/mynamespace/util/Util.java | 161 +++++++
.../myservice/mynamespace/web/DemoServlet.java | 73 +++
.../p10_media/src/main/webapp/WEB-INF/web.xml | 40 ++
.../p10_media/src/main/webapp/index.jsp | 26 +
.../myservice/mynamespace/data/Storage.java | 16 +-
.../myservice/mynamespace/data/Storage.java | 16 +-
samples/tutorials/pom.xml | 1 +
16 files changed, 1949 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/data/Storage.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/data/Storage.java b/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/data/Storage.java
index 2cf43ec..8ef4be9 100644
--- a/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/data/Storage.java
+++ b/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/data/Storage.java
@@ -20,9 +20,11 @@ package myservice.mynamespace.data;
import java.net.URI;
import java.net.URISyntaxException;
+import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
+import java.util.UUID;
import myservice.mynamespace.service.DemoEdmProvider;
import myservice.mynamespace.util.Util;
@@ -36,6 +38,7 @@ import org.apache.olingo.commons.api.edm.EdmEntityType;
import org.apache.olingo.commons.api.edm.EdmKeyPropertyRef;
import org.apache.olingo.commons.api.edm.FullQualifiedName;
import org.apache.olingo.commons.api.ex.ODataRuntimeException;
+import org.apache.olingo.commons.api.format.ContentType;
import org.apache.olingo.commons.api.http.HttpMethod;
import org.apache.olingo.commons.api.http.HttpStatusCode;
import org.apache.olingo.server.api.ODataApplicationException;
@@ -45,18 +48,24 @@ import org.apache.olingo.server.api.uri.UriResourceFunction;
public class Storage {
+ /** Special property to store the media content **/
+ private static final String MEDIA_PROPERTY_NAME = "$value";
+
// represent our database
private List<Entity> productList;
private List<Entity> categoryList;
-
+ private List<Entity> advertisments;
+
public Storage() {
productList = new ArrayList<Entity>();
categoryList = new ArrayList<Entity>();
-
+ advertisments = new ArrayList<Entity>();
+
// creating some sample data
initProductSampleData();
initCategorySampleData();
+ initAdvertismentSampleData();
}
/* PUBLIC FACADE */
@@ -135,6 +144,8 @@ public class Storage {
return getEntityCollection(productList);
} else if (edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
return getEntityCollection(categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ return getEntityCollection(advertisments);
}
return null;
@@ -145,10 +156,12 @@ public class Storage {
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
- if (edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)) {
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
return getEntity(edmEntityType, keyParams, productList);
- } else if (edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)) {
+ } else if (edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
return getEntity(edmEntityType, keyParams, categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ return getEntity(edmEntityType, keyParams, advertisments);
}
return null;
@@ -210,9 +223,9 @@ public class Storage {
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
- if (edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)) {
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
return createEntity(edmEntityType, entityToCreate, productList);
- } else if (edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)) {
+ } else if (edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
return createEntity(edmEntityType, entityToCreate, categoryList);
}
@@ -226,11 +239,13 @@ public class Storage {
HttpMethod httpMethod) throws ODataApplicationException {
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
-
- if (edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)) {
+
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
updateEntity(edmEntityType, keyParams, updateEntity, httpMethod, productList);
- } else if (edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)) {
+ } else if (edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
updateEntity(edmEntityType, keyParams, updateEntity, httpMethod, categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ updateEntity(edmEntityType, keyParams, updateEntity, httpMethod, advertisments);
}
}
@@ -239,13 +254,44 @@ public class Storage {
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
- if (edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)) {
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
deleteEntity(edmEntityType, keyParams, productList);
- } else if (edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)) {
+ } else if (edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
deleteEntity(edmEntityType, keyParams, categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ deleteEntity(edmEntityType, keyParams, advertisments);
}
}
-
+
+ public byte[] readMedia(final Entity entity) {
+ return (byte[]) entity.getProperty(MEDIA_PROPERTY_NAME).asPrimitive();
+ }
+
+ public void updateMedia(final Entity entity, final String mediaContentType, final byte[] data) {
+ entity.getProperties().remove(entity.getProperty(MEDIA_PROPERTY_NAME));
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, data));
+ entity.setMediaContentType(mediaContentType);
+ }
+
+ public Entity createMediaEntity(final EdmEntityType edmEntityType, final String mediaContentType,
+ final byte[] data) {
+ Entity entity = null;
+
+ if(edmEntityType.getName().equals(DemoEdmProvider.ET_ADVERTISMENT_NAME)) {
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, UUID.randomUUID()));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, null));
+ entity.addProperty(new Property(null, "AirDate", ValueType.PRIMITIVE, null));
+
+ entity.setMediaContentType(mediaContentType);
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, data));
+
+ advertisments.add(entity);
+ }
+
+ return entity;
+ }
+
/* INTERNAL */
private Entity createEntity(EdmEntityType edmEntityType, Entity entity, List<Entity> entityList) {
@@ -352,7 +398,8 @@ public class Storage {
Entity entity = getEntity(edmEntityType, keyParams, entityList);
if (entity == null) {
- throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH);
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
}
entityList.remove(entity);
@@ -451,7 +498,28 @@ public class Storage {
entity.setId(createId(entity, "ID"));
categoryList.add(entity);
}
-
+
+private void initAdvertismentSampleData() {
+
+ Entity entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE,
+ UUID.fromString("f89dee73-af9f-4cd4-b330-db93c25ff3c7")));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Old School Lemonade Store, Retro Style"));
+ entity.addProperty(new Property(null, "AirDate", ValueType.PRIMITIVE, Timestamp.valueOf("2012-11-07 00:00:00")));
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, "Super content".getBytes()));
+ entity.setMediaContentType(ContentType.parse("text/plain").toContentTypeString());
+ advertisments.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE,
+ UUID.fromString("db2d2186-1c29-4d1e-88ef-a127f521b9c67")));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Early morning start, need coffee"));
+ entity.addProperty(new Property(null, "AirDate", ValueType.PRIMITIVE, Timestamp.valueOf("2000-02-29 00:00:00")));
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, "Super content2".getBytes()));
+ entity.setMediaContentType(ContentType.parse("text/plain").toContentTypeString());
+ advertisments.add(entity);
+ }
+
private URI createId(Entity entity, String idPropertyName) {
return createId(entity, idPropertyName, null);
}
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java b/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
index 6e4bae2..d878ca8 100644
--- a/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
+++ b/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
@@ -20,6 +20,7 @@ package myservice.mynamespace.service;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collections;
import java.util.List;
import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeKind;
@@ -56,27 +57,31 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
public static final String ET_CATEGORY_NAME = "Category";
public static final FullQualifiedName ET_CATEGORY_FQN = new FullQualifiedName(NAMESPACE, ET_CATEGORY_NAME);
-
+
+ public static final String ET_ADVERTISMENT_NAME = "Advertisment";
+ public static final FullQualifiedName ET_ADVERTISMENT_FQN = new FullQualifiedName(NAMESPACE, ET_ADVERTISMENT_NAME);
+
// Entity Set Names
public static final String ES_PRODUCTS_NAME = "Products";
public static final String ES_CATEGORIES_NAME = "Categories";
+ public static final String ES_ADVERTISMENTS_NAME = "Advertisments";
public static final String NAV_TO_CATEGORY = "Category";
public static final String NAV_TO_PRODUCTS = "Products";
-
+
//Action
- public static final String ACTION_RESET = "Reset";
- public static final FullQualifiedName ACTION_RESET_FQN = new FullQualifiedName(NAMESPACE, ACTION_RESET);
+ public static final String ACTION_RESET = "Reset";
+ public static final FullQualifiedName ACTION_RESET_FQN = new FullQualifiedName(NAMESPACE, ACTION_RESET);
- // Function
- public static final String FUNCTION_COUNT_CATEGORIES = "CountCategories";
- public static final FullQualifiedName FUNCTION_COUNT_CATEGORIES_FQN
+ // Function
+ public static final String FUNCTION_COUNT_CATEGORIES = "CountCategories";
+ public static final FullQualifiedName FUNCTION_COUNT_CATEGORIES_FQN
= new FullQualifiedName(NAMESPACE, FUNCTION_COUNT_CATEGORIES);
- // Function/Action Parameters
- public static final String PARAMETER_AMOUNT = "Amount";
+ // Function/Action Parameters
+ public static final String PARAMETER_AMOUNT = "Amount";
- @Override
- public List<CsdlAction> getActions(final FullQualifiedName actionName) {
+ @Override
+ public List<CsdlAction> getActions(final FullQualifiedName actionName) {
if(actionName.equals(ACTION_RESET_FQN)) {
// It is allowed to overload actions, so we have to provide a list of Actions for each action name
final List<CsdlAction> actions = new ArrayList<CsdlAction>();
@@ -213,6 +218,21 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
entityType.setProperties(Arrays.asList(id, name));
entityType.setKey(Arrays.asList(propertyRef));
entityType.setNavigationProperties(navPropList);
+ } else if(entityTypeName.equals(ET_ADVERTISMENT_FQN)) {
+ CsdlProperty id = new CsdlProperty().setName("ID").setType(EdmPrimitiveTypeKind.Guid.getFullQualifiedName());
+ CsdlProperty name = new CsdlProperty().setName("Name").setType(EdmPrimitiveTypeKind.String
+ .getFullQualifiedName());
+ CsdlProperty airDate = new CsdlProperty().setName("AirDate").setType(EdmPrimitiveTypeKind.DateTimeOffset
+ .getFullQualifiedName());
+
+ CsdlPropertyRef propertyRef = new CsdlPropertyRef();
+ propertyRef.setName("ID");
+
+ entityType = new CsdlEntityType();
+ entityType.setName(ET_ADVERTISMENT_NAME);
+ entityType.setProperties(Arrays.asList(id, name, airDate));
+ entityType.setKey(Collections.singletonList(propertyRef));
+ entityType.setHasStream(true);
}
return entityType;
@@ -253,6 +273,10 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
List<CsdlNavigationPropertyBinding> navPropBindingList = new ArrayList<CsdlNavigationPropertyBinding>();
navPropBindingList.add(navPropBinding);
entitySet.setNavigationPropertyBindings(navPropBindingList);
+ } else if (entitySetName.equals(ES_ADVERTISMENTS_NAME)) {
+ entitySet = new CsdlEntitySet();
+ entitySet.setName(ES_ADVERTISMENTS_NAME);
+ entitySet.setType(ET_ADVERTISMENT_FQN);
}
}
@@ -283,6 +307,7 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
List<CsdlEntityType> entityTypes = new ArrayList<CsdlEntityType>();
entityTypes.add(getEntityType(ET_PRODUCT_FQN));
entityTypes.add(getEntityType(ET_CATEGORY_FQN));
+ entityTypes.add(getEntityType(ET_ADVERTISMENT_FQN));
schema.setEntityTypes(entityTypes);
// add actions
@@ -312,6 +337,7 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
List<CsdlEntitySet> entitySets = new ArrayList<CsdlEntitySet>();
entitySets.add(getEntitySet(CONTAINER, ES_PRODUCTS_NAME));
entitySets.add(getEntitySet(CONTAINER, ES_CATEGORIES_NAME));
+ entitySets.add(getEntitySet(CONTAINER, ES_ADVERTISMENTS_NAME));
// Create function imports
List<CsdlFunctionImport> functionImports = new ArrayList<CsdlFunctionImport>();
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java b/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
index 97a4dc5..e349182 100644
--- a/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
+++ b/samples/tutorials/p0_all/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
@@ -39,6 +39,7 @@ import org.apache.olingo.commons.api.http.HttpMethod;
import org.apache.olingo.commons.api.http.HttpStatusCode;
import org.apache.olingo.server.api.OData;
import org.apache.olingo.server.api.ODataApplicationException;
+import org.apache.olingo.server.api.ODataLibraryException;
import org.apache.olingo.server.api.ODataRequest;
import org.apache.olingo.server.api.ODataResponse;
import org.apache.olingo.server.api.ServiceMetadata;
@@ -46,6 +47,7 @@ import org.apache.olingo.server.api.deserializer.DeserializerException;
import org.apache.olingo.server.api.deserializer.DeserializerResult;
import org.apache.olingo.server.api.deserializer.ODataDeserializer;
import org.apache.olingo.server.api.processor.EntityProcessor;
+import org.apache.olingo.server.api.processor.MediaEntityProcessor;
import org.apache.olingo.server.api.serializer.EntitySerializerOptions;
import org.apache.olingo.server.api.serializer.ODataSerializer;
import org.apache.olingo.server.api.serializer.SerializerException;
@@ -63,7 +65,7 @@ import org.apache.olingo.server.api.uri.queryoption.SelectOption;
import myservice.mynamespace.data.Storage;
import myservice.mynamespace.util.Util;
-public class DemoEntityProcessor implements EntityProcessor {
+public class DemoEntityProcessor implements EntityProcessor, MediaEntityProcessor {
private OData odata;
private ServiceMetadata serviceMetadata;
@@ -375,4 +377,87 @@ public class DemoEntityProcessor implements EntityProcessor {
// 3. configure the response object
response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
}
+
+ @Override
+ public void readMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
+ throws ODataApplicationException, ODataLibraryException {
+
+ final UriResource firstResoucePart = uriInfo.getUriResourceParts().get(0);
+ if(firstResoucePart instanceof UriResourceEntitySet) {
+ final EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ final UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) firstResoucePart;
+
+ final Entity entity = storage.readEntityData(edmEntitySet, uriResourceEntitySet.getKeyPredicates());
+ if(entity == null) {
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
+ }
+
+ final byte[] mediaContent = storage.readMedia(entity);
+ final InputStream responseContent = odata.createFixedFormatSerializer().binary(mediaContent);
+
+ response.setStatusCode(HttpStatusCode.OK.getStatusCode());
+ response.setContent(responseContent);
+ response.setHeader(HttpHeader.CONTENT_TYPE, entity.getMediaContentType());
+ } else {
+ throw new ODataApplicationException("Not implemented", HttpStatusCode.BAD_REQUEST.getStatusCode(),
+ Locale.ENGLISH);
+ }
+ }
+
+ @Override
+ public void createMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
+ ContentType requestFormat, ContentType responseFormat) throws ODataApplicationException, ODataLibraryException {
+
+ final EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ final byte[] mediaContent = odata.createFixedFormatDeserializer().binary(request.getBody());
+
+ final Entity entity = storage.createMediaEntity(edmEntitySet.getEntityType(),
+ requestFormat.toContentTypeString(),
+ mediaContent);
+
+ final ContextURL contextUrl = ContextURL.with().entitySet(edmEntitySet).suffix(Suffix.ENTITY).build();
+ final EntitySerializerOptions opts = EntitySerializerOptions.with().contextURL(contextUrl).build();
+ final SerializerResult serializerResult = odata.createSerializer(responseFormat).entity(serviceMetadata,
+ edmEntitySet.getEntityType(), entity, opts);
+
+ final String location = request.getRawBaseUri() + '/'
+ + odata.createUriHelper().buildCanonicalURL(edmEntitySet, entity);
+ response.setContent(serializerResult.getContent());
+ response.setStatusCode(HttpStatusCode.CREATED.getStatusCode());
+ response.setHeader(HttpHeader.LOCATION, location);
+ response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
+ }
+
+ @Override
+ public void updateMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
+ ContentType requestFormat, ContentType responseFormat) throws ODataApplicationException, ODataLibraryException {
+
+ final UriResource firstResoucePart = uriInfo.getUriResourceParts().get(0);
+ if (firstResoucePart instanceof UriResourceEntitySet) {
+ final EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ final UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) firstResoucePart;
+
+ final Entity entity = storage.readEntityData(edmEntitySet, uriResourceEntitySet.getKeyPredicates());
+ if (entity == null) {
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
+ }
+
+ final byte[] mediaContent = odata.createFixedFormatDeserializer().binary(request.getBody());
+ storage.updateMedia(entity, requestFormat.toContentTypeString(), mediaContent);
+
+ response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
+ } else {
+ throw new ODataApplicationException("Not implemented", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),
+ Locale.ENGLISH);
+ }
+ }
+
+ @Override
+ public void deleteMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo)
+ throws ODataApplicationException, ODataLibraryException {
+
+ deleteEntity(request, response, uriInfo);
+ }
}
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p10_media/pom.xml
----------------------------------------------------------------------
diff --git a/samples/tutorials/p10_media/pom.xml b/samples/tutorials/p10_media/pom.xml
new file mode 100644
index 0000000..5082f81
--- /dev/null
+++ b/samples/tutorials/p10_media/pom.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ 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.
+
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>my.group.id</groupId>
+ <artifactId>DemoService-Media</artifactId>
+ <packaging>war</packaging>
+ <version>4.0.0</version>
+
+ <name>${project.artifactId}-Webapp</name>
+
+ <build>
+ <finalName>DemoService</finalName>
+ </build>
+
+ <properties>
+ <javax.version>2.5</javax.version>
+ <odata.version>4.1.0-SNAPSHOT</odata.version>
+ <slf4j.version>1.7.7</slf4j.version>
+ </properties>
+
+ <dependencies>
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <version>${javax.version}</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.olingo</groupId>
+ <artifactId>odata-server-api</artifactId>
+ <version>${odata.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.olingo</groupId>
+ <artifactId>odata-server-core</artifactId>
+ <version>${odata.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.olingo</groupId>
+ <artifactId>odata-commons-api</artifactId>
+ <version>${odata.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.olingo</groupId>
+ <artifactId>odata-commons-core</artifactId>
+ <version>${odata.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-simple</artifactId>
+ <version>${slf4j.version}</version>
+ <scope>runtime</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ <version>1.7.11</version>
+ <scope>compile</scope>
+ </dependency>
+ </dependencies>
+</project>
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/data/Storage.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/data/Storage.java b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/data/Storage.java
new file mode 100644
index 0000000..3f5990b
--- /dev/null
+++ b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/data/Storage.java
@@ -0,0 +1,480 @@
+/*
+ * 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 myservice.mynamespace.data;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.sql.Timestamp;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+import java.util.UUID;
+
+import org.apache.olingo.commons.api.data.Entity;
+import org.apache.olingo.commons.api.data.EntityCollection;
+import org.apache.olingo.commons.api.data.Property;
+import org.apache.olingo.commons.api.data.ValueType;
+import org.apache.olingo.commons.api.edm.EdmEntitySet;
+import org.apache.olingo.commons.api.edm.EdmEntityType;
+import org.apache.olingo.commons.api.edm.EdmKeyPropertyRef;
+import org.apache.olingo.commons.api.edm.FullQualifiedName;
+import org.apache.olingo.commons.api.ex.ODataRuntimeException;
+import org.apache.olingo.commons.api.format.ContentType;
+import org.apache.olingo.commons.api.http.HttpMethod;
+import org.apache.olingo.commons.api.http.HttpStatusCode;
+import org.apache.olingo.server.api.ODataApplicationException;
+import org.apache.olingo.server.api.uri.UriParameter;
+
+import myservice.mynamespace.service.DemoEdmProvider;
+import myservice.mynamespace.util.Util;
+
+public class Storage {
+ /** Special property to store the media content **/
+ private static final String MEDIA_PROPERTY_NAME = "$value";
+
+ private List<Entity> productList;
+ private List<Entity> categoryList;
+ private List<Entity> advertisments;
+
+
+ public Storage() {
+
+ productList = new ArrayList<Entity>();
+ categoryList = new ArrayList<Entity>();
+ advertisments = new ArrayList<Entity>();
+
+ initProductSampleData();
+ initCategorySampleData();
+ initAdvertismentSampleData();
+ }
+
+ /* PUBLIC FACADE */
+
+ public EntityCollection readEntitySetData(EdmEntitySet edmEntitySet) throws ODataApplicationException {
+
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
+ return getEntityCollection(productList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
+ return getEntityCollection(categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ return getEntityCollection(advertisments);
+ }
+
+ return null;
+ }
+
+ public Entity readEntityData(EdmEntitySet edmEntitySet, List<UriParameter> keyParams)
+ throws ODataApplicationException {
+
+ EdmEntityType edmEntityType = edmEntitySet.getEntityType();
+
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
+ return getEntity(edmEntityType, keyParams, productList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
+ return getEntity(edmEntityType, keyParams, categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ return getEntity(edmEntityType, keyParams, advertisments);
+ }
+
+ return null;
+ }
+
+ public Entity createEntityData(EdmEntitySet edmEntitySet, Entity entityToCreate) {
+
+ EdmEntityType edmEntityType = edmEntitySet.getEntityType();
+
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
+ return createEntity(edmEntityType, entityToCreate, productList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
+ return createEntity(edmEntityType, entityToCreate, categoryList);
+ }
+
+ return null;
+ }
+
+ /**
+ * This method is invoked for PATCH or PUT requests
+ * */
+ public void updateEntityData(EdmEntitySet edmEntitySet, List<UriParameter> keyParams, Entity updateEntity,
+ HttpMethod httpMethod) throws ODataApplicationException {
+
+ EdmEntityType edmEntityType = edmEntitySet.getEntityType();
+
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
+ updateEntity(edmEntityType, keyParams, updateEntity, httpMethod, productList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
+ updateEntity(edmEntityType, keyParams, updateEntity, httpMethod, categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ updateEntity(edmEntityType, keyParams, updateEntity, httpMethod, advertisments);
+ }
+ }
+
+ public void deleteEntityData(EdmEntitySet edmEntitySet, List<UriParameter> keyParams)
+ throws ODataApplicationException {
+
+ EdmEntityType edmEntityType = edmEntitySet.getEntityType();
+
+ if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
+ deleteEntity(edmEntityType, keyParams, productList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
+ deleteEntity(edmEntityType, keyParams, categoryList);
+ } else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_ADVERTISMENTS_NAME)) {
+ deleteEntity(edmEntityType, keyParams, advertisments);
+ }
+ }
+
+ // Navigation
+ public Entity getRelatedEntity(Entity entity, EdmEntityType relatedEntityType) {
+ EntityCollection collection = getRelatedEntityCollection(entity, relatedEntityType);
+ if (collection.getEntities().isEmpty()) {
+ return null;
+ }
+ return collection.getEntities().get(0);
+ }
+
+ public Entity getRelatedEntity(Entity entity, EdmEntityType relatedEntityType, List<UriParameter> keyPredicates)
+ throws ODataApplicationException {
+
+ EntityCollection relatedEntities = getRelatedEntityCollection(entity, relatedEntityType);
+ return Util.findEntity(relatedEntityType, relatedEntities, keyPredicates);
+ }
+
+ public EntityCollection getRelatedEntityCollection(Entity sourceEntity, EdmEntityType targetEntityType) {
+ EntityCollection navigationTargetEntityCollection = new EntityCollection();
+
+ FullQualifiedName relatedEntityFqn = targetEntityType.getFullQualifiedName();
+ String sourceEntityFqn = sourceEntity.getType();
+
+ if (sourceEntityFqn.equals(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString())
+ && relatedEntityFqn.equals(DemoEdmProvider.ET_CATEGORY_FQN)) {
+ // relation Products->Category (result all categories)
+ int productID = (Integer) sourceEntity.getProperty("ID").getValue();
+ if (productID == 0 || productID == 1) {
+ navigationTargetEntityCollection.getEntities().add(categoryList.get(0));
+ } else if (productID == 2 || productID == 3) {
+ navigationTargetEntityCollection.getEntities().add(categoryList.get(1));
+ } else if (productID == 4 || productID == 5) {
+ navigationTargetEntityCollection.getEntities().add(categoryList.get(2));
+ }
+ } else if (sourceEntityFqn.equals(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString())
+ && relatedEntityFqn.equals(DemoEdmProvider.ET_PRODUCT_FQN)) {
+ // relation Category->Products (result all products)
+ int categoryID = (Integer) sourceEntity.getProperty("ID").getValue();
+ if (categoryID == 0) {
+ // the first 2 products are notebooks
+ navigationTargetEntityCollection.getEntities().addAll(productList.subList(0, 2));
+ } else if (categoryID == 1) {
+ // the next 2 products are organizers
+ navigationTargetEntityCollection.getEntities().addAll(productList.subList(2, 4));
+ } else if (categoryID == 2) {
+ // the first 2 products are monitors
+ navigationTargetEntityCollection.getEntities().addAll(productList.subList(4, 6));
+ }
+ }
+
+ return navigationTargetEntityCollection;
+ }
+
+ public byte[] readMedia(final Entity entity) {
+ return (byte[]) entity.getProperty(MEDIA_PROPERTY_NAME).asPrimitive();
+ }
+
+ public void updateMedia(final Entity entity, final String mediaContentType, final byte[] data) {
+ entity.getProperties().remove(entity.getProperty(MEDIA_PROPERTY_NAME));
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, data));
+ entity.setMediaContentType(mediaContentType);
+ }
+
+ public Entity createMediaEntity(final EdmEntityType edmEntityType, final String mediaContentType,
+ final byte[] data) {
+ Entity entity = null;
+
+ if(edmEntityType.getName().equals(DemoEdmProvider.ET_ADVERTISMENT_NAME)) {
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, UUID.randomUUID()));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, null));
+ entity.addProperty(new Property(null, "AirDate", ValueType.PRIMITIVE, null));
+
+ entity.setMediaContentType(mediaContentType);
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, data));
+
+ advertisments.add(entity);
+ }
+
+ return entity;
+ }
+
+ /* INTERNAL */
+
+ private EntityCollection getEntityCollection(final List<Entity> entityList) {
+
+ EntityCollection retEntitySet = new EntityCollection();
+ retEntitySet.getEntities().addAll(entityList);
+
+ return retEntitySet;
+ }
+
+ private Entity getEntity(EdmEntityType edmEntityType, List<UriParameter> keyParams, List<Entity> entityList)
+ throws ODataApplicationException {
+
+ // the list of entities at runtime
+ EntityCollection entitySet = getEntityCollection(entityList);
+
+ /* generic approach to find the requested entity */
+ Entity requestedEntity = Util.findEntity(edmEntityType, entitySet, keyParams);
+
+ if (requestedEntity == null) {
+ // this variable is null if our data doesn't contain an entity for the requested key
+ // Throw suitable exception
+ throw new ODataApplicationException("Entity for requested key doesn't exist",
+ HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH);
+ }
+
+ return requestedEntity;
+ }
+
+ private Entity createEntity(EdmEntityType edmEntityType, Entity entity, List<Entity> entityList) {
+
+ // the ID of the newly created entity is generated automatically
+ int newId = 1;
+ while (entityIdExists(newId, entityList)) {
+ newId++;
+ }
+
+ Property idProperty = entity.getProperty("ID");
+ if (idProperty != null) {
+ idProperty.setValue(ValueType.PRIMITIVE, Integer.valueOf(newId));
+ } else {
+ // as of OData v4 spec, the key property can be omitted from the POST request body
+ entity.getProperties().add(new Property(null, "ID", ValueType.PRIMITIVE, newId));
+ }
+ entity.setId(createId(entity, "ID"));
+ entityList.add(entity);
+
+ return entity;
+ }
+
+ private boolean entityIdExists(int id, List<Entity> entityList) {
+
+ for (Entity entity : entityList) {
+ Integer existingID = (Integer) entity.getProperty("ID").getValue();
+ if (existingID.intValue() == id) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ private void updateEntity(EdmEntityType edmEntityType, List<UriParameter> keyParams, Entity updateEntity,
+ HttpMethod httpMethod, List<Entity> entityList) throws ODataApplicationException {
+
+ Entity entity = getEntity(edmEntityType, keyParams, entityList);
+ if (entity == null) {
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
+ }
+
+ // loop over all properties and replace the values with the values of the given payload
+ // Note: ignoring ComplexType, as we don't have it in our odata model
+ List<Property> existingProperties = entity.getProperties();
+ for (Property existingProp : existingProperties) {
+ String propName = existingProp.getName();
+
+ // ignore the key properties, they aren't updateable
+ if (isKey(edmEntityType, propName)) {
+ continue;
+ }
+
+ Property updateProperty = updateEntity.getProperty(propName);
+ // the request payload might not consider ALL properties, so it can be null
+ if (updateProperty == null) {
+ // if a property has NOT been added to the request payload
+ // depending on the HttpMethod, our behavior is different
+ if (httpMethod.equals(HttpMethod.PATCH)) {
+ // as of the OData spec, in case of PATCH, the existing property is not touched
+ continue; // do nothing
+ } else if (httpMethod.equals(HttpMethod.PUT)) {
+ // as of the OData spec, in case of PUT, the existing property is set to null (or to default value)
+ existingProp.setValue(existingProp.getValueType(), null);
+ continue;
+ }
+ }
+
+ // change the value of the properties
+ existingProp.setValue(existingProp.getValueType(), updateProperty.getValue());
+ }
+ }
+
+ private void deleteEntity(EdmEntityType edmEntityType, List<UriParameter> keyParams, List<Entity> entityList)
+ throws ODataApplicationException {
+
+ Entity entity = getEntity(edmEntityType, keyParams, entityList);
+ if (entity == null) {
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
+ }
+
+ entityList.remove(entity);
+ }
+
+ /* HELPER */
+
+ private boolean isKey(EdmEntityType edmEntityType, String propertyName) {
+
+ List<EdmKeyPropertyRef> keyPropertyRefs = edmEntityType.getKeyPropertyRefs();
+ for (EdmKeyPropertyRef propRef : keyPropertyRefs) {
+ String keyPropertyName = propRef.getName();
+ if (keyPropertyName.equals(propertyName)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private void initProductSampleData() {
+
+ Entity entity = new Entity();
+
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 0));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Notebook Basic 15"));
+ entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
+ "Notebook Basic, 1.7GHz - 15 XGA - 1024MB DDR2 SDRAM - 40GB"));
+ entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ productList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 1));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Notebook Professional 17"));
+ entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
+ "Notebook Professional, 2.8GHz - 15 XGA - 8GB DDR3 RAM - 500GB"));
+ entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ productList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 2));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "1UMTS PDA"));
+ entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
+ "Ultrafast 3G UMTS/HSDPA Pocket PC, supports GSM network"));
+ entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ productList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 3));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Comfort Easy"));
+ entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
+ "32 GB Digital Assitant with high-resolution color screen"));
+ entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ productList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 4));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Ergo Screen"));
+ entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
+ "19 Optimum Resolution 1024 x 768 @ 85Hz, resolution 1280 x 960"));
+ entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ productList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 5));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Flat Basic"));
+ entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
+ "Optimum Hi-Resolution max. 1600 x 1200 @ 85Hz, Dot Pitch: 0.24mm"));
+ entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ productList.add(entity);
+ }
+
+ private void initCategorySampleData() {
+
+ Entity entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 0));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Notebooks"));
+ entity.setType(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ categoryList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 1));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Organizers"));
+ entity.setType(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ categoryList.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 2));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Monitors"));
+ entity.setType(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString());
+ entity.setId(createId(entity, "ID"));
+ categoryList.add(entity);
+ }
+
+ private void initAdvertismentSampleData() {
+
+ Entity entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE,
+ UUID.fromString("f89dee73-af9f-4cd4-b330-db93c25ff3c7")));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Old School Lemonade Store, Retro Style"));
+ entity.addProperty(new Property(null, "AirDate", ValueType.PRIMITIVE, Timestamp.valueOf("2012-11-07 00:00:00")));
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, "Super content".getBytes()));
+ entity.setMediaContentType(ContentType.parse("text/plain").toContentTypeString());
+ advertisments.add(entity);
+
+ entity = new Entity();
+ entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE,
+ UUID.fromString("db2d2186-1c29-4d1e-88ef-a127f521b9c67")));
+ entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Early morning start, need coffee"));
+ entity.addProperty(new Property(null, "AirDate", ValueType.PRIMITIVE, Timestamp.valueOf("2000-02-29 00:00:00")));
+ entity.addProperty(new Property(null, MEDIA_PROPERTY_NAME, ValueType.PRIMITIVE, "Super content2".getBytes()));
+ entity.setMediaContentType(ContentType.parse("text/plain").toContentTypeString());
+ advertisments.add(entity);
+ }
+
+ private URI createId(Entity entity, String idPropertyName) {
+ return createId(entity, idPropertyName, null);
+ }
+
+ private URI createId(Entity entity, String idPropertyName, String navigationName) {
+ try {
+ StringBuilder sb = new StringBuilder(getEntitySetName(entity)).append("(");
+ final Property property = entity.getProperty(idPropertyName);
+ sb.append(property.asPrimitive()).append(")");
+ if(navigationName != null) {
+ sb.append("/").append(navigationName);
+ }
+ return new URI(sb.toString());
+ } catch (URISyntaxException e) {
+ throw new ODataRuntimeException("Unable to create (Atom) id for entity: " + entity, e);
+ }
+ }
+
+ private String getEntitySetName(Entity entity) {
+ if(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString().equals(entity.getType())) {
+ return DemoEdmProvider.ES_CATEGORIES_NAME;
+ } else if(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString().equals(entity.getType())) {
+ return DemoEdmProvider.ES_PRODUCTS_NAME;
+ }
+ return entity.getType();
+ }
+}
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
new file mode 100644
index 0000000..560a420
--- /dev/null
+++ b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
@@ -0,0 +1,239 @@
+/*
+ * 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 myservice.mynamespace.service;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeKind;
+import org.apache.olingo.commons.api.edm.FullQualifiedName;
+import org.apache.olingo.commons.api.edm.provider.CsdlAbstractEdmProvider;
+import org.apache.olingo.commons.api.edm.provider.CsdlEntityContainer;
+import org.apache.olingo.commons.api.edm.provider.CsdlEntityContainerInfo;
+import org.apache.olingo.commons.api.edm.provider.CsdlEntitySet;
+import org.apache.olingo.commons.api.edm.provider.CsdlEntityType;
+import org.apache.olingo.commons.api.edm.provider.CsdlNavigationProperty;
+import org.apache.olingo.commons.api.edm.provider.CsdlNavigationPropertyBinding;
+import org.apache.olingo.commons.api.edm.provider.CsdlProperty;
+import org.apache.olingo.commons.api.edm.provider.CsdlPropertyRef;
+import org.apache.olingo.commons.api.edm.provider.CsdlSchema;
+
+/*
+ * this class is supposed to declare the metadata of the OData service
+ * it is invoked by the Olingo framework e.g. when the metadata document of the service is invoked
+ * e.g. http://localhost:8080/ExampleService1/ExampleService1.svc/$metadata
+ */
+public class DemoEdmProvider extends CsdlAbstractEdmProvider {
+
+ // Service Namespace
+ public static final String NAMESPACE = "OData.Demo";
+
+ // EDM Container
+ public static final String CONTAINER_NAME = "Container";
+ public static final FullQualifiedName CONTAINER = new FullQualifiedName(NAMESPACE, CONTAINER_NAME);
+
+ // Entity Types Names
+ public static final String ET_PRODUCT_NAME = "Product";
+ public static final FullQualifiedName ET_PRODUCT_FQN = new FullQualifiedName(NAMESPACE, ET_PRODUCT_NAME);
+
+ public static final String ET_CATEGORY_NAME = "Category";
+ public static final FullQualifiedName ET_CATEGORY_FQN = new FullQualifiedName(NAMESPACE, ET_CATEGORY_NAME);
+
+ public static final String ET_ADVERTISMENT_NAME = "Advertisment";
+ public static final FullQualifiedName ET_ADVERTISMENT_FQN = new FullQualifiedName(NAMESPACE, ET_ADVERTISMENT_NAME);
+
+ // Entity Set Names
+ public static final String ES_PRODUCTS_NAME = "Products";
+ public static final String ES_CATEGORIES_NAME = "Categories";
+ public static final String ES_ADVERTISMENTS_NAME = "Advertisments";
+
+ public CsdlEntityType getEntityType(FullQualifiedName entityTypeName) {
+
+ // this method is called for each EntityType that are configured in the Schema
+ CsdlEntityType entityType = null;
+
+ if (entityTypeName.equals(ET_PRODUCT_FQN)) {
+ // create EntityType properties
+ CsdlProperty id = new CsdlProperty().setName("ID")
+ .setType(EdmPrimitiveTypeKind.Int32.getFullQualifiedName());
+ CsdlProperty name = new CsdlProperty().setName("Name")
+ .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
+ CsdlProperty description = new CsdlProperty().setName("Description")
+ .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
+
+ // create PropertyRef for Key element
+ CsdlPropertyRef propertyRef = new CsdlPropertyRef();
+ propertyRef.setName("ID");
+
+ // navigation property: many-to-one, null not allowed (product must have a category)
+ CsdlNavigationProperty navProp = new CsdlNavigationProperty().setName("Category")
+ .setType(ET_CATEGORY_FQN).setNullable(true)
+ .setPartner("Products");
+ List<CsdlNavigationProperty> navPropList = new ArrayList<CsdlNavigationProperty>();
+ navPropList.add(navProp);
+
+ // configure EntityType
+ entityType = new CsdlEntityType();
+ entityType.setName(ET_PRODUCT_NAME);
+ entityType.setProperties(Arrays.asList(id, name, description));
+ entityType.setKey(Arrays.asList(propertyRef));
+ entityType.setNavigationProperties(navPropList);
+
+ } else if (entityTypeName.equals(ET_CATEGORY_FQN)) {
+ // create EntityType properties
+ CsdlProperty id = new CsdlProperty().setName("ID")
+ .setType(EdmPrimitiveTypeKind.Int32.getFullQualifiedName());
+ CsdlProperty name = new CsdlProperty().setName("Name")
+ .setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
+
+ // create PropertyRef for Key element
+ CsdlPropertyRef propertyRef = new CsdlPropertyRef();
+ propertyRef.setName("ID");
+
+ // navigation property: one-to-many
+ CsdlNavigationProperty navProp = new CsdlNavigationProperty().setName("Products")
+ .setType(ET_PRODUCT_FQN).setCollection(true)
+ .setPartner("Category");
+ List<CsdlNavigationProperty> navPropList = new ArrayList<CsdlNavigationProperty>();
+ navPropList.add(navProp);
+
+ // configure EntityType
+ entityType = new CsdlEntityType();
+ entityType.setName(ET_CATEGORY_NAME);
+ entityType.setProperties(Arrays.asList(id, name));
+ entityType.setKey(Arrays.asList(propertyRef));
+ entityType.setNavigationProperties(navPropList);
+ } else if(entityTypeName.equals(ET_ADVERTISMENT_FQN)) {
+ CsdlProperty id = new CsdlProperty().setName("ID").setType(EdmPrimitiveTypeKind.Guid.getFullQualifiedName());
+ CsdlProperty name = new CsdlProperty().setName("Name").setType(EdmPrimitiveTypeKind.String
+ .getFullQualifiedName());
+ CsdlProperty airDate = new CsdlProperty().setName("AirDate").setType(EdmPrimitiveTypeKind.DateTimeOffset
+ .getFullQualifiedName());
+
+ CsdlPropertyRef propertyRef = new CsdlPropertyRef();
+ propertyRef.setName("ID");
+
+ entityType = new CsdlEntityType();
+ entityType.setName(ET_ADVERTISMENT_NAME);
+ entityType.setProperties(Arrays.asList(id, name, airDate));
+ entityType.setKey(Collections.singletonList(propertyRef));
+ entityType.setHasStream(true);
+ }
+
+ return entityType;
+ }
+
+ @Override
+ public CsdlEntitySet getEntitySet(FullQualifiedName entityContainer, String entitySetName) {
+
+ CsdlEntitySet entitySet = null;
+
+ if (entityContainer.equals(CONTAINER)) {
+
+ if (entitySetName.equals(ES_PRODUCTS_NAME)) {
+
+ entitySet = new CsdlEntitySet();
+ entitySet.setName(ES_PRODUCTS_NAME);
+ entitySet.setType(ET_PRODUCT_FQN);
+
+ // navigation
+ CsdlNavigationPropertyBinding navPropBinding = new CsdlNavigationPropertyBinding();
+ navPropBinding.setTarget("Categories"); // the target entity set, where the navigation property points to
+ navPropBinding.setPath("Category"); // the path from entity type to navigation property
+ List<CsdlNavigationPropertyBinding> navPropBindingList = new ArrayList<CsdlNavigationPropertyBinding>();
+ navPropBindingList.add(navPropBinding);
+ entitySet.setNavigationPropertyBindings(navPropBindingList);
+
+ } else if (entitySetName.equals(ES_CATEGORIES_NAME)) {
+
+ entitySet = new CsdlEntitySet();
+ entitySet.setName(ES_CATEGORIES_NAME);
+ entitySet.setType(ET_CATEGORY_FQN);
+
+ // navigation
+ CsdlNavigationPropertyBinding navPropBinding = new CsdlNavigationPropertyBinding();
+ navPropBinding.setTarget("Products"); // the target entity set, where the navigation property points to
+ navPropBinding.setPath("Products"); // the path from entity type to navigation property
+ List<CsdlNavigationPropertyBinding> navPropBindingList = new ArrayList<CsdlNavigationPropertyBinding>();
+ navPropBindingList.add(navPropBinding);
+ entitySet.setNavigationPropertyBindings(navPropBindingList);
+ } else if (entitySetName.equals(ES_ADVERTISMENTS_NAME)) {
+ entitySet = new CsdlEntitySet();
+ entitySet.setName(ES_ADVERTISMENTS_NAME);
+ entitySet.setType(ET_ADVERTISMENT_FQN);
+ }
+ }
+
+ return entitySet;
+ }
+
+ @Override
+ public List<CsdlSchema> getSchemas() {
+
+ // create Schema
+ CsdlSchema schema = new CsdlSchema();
+ schema.setNamespace(NAMESPACE);
+
+ // add EntityTypes
+ List<CsdlEntityType> entityTypes = new ArrayList<CsdlEntityType>();
+ entityTypes.add(getEntityType(ET_PRODUCT_FQN));
+ entityTypes.add(getEntityType(ET_CATEGORY_FQN));
+ entityTypes.add(getEntityType(ET_ADVERTISMENT_FQN));
+ schema.setEntityTypes(entityTypes);
+
+ // add EntityContainer
+ schema.setEntityContainer(getEntityContainer());
+
+ // finally
+ List<CsdlSchema> schemas = new ArrayList<CsdlSchema>();
+ schemas.add(schema);
+
+ return schemas;
+ }
+
+ public CsdlEntityContainer getEntityContainer() {
+ // create EntitySets
+ List<CsdlEntitySet> entitySets = new ArrayList<CsdlEntitySet>();
+ entitySets.add(getEntitySet(CONTAINER, ES_PRODUCTS_NAME));
+ entitySets.add(getEntitySet(CONTAINER, ES_CATEGORIES_NAME));
+ entitySets.add(getEntitySet(CONTAINER, ES_ADVERTISMENTS_NAME));
+
+ // create EntityContainer
+ CsdlEntityContainer entityContainer = new CsdlEntityContainer();
+ entityContainer.setName(CONTAINER_NAME);
+ entityContainer.setEntitySets(entitySets);
+
+ return entityContainer;
+ }
+
+ @Override
+ public CsdlEntityContainerInfo getEntityContainerInfo(FullQualifiedName entityContainerName) {
+
+ // This method is invoked when displaying the service document at
+ // e.g. http://localhost:8080/DemoService/DemoService.svc
+ if (entityContainerName == null || entityContainerName.equals(CONTAINER)) {
+ CsdlEntityContainerInfo entityContainerInfo = new CsdlEntityContainerInfo();
+ entityContainerInfo.setContainerName(CONTAINER);
+ return entityContainerInfo;
+ }
+ return null;
+ }
+}
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java
new file mode 100644
index 0000000..80daaae
--- /dev/null
+++ b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java
@@ -0,0 +1,150 @@
+/*
+ * 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 myservice.mynamespace.service;
+
+import java.util.List;
+import java.util.Locale;
+
+import org.apache.olingo.commons.api.data.ContextURL;
+import org.apache.olingo.commons.api.data.Entity;
+import org.apache.olingo.commons.api.data.EntityCollection;
+import org.apache.olingo.commons.api.edm.EdmEntitySet;
+import org.apache.olingo.commons.api.edm.EdmEntityType;
+import org.apache.olingo.commons.api.edm.EdmNavigationProperty;
+import org.apache.olingo.commons.api.format.ContentType;
+import org.apache.olingo.commons.api.http.HttpHeader;
+import org.apache.olingo.commons.api.http.HttpStatusCode;
+import org.apache.olingo.server.api.OData;
+import org.apache.olingo.server.api.ODataApplicationException;
+import org.apache.olingo.server.api.ODataRequest;
+import org.apache.olingo.server.api.ODataResponse;
+import org.apache.olingo.server.api.ServiceMetadata;
+import org.apache.olingo.server.api.processor.EntityCollectionProcessor;
+import org.apache.olingo.server.api.serializer.EntityCollectionSerializerOptions;
+import org.apache.olingo.server.api.serializer.ODataSerializer;
+import org.apache.olingo.server.api.serializer.SerializerException;
+import org.apache.olingo.server.api.serializer.SerializerResult;
+import org.apache.olingo.server.api.uri.UriInfo;
+import org.apache.olingo.server.api.uri.UriParameter;
+import org.apache.olingo.server.api.uri.UriResource;
+import org.apache.olingo.server.api.uri.UriResourceEntitySet;
+import org.apache.olingo.server.api.uri.UriResourceNavigation;
+
+import myservice.mynamespace.data.Storage;
+import myservice.mynamespace.util.Util;
+
+public class DemoEntityCollectionProcessor implements EntityCollectionProcessor {
+
+
+ private OData odata;
+ private ServiceMetadata serviceMetadata;
+ // our database-mock
+ private Storage storage;
+
+ public DemoEntityCollectionProcessor(Storage storage) {
+ this.storage = storage;
+ }
+
+ public void init(OData odata, ServiceMetadata serviceMetadata) {
+ this.odata = odata;
+ this.serviceMetadata = serviceMetadata;
+ }
+
+ /*
+ * This method is invoked when a collection of entities has to be read.
+ * In our example, this can be either a "normal" read operation, or a navigation:
+ *
+ * Example for "normal" read entity set operation:
+ * http://localhost:8080/DemoService/DemoService.svc/Categories
+ *
+ * Example for navigation
+ * http://localhost:8080/DemoService/DemoService.svc/Categories(3)/Products
+ */
+ public void readEntityCollection(ODataRequest request, ODataResponse response,
+ UriInfo uriInfo, ContentType responseFormat)
+ throws ODataApplicationException, SerializerException {
+
+ EdmEntitySet responseEdmEntitySet = null; // we'll need this to build the ContextURL
+ EntityCollection responseEntityCollection = null; // we'll need this to set the response body
+
+ // 1st retrieve the requested EntitySet from the uriInfo (representation of the parsed URI)
+ List<UriResource> resourceParts = uriInfo.getUriResourceParts();
+ int segmentCount = resourceParts.size();
+
+ UriResource uriResource = resourceParts.get(0); // in our example, the first segment is the EntitySet
+ if (!(uriResource instanceof UriResourceEntitySet)) {
+ throw new ODataApplicationException("Only EntitySet is supported",
+ HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
+ }
+
+ UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) uriResource;
+ EdmEntitySet startEdmEntitySet = uriResourceEntitySet.getEntitySet();
+
+ if (segmentCount == 1) { // this is the case for: DemoService/DemoService.svc/Categories
+ responseEdmEntitySet = startEdmEntitySet; // the response body is built from the first (and only) entitySet
+
+ // 2nd: fetch the data from backend for this requested EntitySetName and deliver as EntitySet
+ responseEntityCollection = storage.readEntitySetData(startEdmEntitySet);
+ } else if (segmentCount == 2) { // in case of navigation: DemoService.svc/Categories(3)/Products
+
+ UriResource lastSegment = resourceParts.get(1); // in our example we don't support more complex URIs
+ if (lastSegment instanceof UriResourceNavigation) {
+ UriResourceNavigation uriResourceNavigation = (UriResourceNavigation) lastSegment;
+ EdmNavigationProperty edmNavigationProperty = uriResourceNavigation.getProperty();
+ EdmEntityType targetEntityType = edmNavigationProperty.getType();
+ // from Categories(1) to Products
+ responseEdmEntitySet = Util.getNavigationTargetEntitySet(startEdmEntitySet, edmNavigationProperty);
+
+ // 2nd: fetch the data from backend
+ // first fetch the entity where the first segment of the URI points to
+ List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
+ // e.g. for Categories(3)/Products we have to find the single entity: Category with ID 3
+ Entity sourceEntity = storage.readEntityData(startEdmEntitySet, keyPredicates);
+ // error handling for e.g. DemoService.svc/Categories(99)/Products
+ if (sourceEntity == null) {
+ throw new ODataApplicationException("Entity not found.",
+ HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ROOT);
+ }
+ // then fetch the entity collection where the entity navigates to
+ // note: we don't need to check uriResourceNavigation.isCollection(),
+ // because we are the EntityCollectionProcessor
+ responseEntityCollection = storage.getRelatedEntityCollection(sourceEntity, targetEntityType);
+ }
+ } else { // this would be the case for e.g. Products(1)/Category/Products
+ throw new ODataApplicationException("Not supported",
+ HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
+ }
+
+ // 3rd: create and configure a serializer
+ ContextURL contextUrl = ContextURL.with().entitySet(responseEdmEntitySet).build();
+ final String id = request.getRawBaseUri() + "/" + responseEdmEntitySet.getName();
+ EntityCollectionSerializerOptions opts = EntityCollectionSerializerOptions.with()
+ .contextURL(contextUrl).id(id).build();
+ EdmEntityType edmEntityType = responseEdmEntitySet.getEntityType();
+
+ ODataSerializer serializer = odata.createSerializer(responseFormat);
+ SerializerResult serializerResult = serializer.entityCollection(serviceMetadata, edmEntityType,
+ responseEntityCollection, opts);
+
+ // 4th: configure the response object: set the body, headers and status code
+ response.setContent(serializerResult.getContent());
+ response.setStatusCode(HttpStatusCode.OK.getStatusCode());
+ response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
+ }
+}
http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/16f5c55d/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
----------------------------------------------------------------------
diff --git a/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
new file mode 100644
index 0000000..36958a8
--- /dev/null
+++ b/samples/tutorials/p10_media/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
@@ -0,0 +1,327 @@
+/*
+ * 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 myservice.mynamespace.service;
+
+import java.io.InputStream;
+import java.util.List;
+import java.util.Locale;
+
+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.edm.EdmEntitySet;
+import org.apache.olingo.commons.api.edm.EdmEntityType;
+import org.apache.olingo.commons.api.edm.EdmNavigationProperty;
+import org.apache.olingo.commons.api.format.ContentType;
+import org.apache.olingo.commons.api.http.HttpHeader;
+import org.apache.olingo.commons.api.http.HttpMethod;
+import org.apache.olingo.commons.api.http.HttpStatusCode;
+import org.apache.olingo.server.api.OData;
+import org.apache.olingo.server.api.ODataApplicationException;
+import org.apache.olingo.server.api.ODataLibraryException;
+import org.apache.olingo.server.api.ODataRequest;
+import org.apache.olingo.server.api.ODataResponse;
+import org.apache.olingo.server.api.ServiceMetadata;
+import org.apache.olingo.server.api.deserializer.DeserializerException;
+import org.apache.olingo.server.api.deserializer.DeserializerResult;
+import org.apache.olingo.server.api.deserializer.ODataDeserializer;
+import org.apache.olingo.server.api.processor.EntityProcessor;
+import org.apache.olingo.server.api.processor.MediaEntityProcessor;
+import org.apache.olingo.server.api.serializer.EntitySerializerOptions;
+import org.apache.olingo.server.api.serializer.ODataSerializer;
+import org.apache.olingo.server.api.serializer.SerializerException;
+import org.apache.olingo.server.api.serializer.SerializerResult;
+import org.apache.olingo.server.api.uri.UriInfo;
+import org.apache.olingo.server.api.uri.UriParameter;
+import org.apache.olingo.server.api.uri.UriResource;
+import org.apache.olingo.server.api.uri.UriResourceEntitySet;
+import org.apache.olingo.server.api.uri.UriResourceNavigation;
+
+import myservice.mynamespace.data.Storage;
+import myservice.mynamespace.util.Util;
+
+public class DemoEntityProcessor implements EntityProcessor, MediaEntityProcessor {
+
+ private OData odata;
+ private Storage storage;
+ private ServiceMetadata serviceMetadata;
+
+ public DemoEntityProcessor(Storage storage) {
+ this.storage = storage;
+ }
+
+ public void init(OData odata, ServiceMetadata serviceMetadata) {
+ this.odata = odata;
+ this.serviceMetadata = serviceMetadata;
+ }
+ /**
+ * This method is invoked when a single entity has to be read.
+ * In our example, this can be either a "normal" read operation, or a navigation:
+ *
+ * Example for "normal" read operation:
+ * http://localhost:8080/DemoService/DemoService.svc/Products(1)
+ *
+ * Example for navigation
+ * http://localhost:8080/DemoService/DemoService.svc/Products(1)/Category
+ */
+ public void readEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
+ throws ODataApplicationException, SerializerException {
+
+ EdmEntityType responseEdmEntityType = null; // we'll need this to build the ContextURL
+ Entity responseEntity = null; // required for serialization of the response body
+ EdmEntitySet responseEdmEntitySet = null; // we need this for building the contextUrl
+
+ // 1st step: retrieve the requested Entity: can be "normal" read operation, or navigation (to-one)
+ List<UriResource> resourceParts = uriInfo.getUriResourceParts();
+ int segmentCount = resourceParts.size();
+
+ UriResource uriResource = resourceParts.get(0); // in our example, the first segment is the EntitySet
+ UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) uriResource;
+ EdmEntitySet startEdmEntitySet = uriResourceEntitySet.getEntitySet();
+
+ // Analyze the URI segments
+ if (segmentCount == 1) { // no navigation
+ responseEdmEntityType = startEdmEntitySet.getEntityType();
+ responseEdmEntitySet = startEdmEntitySet; // since we have only one segment
+
+ // 2. step: retrieve the data from backend
+ List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
+ responseEntity = storage.readEntityData(startEdmEntitySet, keyPredicates);
+ } else if (segmentCount == 2) { // navigation
+ UriResource navSegment = resourceParts.get(1); // in our example we don't support more complex URIs
+ if (navSegment instanceof UriResourceNavigation) {
+ UriResourceNavigation uriResourceNavigation = (UriResourceNavigation) navSegment;
+ EdmNavigationProperty edmNavigationProperty = uriResourceNavigation.getProperty();
+ responseEdmEntityType = edmNavigationProperty.getType();
+ // contextURL displays the last segment
+ responseEdmEntitySet = Util.getNavigationTargetEntitySet(startEdmEntitySet, edmNavigationProperty);
+
+ // 2nd: fetch the data from backend.
+ // e.g. for the URI: Products(1)/Category we have to find the correct Category entity
+ List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
+ // e.g. for Products(1)/Category we have to find first the Products(1)
+ Entity sourceEntity = storage.readEntityData(startEdmEntitySet, keyPredicates);
+
+ // now we have to check if the navigation is
+ // a) to-one: e.g. Products(1)/Category
+ // b) to-many with key: e.g. Categories(3)/Products(5)
+ // the key for nav is used in this case: Categories(3)/Products(5)
+ List<UriParameter> navKeyPredicates = uriResourceNavigation.getKeyPredicates();
+
+ if (navKeyPredicates.isEmpty()) { // e.g. DemoService.svc/Products(1)/Category
+ responseEntity = storage.getRelatedEntity(sourceEntity, responseEdmEntityType);
+ } else { // e.g. DemoService.svc/Categories(3)/Products(5)
+ responseEntity = storage.getRelatedEntity(sourceEntity, responseEdmEntityType, navKeyPredicates);
+ }
+ }
+ } else {
+ // this would be the case for e.g. Products(1)/Category/Products(1)/Category
+ throw new ODataApplicationException("Not supported", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
+ }
+
+ if (responseEntity == null) {
+ // this is the case for e.g. DemoService.svc/Categories(4) or DemoService.svc/Categories(3)/Products(999)
+ throw new ODataApplicationException("Nothing found.", HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ROOT);
+ }
+
+ // 3. serialize
+ ContextURL contextUrl = ContextURL.with().entitySet(responseEdmEntitySet).suffix(Suffix.ENTITY).build();
+ EntitySerializerOptions opts = EntitySerializerOptions.with().contextURL(contextUrl).build();
+
+ ODataSerializer serializer = odata.createSerializer(responseFormat);
+ SerializerResult serializerResult = serializer.entity(serviceMetadata,
+ responseEdmEntityType, responseEntity, opts);
+
+ // 4. configure the response object
+ response.setContent(serializerResult.getContent());
+ response.setStatusCode(HttpStatusCode.OK.getStatusCode());
+ response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
+ }
+
+ /*
+ * Example request:
+ *
+ * POST URL: http://localhost:8080/DemoService/DemoService.svc/Products
+ * Header: Content-Type: application/json; odata.metadata=minimal
+ * Request body:
+ {
+ "ID":3,
+ "Name":"Ergo Screen",
+ "Description":"17 Optimum Resolution 1024 x 768 @ 85Hz, resolution 1280 x 960"
+ }
+ * */
+ public void createEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
+ ContentType requestFormat, ContentType responseFormat)
+ throws ODataApplicationException, DeserializerException, SerializerException {
+
+ // 1. Retrieve the entity type from the URI
+ EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ EdmEntityType edmEntityType = edmEntitySet.getEntityType();
+
+ // 2. create the data in backend
+ // 2.1. retrieve the payload from the POST request for the entity to create and deserialize it
+ InputStream requestInputStream = request.getBody();
+ ODataDeserializer deserializer = odata.createDeserializer(requestFormat);
+ DeserializerResult result = deserializer.entity(requestInputStream, edmEntityType);
+ Entity requestEntity = result.getEntity();
+ // 2.2 do the creation in backend, which returns the newly created entity
+ Entity createdEntity = storage.createEntityData(edmEntitySet, requestEntity);
+
+ // 3. serialize the response (we have to return the created entity)
+ ContextURL contextUrl = ContextURL.with().entitySet(edmEntitySet).build();
+ EntitySerializerOptions options = EntitySerializerOptions.with().contextURL(contextUrl).build(); // expand and select currently not supported
+
+ ODataSerializer serializer = odata.createSerializer(responseFormat);
+ SerializerResult serializedResponse = serializer.entity(serviceMetadata, edmEntityType, createdEntity, options);
+
+ //4. configure the response object
+ response.setContent(serializedResponse.getContent());
+ response.setStatusCode(HttpStatusCode.CREATED.getStatusCode());
+ response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
+ }
+
+
+ public void updateEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
+ ContentType requestFormat, ContentType responseFormat)
+ throws ODataApplicationException, DeserializerException, SerializerException {
+
+ // 1. Retrieve the entity set which belongs to the requested entity
+ List<UriResource> resourcePaths = uriInfo.getUriResourceParts();
+ // Note: only in our example we can assume that the first segment is the EntitySet
+ UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) resourcePaths.get(0);
+ EdmEntitySet edmEntitySet = uriResourceEntitySet.getEntitySet();
+ EdmEntityType edmEntityType = edmEntitySet.getEntityType();
+
+ // 2. update the data in backend
+ // 2.1. retrieve the payload from the PUT request for the entity to be updated
+ InputStream requestInputStream = request.getBody();
+ ODataDeserializer deserializer = odata.createDeserializer(requestFormat);
+ DeserializerResult result = deserializer.entity(requestInputStream, edmEntityType);
+ Entity requestEntity = result.getEntity();
+ // 2.2 do the modification in backend
+ List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
+ // Note that this updateEntity()-method is invoked for both PUT or PATCH operations
+ HttpMethod httpMethod = request.getMethod();
+ storage.updateEntityData(edmEntitySet, keyPredicates, requestEntity, httpMethod);
+
+ //3. configure the response object
+ response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
+ }
+
+
+ public void deleteEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo)
+ throws ODataApplicationException {
+
+ // 1. Retrieve the entity set which belongs to the requested entity
+ List<UriResource> resourcePaths = uriInfo.getUriResourceParts();
+ // Note: only in our example we can assume that the first segment is the EntitySet
+ UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) resourcePaths.get(0);
+ EdmEntitySet edmEntitySet = uriResourceEntitySet.getEntitySet();
+
+ // 2. delete the data in backend
+ List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
+ storage.deleteEntityData(edmEntitySet, keyPredicates);
+
+ //3. configure the response object
+ response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
+ }
+
+ @Override
+ public void readMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
+ throws ODataApplicationException, ODataLibraryException {
+
+ final UriResource firstResoucePart = uriInfo.getUriResourceParts().get(0);
+ if(firstResoucePart instanceof UriResourceEntitySet) {
+ final EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ final UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) firstResoucePart;
+
+ final Entity entity = storage.readEntityData(edmEntitySet, uriResourceEntitySet.getKeyPredicates());
+ if(entity == null) {
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
+ }
+
+ final byte[] mediaContent = storage.readMedia(entity);
+ final InputStream responseContent = odata.createFixedFormatSerializer().binary(mediaContent);
+
+ response.setStatusCode(HttpStatusCode.OK.getStatusCode());
+ response.setContent(responseContent);
+ response.setHeader(HttpHeader.CONTENT_TYPE, entity.getMediaContentType());
+ } else {
+ throw new ODataApplicationException("Not implemented", HttpStatusCode.BAD_REQUEST.getStatusCode(),
+ Locale.ENGLISH);
+ }
+ }
+
+ @Override
+ public void createMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
+ ContentType requestFormat, ContentType responseFormat) throws ODataApplicationException, ODataLibraryException {
+
+ final EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ final byte[] mediaContent = odata.createFixedFormatDeserializer().binary(request.getBody());
+
+ final Entity entity = storage.createMediaEntity(edmEntitySet.getEntityType(),
+ requestFormat.toContentTypeString(),
+ mediaContent);
+
+ final ContextURL contextUrl = ContextURL.with().entitySet(edmEntitySet).suffix(Suffix.ENTITY).build();
+ final EntitySerializerOptions opts = EntitySerializerOptions.with().contextURL(contextUrl).build();
+ final SerializerResult serializerResult = odata.createSerializer(responseFormat).entity(serviceMetadata,
+ edmEntitySet.getEntityType(), entity, opts);
+
+ final String location = request.getRawBaseUri() + '/'
+ + odata.createUriHelper().buildCanonicalURL(edmEntitySet, entity);
+ response.setContent(serializerResult.getContent());
+ response.setStatusCode(HttpStatusCode.CREATED.getStatusCode());
+ response.setHeader(HttpHeader.LOCATION, location);
+ response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
+ }
+
+ @Override
+ public void updateMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
+ ContentType requestFormat, ContentType responseFormat) throws ODataApplicationException, ODataLibraryException {
+
+ final UriResource firstResoucePart = uriInfo.getUriResourceParts().get(0);
+ if (firstResoucePart instanceof UriResourceEntitySet) {
+ final EdmEntitySet edmEntitySet = Util.getEdmEntitySet(uriInfo);
+ final UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) firstResoucePart;
+
+ final Entity entity = storage.readEntityData(edmEntitySet, uriResourceEntitySet.getKeyPredicates());
+ if (entity == null) {
+ throw new ODataApplicationException("Entity not found", HttpStatusCode.NOT_FOUND.getStatusCode(),
+ Locale.ENGLISH);
+ }
+
+ final byte[] mediaContent = odata.createFixedFormatDeserializer().binary(request.getBody());
+ storage.updateMedia(entity, requestFormat.toContentTypeString(), mediaContent);
+
+ response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
+ } else {
+ throw new ODataApplicationException("Not implemented", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),
+ Locale.ENGLISH);
+ }
+ }
+
+ @Override
+ public void deleteMediaEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo)
+ throws ODataApplicationException, ODataLibraryException {
+
+ deleteEntity(request, response, uriInfo);
+ }
+}