You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2019/12/11 20:37:48 UTC
[tinkerpop] 01/01: TINKERPOP-2324 Deprecated NioChannelizer
This is an automated email from the ASF dual-hosted git repository.
spmallette pushed a commit to branch TINKERPOP-2324
in repository https://gitbox.apache.org/repos/asf/tinkerpop.git
commit bbaedff7755c90ba15fac31b57841639bfc4fa5b
Author: stephen <sp...@gmail.com>
AuthorDate: Wed Dec 11 15:35:46 2019 -0500
TINKERPOP-2324 Deprecated NioChannelizer
---
CHANGELOG.asciidoc | 1 +
docs/src/reference/gremlin-applications.asciidoc | 2 +-
.../main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java | 4 ++++
.../tinkerpop/gremlin/driver/handler/NioGremlinRequestEncoder.java | 4 +++-
.../tinkerpop/gremlin/driver/handler/NioGremlinResponseDecoder.java | 3 +++
.../java/org/apache/tinkerpop/gremlin/driver/simple/NioClient.java | 2 ++
.../main/java/org/apache/tinkerpop/gremlin/server/Channelizer.java | 2 +-
.../org/apache/tinkerpop/gremlin/server/channel/NioChannelizer.java | 3 +++
.../gremlin/server/handler/NioGremlinBinaryRequestDecoder.java | 4 ++++
.../gremlin/server/handler/NioGremlinResponseFrameEncoder.java | 3 +++
10 files changed, 25 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index f3fe4bd..efb3698 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -26,6 +26,7 @@ image::https://raw.githubusercontent.com/apache/tinkerpop/master/docs/static/ima
* Bump to Tornado 5.x for gremlin-python.
* Deprecated `TraversalStrategies.applyStrategies()`.
* Deprecated Jython support in `gremlin-python`.
+* Deprecated `NioChannelizer` and related classes in `gremlin-driver` and `gremlin-server`.
* Reverted: Modified Java driver to use IP address rather than hostname to create connections.
[[release-3-3-9]]
diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc
index edd2850..fd2eb5e 100644
--- a/docs/src/reference/gremlin-applications.asciidoc
+++ b/docs/src/reference/gremlin-applications.asciidoc
@@ -1210,7 +1210,7 @@ The following table describes the various YAML configuration options that Gremli
|authentication.authenticationHandler | The fully qualified classname of an `AbstractAuthenticationHandler` implementation to use. If this setting is not present, but the `authentication.authenticator` is, it will use that authenticator with the default `AbstractAuthenticationHandler` implementation for the specified `Channelizer` |_none_
|authentication.config |A `Map` of configuration settings to be passes to the `Authenticator` when it is constructed. The settings available are dependent on the implementation. |_none_
|authentication.enableAuditLog |The available authenticators can issue audit logging messages, binding the authenticated user to his remote socket address and binding requests with a gremlin query to the remote socket address. For privacy reasons, the default value of this setting is false. The audit logging messages are logged at the INFO level via the `audit.org.apache.tinkerpop.gremlin.server` logger, which can be configured using the log4j.properties file. |false
-|channelizer |The fully qualified classname of the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. WebSocket, Java NIO, etc.). |`WebSocketChannelizer`
+|channelizer |The fully qualified classname of the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. WebSocket). |`WebSocketChannelizer`
|graphManager |The fully qualified classname of the `GraphManager` implementation to use. A `GraphManager` is a class that adheres to the TinkerPop `GraphManager` interface, allowing custom implementations for storing and managing graph references, as well as defining custom methods to open and close graphs instantiations. It is important to note that the TinkerPop HTTP and WebSocketChannelizers auto-commit and auto-rollback based on the graphs stored in the graphManager upon script exe [...]
|graphs |A `Map` of `Graph` configuration files where the key of the `Map` becomes the name to which the `Graph` will be bound and the value is the file name of a `Graph` configuration file. |_none_
|gremlinPool |The number of "Gremlin" threads available to execute actual scripts in a `ScriptEngine`. This pool represents the workers available to handle blocking operations in Gremlin Server. When set to `0`, Gremlin Server will use the value provided by `Runtime.availableProcessors()`. |0
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
index c5d1cc5..213d5f1 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
@@ -37,6 +37,7 @@ import io.netty.handler.codec.http.HttpObjectAggregator;
import io.netty.handler.codec.http.websocketx.WebSocketClientHandshakerFactory;
import io.netty.handler.codec.http.websocketx.WebSocketVersion;
import io.netty.handler.ssl.SslContext;
+import org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient;
import java.util.Optional;
import java.util.UUID;
@@ -225,7 +226,10 @@ public interface Channelizer extends ChannelHandler {
/**
* NIO {@link Channelizer} implementation.
+ *
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+ @Deprecated
public final class NioChannelizer extends AbstractChannelizer {
@Override
public void init(final Connection connection) {
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinRequestEncoder.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinRequestEncoder.java
index 35c310c..1330a7e 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinRequestEncoder.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinRequestEncoder.java
@@ -28,14 +28,16 @@ import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;
import io.netty.util.CharsetUtil;
+import org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Stephen Mallette (http://stephen.genoprime.com)
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+@Deprecated
public final class NioGremlinRequestEncoder extends MessageToByteEncoder<Object> {
- private static final Logger logger = LoggerFactory.getLogger(WebSocketGremlinRequestEncoder.class);
private boolean binaryEncoding = false;
private final MessageSerializer serializer;
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinResponseDecoder.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinResponseDecoder.java
index d61b809..25e3a1c 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinResponseDecoder.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/handler/NioGremlinResponseDecoder.java
@@ -22,12 +22,15 @@ import io.netty.handler.codec.ReplayingDecoder;
import org.apache.tinkerpop.gremlin.driver.MessageSerializer;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
+import org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient;
import java.util.List;
/**
* @author Stephen Mallette (http://stephen.genoprime.com)
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+@Deprecated
public final class NioGremlinResponseDecoder extends ReplayingDecoder<NioGremlinResponseDecoder.DecoderState> {
private final MessageSerializer serializer;
private int messageLength;
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/simple/NioClient.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/simple/NioClient.java
index cda5043..3904b20 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/simple/NioClient.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/simple/NioClient.java
@@ -39,7 +39,9 @@ import java.net.URI;
* A simple, non-thread safe Gremlin Server client using NIO. Typical use is for testing and demonstration.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+@Deprecated
public class NioClient extends AbstractClient {
private final Channel channel;
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Channelizer.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Channelizer.java
index 01987fc..0f3c358 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Channelizer.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/Channelizer.java
@@ -27,7 +27,7 @@ import org.apache.tinkerpop.gremlin.server.util.ServerGremlinExecutor;
* configured in Gremlin Server with the {@code channelizer} setting in the configuration file.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
- * @see org.apache.tinkerpop.gremlin.server.AbstractChannelizer
+ * @see AbstractChannelizer
*/
public interface Channelizer extends ChannelHandler {
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/channel/NioChannelizer.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/channel/NioChannelizer.java
index 5fca351..8043580 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/channel/NioChannelizer.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/channel/NioChannelizer.java
@@ -18,6 +18,7 @@
*/
package org.apache.tinkerpop.gremlin.server.channel;
+import org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient;
import org.apache.tinkerpop.gremlin.server.AbstractChannelizer;
import org.apache.tinkerpop.gremlin.server.Channelizer;
import org.apache.tinkerpop.gremlin.server.auth.AllowAllAuthenticator;
@@ -36,7 +37,9 @@ import org.slf4j.LoggerFactory;
* A {@link Channelizer} that exposes an NIO-based Gremlin endpoint with a custom protocol.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+@Deprecated
public class NioChannelizer extends AbstractChannelizer {
private static final Logger logger = LoggerFactory.getLogger(NioChannelizer.class);
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinBinaryRequestDecoder.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinBinaryRequestDecoder.java
index f1a34d0..5709143 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinBinaryRequestDecoder.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinBinaryRequestDecoder.java
@@ -25,6 +25,7 @@ import org.apache.tinkerpop.gremlin.driver.message.RequestMessage;
import org.apache.tinkerpop.gremlin.driver.ser.SerializationException;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
+import org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -33,7 +34,10 @@ import java.util.Map;
/**
* @author Stephen Mallette (http://stephen.genoprime.com)
+ *
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+@Deprecated
public class NioGremlinBinaryRequestDecoder extends ReplayingDecoder<NioGremlinBinaryRequestDecoder.DecoderState> {
private static final Logger logger = LoggerFactory.getLogger(NioGremlinBinaryRequestDecoder.class);
private final Map<String, MessageSerializer> serializers;
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinResponseFrameEncoder.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinResponseFrameEncoder.java
index 119b3ef..7bfc98e 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinResponseFrameEncoder.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/handler/NioGremlinResponseFrameEncoder.java
@@ -23,12 +23,15 @@ import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;
import io.netty.util.CharsetUtil;
+import org.apache.tinkerpop.gremlin.driver.simple.WebSocketClient;
/**
* Encodes {@code ByteBuf} and {@code String} values to bytes to be written over NIO.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
+ * @deprecated As of release 3.3.10, not replaced, use {@link WebSocketClient}.
*/
+@Deprecated
@ChannelHandler.Sharable
public class NioGremlinResponseFrameEncoder extends MessageToByteEncoder<Frame> {
@Override