ISPN-10262 Deprecate custom interceptors configuration

* Deprecate the custom interceptors configuration
* Warn at startup if custom interceptors are present
* Deprecate AdvancedCache.getAsyncInterceptorChain()
* Replace interceptors configuration with direct AsyncInterceptorChain
  manipulation in all the modules.

core/src/main/java/org/infinispan/AdvancedCache.java

@@ -18,7 +18,6 @@
 import org.infinispan.commons.api.TransactionalCache;
 import org.infinispan.commons.dataconversion.Encoder;
 import org.infinispan.commons.dataconversion.Wrapper;
-import org.infinispan.commons.util.Experimental;
 import org.infinispan.configuration.cache.ConfigurationBuilder;
 import org.infinispan.configuration.cache.PartitionHandlingConfiguration;
 import org.infinispan.container.DataContainer;
@@ -191,12 +190,10 @@ default AdvancedCache<K, V> transform(Function<AdvancedCache<K, V>, ? extends Ad
 
    /**
     * Allows the modification of the interceptor chain.
-    * <p>
-    * Experimental: The ability to modify the interceptors at runtime may be removed in future versions.
     *
-    * @since 9.0
+    * @deprecated Since 10.0, will be removed without a replacement
     */
-   @Experimental
+   @Deprecated
    AsyncInterceptorChain getAsyncInterceptorChain();
 
    /**

core/src/main/java/org/infinispan/cache/impl/AbstractDelegatingAdvancedCache.java

@@ -70,6 +70,10 @@ public void addInterceptor(CommandInterceptor i, int position) {
       cache.getAsyncInterceptorChain().addInterceptor(i, position);
    }
 
+   /**
+    * @deprecated Since 10.0, will be removed without a replacement
+    */
+   @Deprecated
    @Override
    public AsyncInterceptorChain getAsyncInterceptorChain() {
       return cache.getAsyncInterceptorChain();

core/src/main/java/org/infinispan/cache/impl/CacheImpl.java

@@ -1161,6 +1161,10 @@ public void addInterceptor(CommandInterceptor i, int position) {
       invoker.addInterceptor(i, position);
    }
 
+   /**
+    * @deprecated Since 10.0, will be removed without a replacement
+    */
+   @Deprecated
    @Override
    public AsyncInterceptorChain getAsyncInterceptorChain() {
       return invoker;

core/src/main/java/org/infinispan/cache/impl/SimpleCacheImpl.java

@@ -1194,6 +1194,10 @@ public void addInterceptor(CommandInterceptor i, int position) {
       throw log.interceptorStackNotSupported();
    }
 
+   /**
+    * @deprecated Since 10.0, will be removed without a replacement
+    */
+   @Deprecated
    @Override
    public AsyncInterceptorChain getAsyncInterceptorChain() {
       return EmptyAsyncInterceptorChain.INSTANCE;

core/src/main/java/org/infinispan/configuration/cache/AbstractConfigurationChildBuilder.java

@@ -27,6 +27,10 @@ public ClusteringConfigurationBuilder clustering() {
       return builder.clustering();
    }
 
+   /**
+    * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
+    */
+   @Deprecated
    @Override
    public CustomInterceptorsConfigurationBuilder customInterceptors() {
       return builder.customInterceptors();

core/src/main/java/org/infinispan/configuration/cache/AbstractCustomInterceptorsConfigurationChildBuilder.java

@@ -1,5 +1,9 @@
 package org.infinispan.configuration.cache;
 
+/**
+ * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
+ */
+@Deprecated
 public abstract class AbstractCustomInterceptorsConfigurationChildBuilder extends AbstractConfigurationChildBuilder {
 
    private final CustomInterceptorsConfigurationBuilder customInterceptorsBuilder;

core/src/main/java/org/infinispan/configuration/cache/Configuration.java

@@ -139,6 +139,10 @@ public ClusteringConfiguration clustering() {
       return clusteringConfiguration;
    }
 
+   /**
+    * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
+    */
+   @Deprecated
    public CustomInterceptorsConfiguration customInterceptors() {
       return customInterceptorsConfiguration;
    }

core/src/main/java/org/infinispan/configuration/cache/ConfigurationBuilder.java

@@ -111,6 +111,10 @@ public ClusteringConfigurationBuilder clustering() {
       return clustering;
    }
 
+   /**
+    * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
+    */
+   @Deprecated
    @Override
    public CustomInterceptorsConfigurationBuilder customInterceptors() {
       return customInterceptors;

core/src/main/java/org/infinispan/configuration/cache/ConfigurationChildBuilder.java

@@ -10,6 +10,10 @@ public interface ConfigurationChildBuilder {
 
    ClusteringConfigurationBuilder clustering();
 
+   /**
+    * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
+    */
+   @Deprecated
    CustomInterceptorsConfigurationBuilder customInterceptors();
 
    DataContainerConfigurationBuilder dataContainer();

core/src/main/java/org/infinispan/configuration/cache/CustomInterceptorsConfiguration.java

@@ -15,7 +15,9 @@
  * Configures custom interceptors to be added to the cache.
  *
  * @author pmuir
+ * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
  */
+@Deprecated
 public class CustomInterceptorsConfiguration implements Matchable<CustomInterceptorsConfiguration>, ConfigurationInfo {
 
    static final ElementDefinition ELEMENT_DEFINITION = new DefaultElementDefinition(CUSTOM_INTERCEPTORS.getLocalName());

core/src/main/java/org/infinispan/configuration/cache/CustomInterceptorsConfigurationBuilder.java

@@ -14,8 +14,9 @@
  * Configures custom interceptors to be added to the cache.
  *
  * @author pmuir
- *
+ * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
  */
+@Deprecated
 public class CustomInterceptorsConfigurationBuilder extends AbstractConfigurationChildBuilder implements Builder<CustomInterceptorsConfiguration>, ConfigurationBuilderInfo {
 
    private List<InterceptorConfigurationBuilder> interceptorBuilders = new LinkedList<>();
@@ -26,7 +27,9 @@ public class CustomInterceptorsConfigurationBuilder extends AbstractConfiguratio
 
    /**
     * Adds a new custom interceptor definition, to be added to the cache when the cache is started.
+    * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
     */
+   @Deprecated
    public InterceptorConfigurationBuilder addInterceptor() {
       InterceptorConfigurationBuilder builder = new InterceptorConfigurationBuilder(this);
       this.interceptorBuilders.add(builder);

core/src/main/java/org/infinispan/configuration/cache/InterceptorConfigurationBuilder.java

@@ -28,7 +28,10 @@
 
 /**
  * This builder defines details of a specific custom interceptor.
+ *
+ * @deprecated Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
  */
+@Deprecated
 public class InterceptorConfigurationBuilder extends AbstractCustomInterceptorsConfigurationChildBuilder implements Builder<InterceptorConfiguration>, ConfigurationBuilderInfo {
    private static final Log log = LogFactory.getLog(InterceptorConfigurationBuilder.class);
    private final AttributeSet attributes;

core/src/main/java/org/infinispan/configuration/parsing/Parser.java

@@ -1396,6 +1396,7 @@ protected void parseCacheElement(XMLExtendedStreamReader reader, Element element
             break;
          }
          case CUSTOM_INTERCEPTORS: {
+            log.customInterceptorsDeprecated();
             this.parseCustomInterceptors(reader, holder);
             break;
          }

core/src/main/java/org/infinispan/security/impl/SecureCacheImpl.java

@@ -248,6 +248,10 @@ public void addInterceptor(CommandInterceptor i, int position) {
       delegate.addInterceptor(i, position);
    }
 
+   /**
+    * @deprecated Since 10.0, will be removed without a replacement
+    */
+   @Deprecated
    @Override
    public AsyncInterceptorChain getAsyncInterceptorChain() {
       authzManager.checkPermission(subject, AuthorizationPermission.ADMIN);

core/src/main/java/org/infinispan/util/logging/Log.java

@@ -1867,4 +1867,8 @@ CacheConfigurationException offHeapMemoryEvictionSizeNotLargeEnoughForAddresses(
 
    @Message(value = "Invalidation mode only supports when-split=ALLOW_READ_WRITES", id = 550)
    CacheConfigurationException invalidationPartitionHandlingNotSuported();
+
+   @LogMessage(level = WARN)
+   @Message(value = "The custom interceptors configuration has been deprecated and will be ignored in the future", id = 551)
+   void customInterceptorsDeprecated();
 }

core/src/main/resources/schema/infinispan-config-10.0.xsd

@@ -850,7 +850,8 @@
       </xs:element>
       <xs:element name="custom-interceptors" type="tns:custom-interceptors" minOccurs="0">
         <xs:annotation>
-          <xs:documentation>Configures custom interceptors to be added to the cache.</xs:documentation>
+          <xs:documentation>Deprecated since 10.0, will be removed without a replacement.
+             Configures custom interceptors to be added to the cache.</xs:documentation>
         </xs:annotation>
       </xs:element>
       <xs:element name="security" type="tns:cache-security" minOccurs="0">
@@ -1195,6 +1196,7 @@
   <xs:complexType name="custom-interceptors">
     <xs:sequence>
       <xs:element name="interceptor" minOccurs="0" maxOccurs="unbounded">
+        <xs:annotation>Deprecated since 10.0, will be removed without a replacement.</xs:annotation>
         <xs:complexType>
           <xs:sequence>
             <xs:element name="property" type="tns:property" minOccurs="0"/>

core/src/test/java/org/infinispan/functional/decorators/FunctionalAdvancedCache.java

@@ -293,6 +293,10 @@ public void addInterceptor(CommandInterceptor i, int position) {
       cache.addInterceptor(i, position);
    }
 
+   /**
+    * @deprecated Since 10.0, will be removed without a replacement
+    */
+   @Deprecated
    @Override
    public AsyncInterceptorChain getAsyncInterceptorChain() {
       return cache.getAsyncInterceptorChain();

core/src/test/java/org/infinispan/test/TestingUtil.java

@@ -1027,6 +1027,10 @@ public static PersistenceMarshaller extractPersistenceMarshaller(EmbeddedCacheMa
       return cm.getGlobalComponentRegistry().getComponent(PersistenceMarshaller.class, KnownComponentNames.PERSISTENCE_MARSHALLER);
    }
 
+   public static AsyncInterceptorChain extractInterceptorChain(Cache cache) {
+      return extractComponent(cache, AsyncInterceptorChain.class);
+   }
+
    /**
     * Add a hook to cache startup sequence that will allow to replace existing component with a mock.
     * @param cacheContainer

counter/src/main/java/org/infinispan/counter/impl/CounterModuleLifecycle.java

@@ -30,10 +30,12 @@
 import org.infinispan.counter.impl.metadata.ConfigurationMetadata;
 import org.infinispan.counter.impl.persistence.PersistenceContextInitializerImpl;
 import org.infinispan.counter.logging.Log;
+import org.infinispan.factories.ComponentRegistry;
 import org.infinispan.factories.GlobalComponentRegistry;
-import org.infinispan.factories.annotations.InfinispanModule;
 import org.infinispan.factories.KnownComponentNames;
+import org.infinispan.factories.annotations.InfinispanModule;
 import org.infinispan.factories.impl.BasicComponentRegistry;
+import org.infinispan.interceptors.AsyncInterceptorChain;
 import org.infinispan.interceptors.impl.EntryWrappingInterceptor;
 import org.infinispan.jmx.CacheManagerJmxRegistration;
 import org.infinispan.lifecycle.ModuleLifecycle;
@@ -66,9 +68,7 @@ private static Configuration createCounterCacheConfiguration(CounterManagerConfi
             .partitionHandling().whenSplit(config.reliability() == Reliability.CONSISTENT ?
                                            PartitionHandling.DENY_READ_WRITES :
                                            PartitionHandling.ALLOW_READ_WRITES)
-            .transaction().transactionMode(TransactionMode.NON_TRANSACTIONAL)
-            .customInterceptors().addInterceptor().after(EntryWrappingInterceptor.class)
-            .interceptor(new CounterInterceptor());
+            .transaction().transactionMode(TransactionMode.NON_TRANSACTIONAL);
       return builder.build();
    }
 
@@ -84,9 +84,8 @@ private static void addAdvancedExternalizer(Map<Integer, AdvancedExternalizer<?>
       map.put(ext.getId(), ext);
    }
 
-   private static CounterManagerConfiguration extractConfiguration(GlobalComponentRegistry globalComponentRegistry) {
-      CounterManagerConfiguration config = globalComponentRegistry.getGlobalConfiguration()
-            .module(CounterManagerConfiguration.class);
+   private static CounterManagerConfiguration extractConfiguration(GlobalConfiguration globalConfiguration) {
+      CounterManagerConfiguration config = globalConfiguration.module(CounterManagerConfiguration.class);
       return config == null ? CounterManagerConfigurationBuilder.defaultConfiguration() : config;
    }
 
@@ -136,7 +135,7 @@ public void cacheManagerStarting(GlobalComponentRegistry gcr, GlobalConfiguratio
       PersistenceMarshaller persistenceMarshaller = bcr.getComponent(KnownComponentNames.PERSISTENCE_MARSHALLER, PersistenceMarshaller.class).wired();
       persistenceMarshaller.register(new PersistenceContextInitializerImpl());
 
-      CounterManagerConfiguration counterManagerConfiguration = extractConfiguration(gcr);
+      CounterManagerConfiguration counterManagerConfiguration = extractConfiguration(globalConfiguration);
       if (gcr.getGlobalConfiguration().isClustered()) {
          //only attempts to create the caches if the cache manager is clustered.
          registerCounterCache(internalCacheRegistry, counterManagerConfiguration);
@@ -146,4 +145,16 @@ public void cacheManagerStarting(GlobalComponentRegistry gcr, GlobalConfiguratio
       }
       registerCounterManager(cacheManager, bcr);
    }
+
+   @Override
+   public void cacheStarting(ComponentRegistry cr, Configuration configuration, String cacheName) {
+      if (COUNTER_CACHE_NAME.equals(cacheName) && configuration.clustering().cacheMode().isClustered()) {
+         BasicComponentRegistry bcr = cr.getComponent(BasicComponentRegistry.class);
+         CounterInterceptor counterInterceptor = new CounterInterceptor();
+         bcr.registerComponent(CounterInterceptor.class, counterInterceptor, true);
+         bcr.addDynamicDependency(AsyncInterceptorChain.class.getName(), CounterInterceptor.class.getName());
+         bcr.getComponent(AsyncInterceptorChain.class).wired()
+            .addInterceptorAfter(counterInterceptor, EntryWrappingInterceptor.class);
+      }
+   }
 }

query/src/main/java/org/infinispan/query/impl/LifecycleManager.java

@@ -31,10 +31,7 @@
 import org.infinispan.commons.util.AggregatedClassLoader;
 import org.infinispan.commons.util.ServiceFinder;
 import org.infinispan.configuration.cache.Configuration;
-import org.infinispan.configuration.cache.ConfigurationBuilder;
-import org.infinispan.configuration.cache.CustomInterceptorsConfigurationBuilder;
 import org.infinispan.configuration.cache.IndexingConfiguration;
-import org.infinispan.configuration.cache.InterceptorConfiguration;
 import org.infinispan.configuration.global.GlobalConfiguration;
 import org.infinispan.configuration.global.GlobalJmxStatisticsConfiguration;
 import org.infinispan.factories.ComponentRegistry;
@@ -191,12 +188,8 @@ private void createQueryInterceptorIfNeeded(BasicComponentRegistry cr, Configura
          keyTransformationHandler.registerTransformer(kt.getKey(), (Class<? extends Transformer>) kt.getValue());
       }
 
-      // Interceptor registration not needed, core configuration handling
-      // already does it for all custom interceptors - UNLESS the InterceptorChain already exists in the component registry!
       AsyncInterceptorChain ic = cr.getComponent(AsyncInterceptorChain.class).wired();
 
-      ConfigurationBuilder builder = new ConfigurationBuilder().read(cfg);
-
       EntryWrappingInterceptor wrappingInterceptor = ic.findInterceptorExtending(EntryWrappingInterceptor.class);
       AsyncInterceptor lastLoadingInterceptor = ic.findInterceptorExtending(CacheLoaderInterceptor.class);
       if (lastLoadingInterceptor == null) {
@@ -207,22 +200,12 @@ private void createQueryInterceptorIfNeeded(BasicComponentRegistry cr, Configura
       cr.registerComponent(QueryInterceptor.class, queryInterceptor, true);
       cr.addDynamicDependency(AsyncInterceptorChain.class.getName(), QueryInterceptor.class.getName());
 
-      // add the interceptor to the configuration also
-      builder.customInterceptors().addInterceptor()
-             .interceptor(queryInterceptor).after(lastLoadingInterceptor.getClass());
-
       if (cfg.transaction().transactionMode().isTransactional()) {
          TxQueryInterceptor txQueryInterceptor = new TxQueryInterceptor(txOldValues, queryInterceptor);
          ic.addInterceptorBefore(txQueryInterceptor, wrappingInterceptor.getClass());
          cr.registerComponent(TxQueryInterceptor.class, txQueryInterceptor, true);
          cr.addDynamicDependency(AsyncInterceptorChain.class.getName(), TxQueryInterceptor.class.getName());
-
-         // add the interceptor to the configuration also
-         builder.customInterceptors().addInterceptor()
-               .interceptor(txQueryInterceptor).before(wrappingInterceptor.getClass());
       }
-
-      cfg.customInterceptors().interceptors(builder.build().customInterceptors().interceptors());
    }
 
    @Override
@@ -433,21 +416,6 @@ private void unregisterQueryMBeans(ComponentRegistry cr, String cacheName) {
 
    @Override
    public void cacheStopped(ComponentRegistry cr, String cacheName) {
-      Configuration cfg = cr.getComponent(Configuration.class);
-      removeQueryInterceptorFromConfiguration(cfg);
-   }
-
-   private void removeQueryInterceptorFromConfiguration(Configuration cfg) {
-      ConfigurationBuilder builder = new ConfigurationBuilder();
-      CustomInterceptorsConfigurationBuilder customInterceptorsBuilder = builder.customInterceptors();
-
-      for (InterceptorConfiguration interceptorConfig : cfg.customInterceptors().interceptors()) {
-         if (!(interceptorConfig.asyncInterceptor() instanceof QueryInterceptor)) {
-            customInterceptorsBuilder.addInterceptor().read(interceptorConfig);
-         }
-      }
-
-      cfg.customInterceptors().interceptors(builder.build().customInterceptors().interceptors());
    }
 
    @Override

query/src/test/java/org/infinispan/query/blackbox/IndexedCacheRestartTest.java

@@ -1,7 +1,9 @@
 package org.infinispan.query.blackbox;
 
+import static org.infinispan.test.TestingUtil.extractInterceptorChain;
 import static org.infinispan.test.TestingUtil.withCacheManager;
 import static org.testng.AssertJUnit.assertEquals;
+import static org.testng.AssertJUnit.assertNotNull;
 import static org.testng.AssertJUnit.assertTrue;
 import static org.testng.AssertJUnit.fail;
 
@@ -18,6 +20,7 @@
 import org.infinispan.query.CacheQuery;
 import org.infinispan.query.Search;
 import org.infinispan.query.SearchManager;
+import org.infinispan.query.backend.QueryInterceptor;
 import org.infinispan.query.indexedembedded.Book;
 import org.infinispan.test.AbstractInfinispanTest;
 import org.infinispan.test.CacheManagerCallable;
@@ -49,13 +52,16 @@ private void indexedCacheRestart(boolean localOnly) {
             .addIndexedEntity(Book.class)
             .addProperty("default.directory_provider", "local-heap")
             .addProperty("lucene_version", "LUCENE_CURRENT");
+      // Test that the query module doesn't break user-configured custom interceptors
+      // Not needed since ISPN-10262, as the query module is no longer configuring any custom interceptors
       final NoOpInterceptor noOpInterceptor = new NoOpInterceptor();
       builder.customInterceptors().addInterceptor().interceptor(noOpInterceptor).position(Position.FIRST);
 
       withCacheManager(new CacheManagerCallable(TestCacheManagerFactory.createCacheManager(builder)) {
          @Override
          public void call() {
             Cache<String, Book> cache = cm.getCache();
+            assertNotNull(extractInterceptorChain(cache).findInterceptorExtending(QueryInterceptor.class));
             assertTrue(cache.isEmpty());
             addABook(cache);
             assertFindBook(cache);
@@ -64,6 +70,7 @@ public void call() {
             assertCacheHasCustomInterceptor(cache, noOpInterceptor);
 
             cache.start();
+            assertNotNull(extractInterceptorChain(cache).findInterceptorExtending(QueryInterceptor.class));
             assertTrue(cache.isEmpty());
             //stopped cache lost all data, and in memory index is lost: re-store both
             //(not needed with permanent indexes and caches using a cachestore)