Feature/version 2.2.0

jpa-archetype/odata-jpa-archetype-spring/pom.xml

@@ -17,15 +17,15 @@
 			<extension>
 				<groupId>org.apache.maven.archetype</groupId>
 				<artifactId>archetype-packaging</artifactId>
-				<version>3.2.1</version>
+				<version>3.3.0</version>
 			</extension>
 		</extensions>
 		<pluginManagement>
 			<plugins>
 				<plugin>
 					<groupId>org.apache.maven.plugins</groupId>
 					<artifactId>maven-archetype-plugin</artifactId>
-					<version>3.2.1</version>
+					<version>3.3.0</version>
 					<configuration>
 						<debug>true</debug>
 					</configuration>

jpa/odata-jpa-metadata/src/test/java/com/sap/olingo/jpa/metadata/core/edm/mapper/impl/IntermediateDescriptionPropertyTest.java

@@ -262,7 +262,6 @@ void checkAnnotations() throws ODataJPAModelException {
 
   @Test
   void checkPostProcessorCalled() throws ODataJPAModelException {
-    // PostProcessorSpy spy = new PostProcessorSpy();
     IntermediateModelElement.setPostProcessor(processor);
     final Attribute<?, ?> jpaAttribute = helper.getDeclaredAttribute(helper.getEmbeddableType("PostalAddressData"),
         "countryName");
@@ -285,35 +284,31 @@ void checkPostProcessorAnnotationAdded() throws ODataJPAModelException {
   @Test
   void checkEmptyAssociationThrowsException() throws ODataJPAModelException {
 
-    final IntermediateDescriptionProperty cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(
-        false, false, 0), et, helper.schema);
+    cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(false, false, 0), et, helper.schema);
     final ODataJPAModelException act = assertThrows(ODataJPAModelException.class, () -> cut.lazyBuildEdmItem());
     assertEquals(ODataJPAModelException.MessageKeys.DESCRIPTION_ANNOTATION_MISSING.getKey(), act.getId());
   }
 
   @Test
   void checkUnknownAttributeAtTargetThrowsException() throws ODataJPAModelException {
 
-    final IntermediateDescriptionProperty cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(
-        true, false, 0), et, helper.schema);
+    cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(true, false, 0), et, helper.schema);
     final ODataJPAModelException act = assertThrows(ODataJPAModelException.class, () -> cut.lazyBuildEdmItem());
     assertEquals(ODataJPAModelException.MessageKeys.INVALID_DESCRIPTION_PROPERTY.getKey(), act.getId());
   }
 
   @Test
   void checkNoLocationAtTargetThrowsException() throws ODataJPAModelException {
 
-    final IntermediateDescriptionProperty cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(
-        true, true, 0), et, helper.schema);
+    cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(true, true, 0), et, helper.schema);
     final ODataJPAModelException act = assertThrows(ODataJPAModelException.class, () -> cut.lazyBuildEdmItem());
     assertEquals(ODataJPAModelException.MessageKeys.DESCRIPTION_LOCALE_FIELD_MISSING.getKey(), act.getId());
   }
 
   @Test
   void checkLocationAndLanguageAtTargetThrowsException() throws ODataJPAModelException {
 
-    final IntermediateDescriptionProperty cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(
-        true, true, 2), et, helper.schema);
+    cut = new IntermediateDescriptionProperty(nameBuilder, createAttributeMock(true, true, 2), et, helper.schema);
     final ODataJPAModelException act = assertThrows(ODataJPAModelException.class, () -> cut.lazyBuildEdmItem());
     assertEquals(ODataJPAModelException.MessageKeys.DESCRIPTION_LOCALE_FIELD_MISSING.getKey(), act.getId());
   }
@@ -393,17 +388,24 @@ void checkPathHasJoinTableNull() throws ODataJPAModelException {
     assertNull(act.getJoinTable());
   }
 
