Enh 34451765 - [34432231->22.09] Add the ability to configure a global socket provider (merge main -> ce/main 94613)

RQ job.9.20220801124933.24624 [git-p4: depot-paths = "//dev/coherence-ce/main/": change = 94619]

Author: Jonathan Knight

prj/coherence-core/src/main/java/com/tangosol/coherence/config/builder/SSLSocketProviderDependenciesBuilder.java

@@ -2,7 +2,7 @@
  * Copyright (c) 2000, 2022, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
- * http://oss.oracle.com/licenses/upl.
+ * https://oss.oracle.com/licenses/upl.
  */
 package com.tangosol.coherence.config.builder;
 
@@ -60,8 +60,8 @@
 
 /**
  * {@link SSLSocketProviderDependenciesBuilder} enables lazy instantiation of SSL SocketProvider.
- *
- * Builder includes methods that allows one to specify whether to get a datagram or demultiplexed
+ * <p>
+ * This builder includes methods that allows one to specify whether to get a datagram or demultiplexed
  * {@link SocketProvider} and what subport to use for the socketprovider.
  *
  * @author jf 2015.11.11
@@ -82,7 +82,7 @@ public class SSLSocketProviderDependenciesBuilder
  public SSLSocketProviderDependenciesBuilder(SSLSocketProviderDefaultDependencies deps)
  {
  m_deps = deps;
- m_bldrDelegateSocketProvider = new SocketProviderBuilder(SocketProviderFactory.DEFAULT_SOCKET_PROVIDER);
+ m_bldrDelegateSocketProvider = new SocketProviderBuilder(SocketProviderFactory.DEFAULT_SOCKET_PROVIDER, false);
  m_sNameProtocol = SSLSocketProviderDefaultDependencies.DEFAULT_SSL_PROTOCOL;
  }
 
@@ -314,8 +314,8 @@ public SocketProviderBuilder getSocketProviderBuilder()
 
  /**
  * Realize a SSLSocketProviderDefaultDependencies based on configured/defaulted values for config element ssl.
- *
- * Note: unlike typical builders, this is realize once since sensitive password data is nulled after realizing.
+ * <p>
+ * Note: unlike typical builders, this is realized once, since sensitive password data is nullified after realizing.
  *
  * @return {@link SSLSocketProviderDefaultDependencies}
  */

prj/coherence-core/src/main/java/com/tangosol/coherence/config/builder/SocketProviderBuilder.java

@@ -1,8 +1,8 @@
 /*
- * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
+ * Copyright (c) 2000, 2022, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
- * http://oss.oracle.com/licenses/upl.
+ * https://oss.oracle.com/licenses/upl.
  */
 package com.tangosol.coherence.config.builder;
 
@@ -32,26 +32,31 @@ public class SocketProviderBuilder implements ParameterizedBuilder<SocketProvide
  /**
  * Construct a {@link SocketProviderBuilder} from its definition id and its dependencies.
  *
- * @param sId provider definition id. {@link #UNNAMED_PROVIDER_ID} indicates an inlined anonymous socket provider
- * @param deps SocketProvider dependencies
+ * @param sId provider definition id. {@link #UNNAMED_PROVIDER_ID} indicates an inlined
+ * anonymous socket provider
+ * @param deps SocketProvider dependencies
+ * @param fCanUseGlobal {@code true} if the global provider builder can be used over this builder
  */
- public SocketProviderBuilder(String sId, SocketProviderFactory.Dependencies deps)
+ public SocketProviderBuilder(String sId, SocketProviderFactory.Dependencies deps, boolean fCanUseGlobal)
  {
- f_sId = sId;
- f_deps = deps;
- f_provider = null;
+ f_sId = sId;
+ f_deps = deps;
+ f_provider = null;
+ f_fUseGlobal = fCanUseGlobal;
  }
 
  /**
  * Wrapper an existing {@link SocketProvider} into a Builder so it can be registered in cluster BuilderRegistry.
  *
- * @param provider a SocketProvider
+ * @param provider a {@link SocketProvider}
+ * @param fCanUseGlobal {@code true} if the global provider builder can be used over this builder
  */
- public SocketProviderBuilder(SocketProvider provider)
+ public SocketProviderBuilder(SocketProvider provider, boolean fCanUseGlobal)
  {
- f_sId = null;
- f_deps = null;
- f_provider = provider;
+ f_sId = null;
+ f_deps = null;
+ f_provider = provider;
+ f_fUseGlobal = fCanUseGlobal;
  }
 
  // ----- SocketProviderBuilder methods -----------------------------------
@@ -83,10 +88,15 @@ public String getId()
  * @param nSubport subport for demultiplexed socket provider.
  *
  * @return the provider
