Replace EntityEncoderFilter with per-entity object read filter #501

cleanup, refactoring
agrestio · Nov 28, 2021 · 824cdfb · 824cdfb
1 parent 255fe1c
commit 824cdfb
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 7 deletions.
diff --git a/agrest-cayenne/src/main/java/io/agrest/cayenne/compiler/CayenneAgEntityBuilder.java b/agrest-cayenne/src/main/java/io/agrest/cayenne/compiler/CayenneAgEntityBuilder.java
@@ -205,7 +205,7 @@ protected AgEntity<T> buildEntity() {
                 rootDataResolver != null ? rootDataResolver : ThrowingRootDataResolver.getInstance(),
 
                 // TODO: support Exp filters via annotations?
-                ObjectFilter.trueFilter());
+                ObjectFilter.allowsAllFilter());
     }
 
     /**

diff --git a/agrest-cayenne/src/test/java/io/agrest/cayenne/GET_ObjectFilterIT.java b/agrest-cayenne/src/test/java/io/agrest/cayenne/GET_ObjectFilterIT.java
@@ -217,7 +217,7 @@ public DataResponse<E4> getWithRequestEncoder(@Context UriInfo uriInfo, @PathPar
 
             return Ag.service(config)
                     .select(E4.class)
-                    .objectFilter(E4.class, e4 -> cVarchar.equals(e4.getCVarchar()))
+                    .filter(E4.class, e4 -> cVarchar.equals(e4.getCVarchar()))
                     .uri(uriInfo)
                     .get();
         }

diff --git a/agrest-engine/src/main/java/io/agrest/SelectBuilder.java b/agrest-engine/src/main/java/io/agrest/SelectBuilder.java
@@ -46,7 +46,7 @@ public interface SelectBuilder<T> {
      * @return this builder instance
      * @see AgBuilder#entityEncoderFilter(EntityEncoderFilter)
      * @since 3.4
-     * @deprecated since 4.8 in favor of {@link #objectFilter(Class, ObjectFilter)}.
+     * @deprecated since 4.8 in favor of {@link #filter(Class, ObjectFilter)}.
      */
     @Deprecated
     SelectBuilder<T> entityEncoderFilter(EntityEncoderFilter filter);
@@ -111,10 +111,13 @@ default <A> SelectBuilder<T> propFilter(Class<A> entityType, PropertyFilter filt
     }
 
     /**
+     * Installs an in-memory filter for a given entity type that will exclude objects from response that do not match
+     * the filter. This filter is combined with any runtime-level filters for the same entity.
+     *
      * @return this builder instance
      * @since 4.8
      */
-    default <A> SelectBuilder<T> objectFilter(Class<A> entityType, ObjectFilter<A> filter) {
+    default <A> SelectBuilder<T> filter(Class<A> entityType, ObjectFilter<A> filter) {
         return entityOverlay(AgEntity.overlay(entityType).selectFilter(filter));
     }
 

diff --git a/agrest-engine/src/main/java/io/agrest/compiler/AnnotationsAgEntityBuilder.java b/agrest-engine/src/main/java/io/agrest/compiler/AnnotationsAgEntityBuilder.java
@@ -209,7 +209,7 @@ protected AgEntity<T> buildEntity() {
                 rootDataResolver != null ? rootDataResolver : ThrowingRootDataResolver.getInstance(),
 
                 // TODO: support Exp filters via annotations?
-                ObjectFilter.trueFilter());
+                ObjectFilter.allowsAllFilter());
     }
 
     /**

diff --git a/agrest-engine/src/main/java/io/agrest/filter/ObjectFilter.java b/agrest-engine/src/main/java/io/agrest/filter/ObjectFilter.java
@@ -8,7 +8,7 @@
 @FunctionalInterface
 public interface ObjectFilter<T> {
 
-    static <T> ObjectFilter<T> trueFilter() {
+    static <T> ObjectFilter<T> allowsAllFilter() {
         return AllowAllObjectFilter.instance;
     }
 

diff --git a/agrest-engine/src/main/java/io/agrest/meta/AgEntityOverlay.java b/agrest-engine/src/main/java/io/agrest/meta/AgEntityOverlay.java
@@ -40,7 +40,7 @@ public AgEntityOverlay(Class<T> type) {
         this.type = type;
         this.attributes = new HashMap<>();
         this.relationships = new HashMap<>();
-        this.selectFilter = ObjectFilter.trueFilter();
+        this.selectFilter = ObjectFilter.allowsAllFilter();
     }
 
     private static PropertyReader fromFunction(Function<?, ?> f) {