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 2016/03/07 17:42:11 UTC
[1/4] incubator-tinkerpop git commit: Added transaction management to
the TraversalOpProcessor.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/TINKERPOP-575 f1eafe57f -> 1de0e1143
Added transaction management to the TraversalOpProcessor.
Open and close transactions on each request and do error handling as needed.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/e88e9e5a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/e88e9e5a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/e88e9e5a
Branch: refs/heads/TINKERPOP-575
Commit: e88e9e5a77b39914fd0423cec55ce9057b1d1b88
Parents: f1eafe5
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Mar 4 15:15:10 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Mar 4 15:15:10 2016 -0500
----------------------------------------------------------------------
.../op/traversal/TraversalOpProcessor.java | 40 +++++++++++++++++++-
1 file changed, 38 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/e88e9e5a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
index 03844db..3d50b26 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
@@ -18,6 +18,7 @@
*/
package org.apache.tinkerpop.gremlin.server.op.traversal;
+import io.netty.channel.ChannelHandlerContext;
import org.apache.tinkerpop.gremlin.driver.Tokens;
import org.apache.tinkerpop.gremlin.driver.message.RequestMessage;
import org.apache.tinkerpop.gremlin.driver.message.ResponseMessage;
@@ -25,10 +26,12 @@ import org.apache.tinkerpop.gremlin.driver.message.ResponseStatusCode;
import org.apache.tinkerpop.gremlin.process.computer.util.VertexProgramHelper;
import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
import org.apache.tinkerpop.gremlin.server.Context;
+import org.apache.tinkerpop.gremlin.server.GraphManager;
import org.apache.tinkerpop.gremlin.server.OpProcessor;
import org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor;
import org.apache.tinkerpop.gremlin.server.op.AbstractOpProcessor;
import org.apache.tinkerpop.gremlin.server.op.OpProcessorException;
+import org.apache.tinkerpop.gremlin.structure.Graph;
import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerFactory;
import org.apache.tinkerpop.gremlin.util.Serializer;
import org.apache.tinkerpop.gremlin.util.function.ThrowingConsumer;
@@ -37,6 +40,7 @@ import org.slf4j.LoggerFactory;
import java.util.Map;
import java.util.Optional;
+import java.util.concurrent.TimeoutException;
import java.util.function.Function;
/**
@@ -125,9 +129,41 @@ public class TraversalOpProcessor extends AbstractOpProcessor {
}
try {
+ final ChannelHandlerContext ctx = context.getChannelHandlerContext();
+ final GraphManager graphManager = context.getGraphManager();
final String graphName = aliases.entrySet().iterator().next().getValue();
- traversal.asAdmin().setGraph(context.getGraphManager().getGraphs().get(graphName));
- handleIterator(context, traversal);
+ final Graph graph = graphManager.getGraphs().get(graphName);
+ final boolean supportsTransactions = graph.features().graph().supportsTransactions();
+
+ traversal.asAdmin().setGraph(graph);
+
+ context.getGremlinExecutor().getExecutorService().submit(() -> {
+ try {
+ if (supportsTransactions && graph.tx().isOpen()) graph.tx().rollback();
+
+ try {
+ handleIterator(context, traversal);
+ } catch (TimeoutException ex) {
+ final String errorMessage = String.format("Response iteration exceeded the configured threshold for request [%s] - %s", msg.getRequestId(), ex.getMessage());
+ logger.warn(errorMessage);
+ ctx.writeAndFlush(ResponseMessage.build(msg).code(ResponseStatusCode.SERVER_ERROR_TIMEOUT).statusMessage(errorMessage).create());
+ if (supportsTransactions && graph.tx().isOpen()) graph.tx().rollback();
+ return;
+ } catch (Exception ex) {
+ logger.warn(String.format("Exception processing a Traversal on iteration for request [%s].", msg.getRequestId()), ex);
+ ctx.writeAndFlush(ResponseMessage.build(msg).code(ResponseStatusCode.SERVER_ERROR).statusMessage(ex.getMessage()).create());
+ if (supportsTransactions && graph.tx().isOpen()) graph.tx().rollback();
+ return;
+ }
+
+ if (graph.features().graph().supportsTransactions()) graph.tx().commit();
+ } catch (Exception ex) {
+ logger.warn(String.format("Exception processing a Traversal on request [%s].", msg.getRequestId()), ex);
+ ctx.writeAndFlush(ResponseMessage.build(msg).code(ResponseStatusCode.SERVER_ERROR).statusMessage(ex.getMessage()).create());
+ if (graph.features().graph().supportsTransactions() && graph.tx().isOpen()) graph.tx().rollback();
+ }
+ });
+
} catch (Exception ex) {
throw new OpProcessorException("Could not iterate the Traversal instance",
ResponseMessage.build(msg).code(ResponseStatusCode.SERVER_ERROR).statusMessage(ex.getMessage()).create());
[2/4] incubator-tinkerpop git commit: Compile the traversal on the
server first before trying to get Traversers.
Posted by sp...@apache.org.
Compile the traversal on the server first before trying to get Traversers.
Without compiling, the Traversal returns no Traversers.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/9131c4d2
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/9131c4d2
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/9131c4d2
Branch: refs/heads/TINKERPOP-575
Commit: 9131c4d212da1000e50cd878c5d9899f16b0ea1a
Parents: e88e9e5
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Mar 7 09:32:28 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Mar 7 09:32:28 2016 -0500
----------------------------------------------------------------------
.../op/traversal/TraversalOpProcessor.java | 27 +++++++++++++++++++-
1 file changed, 26 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/9131c4d2/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
index 3d50b26..4036d55 100644
--- a/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
+++ b/gremlin-server/src/main/java/org/apache/tinkerpop/gremlin/server/op/traversal/TraversalOpProcessor.java
@@ -25,6 +25,7 @@ import org.apache.tinkerpop.gremlin.driver.message.ResponseMessage;
import org.apache.tinkerpop.gremlin.driver.message.ResponseStatusCode;
import org.apache.tinkerpop.gremlin.process.computer.util.VertexProgramHelper;
import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
+import org.apache.tinkerpop.gremlin.process.traversal.Traverser;
import org.apache.tinkerpop.gremlin.server.Context;
import org.apache.tinkerpop.gremlin.server.GraphManager;
import org.apache.tinkerpop.gremlin.server.OpProcessor;
@@ -38,6 +39,7 @@ import org.apache.tinkerpop.gremlin.util.function.ThrowingConsumer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import java.util.Iterator;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeoutException;
@@ -142,7 +144,11 @@ public class TraversalOpProcessor extends AbstractOpProcessor {
if (supportsTransactions && graph.tx().isOpen()) graph.tx().rollback();
try {
- handleIterator(context, traversal);
+ // compile the traversal - without it getEndStep() has nothing in it
+ traversal.hasNext();
+
+ final Iterator<Traverser> itty = new DetachingIterator(traversal.asAdmin().getEndStep());
+ handleIterator(context, itty);
} catch (TimeoutException ex) {
final String errorMessage = String.format("Response iteration exceeded the configured threshold for request [%s] - %s", msg.getRequestId(), ex.getMessage());
logger.warn(errorMessage);
@@ -169,4 +175,23 @@ public class TraversalOpProcessor extends AbstractOpProcessor {
ResponseMessage.build(msg).code(ResponseStatusCode.SERVER_ERROR).statusMessage(ex.getMessage()).create());
}
}
+
+ static class DetachingIterator implements Iterator<Traverser> {
+
+ private Iterator<Traverser> inner;
+
+ public DetachingIterator(final Iterator<Traverser> toDetach) {
+ inner = toDetach;
+ }
+
+ @Override
+ public boolean hasNext() {
+ return inner.hasNext();
+ }
+
+ @Override
+ public Traverser next() {
+ return inner.next().asAdmin().detach();
+ }
+ }
}
[4/4] incubator-tinkerpop git commit: Added configuration to unroll
traversers on the client-side.
Posted by sp...@apache.org.
Added configuration to unroll traversers on the client-side.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/1de0e114
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/1de0e114
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/1de0e114
Branch: refs/heads/TINKERPOP-575
Commit: 1de0e1143db1ca90d4599ab66e7fc4051895148b
Parents: 8bcd524
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Mar 7 11:41:20 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Mar 7 11:41:20 2016 -0500
----------------------------------------------------------------------
.../tinkerpop/gremlin/driver/Channelizer.java | 2 +-
.../apache/tinkerpop/gremlin/driver/Client.java | 2 +-
.../tinkerpop/gremlin/driver/Handler.java | 22 ++++++++--
.../server/GremlinResultSetIntegrateTest.java | 45 ++++++++++++++------
4 files changed, 54 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/1de0e114/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Channelizer.java
----------------------------------------------------------------------
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 b059c3f..153e02b 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
@@ -138,7 +138,7 @@ public interface Channelizer extends ChannelHandler {
configure(pipeline);
pipeline.addLast(PIPELINE_GREMLIN_SASL_HANDLER, new Handler.GremlinSaslAuthenticationHandler(cluster.authProperties()));
- pipeline.addLast(PIPELINE_GREMLIN_HANDLER, new Handler.GremlinResponseHandler(pending));
+ pipeline.addLast(PIPELINE_GREMLIN_HANDLER, new Handler.GremlinResponseHandler(pending, connection.getClient().getSettings()));
}
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/1de0e114/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
index ec315c8..8bba22d 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
@@ -644,7 +644,7 @@ public abstract class Client {
* values is instead set to {@code false} then the {@link ResultSet} will simply contain a {@link Traverser}
* and it will be up to the user to work with that component directly.
*/
- public boolean isUnrollTraversers() {
+ public boolean unrollTraversers() {
return unrollTraversers;
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/1de0e114/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Handler.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Handler.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Handler.java
index fce658f..ec91954 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Handler.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Handler.java
@@ -29,6 +29,7 @@ import io.netty.util.Attribute;
import io.netty.util.AttributeKey;
import io.netty.util.ReferenceCountUtil;
import org.apache.tinkerpop.gremlin.driver.ser.SerializationException;
+import org.apache.tinkerpop.gremlin.process.traversal.Traverser;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -168,9 +169,11 @@ final class Handler {
static class GremlinResponseHandler extends SimpleChannelInboundHandler<ResponseMessage> {
private static final Logger logger = LoggerFactory.getLogger(GremlinResponseHandler.class);
private final ConcurrentMap<UUID, ResultQueue> pending;
+ private final boolean unrollTraversers;
- public GremlinResponseHandler(final ConcurrentMap<UUID, ResultQueue> pending) {
+ public GremlinResponseHandler(final ConcurrentMap<UUID, ResultQueue> pending, final Client.Settings settings) {
this.pending = pending;
+ unrollTraversers = settings.unrollTraversers();
}
@Override
@@ -183,10 +186,11 @@ final class Handler {
// unrolls the collection into individual results to be handled by the queue.
final List<Object> listToUnroll = (List<Object>) data;
final ResultQueue queue = pending.get(response.getRequestId());
- listToUnroll.forEach(item -> queue.add(new Result(item)));
+ listToUnroll.forEach(item -> tryUnrollTraverser(queue, item));
} else {
// since this is not a list it can just be added to the queue
- pending.get(response.getRequestId()).add(new Result(response.getResult().getData()));
+ final ResultQueue queue = pending.get(response.getRequestId());
+ tryUnrollTraverser(queue, response.getResult().getData());
}
} else {
// this is a "success" but represents no results otherwise it is an error
@@ -204,6 +208,18 @@ final class Handler {
}
}
+ private void tryUnrollTraverser(final ResultQueue queue, final Object item) {
+ if (unrollTraversers && item instanceof Traverser) {
+ final Traverser t = (Traverser) item;
+ final Object traverserObject = t.get();
+ for (long ix = 0; ix < t.bulk(); ix++) {
+ queue.add(new Result(traverserObject));
+ }
+ } else {
+ queue.add(new Result(item));
+ }
+ }
+
@Override
public void exceptionCaught(final ChannelHandlerContext ctx, final Throwable cause) throws Exception {
// if this happens enough times (like the client is unable to deserialize a response) the pending
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/1de0e114/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinResultSetIntegrateTest.java
----------------------------------------------------------------------
diff --git a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinResultSetIntegrateTest.java b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinResultSetIntegrateTest.java
index 55ee3b1..129f1a0 100644
--- a/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinResultSetIntegrateTest.java
+++ b/gremlin-server/src/test/java/org/apache/tinkerpop/gremlin/server/GremlinResultSetIntegrateTest.java
@@ -25,6 +25,7 @@ import org.apache.tinkerpop.gremlin.driver.Result;
import org.apache.tinkerpop.gremlin.driver.ResultSet;
import org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV1d0;
import org.apache.tinkerpop.gremlin.process.traversal.Path;
+import org.apache.tinkerpop.gremlin.process.traversal.Traverser;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.structure.Edge;
import org.apache.tinkerpop.gremlin.structure.Graph;
@@ -39,6 +40,7 @@ import org.apache.tinkerpop.gremlin.structure.util.detached.DetachedVertex;
import org.apache.tinkerpop.gremlin.structure.util.detached.DetachedVertexProperty;
import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerGraph;
import org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerIoRegistry;
+import org.hamcrest.CoreMatchers;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
@@ -92,19 +94,38 @@ public class GremlinResultSetIntegrateTest extends AbstractGremlinServerIntegrat
final Graph graph = TinkerGraph.open();
final GraphTraversalSource g = graph.traversal();
final Client aliased = client.alias("graph");
- final ResultSet results = aliased.submit(g.V(1));
- final Vertex v = results.all().get().get(0).getVertex();
- assertThat(v, instanceOf(DetachedVertex.class));
+ final ResultSet resultSet = aliased.submit(g.V().both().both());
+ final List<Result> results = resultSet.all().get();
- assertEquals("marko", v.properties("name").next().value());
- v.properties().forEachRemaining(p -> {
- if (p.key().equals("name"))
- assertEquals("marko", p.value());
- else if (p.key().equals("age"))
- assertEquals(29, p.value());
- else
- fail("Should not have any other keys besides 'name' and 'age'");
- });
+ assertThat(results.get(0).getObject(), CoreMatchers.instanceOf(Vertex.class));
+ assertEquals(30, results.size());
+ }
+
+ @Test
+ public void shouldHandleVertexResultFromTraversalAsTraversersUnrolled() throws Exception {
+ final Graph graph = TinkerGraph.open();
+ final GraphTraversalSource g = graph.traversal();
+ final Client aliased = client.alias("graph");
+ final ResultSet resultSetUnrolled = aliased.submit(g.V().both().barrier().both().barrier());
+ final List<Result> results = resultSetUnrolled.all().get();
+
+ assertThat(results.get(0).getObject(), CoreMatchers.instanceOf(Vertex.class));
+ assertEquals(30, results.size());
+ }
+
+ @Test
+ public void shouldHandleVertexResultFromTraversalAsTraversers() throws Exception {
+ final Graph graph = TinkerGraph.open();
+ final GraphTraversalSource g = graph.traversal();
+ final Client clientWithUnrolling = cluster.connect(Client.Settings.build().unrollTraversers(false).create());
+ final Client aliased = clientWithUnrolling.alias("graph");
+ final ResultSet resultSet = aliased.submit(g.V().both().barrier().both().barrier());
+ final List<Result> results = resultSet.all().get();
+
+ assertThat(results.get(0).getObject(), CoreMatchers.instanceOf(Traverser.class));
+ assertEquals(6, results.size());
+
+ aliased.close();
}
@Test
[3/4] incubator-tinkerpop git commit: Refactored Client/Cluster to
take Client.Settings
Posted by sp...@apache.org.
Refactored Client/Cluster to take Client.Settings
Client.Settings provides a more extensible manner in which to pass the growing number of configurations to the Client instances.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/8bcd524a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/8bcd524a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/8bcd524a
Branch: refs/heads/TINKERPOP-575
Commit: 8bcd524ab00b640f05163ab75e87d76e9ac493fe
Parents: 9131c4d
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Mar 7 09:33:41 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Mar 7 09:33:41 2016 -0500
----------------------------------------------------------------------
.../apache/tinkerpop/gremlin/driver/Client.java | 245 ++++++++++++++++---
.../tinkerpop/gremlin/driver/Cluster.java | 18 +-
2 files changed, 220 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/8bcd524a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
index 0e64842..ec315c8 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
@@ -22,7 +22,9 @@ import org.apache.tinkerpop.gremlin.driver.exception.ConnectionException;
import org.apache.tinkerpop.gremlin.driver.message.RequestMessage;
import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
import org.apache.tinkerpop.gremlin.process.traversal.TraversalSource;
+import org.apache.tinkerpop.gremlin.process.traversal.Traverser;
import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.apache.tinkerpop.gremlin.util.Serializer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -33,6 +35,7 @@ import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Optional;
+import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
@@ -55,9 +58,11 @@ public abstract class Client {
protected final Cluster cluster;
protected volatile boolean initialized;
+ protected final Client.Settings settings;
- Client(final Cluster cluster) {
+ Client(final Cluster cluster, final Client.Settings settings) {
this.cluster = cluster;
+ this.settings = settings;
}
/**
@@ -95,14 +100,24 @@ public abstract class Client {
@Deprecated
public abstract Client rebind(final String graphOrTraversalSource);
-
/**
* Create a new {@code Client} that aliases the specified {@link Graph} or {@link TraversalSource} name on the
* server to a variable called "g" for the context of the requests made through that {@code Client}.
*
* @param graphOrTraversalSource rebinds the specified global Gremlin Server variable to "g"
*/
- public abstract Client alias(final String graphOrTraversalSource);
+ public Client alias(final String graphOrTraversalSource) {
+ return alias(makeDefaultAliasMap(graphOrTraversalSource));
+ }
+
+ /**
+ * Create a a new {@code Client} that aliases against multiple {@link Graph} or {@link TraversalSource} instances,
+ * where the key to the supplied {@link Map} is the "alias" and the value is the name of the {@link Graph} or
+ * {@link TraversalSource} on the server.
+ *
+ * @param aliases one or more aliases
+ */
+ public abstract Client alias(final Map<String,String> aliases);
/**
* Submit a {@link Traversal} to the server for remote execution.
@@ -232,6 +247,19 @@ public abstract class Client {
}
/**
+ * Gets the {@link Client.Settings}.
+ */
+ public Settings getSettings() {
+ return settings;
+ }
+
+ protected Map<String,String> makeDefaultAliasMap(final String graphOrTraversalSource) {
+ final Map<String,String> aliases = new HashMap<>();
+ aliases.put("g", graphOrTraversalSource);
+ return aliases;
+ }
+
+ /**
* A {@code Client} implementation that does not operate in a session. Requests are sent to multiple servers
* given a {@link LoadBalancingStrategy}. Transactions are automatically committed
* (or rolled-back on error) after each request.
@@ -240,8 +268,8 @@ public abstract class Client {
private ConcurrentMap<Host, ConnectionPool> hostConnectionPools = new ConcurrentHashMap<>();
- ClusteredClient(final Cluster cluster) {
- super(cluster);
+ ClusteredClient(final Cluster cluster, final Client.Settings settings) {
+ super(cluster, settings);
}
/**
@@ -289,7 +317,7 @@ public abstract class Client {
Optional.ofNullable(parameters).ifPresent(params -> request.addArg(Tokens.ARGS_BINDINGS, parameters));
if (graphOrTraversalSource != null && !graphOrTraversalSource.isEmpty())
- request.addArg(Tokens.ARGS_ALIASES, makeRebindings(graphOrTraversalSource));
+ request.addArg(Tokens.ARGS_ALIASES, makeDefaultAliasMap(graphOrTraversalSource));
return submitAsync(buildMessage(request));
}
@@ -331,8 +359,10 @@ public abstract class Client {
* {@inheritDoc}
*/
@Override
- public Client alias(String graphOrTraversalSource) {
- return new AliasClusteredClient(this, graphOrTraversalSource);
+ public Client alias(final String graphOrTraversalSource) {
+ final Map<String,String> aliases = new HashMap<>();
+ aliases.put("g", graphOrTraversalSource);
+ return alias(aliases);
}
/**
@@ -346,12 +376,11 @@ public abstract class Client {
}
/**
- * Creates a {@code Client} that supplies the specified set of aliases, thus allowing the user to re-name
- * one or more globally defined {@link Graph} or {@link TraversalSource} server bindings for the context of
- * the created {@code Client}.
+ * {@inheritDoc}
*/
+ @Override
public Client alias(final Map<String,String> aliases) {
- return new AliasClusteredClient(this, aliases);
+ return new AliasClusteredClient(this, aliases, settings);
}
/**
@@ -396,12 +425,6 @@ public abstract class Client {
hostConnectionPools.values().stream().map(ConnectionPool::closeAsync).collect(Collectors.toList()).toArray(poolCloseFutures);
return CompletableFuture.allOf(poolCloseFutures);
}
-
- private Map<String,String> makeRebindings(final String graphOrTraversalSource) {
- final Map<String,String> rebindings = new HashMap<>();
- rebindings.put("g", graphOrTraversalSource);
- return rebindings;
- }
}
/**
@@ -409,12 +432,9 @@ public abstract class Client {
* specified {@link Graph} or {@link TraversalSource} instances on the server-side.
*/
public final static class AliasClusteredClient extends ReboundClusteredClient {
- public AliasClusteredClient(ClusteredClient clusteredClient, String graphOrTraversalSource) {
- super(clusteredClient, graphOrTraversalSource);
- }
-
- public AliasClusteredClient(ClusteredClient clusteredClient, Map<String, String> rebindings) {
- super(clusteredClient, rebindings);
+ public AliasClusteredClient(final ClusteredClient clusteredClient, final Map<String, String> rebindings,
+ final Client.Settings settings) {
+ super(clusteredClient, rebindings, settings);
}
}
@@ -430,14 +450,9 @@ public abstract class Client {
private final Map<String,String> aliases = new HashMap<>();
final CompletableFuture<Void> close = new CompletableFuture<>();
- ReboundClusteredClient(final ClusteredClient clusteredClient, final String graphOrTraversalSource) {
- super(clusteredClient.cluster);
- this.clusteredClient = clusteredClient;
- aliases.put("g", graphOrTraversalSource);
- }
-
- ReboundClusteredClient(final ClusteredClient clusteredClient, final Map<String,String> rebindings) {
- super(clusteredClient.cluster);
+ ReboundClusteredClient(final ClusteredClient clusteredClient, final Map<String,String> rebindings,
+ final Client.Settings settings) {
+ super(clusteredClient.cluster, settings);
this.clusteredClient = clusteredClient;
this.aliases.putAll(rebindings);
}
@@ -516,9 +531,9 @@ public abstract class Client {
* {@inheritDoc}
*/
@Override
- public Client alias(String graphOrTraversalSource) {
+ public Client alias(final Map<String, String> aliases) {
if (close.isDone()) throw new IllegalStateException("Client is closed");
- return new AliasClusteredClient(clusteredClient, graphOrTraversalSource);
+ return new AliasClusteredClient(clusteredClient, aliases, settings);
}
}
@@ -533,10 +548,10 @@ public abstract class Client {
private ConnectionPool connectionPool;
- SessionedClient(final Cluster cluster, final String sessionId, final boolean manageTransactions) {
- super(cluster);
- this.sessionId = sessionId;
- this.manageTransactions = manageTransactions;
+ SessionedClient(final Cluster cluster, final Client.Settings settings) {
+ super(cluster, settings);
+ this.sessionId = settings.getSession().get().sessionId;
+ this.manageTransactions = settings.getSession().get().manageTransactions;
}
String getSessionId() {
@@ -561,7 +576,7 @@ public abstract class Client {
* @throws UnsupportedOperationException
*/
@Override
- public Client alias(String graphOrTraversalSource) {
+ public Client alias(final Map<String, String> aliases) {
throw new UnsupportedOperationException("Sessioned client does not support aliasing");
}
@@ -605,4 +620,156 @@ public abstract class Client {
return connectionPool.closeAsync();
}
}
+
+ /**
+ * Settings given to {@link Cluster#connect(Settings)} that configures how a {@link Client} will behave.
+ */
+ public static class Settings {
+ private final boolean unrollTraversers;
+ private final Optional<SessionSettings> session;
+
+ private Settings(final Builder builder) {
+ this.unrollTraversers = builder.unrollTraversers;
+ this.session = builder.session;
+ }
+
+ public static Builder build() {
+ return new Builder();
+ }
+
+ /**
+ * A request to Gremlin Server may return a {@link Traverser}. By default a {@link Traverser} is "unrolled"
+ * into an actual result on the client side. So, if the {@link Traverser} contained a {@link Vertex} then
+ * the {@link Vertex} would be extracted out of that {@link Traverser} for purposes of the result. If this
+ * values is instead set to {@code false} then the {@link ResultSet} will simply contain a {@link Traverser}
+ * and it will be up to the user to work with that component directly.
+ */
+ public boolean isUnrollTraversers() {
+ return unrollTraversers;
+ }
+
+ /**
+ * Determines if the {@link Client} is to be constructed with a session. If the value is present, then a
+ * session is expected.
+ */
+ public Optional<SessionSettings> getSession() {
+ return session;
+ }
+
+ public static class Builder {
+ private boolean unrollTraversers = true;
+ private Optional<SessionSettings> session = Optional.empty();
+
+ private Builder() {}
+
+ /**
+ * A request to Gremlin Server may return a {@link Traverser}. By default a {@link Traverser} is "unrolled"
+ * into an actual result on the client side. So, if the {@link Traverser} contained a {@link Vertex} then
+ * the {@link Vertex} would be extracted out of that {@link Traverser} for purposes of the result. If this
+ * values is instead set to {@code false} then the {@link ResultSet} will simply contain a {@link Traverser}
+ * and it will be up to the user to work with that component directly.
+ */
+ public Builder unrollTraversers(final boolean unrollTraversers) {
+ this.unrollTraversers = unrollTraversers;
+ return this;
+ }
+
+ /**
+ * Enables a session. By default this will create a random session name and configure transactions to be
+ * unmanaged. This method will override settings provided by calls to the other overloads of
+ * {@code useSession}.
+ */
+ public Builder useSession(final boolean enabled) {
+ session = enabled ? Optional.of(SessionSettings.build().create()) : Optional.empty();
+ return this;
+ }
+
+ /**
+ * Enables a session. By default this will create a session with the provided name and configure
+ * transactions to be unmanaged. This method will override settings provided by calls to the other
+ * overloads of {@code useSession}.
+ */
+ public Builder useSession(final String sessionId) {
+ session = sessionId != null && !sessionId.isEmpty() ?
+ Optional.of(SessionSettings.build().sessionId(sessionId).create()) : Optional.empty();
+ return this;
+ }
+
+ /**
+ * Enables a session. This method will override settings provided by calls to the other overloads of
+ * {@code useSession}.
+ */
+ public Builder useSession(final SessionSettings settings) {
+ session = Optional.ofNullable(settings);
+ return this;
+ }
+
+ public Settings create() {
+ return new Settings(this);
+ }
+
+ }
+ }
+
+ /**
+ * Settings for a {@link Client} that involve a session.
+ */
+ public static class SessionSettings {
+ private final boolean manageTransactions;
+ private final String sessionId;
+
+ private SessionSettings(final Builder builder) {
+ manageTransactions = builder.manageTransactions;
+ sessionId = builder.sessionId;
+ }
+
+ /**
+ * If enabled, transactions will be "managed" such that each request will represent a complete transaction.
+ */
+ public boolean manageTransactions() {
+ return manageTransactions;
+ }
+
+ /**
+ * Provides the identifier of the session.
+ */
+ public String getSessionId() {
+ return sessionId;
+ }
+
+ public static SessionSettings.Builder build() {
+ return new SessionSettings.Builder();
+ }
+
+ public static class Builder {
+ private boolean manageTransactions = false;
+ private String sessionId = UUID.randomUUID().toString();
+
+ private Builder() {}
+
+ /**
+ * If enabled, transactions will be "managed" such that each request will represent a complete transaction.
+ * By default this value is {@code false}.
+ */
+ public Builder manageTransactions(final boolean manage) {
+ manageTransactions = manage;
+ return this;
+ }
+
+ /**
+ * Provides the identifier of the session. This value cannot be null or empty. By default it is set to
+ * a random {@code UUID}.
+ */
+ public Builder sessionId(final String sessionId) {
+ if (null == sessionId || sessionId.isEmpty())
+ throw new IllegalArgumentException("sessionId cannot be null or empty");
+ this.sessionId = sessionId;
+ return this;
+ }
+
+ public SessionSettings create() {
+ return new SessionSettings(this);
+ }
+ }
+ }
}
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/8bcd524a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
index b29cc95..9e79aa8 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Cluster.java
@@ -79,7 +79,7 @@ public final class Cluster {
* submitted or can be directly initialized via {@link Client#init()}.
*/
public <T extends Client> T connect() {
- return (T) new Client.ClusteredClient(this);
+ return (T) new Client.ClusteredClient(this, Client.Settings.build().create());
}
/**
@@ -116,9 +116,19 @@ public final class Cluster {
* @param manageTransactions enables auto-transactions when set to true
*/
public <T extends Client> T connect(final String sessionId, final boolean manageTransactions) {
- if (null == sessionId || sessionId.isEmpty())
- throw new IllegalArgumentException("sessionId cannot be null or empty");
- return (T) new Client.SessionedClient(this, sessionId, manageTransactions);
+ final Client.SessionSettings sessionSettings = Client.SessionSettings.build()
+ .manageTransactions(manageTransactions)
+ .sessionId(sessionId).create();
+ final Client.Settings settings = Client.Settings.build().useSession(sessionSettings).create();
+ return connect(settings);
+ }
+
+ /**
+ * Creates a new {@link Client} based on the settings provided.
+ */
+ public <T extends Client> T connect(final Client.Settings settings) {
+ return settings.getSession().isPresent() ? (T) new Client.SessionedClient(this, settings) :
+ (T) new Client.ClusteredClient(this, settings);
}
@Override