+ * @throws NullPointerException if this builders {@link #f_deps} field is {@code null}
  */
  public SocketProvider getDemultiplexedSocketProvider(int nSubport)
  {
- return f_deps.getSocketProviderFactory().getDemultiplexedSocketProvider(f_sId, f_deps, nSubport);
+ if (f_deps == null)
+ {
+ throw new NullPointerException("The SocketProviderFactory dependencies field is null");
+ }
+ return f_deps.getSocketProviderFactory().getDemultiplexedSocketProvider(f_sId, f_deps, nSubport, f_fUseGlobal);
  }
 
  /**
@@ -95,30 +105,87 @@ public SocketProvider getDemultiplexedSocketProvider(int nSubport)
  * @param nSubport subport for a demultiplexed socket provider.
  *
  * @return the provider
+ * @throws NullPointerException if this builders {@link #f_deps} field is {@code null}
  */
  public DatagramSocketProvider getDatagramSocketProvider(int nSubport)
  {
- return f_deps.getSocketProviderFactory().getDatagramSocketProvider(f_sId, f_deps, nSubport);
+ if (f_deps == null)
+ {
+ throw new NullPointerException("The SocketProviderFactory dependencies field is null");
+ }
+ return f_deps.getSocketProviderFactory().getDatagramSocketProvider(f_sId, f_deps, nSubport, f_fUseGlobal);
  }
 
 
  /**
  * Return SSLSettings for {@link SocketProviderBuilder}.
+ * <p>
+ * If this builder's {@link #canUseGlobal()} method returns {@code} and there is a
+ * global {@link SocketProviderBuilder} configured, then the result of calling the
+ * global builder's getSSLSettings() method will be returned.
  *
  * @return the sslSettings if the socket provider builder has a ssl settings directly or via delegate.
+ * @throws NullPointerException if the global builder is not used and this builders {@link #f_deps}
+ * field is {@code null}
  */
  public SSLSettings getSSLSettings()
  {
+ if (canUseGlobal())
+ {
+ SocketProviderBuilder builder = SocketProviderFactory.getGlobalSocketProviderBuilder();
+ if (builder != null)
+ {
+ return builder.getSSLSettings();
+ }
+ }
+
+ if (f_deps == null)
+ {
+ throw new NullPointerException("The SocketProviderFactory dependencies field is null");
+ }
+
  SSLSocketProvider.Dependencies depsSSL = f_deps.getSSLDependencies(f_sId);
  return depsSSL == null ? null : SocketProviderFactory.createSSLSettings(depsSSL);
  }
 
+ /**
+ * Returns {@code true} if the {@link SocketProviderFactory} can use the
+ * global provider builder over this builder, if a global builder is
+ * present.
+ *
+ * @return {@code true} if the {@link SocketProviderFactory} can use the
+ * global provider builder over this builder
+ */
+ public boolean canUseGlobal()
+ {
+ return f_fUseGlobal;
+ }
+
  // ----- ParameterizedBuilder methods ------------------------------------
 
  @Override
  public SocketProvider realize(ParameterResolver resolver, ClassLoader loader, ParameterList listParameters)
  {
- return f_provider == null ? f_deps.getSocketProviderFactory().getSocketProvider(f_sId, f_deps, 0) : f_provider;
+ if (f_fUseGlobal)
+ {
+ SocketProviderBuilder builder = SocketProviderFactory.getGlobalSocketProviderBuilder();
+ if (builder != null)
+ {
+ return builder.realize(resolver, loader, listParameters);
+ }
+ }
+
+ if (f_provider != null)
+ {
+ return f_provider;
+ }
+
+ if (f_deps == null)
+ {
+ throw new NullPointerException("The SocketProviderFactory dependencies field is null");
+ }
+
+ return f_deps.getSocketProviderFactory().getSocketProvider(f_sId, f_deps, 0);
  }
 
  // ----- constants -------------------------------------------------------
@@ -133,7 +200,7 @@ public SocketProvider realize(ParameterResolver resolver, ClassLoader loader, Pa
  /**
  * SocketProvider definition id
  */
- private final String  f_sId;
+ private final String f_sId;
 
  /**
  * Either an anonymous SocketProviderFactory dependencies for an inlined socket-provider or
@@ -144,5 +211,11 @@ public SocketProvider realize(ParameterResolver resolver, ClassLoader loader, Pa
  /**
  * A Wrapped SocketProvider.
  */
- private final SocketProvider f_provider;
+ private final SocketProvider f_provider;
+
+ /**
+ * If {@code true} the {@link SocketProviderFactory} can supply the global
+ * {@link SocketProviderBuilder} over this builder, if one is present.
+ */
+ private final boolean f_fUseGlobal;
  }

prj/coherence-core/src/main/java/com/tangosol/coherence/config/xml/OperationalConfigNamespaceHandler.java

@@ -2,13 +2,14 @@
  * Copyright (c) 2000, 2022, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
- * http://oss.oracle.com/licenses/upl.
+ * https://oss.oracle.com/licenses/upl.
  */
 package com.tangosol.coherence.config.xml;
 
 import com.tangosol.coherence.config.xml.preprocessor.SystemPropertyPreprocessor;
 import com.tangosol.coherence.config.xml.processor.AddressProviderBuilderProcessor;
 import com.tangosol.coherence.config.xml.processor.ExecutorProcessor;
+import com.tangosol.coherence.config.xml.processor.GlobalSocketProviderProcessor;
 import com.tangosol.coherence.config.xml.processor.InitParamProcessor;
 import com.tangosol.coherence.config.xml.processor.InitParamsProcessor;
 import com.tangosol.coherence.config.xml.processor.InstanceProcessor;
@@ -47,6 +48,7 @@
 import com.tangosol.run.xml.XmlElement;
 
 import java.net.URI;
+import java.util.ServiceLoader;
 
 /**
  * The {@link OperationalConfigNamespaceHandler} is responsible for capturing and
@@ -77,6 +79,7 @@ public OperationalConfigNamespaceHandler()
  // register the type-based ElementProcessors
  registerProcessor(AddressProviderBuilderProcessor.class);
  registerProcessor(ExecutorProcessor.class);
+ registerProcessor(GlobalSocketProviderProcessor.class);
  registerProcessor(InitParamProcessor.class);
  registerProcessor(InitParamsProcessor.class);
  registerProcessor(InstanceProcessor.class);
@@ -95,11 +98,11 @@ public OperationalConfigNamespaceHandler()
  registerProcessor(SerializerBuilderProcessor.class);
  registerProcessor(SerializersProcessor.class);
  registerProcessor(SocketProviderProcessor.class);
+ registerProcessor(SocketProvidersProcessor.class);
  registerProcessor(SSLProcessor.class);
  registerProcessor(SSLHostnameVerifierProcessor.class);
  registerProcessor(StorageAccessAuthorizerBuilderProcessor.class);
  registerProcessor(StorageAccessAuthorizersProcessor.class);
- registerProcessor(SocketProvidersProcessor.class);
 
  // register customized ElementProcessors
  registerProcessor("address-provider", new AddressProviderBuilderProcessor());
@@ -113,12 +116,14 @@ public OperationalConfigNamespaceHandler()
  registerProcessor("name-service-addresses", new AddressProviderBuilderProcessor());
  registerProcessor("protocol-versions", new SSLNameListProcessor("protocol-versions"));
  registerProcessor("remote-addresses", new AddressProviderBuilderProcessor());
- registerProcessor("socket-provider", new SocketProviderProcessor());
  registerProcessor("trust-manager", new SSLManagerProcessor());
  registerProcessor("url", new SimpleElementProcessor<>(URLKeyStoreLoader.class));
 
  // register injectable types (in alphabetical order)
  registerProcessor("federation-config", new UnsupportedFeatureProcessor("Federated Caching"));
+
+ ServiceLoader<Extension> extensions = ServiceLoader.load(Extension.class);
+ extensions.forEach(e -> e.extend(this));
  }
 
  // ----- NamespaceHandler interface -------------------------------------
@@ -131,4 +136,23 @@ public void onStartNamespace(ProcessingContext context, XmlElement element, Stri
  {
  super.onStartNamespace(context, element, prefix, uri);
  }
+
+ // ----- inner interface Extension --------------------------------------
+
+ /**
+ * Implementations of {@link Extension} are able to modify the {@link OperationalConfigNamespaceHandler}
+ * before it is used.
+ * <p>
+ * Instances of {@link Extension} are discovered using the {@link ServiceLoader}. If multiple
+ * instances are on the class pathe there is no guaranteed order in which they will be applied.
+ */
+ public interface Extension
+ {
+ /**
+ * Add extensions to the {@link OperationalConfigNamespaceHandler}.
+ *
+ * @param handler the {@link OperationalConfigNamespaceHandler} to extend
+ */
+ void extend(OperationalConfigNamespaceHandler handler);
+ }
  }

