[WIP] Move read methods to binary-impl

modules/binary/api/src/main/java/org/apache/ignite/internal/binary/BinaryContext.java

@@ -25,6 +25,7 @@
 import java.sql.Time;
 import java.sql.Timestamp;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Date;
@@ -79,6 +80,21 @@
 
 /**
  * Binary context.
+ *
+ * <h3>Class loaders</h3>
+ * Binary code deals with exactly two kinds of class loaders:
+ * <ul>
+ *     <li><b>Default loader</b> - {@link #classLoader()}. It is the loader set via
+ *     {@code IgniteConfiguration#getClassLoader()} or ({@link CommonUtils#gridClassLoader()}).
+ *     Classes resolved through it are cached.</li>
+ *
+ *     <li><b>Custom loader</b> - a deployment (peer class loading) or user supplied loader passed explicitly
+ *     into a binary API call. Such loaders can be undeployed (see {@link #onUndeploy(ClassLoader)}),
+ *     so classes resolved through them are never cached.</li>
+ * </ul>
+ * A {@code null} loader anywhere in the binary API means "use the default loader".
+ * Use {@link #resolveClassLoader(ClassLoader)} to turn a caller supplied loader into the one to actually use and
+ * {@link #isCustomLoader(ClassLoader)} to decide whether caching must be bypassed.
  */
 public class BinaryContext {
     /** */
@@ -122,8 +138,8 @@ public class BinaryContext {
     /** Node name. */
     private final @Nullable String igniteInstanceName;
 
-    /** Class loader. */
-    private final @Nullable ClassLoader clsLdr;
+    /** Default class loader. Configured loader or the loader Ignite was loaded by. Never {@code null}. */
+    private final ClassLoader clsLdr;
 
     /** Actual marshaller. */
     private final BinaryMarshaller marsh;
@@ -156,7 +172,7 @@ public class BinaryContext {
      * @param metaHnd Meta data handler.
      * @param marsh Binary marshaller.
      * @param igniteInstanceName Ignite instance name.
-     * @param clsLdr Class loader.
+     * @param clsLdr Configured class loader or {@code null} to use the loader Ignite was loaded by.
      * @param dfltSerializer Binary serializer.
      * @param idMapper Binary id mapper.
      * @param nameMapper Binary name mapper.
@@ -185,7 +201,7 @@ public BinaryContext(
 
         this.metaHnd = metaHnd;
         this.igniteInstanceName = igniteInstanceName;
-        this.clsLdr = clsLdr;
+        this.clsLdr = clsLdr != null ? clsLdr : CommonUtils.gridClassLoader();
         this.dfltSerializer = dfltSerializer;
 
         if (idMapper != null || nameMapper != null || !F.isEmpty(typeCfgs))
@@ -325,20 +341,38 @@ public String igniteInstanceName() {
     }
 
     /**
-     * @return Class loader.
+     * @return Default class loader. Configured loader or the loader Ignite was loaded by. Never {@code null}.
      */
     public ClassLoader classLoader() {
         return clsLdr;
     }
 
+    /**
+     * @param ldr Caller supplied class loader or {@code null}.
+     * @return {@code ldr} if it is a custom loader, default loader otherwise.
+     * @see #isCustomLoader(ClassLoader)
+     */
+    public ClassLoader resolveClassLoader(@Nullable ClassLoader ldr) {
+        return isCustomLoader(ldr) ? ldr : clsLdr;
+    }
+
+    /**
+     * @param ldr Caller supplied class loader or {@code null}.
+     * @return {@code True} if {@code ldr} is a custom (deployment or user supplied) loader,
+     *      {@code false} if it is {@code null}, the default loader or the loader Ignite was loaded by.
+     */
+    public boolean isCustomLoader(@Nullable ClassLoader ldr) {
+        return ldr != null && ldr != clsLdr && ldr != CommonUtils.gridClassLoader();
+    }
+
     /**
      * @param clsName Class name.
      * @return Class loaded by the configured class loader or {@code null} if it is not available to it.
      * @see org.apache.ignite.configuration.IgniteConfiguration#getClassLoader()
      */
     @Nullable private Class<?> loadClassOrNull(String clsName) {
         try {
-            return CommonUtils.resolveClassLoader(null, clsLdr).loadClass(clsName);
+            return clsLdr.loadClass(clsName);
         }
         catch (ClassNotFoundException | NoClassDefFoundError ignored) {
             return null;
@@ -473,20 +507,24 @@ public static BinaryNameMapper defaultNameMapper() {
     }
 
     /**
+     * Lists classes of the package visible on the classpath of {@link #classLoader()}.
+     * When a custom loader is configured, the classpath Ignite itself was loaded from is scanned as well.
+     *
      * @param pkgName Package name.
      * @return Class names.
      */
     @SuppressWarnings("ConstantConditions")
-    private static Iterable<String> classesInPackage(String pkgName) {
+    private Iterable<String> classesInPackage(String pkgName) {
         assert pkgName != null;
 
         Collection<String> clsNames = new ArrayList<>();
 
-        ClassLoader ldr = CommonUtils.gridClassLoader();
-
         String pkgPath = pkgName.replaceAll("\\.", "/");
 
-        URL[] urls = CommonUtils.classLoaderUrls(ldr);
+        Collection<URL> urls = new LinkedHashSet<>(Arrays.asList(CommonUtils.classLoaderUrls(clsLdr)));
+
+        if (clsLdr != CommonUtils.gridClassLoader())
+            urls.addAll(Arrays.asList(CommonUtils.classLoaderUrls(CommonUtils.gridClassLoader())));
 
         for (URL url : urls) {
             String proto = url.getProtocol().toLowerCase();
@@ -717,14 +755,14 @@ private BinaryClassDescriptor systemClassDescriptor(Class<?> cls, String clsName
     /**
      * @param userType User type or not.
      * @param typeId Type ID.
-     * @param ldr Class loader or {@code null} to use {@link CommonUtils#gridClassLoader()}.
+     * @param ldr Custom class loader or {@code null} to use {@link #classLoader()}.
      * @param registerMeta If {@code true}, then metadata will be registered along with the type descriptor.
      * @return Class descriptor.
      */
     BinaryClassDescriptor descriptorForTypeId(
         boolean userType,
         int typeId,
-        ClassLoader ldr,
+        @Nullable ClassLoader ldr,
         boolean registerMeta
     ) {
         assert typeId != GridBinaryMarshaller.UNREGISTERED_TYPE_ID;
@@ -735,6 +773,8 @@ BinaryClassDescriptor descriptorForTypeId(
         if (desc != null)
             return desc;
 
+        ldr = resolveClassLoader(ldr);
+
         Class cls;
 
         try {
@@ -760,20 +800,14 @@ BinaryClassDescriptor descriptorForTypeId(
         }
         catch (ClassNotFoundException e) {
             // Class might have been loaded by default class loader.
-            if (userType
-                && ldr != null
-                && !ldr.equals(CommonUtils.gridClassLoader())
-                && (desc = descriptorForTypeId(true, typeId, null, registerMeta)) != null)
+            if (userType && isCustomLoader(ldr) && (desc = descriptorForTypeId(true, typeId, null, registerMeta)) != null)
                 return desc;
 
             throw new BinaryInvalidTypeException(e);
         }
         catch (IgniteCheckedException e) {
             // Class might have been loaded by default class loader.
-            if (userType
-                && ldr != null
-                && !ldr.equals(CommonUtils.gridClassLoader())
-                && (desc = descriptorForTypeId(true, typeId, null, registerMeta)) != null)
+            if (userType && isCustomLoader(ldr) && (desc = descriptorForTypeId(true, typeId, null, registerMeta)) != null)
                 return desc;
 
             throw new BinaryObjectException("Failed resolve class for ID: " + typeId, e);

modules/binary/api/src/main/java/org/apache/ignite/internal/marshaller/ClassLoaderUtils.java

@@ -29,6 +29,12 @@
 /**
  * Utility class to deal with class loading.
  * Contains internal class cache.
+ * <p>
+ * A {@code null} class loader passed to any method of this class means the loader Ignite itself was loaded by,
+ * {@link CommonUtils#gridClassLoader()}. This fallback serves {@link org.apache.ignite.marshaller.Marshaller} API
+ * callers and deployment code.
+ * Binary code resolves loaders through {@code BinaryContext#resolveClassLoader(ClassLoader)} and never passes
+ * {@code null} here.
  */
 public class ClassLoaderUtils {
     /** Primitive class map. */

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/BinaryArray.java

@@ -104,7 +104,7 @@ public BinaryArray(BinaryContext ctx, int compTypeId, @Nullable String compClsNa
 
     /** {@inheritDoc} */
     @Override public <T> T deserialize(ClassLoader ldr) throws BinaryObjectException {
-        if (ldr != null)
+        if (ctx.isCustomLoader(ldr))
             Marshallers.USE_CACHE.set(Boolean.FALSE);
 
         try {

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/BinaryEnumObjectImpl.java

@@ -169,13 +169,15 @@ public BinaryEnumObjectImpl(BinaryContext ctx, byte[] arr) {
 
     /** {@inheritDoc} */
     @Override public <T> T deserialize(@Nullable ClassLoader ldr) throws BinaryObjectException {
-        if (ldr != null)
+        boolean customLdr = ctx.isCustomLoader(ldr);
+
+        if (customLdr)
             Marshallers.USE_CACHE.set(Boolean.FALSE);
 
         try {
             Class cls = BinaryImplUtils.resolveClass(ctx, typeId, clsName, ldr, false);
 
-            return (T)(ldr == null ? BinaryEnumCache.get(cls, ord) : uncachedValue(cls));
+            return (T)(customLdr ? uncachedValue(cls) : BinaryEnumCache.get(cls, ord));
         }
         finally {
             Marshallers.USE_CACHE.set(Boolean.TRUE);

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/BinaryImplUtils.java

@@ -17,13 +17,11 @@
 package org.apache.ignite.internal.binary;
 
 import java.io.ByteArrayInputStream;
-
 import org.apache.ignite.IgniteCheckedException;
 import org.apache.ignite.binary.BinaryInvalidTypeException;
 import org.apache.ignite.binary.BinaryObjectException;
 import org.apache.ignite.internal.binary.streams.BinaryInputStream;
 import org.apache.ignite.internal.marshaller.ClassLoaderUtils;
-import org.apache.ignite.internal.util.CommonUtils;
 import org.apache.ignite.internal.util.typedef.F;
 import org.apache.ignite.lang.IgniteBiTuple;
 import org.jetbrains.annotations.Nullable;
@@ -370,7 +368,7 @@ public static Object doReadOptimized(BinaryInputStream in, BinaryContext ctx, @N
         ByteArrayInputStream input = new ByteArrayInputStream(in.array(), in.position(), len);
 
         try {
-            return ctx.optimizedMarsh().unmarshal(input, CommonUtils.resolveClassLoader(clsLdr, ctx.classLoader()));
+            return ctx.optimizedMarsh().unmarshal(input, ctx.resolveClassLoader(clsLdr));
         }
         catch (IgniteCheckedException e) {
             throw new BinaryObjectException("Failed to unmarshal object with optimized marshaller", e);
@@ -394,8 +392,7 @@ static Class resolveClass(BinaryContext ctx, int typeId, @Nullable String clsNam
                               @Nullable ClassLoader ldr, boolean registerMeta) {
         Class cls;
 
-        if (ldr == null)
-            ldr = ctx.classLoader();
+        ldr = ctx.resolveClassLoader(ldr);
 
         if (typeId != GridBinaryMarshaller.UNREGISTERED_TYPE_ID)
             cls = ctx.descriptorForTypeId(true, typeId, ldr, registerMeta).describedClass();

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/BinaryObjectImpl.java

@@ -701,7 +701,7 @@ else if (fieldOffsetLen == BinaryImplUtils.OFFSET_2)
 
     /** {@inheritDoc} */
     @Nullable @Override public <T> T deserialize(@Nullable ClassLoader ldr) throws BinaryObjectException {
-        if (ldr == null)
+        if (!ctx.isCustomLoader(ldr))
             return deserialize();
 
         Marshallers.USE_CACHE.set(Boolean.FALSE);

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/BinaryObjectOffheapImpl.java

@@ -400,7 +400,7 @@ else if (fieldOffLen == BinaryImplUtils.OFFSET_2)
 
     /** {@inheritDoc} */
     @Nullable @Override public <T> T deserialize(@Nullable ClassLoader ldr) throws BinaryObjectException {
-        if (ldr == null)
+        if (!ctx.isCustomLoader(ldr))
             return deserialize();
 
         Marshallers.USE_CACHE.set(Boolean.FALSE);

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/BinaryReaderExImpl.java

@@ -110,7 +110,10 @@ public final class BinaryReaderExImpl extends BinaryReaderHandlesHolder implemen
     /** Input stream. */
     private final BinaryInputStream in;
 
-    /** Class loader. */
+    /**
+     * Class loader to resolve classes with: custom loader or {@link BinaryContext#classLoader()}, resolved once here.
+     * {@code null} only when {@link #ctx} is {@code null}; such readers can read primitives only.
+     */
     private final ClassLoader ldr;
 
     /** */
@@ -204,14 +207,14 @@ public BinaryReaderExImpl(BinaryContext ctx,
      *
      * @param ctx Context.
      * @param in Input stream.
-     * @param ldr Class loader.
+     * @param ldr Custom class loader or {@code null} to use {@link BinaryContext#classLoader()}.
      * @param hnds Reader handles or {@code null} to start a new handles context.
      * @param skipHdrCheck Whether to skip header check.
      * @param forUnmarshal {@code True} if reader is need to unmarshal object.
      */
     public BinaryReaderExImpl(BinaryContext ctx,
         BinaryInputStream in,
-        ClassLoader ldr,
+        @Nullable ClassLoader ldr,
         @Nullable BinaryReaderHandles hnds,
         boolean skipHdrCheck,
         boolean forUnmarshal) {
@@ -220,7 +223,7 @@ public BinaryReaderExImpl(BinaryContext ctx,
 
         this.ctx = ctx;
         this.in = in;
-        this.ldr = ldr;
+        this.ldr = ctx == null ? ldr : ctx.resolveClassLoader(ldr);
 
         start = in.position();
 
@@ -3278,7 +3281,7 @@ private static Object doReadProxy(BinaryInputStream in, BinaryContext ctx, Class
 
         InvocationHandler ih = (InvocationHandler)doReadObject(in, ctx, ldr, handles);
 
-        return Proxy.newProxyInstance(ldr != null ? ldr : CommonUtils.gridClassLoader(), intfs, ih);
+        return Proxy.newProxyInstance(ldr, intfs, ih);
     }
 
     /**
@@ -3381,9 +3384,9 @@ private static Object[] doReadBinaryEnumArray(BinaryInputStream in, BinaryContex
      * @return Unmarshalled value.
      * @throws BinaryObjectException In case of error.
      */
-    @Nullable static Object unmarshal(BinaryInputStream in, BinaryContext ctx, ClassLoader ldr)
+    @Nullable static Object unmarshal(BinaryInputStream in, BinaryContext ctx, @Nullable ClassLoader ldr)
         throws BinaryObjectException {
-        return unmarshal(in, ctx, ldr, new BinaryReaderHandlesHolder(null));
+        return unmarshal(in, ctx, ctx.resolveClassLoader(ldr), new BinaryReaderHandlesHolder(null), false, false);
     }
 
     /**

modules/binary/impl/src/main/java/org/apache/ignite/internal/binary/builder/BinaryBuilderReader.java

@@ -491,7 +491,7 @@ public Object getValueQuickly(int pos, int len) {
             case GridBinaryMarshaller.OPTM_MARSH: {
                 final BinaryInputStream bin = BinaryStreams.inputStream(arr, pos + 1);
 
-                final Object obj = BinaryImplUtils.doReadOptimized(bin, ctx, ctx.classLoader());
+                final Object obj = BinaryImplUtils.doReadOptimized(bin, ctx, null);
 
                 return obj;
             }
@@ -843,7 +843,7 @@ else if (flag == GridBinaryMarshaller.DECIMAL) {
             case GridBinaryMarshaller.OPTM_MARSH: {
                 final BinaryInputStream bin = BinaryStreams.inputStream(arr, pos);
 
-                final Object obj = BinaryImplUtils.doReadOptimized(bin, ctx, ctx.classLoader());
+                final Object obj = BinaryImplUtils.doReadOptimized(bin, ctx, null);
 
                 pos = bin.position();
 

modules/binary/impl/src/main/java/org/apache/ignite/internal/marshaller/optimized/OptimizedObjectInputStream.java

@@ -43,7 +43,6 @@
 import java.util.concurrent.ConcurrentMap;
 import org.apache.ignite.IgniteCheckedException;
 import org.apache.ignite.internal.marshaller.ClassLoaderUtils;
-import org.apache.ignite.internal.util.CommonUtils;
 import org.apache.ignite.internal.util.GridUnsafe;
 import org.apache.ignite.internal.util.io.GridDataInput;
 import org.apache.ignite.internal.util.typedef.internal.SB;
@@ -330,7 +329,7 @@ private Object readObject0() throws ClassNotFoundException, IOException {
 
                 InvocationHandler ih = (InvocationHandler)readObject();
 
-                return Proxy.newProxyInstance(clsLdr != null ? clsLdr : CommonUtils.gridClassLoader(), intfs, ih);
+                return Proxy.newProxyInstance(clsLdr, intfs, ih);
 
             case ENUM:
             case EXTERNALIZABLE:

modules/binary/impl/src/main/java/org/apache/ignite/marshaller/jdk/JdkMarshallerImpl.java

@@ -116,9 +116,6 @@ else if (!(objFilter instanceof IgniteObjectInputFilter)) {
     @Override protected <T> T unmarshal0(InputStream in, @Nullable ClassLoader clsLdr) throws IgniteCheckedException {
         assert in != null;
 
-        if (clsLdr == null)
-            clsLdr = getClass().getClassLoader();
-
         try (ObjectInputStream objIn = new JdkMarshallerObjectInputStream(new JdkMarshallerInputStreamWrapper(in), clsLdr)) {
             return (T)objIn.readObject();
         }

modules/binary/impl/src/main/java/org/apache/ignite/marshaller/jdk/JdkMarshallerObjectInputStream.java

@@ -22,13 +22,14 @@
 import java.io.ObjectInputStream;
 import java.io.ObjectStreamClass;
 import org.apache.ignite.internal.marshaller.ClassLoaderUtils;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * This class defines custom JDK object input stream.
  */
 class JdkMarshallerObjectInputStream extends ObjectInputStream {
     /** */
-    private final ClassLoader clsLdr;
+    private final @Nullable ClassLoader clsLdr;
 
     /**
      * @param in Parent input stream.
@@ -38,8 +39,6 @@ class JdkMarshallerObjectInputStream extends ObjectInputStream {
     JdkMarshallerObjectInputStream(InputStream in, ClassLoader clsLdr) throws IOException {
         super(in);
 
-        assert clsLdr != null;
-
         this.clsLdr = clsLdr;
 
         enableResolveObject(true);