visibility cleanup, move AbstractExternal-s

Author: yaauie

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/StableBridgeAPI.java

@@ -50,6 +50,11 @@ static <T, B extends StableBridgeAPI<T>> B fromInternal(final T delegate, final
      * An {@code ProxyInternal<INTERNAL>} is an implementation of {@code StableBridgeAPI<INTERNAL>} that
      * proxies calls to a delegate that is an actual {@code INTERNAL}.
      *
+     * <p>
+     *     implementations are intended to be <em>opaque</em> to consumers of this library,
+     *     and should <em>NOT</em> have public constructors.
+     * </p>
+     *
      * @param <INTERNAL>
      */
     abstract class ProxyInternal<INTERNAL> implements StableBridgeAPI<INTERNAL> {

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/common/ProjectIdBridge.java

@@ -12,6 +12,9 @@
 import org.elasticsearch.cluster.metadata.ProjectId;
 import org.elasticsearch.logstashbridge.StableBridgeAPI;
 
+/**
+ * A {@link StableBridgeAPI} for {@link ProjectId}
+ */
 public interface ProjectIdBridge extends StableBridgeAPI<ProjectId> {
     String id();
 
@@ -28,18 +31,22 @@ static ProjectIdBridge getDefault() {
         return ProxyInternal.DEFAULT;
     }
 
-    class ProxyInternal implements ProjectIdBridge {
-        private final ProjectId internalDelegate;
-
-        static final ProjectIdBridge.ProxyInternal DEFAULT = new ProjectIdBridge.ProxyInternal(ProjectId.DEFAULT);
-
-        public ProxyInternal(ProjectId internalDelegate) {
-            this.internalDelegate = internalDelegate;
+    /**
+     * An implementation of {@link ProjectIdBridge} that proxies calls to
+     * an internal {@link ProjectId} instance.
+     *
+     * @see StableBridgeAPI.ProxyInternal
+     */
+    final class ProxyInternal extends StableBridgeAPI.ProxyInternal<ProjectId> implements ProjectIdBridge {
+        private static final ProjectIdBridge.ProxyInternal DEFAULT = new ProjectIdBridge.ProxyInternal(ProjectId.DEFAULT);
+
+        ProxyInternal(ProjectId internalDelegate) {
+            super(internalDelegate);
         }
 
         @Override
         public String id() {
-            return toInternal().id();
+            return this.internalDelegate.id();
         }
 
         @Override

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/common/SettingsBridge.java

@@ -12,53 +12,27 @@
 import org.elasticsearch.logstashbridge.StableBridgeAPI;
 
 /**
- * An external bridge for {@link Settings}
+ * A {@link StableBridgeAPI} for {@link Settings}
  */
 public interface SettingsBridge extends StableBridgeAPI<Settings> {
 
     static SettingsBridge fromInternal(final Settings delegate) {
-        return new SettingsBridge.ProxyInternal(delegate);
+        return new ProxyInternal(delegate);
     }
 
-    static Builder builder() {
-        return Builder.fromInternal(Settings.builder());
-    }
-
-    class ProxyInternal extends StableBridgeAPI.ProxyInternal<Settings> implements SettingsBridge {
-        public ProxyInternal(Settings internalDelegate) {
-            super(internalDelegate);
-        }
+    static SettingsBuilderBridge builder() {
+        return SettingsBuilderBridge.fromInternal(Settings.builder());
     }
 
     /**
-     * An external bridge for {@link Settings.Builder} that proxies calls to a real {@link Settings.Builder}
+     * An implementation of {@link SettingsBridge} that proxies calls to
+     * an internal {@link Settings} instance.
+     *
+     * @see StableBridgeAPI.ProxyInternal
      */
-    interface Builder extends StableBridgeAPI<Settings.Builder> {
-
-        Builder put(String key, String value);
-
-        SettingsBridge build();
-
-        static Builder fromInternal(final Settings.Builder builder) {
-            return new ProxyInternal(builder);
-        }
-
-        class ProxyInternal extends StableBridgeAPI.ProxyInternal<Settings.Builder> implements Builder {
-            public ProxyInternal(Settings.Builder internalDelegate) {
-                super(internalDelegate);
-            }
-
-            @Override
-            public Builder put(String key, String value) {
-                internalDelegate.put(key, value);
-                return this;
-            }
-
-            @Override
-            public SettingsBridge build() {
-                final Settings delegate = internalDelegate.build();
-                return SettingsBridge.fromInternal(delegate);
-            }
+    final class ProxyInternal extends StableBridgeAPI.ProxyInternal<Settings> implements SettingsBridge {
+        ProxyInternal(Settings internalDelegate) {
+            super(internalDelegate);
         }
     }
 }

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/common/SettingsBuilderBridge.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.logstashbridge.common;
+
+import org.elasticsearch.common.settings.Settings;
+import org.elasticsearch.logstashbridge.StableBridgeAPI;
+
+/**
+ * A {@link StableBridgeAPI} for {@link Settings.Builder}.
+ */
+public interface SettingsBuilderBridge extends StableBridgeAPI<Settings.Builder> {
+
+    SettingsBuilderBridge put(String key, String value);
+
+    SettingsBridge build();
+
+    static SettingsBuilderBridge fromInternal(final Settings.Builder builder) {
+        return new ProxyInternal(builder);
+    }
+
+    /**
+     * An implementation of {@link SettingsBuilderBridge} that proxies calls to
+     * an internal {@link Settings.Builder} instance.
+     *
+     * @see StableBridgeAPI.ProxyInternal
+     */
+    final class ProxyInternal extends StableBridgeAPI.ProxyInternal<Settings.Builder> implements SettingsBuilderBridge {
+        ProxyInternal(Settings.Builder internalDelegate) {
+            super(internalDelegate);
+        }
+
+        @Override
+        public SettingsBuilderBridge put(String key, String value) {
+            internalDelegate.put(key, value);
+            return this;
+        }
+
+        @Override
+        public SettingsBridge build() {
+            final Settings delegate = internalDelegate.build();
+            return SettingsBridge.fromInternal(delegate);
+        }
+    }
+}

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/core/CheckedBiFunctionBridge.java

@@ -12,6 +12,14 @@
 import org.elasticsearch.common.CheckedBiFunction;
 import org.elasticsearch.logstashbridge.StableBridgeAPI;
 
+/**
+ * A stable interface on top of {@link CheckedBiFunction}.
+ * @param <T> type of lhs parameter
+ * @param <U> type of rhs parameter
+ * @param <R> type of return value
+ * @param <E> type of anticipated exception
+ */
+@FunctionalInterface
 public interface CheckedBiFunctionBridge<T, U, R, E extends Exception> extends StableBridgeAPI<CheckedBiFunction<T, U, R, E>> {
     R apply(T t, U u) throws E;
 

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/core/IOUtilsBridge.java

@@ -16,6 +16,8 @@
  * An external bridge for {@link IOUtils}
  */
 public class IOUtilsBridge {
+    private IOUtilsBridge() {}
+
     public static void closeWhileHandlingException(final Iterable<? extends Closeable> objects) {
         IOUtils.closeWhileHandlingException(objects);
     }

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/core/RefCountingRunnableBridge.java

@@ -16,7 +16,7 @@
 import java.io.Closeable;
 
 /**
- * An external bridge for {@link RefCountingRunnable} that proxies calls through a real {@link RefCountingRunnable}
+ * A {@link StableBridgeAPI} for {@link RefCountingRunnable}
  */
 public interface RefCountingRunnableBridge extends StableBridgeAPI<RefCountingRunnable>, Closeable {
 
@@ -38,9 +38,10 @@ static RefCountingRunnableBridge create(final Runnable delegate) {
 
     /**
      * An implementation of {@link RefCountingRunnableBridge} that proxies calls through
-     * to an internal {@link RefCountingRunnable}
+     * to an internal {@link RefCountingRunnable}.
+     * @see StableBridgeAPI.ProxyInternal
      */
-    class ProxyInternal extends StableBridgeAPI.ProxyInternal<RefCountingRunnable> implements RefCountingRunnableBridge {
+    final class ProxyInternal extends StableBridgeAPI.ProxyInternal<RefCountingRunnable> implements RefCountingRunnableBridge {
         private ProxyInternal(final RefCountingRunnable delegate) {
             super(delegate);
         }

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/core/ReleasableBridge.java

@@ -14,6 +14,9 @@
 
 import java.io.Closeable;
 
+/**
+ * A {@link StableBridgeAPI} for {@link Releasable} for use with {@link RefCountingRunnableBridge}
+ */
 public interface ReleasableBridge extends StableBridgeAPI<Releasable>, Closeable {
 
     @Override // only RuntimeException
@@ -23,9 +26,14 @@ static ReleasableBridge fromInternal(Releasable releasable) {
         return new ProxyInternal(releasable);
     }
 
-    class ProxyInternal extends StableBridgeAPI.ProxyInternal<Releasable> implements ReleasableBridge {
+    /**
+     * An implementation of {@link ReleasableBridge} that proxies calls through
+     * to an internal {@link Releasable}.
+     * @see StableBridgeAPI.ProxyInternal
+     */
+    final class ProxyInternal extends StableBridgeAPI.ProxyInternal<Releasable> implements ReleasableBridge {
 
-        public ProxyInternal(final Releasable delegate) {
+        private ProxyInternal(final Releasable delegate) {
             super(delegate);
         }
 

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/env/EnvironmentBridge.java

@@ -15,7 +15,7 @@
 import java.nio.file.Path;
 
 /**
- * An external bridge for {@link Environment}
+ * A {@link StableBridgeAPI} for {@link Environment}
  */
 public interface EnvironmentBridge extends StableBridgeAPI<Environment> {
     static EnvironmentBridge fromInternal(final Environment delegate) {
@@ -26,7 +26,12 @@ static EnvironmentBridge create(final SettingsBridge bridgedSettings, final Path
         return fromInternal(new Environment(bridgedSettings.toInternal(), configPath));
     }
 
-    class ProxyInternal extends StableBridgeAPI.ProxyInternal<Environment> implements EnvironmentBridge {
+    /**
+     * An implementation of {@link EnvironmentBridge} that proxies calls through
+     * to an internal {@link Environment}.
+     * @see StableBridgeAPI.ProxyInternal
+     */
+    final class ProxyInternal extends StableBridgeAPI.ProxyInternal<Environment> implements EnvironmentBridge {
         private ProxyInternal(final Environment delegate) {
             super(delegate);
         }

libs/logstash-bridge/src/main/java/org/elasticsearch/logstashbridge/geoip/AbstractExternalIpDatabaseBridge.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.logstashbridge.geoip;
+
+import com.maxmind.db.Reader;
+
+import org.elasticsearch.common.CheckedBiFunction;
+import org.elasticsearch.ingest.geoip.IpDatabase;
+
+import java.io.IOException;
+
+/**
+ * The {@code IpDatabaseBridge.AbstractExternal} is an abstract base class for implementing
+ * the {@link IpDatabaseBridge} externally to the Elasticsearch code-base. It takes care of
+ * the details of maintaining a singular internal-form implementation of {@link IpDatabase}
+ * that proxies calls to the external implementation.
+ */
+public abstract class AbstractExternalIpDatabaseBridge implements IpDatabaseBridge {
+    private ProxyExternal internalDatabase;
+
+    @Override
+    public IpDatabase toInternal() {
+        if (internalDatabase == null) {
+            internalDatabase = new ProxyExternal();
+        }
+        return internalDatabase;
+    }
+
+    /**
+     * An implementation of {@link IpDatabase} that proxies calls to
+     * a bridged {@link AbstractExternalIpDatabaseBridge} instance.
+     */
+    private final class ProxyExternal implements IpDatabase {
+
+        @Override
+        public String getDatabaseType() throws IOException {
+            return AbstractExternalIpDatabaseBridge.this.getDatabaseType();
+        }
+
+        @Override
+        public <RESPONSE> RESPONSE getResponse(String ipAddress, CheckedBiFunction<Reader, String, RESPONSE, Exception> responseProvider) {
+            return AbstractExternalIpDatabaseBridge.this.getResponse(ipAddress, responseProvider::apply);
+        }
+
+        @Override
+        public void close() throws IOException {
+            AbstractExternalIpDatabaseBridge.this.close();
+        }
+    }
+}