prj/coherence-core/src/main/java/com/tangosol/coherence/config/xml/processor/GlobalSocketProviderProcessor.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2000, 2022, Oracle and/or its affiliates.
+ *
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * https://oss.oracle.com/licenses/upl.
+ */
+package com.tangosol.coherence.config.xml.processor;
+
+import com.tangosol.coherence.config.builder.SocketProviderBuilder;
+import com.tangosol.config.ConfigurationException;
+import com.tangosol.config.xml.ElementProcessor;
+import com.tangosol.config.xml.ProcessingContext;
+import com.tangosol.config.xml.XmlSimpleName;
+import com.tangosol.net.SocketProviderFactory;
+import com.tangosol.run.xml.XmlElement;
+
+/**
+ * An {@link ElementProcessor} that will parse a <global-socket-provider> and
+ * produce the global {@link SocketProviderBuilder}.
+ *
+ * @author Jonathan Knight 2022.07.26
+ * @since 22.06.2
+ */
+@XmlSimpleName("global-socket-provider")
+public class GlobalSocketProviderProcessor
+ extends SocketProviderProcessor
+ {
+ @Override
+ public SocketProviderBuilder process(ProcessingContext ctx, XmlElement xml) throws ConfigurationException
+ {
+ SocketProviderBuilder builder = super.process(ctx, xml);
+ if (!builder.canUseGlobal())
+ {
+ SocketProviderFactory.setGlobalSocketProvider(builder);
+ }
+ return builder;
+ }
+ }