-  private class PostProcessorSetName implements JPAEdmMetadataPostProcessor {
+  @Test
+  void checkPathGetForeignKeyColumns() throws ODataJPAModelException {
+    createDefaultCut();
+    final var act = cut.getPath().getForeignKeyColumns();
+    assertNotNull(act);
+    assertTrue(act.isEmpty());
+  }
+
+  private static class PostProcessorSetName implements JPAEdmMetadataPostProcessor {
 
     @Override
     public void processProperty(final IntermediatePropertyAccess property, final String jpaManagedTypeClassName) {
-      if (jpaManagedTypeClassName.equals(ADDR_CANONICAL_NAME)) {
-        if (property.getInternalName().equals("countryName")) {
-          final CsdlAnnotation annotation = new CsdlAnnotation();
-          annotation.setTerm("Immutable");
-          annotation.setExpression(new CsdlConstantExpression(ConstantExpressionType.Bool, "true"));
-          property.addAnnotations(Collections.singletonList(annotation));
-        }
+      if (jpaManagedTypeClassName.equals(ADDR_CANONICAL_NAME)
+          && property.getInternalName().equals("countryName")) {
+        final CsdlAnnotation annotation = new CsdlAnnotation();
+        annotation.setTerm("Immutable");
+        annotation.setExpression(new CsdlConstantExpression(ConstantExpressionType.Bool, "true"));
+        property.addAnnotations(Collections.singletonList(annotation));
       }
     }
 
@@ -430,7 +432,7 @@ private void createDefaultCut() throws ODataJPAModelException {
   }
 
   private Attribute<?, ?> createAttributeMock(final boolean association, final boolean associationName,
-      final int langFields) {
+      final int languageFields) {
     final Attribute<?, ?> attribute = mock(Attribute.class);
     final ManagedType<?> managedType = mock(ManagedType.class);
     final Member member = mock(AnnotatedMember.class);
@@ -461,9 +463,9 @@ public Class<BusinessPartner> answer(final InvocationOnMock invocation) throws T
       when(((AnnotatedElement) member).getAnnotation(EdmDescriptionAssociation.class)).thenReturn(a);
       if (associationName)
         when(a.descriptionAttribute()).thenReturn("name");
-      if (langFields > 0)
+      if (languageFields > 0)
         when(a.languageAttribute()).thenReturn("language");
-      if (langFields > 1)
+      if (languageFields > 1)
         when(a.localeAttribute()).thenReturn("location");
     }
     return attribute;

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/api/JPAODataPage.java

@@ -5,8 +5,20 @@
 
 import org.apache.olingo.server.api.uri.UriInfoResource;
 
+/**
+ * A page in case a the amount of returned data shall be restricted by the server.
+ *
+ * @param uriInfo UriInfoResource of the original request
+ * @param skip Skip value to be used
+ * @param top Top value to be used
+ * @param skipToken The skip token to be used in the next link for non expand requests.
+ * @param expandInformation Provides for pages of restricted expand requests the path and key information needed to build the
+ * next
+ * request.
+ *
+ */
 public record JPAODataPage(UriInfoResource uriInfo, int skip, int top, Object skipToken,
-    List<JPAODataPageExpandInfo> expandInfo) {
+    List<JPAODataPageExpandInfo> expandInformation) {
 
   public JPAODataPage(final UriInfoResource uriInfo, final int skip, final int top, final Object skipToken) {
     this(uriInfo, skip, top, skipToken, Collections.emptyList());

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/api/JPAODataPageExpandInfo.java

@@ -1,5 +1,14 @@
 package com.sap.olingo.jpa.processor.core.api;
 
+/**
+ *
+ * @param navigationPropertyPath Concatenated path information leading to the next expand
+ * @param keyPath Concatenated key information to be used to convert the expand
+ *
+ * @author Oliver Grande
+ * @since 2.2.0
+ *
+ */
 public record JPAODataPageExpandInfo(String navigationPropertyPath, String keyPath) {
 
 }

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/api/JPAODataPagingProvider.java

@@ -83,7 +83,7 @@ default JPAODataPage getFirstPage(final UriInfo uriInfo, @Nullable final Integer
    * @param uriInfo
    * @param preferredPageSize Value of the odata.maxpagesize preference header
    * @param countQuery A query that can be used to determine the maximum number of results that can be
-   * expected. Only if the number of expected results is bigger then the page size a next link
+   * expected. Only if the number of expected results is bigger then the page size a page should be generated.
    * @param em An instance of the entity manager
    * @return An optional of the page that shall be read. In case the optional is empty, all records are read from the
    * database.
@@ -98,11 +98,12 @@ default Optional<JPAODataPage> getFirstPage(final JPARequestParameterMap request
   /**
    * Requires module {@code odata-jpa-processor-cb}
    * @param requestParameter The parameter from the request context
-   * @param pathInformation
-   * @param uriInfo
-   * @param association
+   * @param pathInformation Fragmented string representation of the URI, to be able to rebuild the uri info.
+   * @param uriInfo Java representation of the request URI
+   * @param association Metadata of the 
    * @param preferredPageSize
-   * @param count
+   * @param count A query that can be used to determine the maximum number of results that can be
+   * expected per parent. Only if the number of expected results is bigger then the page size a page should be generated.
    * @param em An instance of the entity manager
    * @return
    */

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/api/JPAODataRequestContextAccess.java

@@ -73,4 +73,6 @@ public Optional<EdmQueryExtensionProvider> getQueryEnhancement(@Nonnull final JP
   public JPAODataEtagHelper getEtagHelper();
 
   public Optional<JPAODataPagingProvider> getPagingProvider();
+
+  public JPAODataPathInformation getPathInformation();
 }

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/processor/JPANavigationRequestProcessor.java

@@ -82,7 +82,6 @@ public <K extends Comparable<K>> void retrieveData(final ODataRequest request, f
       final ContentType responseFormat) throws ODataException {
 
     try (var measurement = debugger.newMeasurement(this, "retrieveData")) {
-
       checkRequestSupported();
       // Create a JPQL Query and execute it
       JPAJoinQuery query = null;

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/processor/JPAODataInternalRequestContext.java

@@ -36,6 +36,7 @@
 import com.sap.olingo.jpa.processor.core.api.JPAODataEtagHelper;
 import com.sap.olingo.jpa.processor.core.api.JPAODataGroupProvider;
 import com.sap.olingo.jpa.processor.core.api.JPAODataPagingProvider;
+import com.sap.olingo.jpa.processor.core.api.JPAODataPathInformation;
 import com.sap.olingo.jpa.processor.core.api.JPAODataQueryDirectives;
 import com.sap.olingo.jpa.processor.core.api.JPAODataRequestContext;
 import com.sap.olingo.jpa.processor.core.api.JPAODataRequestContextAccess;
@@ -71,6 +72,7 @@ public final class JPAODataInternalRequestContext implements JPAODataRequestCont
   private JPAODataQueryDirectives queryDirectives;
   private JPAODataEtagHelper etagHelper;
   private Optional<JPAODataPagingProvider> pagingProvider;
+  private JPAODataPathInformation pathInformation;
 
   public JPAODataInternalRequestContext(@Nonnull final JPAODataRequestContext requestContext,
       @Nonnull final JPAODataSessionContextAccess sessionContext, final OData odata) {
@@ -89,7 +91,7 @@ public JPAODataInternalRequestContext(@Nonnull final JPAODataRequestContext requ
    */
   public JPAODataInternalRequestContext(final UriInfoResource uriInfo, final JPAODataRequestContextAccess context)
       throws ODataJPAProcessorException {
-    this(uriInfo, null, context, context.getHeader());
+    this(uriInfo, null, context, context.getHeader(), null);
   }
 
   /**
@@ -100,11 +102,12 @@ public JPAODataInternalRequestContext(final UriInfoResource uriInfo, final JPAOD
    */
   public JPAODataInternalRequestContext(final UriInfoResource uriInfo, final JPAODataRequestContextAccess context,
       final Map<String, List<String>> header) throws ODataJPAProcessorException {
-    this(uriInfo, null, context, header);
+    this(uriInfo, null, context, header, null);
   }
 
   JPAODataInternalRequestContext(final UriInfoResource uriInfo, @Nullable final JPASerializer serializer,
-      final JPAODataRequestContextAccess context, final Map<String, List<String>> header)
+      final JPAODataRequestContextAccess context, final Map<String, List<String>> header,
+      final JPAODataPathInformation pathInformation)
       throws ODataJPAProcessorException {
 
     copyContextValues(context);
@@ -115,6 +118,7 @@ public JPAODataInternalRequestContext(final UriInfoResource uriInfo, final JPAOD
     this.header = new JPAHttpHeaderHashMap(header);
     this.customParameter = new JPARequestParameterHashMap(context.getRequestParameter());
     this.hookFactory = new JPAHookFactory(em, this.header, customParameter);
+    this.pathInformation = pathInformation != null ? pathInformation : this.pathInformation;
   }
 
   @Override
@@ -248,6 +252,11 @@ public Optional<JPAODataPagingProvider> getPagingProvider() {
     return pagingProvider;
   }
 
+  @Override
+  public JPAODataPathInformation getPathInformation() {
+    return pathInformation;
+  }
+
   private void copyContextValues(final JPAODataRequestContextAccess context)
       throws ODataJPAProcessorException {
     this.em = context.getEntityManager();
@@ -264,6 +273,7 @@ private void copyContextValues(final JPAODataRequestContextAccess context)
     this.queryDirectives = context.getQueryDirectives();
     this.etagHelper = context.getEtagHelper();
     this.pagingProvider = context.getPagingProvider();
+    this.pathInformation = context.getPathInformation();
   }
 
   private void copyRequestContext(@Nonnull final JPAODataRequestContext requestContext,

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/processor/JPAProcessorFactory.java

@@ -55,7 +55,7 @@ public JPACUDRequestProcessor createCUDRequestProcessor(final UriInfo uriInfo, f
 
     final JPAODataRequestContextAccess requestContext = new JPAODataInternalRequestContext(uriInfo, serializerFactory
         .createCUDSerializer(responseFormat, uriInfo, Optional.ofNullable(header.get(HttpHeader.ODATA_MAX_VERSION))),
-        context, header);
+        context, header, null);
 
     return new JPACUDRequestProcessor(odata, serviceMetadata, requestContext, new JPAConversionHelper());
   }
@@ -73,7 +73,7 @@ public JPAActionRequestProcessor createActionProcessor(final UriInfo uriInfo, fi
 
     final JPAODataRequestContextAccess requestContext = new JPAODataInternalRequestContext(uriInfo,
         responseFormat != null ? serializerFactory.createSerializer(responseFormat, uriInfo, Optional.ofNullable(header
-            .get(HttpHeader.ODATA_MAX_VERSION))) : null, context, header);
+            .get(HttpHeader.ODATA_MAX_VERSION))) : null, context, header, null);
 
     return new JPAActionRequestProcessor(odata, requestContext);
 
@@ -88,7 +88,7 @@ public JPARequestProcessor createProcessor(final UriInfo uriInfo, final ContentT
 
     final JPAODataRequestContextAccess requestContext = new JPAODataInternalRequestContext(newUriInfo, serializerFactory
         .createSerializer(responseFormat, newUriInfo, Optional.ofNullable(header.get(
-            HttpHeader.ODATA_MAX_VERSION))), context, header);
+            HttpHeader.ODATA_MAX_VERSION))), context, header, pathInformation);
 
     return switch (newUriInfo.getLastResourcePart().getKind()) {
       case count -> new JPACountRequestProcessor(odata, requestContext);

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/query/JPAExpandItemInfoFactory.java

@@ -72,7 +72,8 @@ public List<JPAExpandItemInfo> buildExpandItemInfo(final JPAServiceDocument sd,
         final Optional<JPAODataExpandPage> page;
         if (provider.isPresent())
           page = provider.get().getFirstPageExpand(requestContext.getRequestParameter(),
-              null, requestContext.getUriInfo(), item.getKey().getTopOption(), item.getKey().getSkipOption(),
+              requestContext.getPathInformation(), requestContext.getUriInfo(), item.getKey().getTopOption(), item
+                  .getKey().getSkipOption(),
               item.getValue().getLeaf(), count, requestContext.getEntityManager());
         else
           page = Optional.empty();

jpa/odata-jpa-processor/src/main/java/com/sap/olingo/jpa/processor/core/uri/JPAUriInfoFactory.java

@@ -36,23 +36,23 @@ public JPAUriInfoFactory(@Nonnull final JPAODataPage page) {
   }
 
   public JPAUriInfoResource build() {
-    if (page.expandInfo().isEmpty())
+    if (page.expandInformation().isEmpty())
       // Standard pagination not resolving the $levels, as JPA Processor supports ODatas max option,
       // so depth is not known up-front and a late resolution has to be done anyhow. This also prevent the early
       // resolution of *
       return new JPAUriInfoBuilder(page.uriInfo())
-          // .withResolvedStars()
           .withTop(page.top())
           .withSkip(page.skip())
           .withSkipToken(page.skipToken())
           .build();
     else
       return new JPAUriInfoBuilder(page.uriInfo())
-          .withResolvedStars(page.expandInfo())
-          .withExpandInfo(page.expandInfo())
+          .withResolvedStars(page.expandInformation())
+          .withExpandInfo(page.expandInformation())
           .withExpandOrderBy()
           .withTop(page.top())
           .withSkip(page.skip())
+          .withSkipToken(page.skipToken())
           .build();
   }