org.apache.tinkerpop.gremlin.server.op.session

Class SessionOpProcessor

java.lang.Object

org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor

org.apache.tinkerpop.gremlin.server.op.session.SessionOpProcessor

All Implemented Interfaces:

AutoCloseable, OpProcessor

public class SessionOpProcessor
extends AbstractEvalOpProcessor

Simple OpProcessor implementation that handles ScriptEngine script evaluation in the context of a session. Note that this processor will also take a "close" op to kill the session and rollback any incomplete transactions.

Author:

Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor

AbstractEvalOpProcessor.BindingSupplier

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_SESSION_TIMEOUT Configuration setting for how long a session will be available before it timesout.
static long	DEFAULT_SESSION_TIMEOUT Default timeout for a session is eight hours.
static String	OP_PROCESSOR_NAME
protected static ConcurrentHashMap<String,Session>	sessions Script engines are evaluated in a per session context where imports/scripts are isolated per session.

Fields inherited from class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor

evalOpTimer, manageTransactions, validBindingName

Constructor Summary

Constructors

Constructor and Description
SessionOpProcessor()

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	evalOp(Context context)
ThrowingConsumer<Context>	getEvalOp() Provides an operation for evaluating a Gremlin script.
String	getName() The name of the processor which requests must refer to "processor" field on a request.
protected static Session	getSession(Context context, RequestMessage msg) Examines the RequestMessage and extracts the session token.
Optional<ThrowingConsumer<Context>>	selectOther(RequestMessage requestMessage) Session based requests accept a "close" operator in addition to "eval".
protected Optional<ThrowingConsumer<Context>>	validateEvalMessage(RequestMessage message)

Methods inherited from class org.apache.tinkerpop.gremlin.server.op.AbstractEvalOpProcessor

evalOpInternal, handleIterator, select

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OP_PROCESSOR_NAME

public static final String OP_PROCESSOR_NAME

See Also:

Constant Field Values

sessions

protected static ConcurrentHashMap<String,Session> sessions

Script engines are evaluated in a per session context where imports/scripts are isolated per session.

CONFIG_SESSION_TIMEOUT

public static final String CONFIG_SESSION_TIMEOUT

Configuration setting for how long a session will be available before it timesout.

See Also:

Constant Field Values

DEFAULT_SESSION_TIMEOUT

public static final long DEFAULT_SESSION_TIMEOUT

Default timeout for a session is eight hours.

See Also:

Constant Field Values

Constructor Detail

SessionOpProcessor

public SessionOpProcessor()

Method Detail

getName

public String getName()

Description copied from interface: OpProcessor

The name of the processor which requests must refer to "processor" field on a request.

selectOther

public Optional<ThrowingConsumer<Context>> selectOther(RequestMessage requestMessage)
                                                throws OpProcessorException

Session based requests accept a "close" operator in addition to "eval". A close will trigger the session to be killed and any uncommitted transaction to be rolled-back.

Specified by:

selectOther in class AbstractEvalOpProcessor

Throws:

OpProcessorException

getEvalOp

public ThrowingConsumer<Context> getEvalOp()

Description copied from class: AbstractEvalOpProcessor

Provides an operation for evaluating a Gremlin script.

Specified by:

getEvalOp in class AbstractEvalOpProcessor

validateEvalMessage

protected Optional<ThrowingConsumer<Context>> validateEvalMessage(RequestMessage message)
                                                           throws OpProcessorException

Overrides:

validateEvalMessage in class AbstractEvalOpProcessor

Throws:

OpProcessorException

close

public void close()
           throws Exception

Throws:

Exception

evalOp

protected void evalOp(Context context)
               throws OpProcessorException

Throws:

OpProcessorException

getSession

protected static Session getSession(Context context,
                                    RequestMessage msg)

Examines the RequestMessage and extracts the session token. The session is then either found or a new one is created.