public abstract class AbstractEvalOpProcessor extends Object implements OpProcessor
OpProcessor implementation that helps with operations that deal
with script evaluation functions.| Modifier and Type | Class and Description |
|---|---|
static interface |
AbstractEvalOpProcessor.BindingSupplier<T> |
| Modifier and Type | Field and Description |
|---|---|
static Timer |
evalOpTimer |
protected boolean |
manageTransactions |
| Modifier | Constructor and Description |
|---|---|
protected |
AbstractEvalOpProcessor(boolean manageTransactions) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
evalOpInternal(Context context,
Supplier<GremlinExecutor> gremlinExecutorSupplier,
AbstractEvalOpProcessor.BindingSupplier<Bindings> bindingsSupplier)
A generalized implementation of the "eval" operation.
|
abstract ThrowingConsumer<Context> |
getEvalOp()
Provides an operation for evaluating a Gremlin script.
|
protected void |
handleIterator(Context context,
Iterator itty)
|
ThrowingConsumer<Context> |
select(Context ctx)
Given the context (which contains the RequestMessage), return back a Consumer function that will be
executed with the context.
|
abstract Optional<ThrowingConsumer<Context>> |
selectOther(RequestMessage requestMessage)
A sub-class may have additional "ops" that it will service.
|
protected Optional<ThrowingConsumer<Context>> |
validateEvalMessage(RequestMessage message) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetNameclosepublic static final Timer evalOpTimer
protected final boolean manageTransactions
protected AbstractEvalOpProcessor(boolean manageTransactions)
public abstract ThrowingConsumer<Context> getEvalOp()
public abstract Optional<ThrowingConsumer<Context>> selectOther(RequestMessage requestMessage) throws OpProcessorException
select(Context) that are not
handled will be passed to this method to see if the sub-class can service the requested op code.OpProcessorExceptionpublic ThrowingConsumer<Context> select(Context ctx) throws OpProcessorException
OpProcessorselect in interface OpProcessorOpProcessorExceptionprotected Optional<ThrowingConsumer<Context>> validateEvalMessage(RequestMessage message) throws OpProcessorException
OpProcessorExceptionprotected void evalOpInternal(Context context, Supplier<GremlinExecutor> gremlinExecutorSupplier, AbstractEvalOpProcessor.BindingSupplier<Bindings> bindingsSupplier) throws OpProcessorException
ResponseMessage objects down the Netty pipeline. It also handles script timeouts,
iteration timeouts, metrics and building bindings. Note that result iteration is delegated to the
handleIterator(org.apache.tinkerpop.gremlin.server.Context, java.util.Iterator) method, so those extending this class could override that method for better control
over result iteration.context - The current Gremlin Server ContextgremlinExecutorSupplier - A function that returns the GremlinExecutor to use in executing the
script evaluation.bindingsSupplier - A function that returns the Bindings to provide to the
GremlinExecutor.eval(java.lang.String) method.OpProcessorExceptionprotected void handleIterator(Context context, Iterator itty) throws TimeoutException, InterruptedException
evalOpInternal(org.apache.tinkerpop.gremlin.server.Context, java.util.function.Supplier<org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor>, org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor.BindingSupplier<javax.script.Bindings>) when iterating a result set. Implementers should respect the
Settings.serializedResponseTimeout configuration and break the serialization process if
it begins to take too long to do so, throwing a TimeoutException in such
cases.context - The Gremlin Server Context object containing settings, request message, etc.itty - The result to iteratorTimeoutException - if the time taken to serialize the entire result set exceeds the allowable time.InterruptedExceptionCopyright © 2013–2015 Apache Software Foundation. All rights reserved.