org.apache.tinkerpop.gremlin.groovy.plugin

Interface RemoteAcceptor

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HadoopRemoteAcceptor

public interface RemoteAcceptor
extends Closeable

The Gremlin Console supports the :remote and :submit commands which provide standardized ways for plugins to provide "remote connections" to resources and a way to "submit" a command to those resources. A "remote connection" does not necessarily have to be a remote server. It simply refers to a resource that is external to the console.

By implementing this interface and returning an instance of it through GremlinPlugin.remoteAcceptor() a plugin can hook into those commands and provide remoting features.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESULT

Method Summary

Modifier and Type	Method and Description
Object	configure(List<String> args) Gets called when :remote is used in conjunction with the config option.
Object	connect(List<String> args) Gets called when :remote is used in conjunction with the "connect" option.
static String	getScript(String submittedScript, Groovysh shell) Retrieve a script as defined in the shell context.
Object	submit(List<String> args) Gets called when :submit is executed.

Methods inherited from interface java.io.Closeable

close

Field Detail

RESULT

static final String RESULT

See Also:

Constant Field Values

Method Detail

connect

Object connect(List<String> args)
        throws RemoteException

Gets called when :remote is used in conjunction with the "connect" option. It is up to the implementation to decide how additional arguments on the line should be treated after "connect".

Returns:

an object to display as output to the user

Throws:

RemoteException - if there is a problem with connecting

configure

Object configure(List<String> args)
          throws RemoteException

Gets called when :remote is used in conjunction with the config option. It is up to the implementation to decide how additional arguments on the line should be treated after config.

Returns:

an object to display as output to the user

Throws:

RemoteException - if there is a problem with configuration

submit

Object submit(List<String> args)
       throws RemoteException

Gets called when :submit is executed. It is up to the implementation to decide how additional arguments on the line should be treated after :submit.

Returns:

an object to display as output to the user

Throws:

RemoteException - if there is a problem with submission

getScript

static String getScript(String submittedScript,
                        Groovysh shell)

Retrieve a script as defined in the shell context. This allows for multi-line scripts to be submitted.