Refactoring in preparation of appfeat.filter.spi

api/applib/src/main/java/org/apache/causeway/applib/services/appfeat/ApplicationFeatureFilter.java

@@ -0,0 +1,41 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.causeway.applib.services.appfeat;
+
+/**
+ * The various viewer implementations will individually honor any filters registered with Spring,
+ * based on a matching qualifier ('Graphql', 'Restful', etc.).
+ *
+ * <p>All filters that match a qualifier are consulted until any one rejects the {@link ApplicationFeature}.
+ *
+ * <p>If no filters match a qualifier, any {@link ApplicationFeature} is accepted.
+ *
+ * <p>'NoViewer' is a reserved string internally used to mean 'no filtering', hence it should not be used to qualify a filter.
+ *
+ * @since 4.0 {@index}
+ */
+@FunctionalInterface
+public interface ApplicationFeatureFilter {
+
+	/**
+	 * Whether to include given {@link ApplicationFeature}.
+	 */
+	boolean filter(ApplicationFeature feature);
+
+}

api/applib/src/main/java/org/apache/causeway/applib/services/wrapper/control/SyncControl.java

@@ -20,8 +20,9 @@
 
 import java.util.UUID;
 
-import org.jspecify.annotations.Nullable;
+import org.springframework.util.StringUtils;
 
+import org.apache.causeway.applib.annotation.Where;
 import org.apache.causeway.applib.services.iactnlayer.InteractionContext;
 import org.apache.causeway.commons.collections.Can;
 import org.apache.causeway.schema.cmd.v2.CommandDto;
