[OLINGO-713] Added tutorial project for navigation
Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/51668801 Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/51668801 Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/51668801 Branch: refs/heads/olingo712 Commit: 516688010a3844d9431c6be13a3aa079882cf8d9 Parents: a4288fc Author: Michael Bolz <[email protected]> Authored: Wed Jun 24 06:27:56 2015 +0200 Committer: Michael Bolz <[email protected]> Committed: Wed Jun 24 06:28:52 2015 +0200 ---------------------------------------------------------------------- samples/tutorials/p4_navigation/pom.xml | 59 +++++ .../myservice/mynamespace/data/Storage.java | 260 +++++++++++++++++++ .../mynamespace/service/DemoEdmProvider.java | 216 +++++++++++++++ .../service/DemoEntityCollectionProcessor.java | 154 +++++++++++ .../service/DemoEntityProcessor.java | 189 ++++++++++++++ .../service/DemoPrimitiveProcessor.java | 154 +++++++++++ .../java/myservice/mynamespace/util/Util.java | 145 +++++++++++ .../myservice/mynamespace/web/DemoServlet.java | 76 ++++++ .../src/main/webapp/WEB-INF/web.xml | 34 +++ .../p4_navigation/src/main/webapp/index.jsp | 26 ++ samples/tutorials/pom.xml | 1 + 11 files changed, 1314 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/pom.xml ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/pom.xml b/samples/tutorials/p4_navigation/pom.xml new file mode 100755 index 0000000..fccd1e1 --- /dev/null +++ b/samples/tutorials/p4_navigation/pom.xml @@ -0,0 +1,59 @@ +<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-Navigation</artifactId> + <packaging>war</packaging> + <version>0.0.1</version> + + <name>${project.artifactId}-Webapp</name> + + <build> + <finalName>DemoService</finalName> + </build> + + <properties> + <javax.version>2.5</javax.version> + <odata.version>4.0.0-beta-03</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> + <scope>runtime</scope> + </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> + </dependencies> +</project> http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/data/Storage.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/data/Storage.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/data/Storage.java new file mode 100755 index 0000000..9db188c --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/data/Storage.java @@ -0,0 +1,260 @@ +/* + * 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.util.ArrayList; +import java.util.List; + +import myservice.mynamespace.service.DemoEdmProvider; +import myservice.mynamespace.util.Util; + +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.FullQualifiedName; +import org.apache.olingo.server.api.uri.UriParameter; + +public class Storage { + + // represent our database + private List<Entity> productList; + private List<Entity> categoryList; + + + public Storage() { + + productList = new ArrayList<Entity>(); + categoryList = new ArrayList<Entity>(); + + // creating some sample data + initProductSampleData(); + initCategorySampleData(); + } + + /* PUBLIC FACADE */ + + public EntityCollection readEntitySetData(EdmEntitySet edmEntitySet) { + EntityCollection entitySet = null; + + if(edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)){ + entitySet = getProducts(); + }else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)){ + entitySet = getCategories(); + } + + return entitySet; + } + + + public Entity readEntityData(EdmEntitySet edmEntitySet, List<UriParameter> keyParams) { + Entity entity = null; + + EdmEntityType edmEntityType = edmEntitySet.getEntityType(); + + if(edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)){ + entity = getProduct(edmEntityType, keyParams); + }else if(edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)){ + entity = getCategory(edmEntityType, keyParams); + } + + return entity; + } + + + // 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) { + + 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 == 1 || productID == 2) { + navigationTargetEntityCollection.getEntities().add(categoryList.get(0)); + } else if(productID == 3 || productID == 4) { + navigationTargetEntityCollection.getEntities().add(categoryList.get(1)); + } else if(productID == 5 || productID == 6) { + 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 == 1){ + navigationTargetEntityCollection.getEntities().addAll(productList.subList(0, 2));// the first 2 products are notebooks + }else if(categoryID == 2){ + navigationTargetEntityCollection.getEntities().addAll(productList.subList(2, 4));// the next 2 products are organizers + }else if(categoryID == 3){ + navigationTargetEntityCollection.getEntities().addAll(productList.subList(4, 6));// the first 2 products are monitors + } + } + + if(navigationTargetEntityCollection.getEntities().isEmpty()){ + return null; + } + + return navigationTargetEntityCollection; + } + + + /* INTERNAL */ + + private EntityCollection getProducts(){ + EntityCollection retEntitySet = new EntityCollection(); + + for(Entity productEntity : this.productList){ + retEntitySet.getEntities().add(productEntity); + } + + return retEntitySet; + } + + + private Entity getProduct(EdmEntityType edmEntityType, List<UriParameter> keyParams) { + + // the list of entities at runtime + EntityCollection entityCollection = getProducts(); + + /* generic approach to find the requested entity */ + return Util.findEntity(edmEntityType, entityCollection, keyParams); + } + + + private EntityCollection getCategories(){ + EntityCollection entitySet = new EntityCollection(); + + for(Entity categoryEntity : this.categoryList){ + entitySet.getEntities().add(categoryEntity); + } + + return entitySet; + } + + + private Entity getCategory(EdmEntityType edmEntityType, List<UriParameter> keyParams) { + + // the list of entities at runtime + EntityCollection entitySet = getCategories(); + + /* generic approach to find the requested entity */ + return Util.findEntity(edmEntityType, entitySet, keyParams); + } + + + + /* HELPER */ + + private void initProductSampleData(){ + + Entity entity = new Entity(); + + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 1)); + 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()); + productList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 2)); + 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()); + productList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 3)); + 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()); + productList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 4)); + 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()); + productList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 5)); + 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()); + productList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 6)); + 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()); + productList.add(entity); + } + + private void initCategorySampleData(){ + + Entity entity = new Entity(); + + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 1)); + entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Notebooks")); + entity.setType(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString()); + categoryList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 2)); + entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Organizers")); + entity.setType(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString()); + categoryList.add(entity); + + entity = new Entity(); + entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 3)); + entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Monitors")); + entity.setType(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString()); + categoryList.add(entity); + } + +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java new file mode 100755 index 0000000..86dd9fb --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java @@ -0,0 +1,216 @@ +/* + * 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.List; + +import org.apache.olingo.commons.api.ODataException; +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; + +public class DemoEdmProvider extends CsdlAbstractEdmProvider { + + + // Service Namespace + public static final String NAMESPACE = "OData.Demo"; + + // 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); + + // Entity Set Names + public static final String ES_PRODUCTS_NAME = "Products"; + public static final String ES_CATEGORIES_NAME = "Categories"; + + + + @Override + public CsdlEntityType getEntityType(FullQualifiedName entityTypeName) throws ODataException { + + // 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(false).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); + } + + return entityType; + + } + + @Override + public CsdlEntitySet getEntitySet(FullQualifiedName entityContainer, String entitySetName) throws ODataException { + + 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); + } + } + + return entitySet; + } + + @Override + public CsdlEntityContainerInfo getEntityContainerInfo(FullQualifiedName entityContainerName) throws ODataException { + + // 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; + } + + @Override + public List<CsdlSchema> getSchemas() throws ODataException { + // 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)); + schema.setEntityTypes(entityTypes); + + // add EntityContainer + schema.setEntityContainer(getEntityContainer()); + + // finally + List<CsdlSchema> schemas = new ArrayList<CsdlSchema>(); + schemas.add(schema); + + return schemas; + } + + @Override + public CsdlEntityContainer getEntityContainer() throws ODataException { + + // create EntitySets + List<CsdlEntitySet> entitySets = new ArrayList<CsdlEntitySet>(); + entitySets.add(getEntitySet(CONTAINER, ES_PRODUCTS_NAME)); + entitySets.add(getEntitySet(CONTAINER, ES_CATEGORIES_NAME)); + + // create EntityContainer + CsdlEntityContainer entityContainer = new CsdlEntityContainer(); + entityContainer.setName(CONTAINER_NAME); + entityContainer.setEntitySets(entitySets); + + return entityContainer; + } +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java new file mode 100755 index 0000000..932691e --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java @@ -0,0 +1,154 @@ +/* + * 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 myservice.mynamespace.data.Storage; +import myservice.mynamespace.util.Util; + +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.format.ODataFormat; +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; + +public class DemoEntityCollectionProcessor implements EntityCollectionProcessor { + + + private OData odata; + private ServiceMetadata srvMetadata; + // our database-mock + private Storage storage; + + + + public DemoEntityCollectionProcessor(Storage storage) { + this.storage = storage; + } + + public void init(OData odata, ServiceMetadata serviceMetadata) { + this.odata = odata; + this.srvMetadata = 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(); + EntityCollectionSerializerOptions opts = EntityCollectionSerializerOptions.with().contextURL(contextUrl).build(); + EdmEntityType edmEntityType = responseEdmEntitySet.getEntityType(); + + ODataSerializer serializer = odata.createSerializer(ODataFormat.fromContentType(responseFormat)); + SerializerResult serializerResult = serializer.entityCollection(this.srvMetadata, 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/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java new file mode 100755 index 0000000..1d05e12 --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java @@ -0,0 +1,189 @@ +/* + * 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 myservice.mynamespace.data.Storage; +import myservice.mynamespace.util.Util; + +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.format.ODataFormat; +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.deserializer.DeserializerException; +import org.apache.olingo.server.api.processor.EntityProcessor; +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; + +public class DemoEntityProcessor implements EntityProcessor { + + + private OData odata; + private ServiceMetadata srvMetadata; + private Storage storage; + + + + public DemoEntityProcessor(Storage storage) { + this.storage = storage; + } + + + public void init(OData odata, ServiceMetadata serviceMetadata) { + this.odata = odata; + this.srvMetadata = 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 + if (! (uriResource instanceof UriResourceEntitySet)) { + throw new ODataApplicationException("Only EntitySet is supported", + HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),Locale.ENGLISH); + } + + 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(); + + ODataFormat oDataFormat = ODataFormat.fromContentType(responseFormat); + ODataSerializer serializer = this.odata.createSerializer(oDataFormat); + SerializerResult serializerResult = serializer.entity(this.srvMetadata, + responseEdmEntityType, responseEntity, opts); + + //4. configure the response object + response.setContent(serializerResult.getContent()); + response.setStatusCode(HttpStatusCode.OK.getStatusCode()); + response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString()); + } + + + + /* + * These processor methods are not handled in this tutorial + * */ + + public void createEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, + ContentType requestFormat, ContentType responseFormat) + throws ODataApplicationException, DeserializerException, SerializerException { + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } + + + public void updateEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, + ContentType requestFormat, ContentType responseFormat) + throws ODataApplicationException, DeserializerException, SerializerException { + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } + + + public void deleteEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo) + throws ODataApplicationException { + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoPrimitiveProcessor.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoPrimitiveProcessor.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoPrimitiveProcessor.java new file mode 100755 index 0000000..6436ae5 --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoPrimitiveProcessor.java @@ -0,0 +1,154 @@ +/* + * 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 myservice.mynamespace.data.Storage; + +import org.apache.olingo.commons.api.data.ContextURL; +import org.apache.olingo.commons.api.data.Entity; +import org.apache.olingo.commons.api.data.Property; +import org.apache.olingo.commons.api.edm.EdmEntitySet; +import org.apache.olingo.commons.api.edm.EdmPrimitiveType; +import org.apache.olingo.commons.api.edm.EdmProperty; +import org.apache.olingo.commons.api.format.ContentType; +import org.apache.olingo.commons.api.format.ODataFormat; +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.deserializer.DeserializerException; +import org.apache.olingo.server.api.processor.PrimitiveProcessor; +import org.apache.olingo.server.api.serializer.ODataSerializer; +import org.apache.olingo.server.api.serializer.PrimitiveSerializerOptions; +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.UriResourceProperty; + +public class DemoPrimitiveProcessor implements PrimitiveProcessor { + + private OData odata; + private Storage storage; + + + + public DemoPrimitiveProcessor(Storage storage) { + this.storage = storage; + } + + + public void init(OData odata, ServiceMetadata serviceMetadata) { + this.odata = odata; + + } + + + /* + * In our example, the URL would be: http://localhost:8080/DemoService/DemoService.svc/Products(1)/Name + * and the response: + * { + * @odata.context: "$metadata#Products/Name", + * value: "Notebook Basic 15" + * } + * */ + public void readPrimitive(ODataRequest request, ODataResponse response, + UriInfo uriInfo, ContentType responseFormat) + throws ODataApplicationException, SerializerException { + + // 1. Retrieve info from URI + // 1.1. retrieve the info about the requested entity set + List<UriResource> resourceParts = uriInfo.getUriResourceParts(); + // Note: only in our example we can rely that the first segment is the EntitySet + UriResourceEntitySet uriEntityset = (UriResourceEntitySet) resourceParts.get(0); + EdmEntitySet edmEntitySet = uriEntityset.getEntitySet(); + // the key for the entity + List<UriParameter> keyPredicates = uriEntityset.getKeyPredicates(); + + // 1.2. retrieve the requested (Edm) property + // the last segment is the Property + UriResourceProperty uriProperty = (UriResourceProperty)resourceParts.get(resourceParts.size() -1); + EdmProperty edmProperty = uriProperty.getProperty(); + String edmPropertyName = edmProperty.getName(); + // in our example, we know we have only primitive types in our model + EdmPrimitiveType edmPropertyType = (EdmPrimitiveType) edmProperty.getType(); + + + // 2. retrieve data from backend + // 2.1. retrieve the entity data, for which the property has to be read + Entity entity = storage.readEntityData(edmEntitySet, keyPredicates); + if (entity == null) { // Bad request + throw new ODataApplicationException("Entity not found", + HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH); + } + + // 2.2. retrieve the property data from the entity + Property property = entity.getProperty(edmPropertyName); + if (property == null) { + throw new ODataApplicationException("Property not found", + HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH); + } + + // 3. serialize + Object value = property.getValue(); + if (value != null) { + // 3.1. configure the serializer + ODataFormat format = ODataFormat.fromContentType(responseFormat); + ODataSerializer serializer = odata.createSerializer(format); + + ContextURL contextUrl = ContextURL.with().entitySet(edmEntitySet).navOrPropertyPath(edmPropertyName).build(); + PrimitiveSerializerOptions options = PrimitiveSerializerOptions.with().contextURL(contextUrl).build(); + // 3.2. serialize + SerializerResult serializerResult = serializer.primitive(edmPropertyType, property, options); + InputStream propertyStream = serializerResult.getContent(); + + //4. configure the response object + response.setContent(propertyStream); + response.setStatusCode(HttpStatusCode.OK.getStatusCode()); + response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString()); + }else{ + // in case there's no value for the property, we can skip the serialization + response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode()); + } + } + + + + /* + * These processor methods are not handled in this tutorial + * */ + + public void updatePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestFormat, ContentType responseFormat) + throws ODataApplicationException, DeserializerException, SerializerException { + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } + + public void deletePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo) throws ODataApplicationException { + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/util/Util.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/util/Util.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/util/Util.java new file mode 100755 index 0000000..6a9ecb2 --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/util/Util.java @@ -0,0 +1,145 @@ +/* + * 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.util; + +import java.util.List; +import java.util.Locale; + +import org.apache.olingo.commons.api.data.Entity; +import org.apache.olingo.commons.api.data.EntityCollection; +import org.apache.olingo.commons.api.edm.EdmBindingTarget; +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.edm.EdmPrimitiveType; +import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeException; +import org.apache.olingo.commons.api.edm.EdmProperty; +import org.apache.olingo.commons.api.edm.EdmType; +import org.apache.olingo.commons.api.http.HttpStatusCode; +import org.apache.olingo.server.api.ODataApplicationException; +import org.apache.olingo.server.api.uri.UriParameter; + +public class Util { + + + public static Entity findEntity(EdmEntityType edmEntityType, EntityCollection entitySet, List<UriParameter> keyParams) { + + List<Entity> entityList = entitySet.getEntities(); + + // loop over all entities in order to find that one that matches all keys in request e.g. contacts(ContactID=1, CompanyID=1) + for(Entity entity : entityList){ + boolean foundEntity = entityMatchesAllKeys(edmEntityType, entity, keyParams); + if(foundEntity){ + return entity; + } + } + + return null; + } + + + public static boolean entityMatchesAllKeys(EdmEntityType edmEntityType, Entity rt_entity, List<UriParameter> keyParams) { + + // loop over all keys + for (final UriParameter key : keyParams) { + // key + String keyName = key.getName(); + String keyText = key.getText(); + + // note: below line doesn't consider: keyProp can be part of a complexType in V4 + // in such case, it would be required to access it via getKeyPropertyRef() + // but since this isn't the case in our model, we ignore it in our implementation + EdmProperty edmKeyProperty = (EdmProperty )edmEntityType.getProperty(keyName); + // Edm: we need this info for the comparison below + Boolean isNullable = edmKeyProperty.isNullable(); + Integer maxLength = edmKeyProperty.getMaxLength(); + Integer precision = edmKeyProperty.getPrecision(); + Boolean isUnicode = edmKeyProperty.isUnicode(); + Integer scale = edmKeyProperty.getScale(); + // get the EdmType in order to compare + EdmType edmType = edmKeyProperty.getType(); + //if(EdmType instanceof EdmPrimitiveType) // do we need this? + EdmPrimitiveType edmPrimitiveType = (EdmPrimitiveType)edmType; + + // Runtime data: the value of the current entity + Object valueObject = rt_entity.getProperty(keyName).getValue(); // don't need to check for null, this is done in FWK + // TODO if the property is a complex type + + // now need to compare the valueObject with the keyText String + // this is done using the type.valueToString + String valueAsString = null; + try { + valueAsString = edmPrimitiveType.valueToString(valueObject, isNullable, maxLength, precision, scale, isUnicode); + } catch (EdmPrimitiveTypeException e) { + return false; // TODO proper Exception handling + } + + if (valueAsString == null){ + return false; + } + + boolean matches = valueAsString.equals(keyText); + if(matches){ + // if the given key value is found in the current entity, continue with the next key + continue; + }else{ + // if any of the key properties is not found in the entity, we don't need to search further + return false; + } + } + + return true; + } + + + + /* + * Example: + * For the following navigation: DemoService.svc/Categories(1)/Products + * we need the EdmEntitySet for the navigation property "Products" + * + * This is defined as follows in the metadata: + * + * <EntitySet Name="Categories" EntityType="OData.Demo.Category"> + <NavigationPropertyBinding Path="Products" Target="Products"/> + </EntitySet> + * The "Target" attribute specifies the target EntitySet + * Therefore we need the startEntitySet "Categories" in order to retrieve the target EntitySet "Products" + */ + public static EdmEntitySet getNavigationTargetEntitySet(EdmEntitySet startEntitySet, EdmNavigationProperty edmNavigationProperty) throws ODataApplicationException { + EdmEntitySet navigationTargetEntitySet = null; + + String navPropName = edmNavigationProperty.getName(); + EdmBindingTarget edmBindingTarget = startEntitySet.getRelatedBindingTarget(navPropName); + if(edmBindingTarget == null){ + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } + + if(edmBindingTarget instanceof EdmEntitySet){ + navigationTargetEntitySet = (EdmEntitySet)edmBindingTarget; + }else{ + throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT); + } + + return navigationTargetEntitySet; + } + + +} + http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/web/DemoServlet.java ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/web/DemoServlet.java b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/web/DemoServlet.java new file mode 100755 index 0000000..dd83c6e --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/web/DemoServlet.java @@ -0,0 +1,76 @@ +/* + * 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.web; + +import java.io.IOException; +import java.util.ArrayList; + +import javax.servlet.ServletException; +import javax.servlet.http.HttpServlet; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import javax.servlet.http.HttpSession; + +import myservice.mynamespace.data.Storage; +import myservice.mynamespace.service.DemoEdmProvider; +import myservice.mynamespace.service.DemoEntityCollectionProcessor; +import myservice.mynamespace.service.DemoEntityProcessor; +import myservice.mynamespace.service.DemoPrimitiveProcessor; + +import org.apache.olingo.server.api.OData; +import org.apache.olingo.server.api.ODataHttpHandler; +import org.apache.olingo.server.api.ServiceMetadata; +import org.apache.olingo.server.api.edmx.EdmxReference; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class DemoServlet extends HttpServlet { + + private static final long serialVersionUID = 1L; + private static final Logger LOG = LoggerFactory.getLogger(DemoServlet.class); + + + @Override + protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { + try { + HttpSession session = req.getSession(true); + Storage storage = (Storage) session.getAttribute(Storage.class.getName()); + if (storage == null) { + storage = new Storage(); + session.setAttribute(Storage.class.getName(), storage); + } + + // create odata handler and configure it with EdmProvider and Processor + OData odata = OData.newInstance(); + ServiceMetadata edm = odata.createServiceMetadata(new DemoEdmProvider(), new ArrayList<EdmxReference>()); + ODataHttpHandler handler = odata.createHandler(edm); + handler.register(new DemoEntityCollectionProcessor(storage)); + handler.register(new DemoEntityProcessor(storage)); + handler.register(new DemoPrimitiveProcessor(storage)); + + // let the handler do the work + handler.process(req, resp); + } catch (RuntimeException e) { + LOG.error("Server Error occurred in DemoServlet", e); + throw new ServletException(e); + } + + } + +} http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/webapp/WEB-INF/web.xml ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/webapp/WEB-INF/web.xml b/samples/tutorials/p4_navigation/src/main/webapp/WEB-INF/web.xml new file mode 100755 index 0000000..bc216cb --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/webapp/WEB-INF/web.xml @@ -0,0 +1,34 @@ +<?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. +--> +<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns="http://java.sun.com/xml/ns/javaee"; xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"; + xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"; id="WebApp_ID" version="2.5"> + + <servlet> + <servlet-name>DemoServlet</servlet-name> + <servlet-class> myservice.mynamespace.web.DemoServlet</servlet-class> + <load-on-startup>1</load-on-startup> + </servlet> + + <servlet-mapping> + <servlet-name>DemoServlet</servlet-name> + <url-pattern>/DemoService.svc/*</url-pattern> + </servlet-mapping> +</web-app> http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/p4_navigation/src/main/webapp/index.jsp ---------------------------------------------------------------------- diff --git a/samples/tutorials/p4_navigation/src/main/webapp/index.jsp b/samples/tutorials/p4_navigation/src/main/webapp/index.jsp new file mode 100755 index 0000000..9ec4bc3 --- /dev/null +++ b/samples/tutorials/p4_navigation/src/main/webapp/index.jsp @@ -0,0 +1,26 @@ +<!-- + +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. + +--> +<html> +<body> +<h2>Hello World!</h2> +<a href="DemoService.svc/">OData Olingo V4 Demo Service - Navigation</a> +</body> +</html> http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/51668801/samples/tutorials/pom.xml ---------------------------------------------------------------------- diff --git a/samples/tutorials/pom.xml b/samples/tutorials/pom.xml index e64da0a..915fbb5 100644 --- a/samples/tutorials/pom.xml +++ b/samples/tutorials/pom.xml @@ -38,6 +38,7 @@ <module>p1_read</module> <module>p2_readep</module> <module>p3_write</module> + <module>p4_navigation</module> </modules> <build>