@@ -31,7 +32,7 @@
 /**
  * Controls the way that a (synchronous) wrapper works.
  *
- * @since 2.0 revised for 3.4 {@index}
+ * @since 2.0 revised for 3.4 and 4.0 {@index}
  */
 public record SyncControl(
         /**
@@ -50,7 +51,12 @@ public record SyncControl(
          *
          * <p>The default behaviour is to rethrow the exception.
          */
-        ExceptionHandler exceptionHandler) {
+        ExceptionHandler exceptionHandler,
+        /**
+         * Simulated viewerId, honoring feature filtering.
+         */
+        String viewerId,
+        Where where) {
 
     //TODO can this be further simplified, or is there already an API we can reuse?
 
@@ -79,50 +85,50 @@ public void onCommand(
     }
 
     public static SyncControl defaults() {
-        return new SyncControl(false, false, null, null);
+        return new SyncControl(false, false, null, null, null, null);
     }
 
-    public SyncControl(
-            boolean isSkipRules,
-            boolean isSkipExecute,
-            @Nullable Can<CommandListener> commandListeners,
-            @Nullable ExceptionHandler exceptionHandler) {
-        this.isSkipRules = isSkipRules;
-        this.isSkipExecute = isSkipExecute;
-        this.commandListeners = commandListeners!=null
-                ? commandListeners
-                : Can.empty();
-        this.exceptionHandler = exceptionHandler!=null
-                ? exceptionHandler
-                : exception -> { throw exception; };
+    public SyncControl {
+        commandListeners = commandListeners!=null
+            ? commandListeners
+            : Can.empty();
+        exceptionHandler = exceptionHandler!=null
+            ? exceptionHandler
+            : exception -> { throw exception; };
+        viewerId = StringUtils.hasText(viewerId)
+            ? viewerId
+            : "NoViewer";
+    	where = where!=null
+            ? where
+            : Where.ANYWHERE;
     }
 
     /**
      * Skip checking business rules (hide/disable/validate) before
      * executing the underlying property or action
      */
     public SyncControl withSkipRules() {
-        return new SyncControl(true, isSkipExecute, commandListeners, exceptionHandler);
+        return new SyncControl(true, isSkipExecute, commandListeners, exceptionHandler, viewerId, where);
     }
     public SyncControl withCheckRules() {
-        return new SyncControl(false, isSkipExecute, commandListeners, exceptionHandler);
+        return new SyncControl(false, isSkipExecute, commandListeners, exceptionHandler, viewerId, where);
     }
 
     /**
      * Explicitly set the action to be executed.
      */
     public SyncControl withExecute() {
-        return new SyncControl(isSkipRules, false, commandListeners, exceptionHandler);
+        return new SyncControl(isSkipRules, false, commandListeners, exceptionHandler, viewerId, where);
     }
     /**
      * Explicitly set the action to <i>not</i> be executed, in other words a 'dry run'.
      */
     public SyncControl withNoExecute() {
-        return new SyncControl(isSkipRules, true, commandListeners, exceptionHandler);
+        return new SyncControl(isSkipRules, true, commandListeners, exceptionHandler, viewerId, where);
     }
 
-    public SyncControl listen(@NonNull CommandListener commandListener) {
-        return new SyncControl(isSkipRules, isSkipExecute, commandListeners.add(commandListener), exceptionHandler);
+    public SyncControl listen(@NonNull final CommandListener commandListener) {
+        return new SyncControl(isSkipRules, isSkipExecute, commandListeners.add(commandListener), exceptionHandler, viewerId, where);
     }
 
     /**
@@ -131,13 +137,21 @@ public SyncControl listen(@NonNull CommandListener commandListener) {
      * <p>The default behaviour is to rethrow the exception.
      */
     public SyncControl withExceptionHandler(final @NonNull ExceptionHandler exceptionHandler) {
-        return new SyncControl(isSkipRules, isSkipExecute, commandListeners, exceptionHandler);
+        return new SyncControl(isSkipRules, isSkipExecute, commandListeners, exceptionHandler, viewerId, where);
+    }
+
+    public SyncControl withViewerId(final String viewerId) {
+        return new SyncControl(isSkipRules, isSkipExecute, commandListeners, exceptionHandler, viewerId, where);
+    }
+
+    public SyncControl withWhere(final Where where) {
+        return new SyncControl(isSkipRules, isSkipExecute, commandListeners, exceptionHandler, viewerId, where);
     }
 
     /**
      * @return whether this and other share the same execution mode, ignoring exceptionHandling
      */
-    public boolean isEquivalent(SyncControl other) {
+    public boolean isEquivalent(final SyncControl other) {
         return this.isSkipExecute == other.isSkipExecute
                 && this.isSkipRules == other.isSkipRules;
     }

commons/src/main/java/org/apache/causeway/commons/internal/ioc/SpringContextHolder.java

@@ -105,7 +105,6 @@ public <T> Optional<T> get(final @NonNull Class<T> requiredType) {
      * @see #select(Class, Annotation[])
      * @see #getSingletonElseFail(Class)
      */
-    @SuppressWarnings("javadoc")
     public <T> Can<T> select(final @NonNull Class<T> requiredType) {
         var allMatchingBeans = springContext.getBeanProvider(requiredType)
                 .orderedStream()
@@ -128,7 +127,6 @@ public <T> Can<T> select(final @NonNull Class<T> requiredType) {
      *
      * @see #select(Class)
      */
-    @SuppressWarnings("javadoc")
     public <T> Can<T> select(
         final @NonNull Class<T> requiredType,
         final @Nullable Annotation[] qualifiers) {
@@ -165,7 +163,6 @@ public <T> Can<T> select(
      * @return IoC managed singleton
      * @throws NoSuchElementException - if the singleton is not resolvable
      */
-    @SuppressWarnings("javadoc")
     public <T> T getSingletonElseFail(final @NonNull Class<T> type) {
         var candidates = select(type);
         if (candidates.getCardinality() == Cardinality.ZERO) {

commons/src/main/java/org/apache/causeway/commons/io/JaxbUtils.java

@@ -24,7 +24,6 @@
 import java.io.StringReader;
 import java.io.StringWriter;
 import java.util.Collections;
-import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.function.Consumer;

commons/src/test/java/org/apache/causeway/commons/net/DataUriTest.java

@@ -27,8 +27,6 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
-import org.apache.causeway.commons.net.DataUri;
-
 import lombok.RequiredArgsConstructor;
 
 class DataUriTest {

core/interaction/src/main/java/module-info.java

@@ -18,6 +18,7 @@
  */
 module org.apache.causeway.core.interaction {
     exports org.apache.causeway.core.interaction;
+    exports org.apache.causeway.core.interaction.core;
     exports org.apache.causeway.core.interaction.scope;
     exports org.apache.causeway.core.interaction.session;
 

core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/hidden/HiddenTypeFacet.java → core/interaction/src/main/java/org/apache/causeway/core/interaction/core/AccessRestriction.java

@@ -16,8 +16,16 @@
  *  specific language governing permissions and limitations
  *  under the License.
  */
-package org.apache.causeway.core.metamodel.facets.object.hidden;
+package org.apache.causeway.core.interaction.core;
 
-public interface HiddenTypeFacet extends HiddenInstanceFacet {
+import java.util.Optional;
 
+import org.apache.causeway.core.metamodel.consent.Consent;
+
+public record AccessRestriction(
+		boolean canView,
+		boolean canEdit,
+		Optional<Consent.VetoReason> vetoReasonOpt
+		) {
 }
+

core/interaction/src/main/java/org/apache/causeway/core/interaction/core/ApplicationFeatureFilters.java

@@ -0,0 +1,85 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.causeway.core.interaction.core;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Stream;
+
+import org.jspecify.annotations.Nullable;
+
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.context.ApplicationContext;
+import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.util.StringUtils;
+
+import org.apache.causeway.applib.services.appfeat.ApplicationFeatureFilter;
+import org.apache.causeway.commons.collections.Can;
+import org.apache.causeway.commons.internal.base._NullSafe;
+import org.apache.causeway.commons.internal.collections._Multimaps;
+
+record ApplicationFeatureFilters(
+		Can<ApplicationFeatureFilter> unqualifiedFilters,
+		Map<String, Can<ApplicationFeatureFilter>> filtersByQualifier) {
+
+	// -- FACTORIES
+
+	static ApplicationFeatureFilters empty() {
+		return new ApplicationFeatureFilters(Can.empty(), Collections.emptyMap());
+	}
+
+	static ApplicationFeatureFilters collectFrom(final @Nullable ApplicationContext springContext) {
+		if(springContext==null)
+			//JUnit Support
+			return ApplicationFeatureFilters.empty();
+
+		var unqualifiedFilters = new ArrayList<ApplicationFeatureFilter>();
+		var filtersByQualifier = _Multimaps.<String, ApplicationFeatureFilter>newListMultimap();
+
+        Stream.of(springContext.getBeanNamesForType(ApplicationFeatureFilter.class))
+    	.forEach(beanName->{
+    		var filterBean = springContext.getBean(beanName, ApplicationFeatureFilter.class);
+            @SuppressWarnings("deprecation")
+			Set<Qualifier> qualifiers = AnnotationUtils.getRepeatableAnnotations(filterBean.getClass(), Qualifier.class);
+            if(!_NullSafe.isEmpty(qualifiers)) {
+            	qualifiers.forEach(qualifier->{
+            		if(StringUtils.hasText(qualifier.value())) {
+            			filtersByQualifier.putElement(qualifier.value(), filterBean);
+            		} else {
+            			unqualifiedFilters.add(filterBean);
+            		}
+            	});
+            } else {
+            	unqualifiedFilters.add(filterBean);
+            }
+    	});
+
+        // Sanitize (no duplicates, when already in unqualified Can) and make immutable
+        var unqualifiedFiltersCanned = Can.ofCollection(unqualifiedFilters).distinct();
+		var filtersByQualifierCanned = new HashMap<String, Can<ApplicationFeatureFilter>>();
+		filtersByQualifier.forEach((k, v)->filtersByQualifierCanned.put(k, Can.ofCollection(v).distinct().filter(it->!unqualifiedFiltersCanned.contains(it))));
+		return new ApplicationFeatureFilters(
+				unqualifiedFiltersCanned,
+				Collections.unmodifiableMap(filtersByQualifierCanned));
+	}
+
+}

core/interaction/src/main/java/org/apache/causeway/core/interaction/core/InteractionConstraint.java

@@ -0,0 +1,44 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you under the Apache License, Version 2.0 (the
+ *  "License"); you may not use this file except in compliance
+ *  with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied.  See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+package org.apache.causeway.core.interaction.core;
+
+import org.apache.causeway.applib.annotation.Where;
+import org.apache.causeway.core.metamodel.consent.InteractionInitiatedBy;
+import org.apache.causeway.core.metamodel.interactions.VisibilityConstraint;
+import org.apache.causeway.core.metamodel.interactions.WhatViewer;
+
+public record InteractionConstraint(
+		WhatViewer whatViewer,
+		InteractionInitiatedBy initiatedBy,
+		Where where
+		) {
+
+	public InteractionConstraint withWhere(final Where where) {
+		return new InteractionConstraint(whatViewer, initiatedBy, where);
+	}
+
+	public InteractionConstraint withInitiatedBy(final InteractionInitiatedBy initiatedBy) {
+		return new InteractionConstraint(whatViewer, initiatedBy, where);
+	}
+
+	public VisibilityConstraint asVisibilityConstraint() {
+		return new VisibilityConstraint(whatViewer, where);
+	}
+
+}