org.apache.tinkerpop.gremlin.structure.service

Interface Service.DirectoryService<I>

All Superinterfaces:

AutoCloseable, Service<I,String>, Service.ServiceFactory

All Known Implementing Classes:

ServiceRegistry, TinkerServiceRegistry

Enclosing interface:

Service<I,R>

public static interface Service.DirectoryService<I>
extends Service<I,String>, Service.ServiceFactory

Meta-service to list and describe registered callable services.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Service.DirectoryService.Params

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service

Service.DirectoryService<I>, Service.Exceptions, Service.ServiceCallContext, Service.ServiceFactory<I,R>, Service.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Method Summary

Modifier and Type	Method and Description
default void	close() Services can implement cleanup/shutdown procedures here.
default Service	createService(boolean isStart, Map params) Create a Service call instance.
default Map	describeParams() Return a description of any service call parameters.
CloseableIterator<String>	execute(Service.ServiceCallContext ctx, Map params) List or describe any registered callable services.
default String	getName() Get the name of this service.
default Set<Service.Type>	getSupportedTypes() Get the execution modes that it supports.
default Service.Type	getType() Return the Service.Type of service call.

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service

execute, execute, getMaxBarrierSize, getRequirements, isBarrier, isStart, isStreaming

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service.ServiceFactory

getRequirements, getRequirementsByType

Field Detail

NAME

static final String NAME

See Also:

Constant Field Values

Method Detail

getName

default String getName()

Description copied from interface: Service.ServiceFactory

Get the name of this service.

Specified by:

getName in interface Service.ServiceFactory

getType

default Service.Type getType()

Description copied from interface: Service

Return the Service.Type of service call.

Specified by:

getType in interface Service<I,String>

getSupportedTypes

default Set<Service.Type> getSupportedTypes()

Description copied from interface: Service.ServiceFactory

Get the execution modes that it supports.

Specified by:

getSupportedTypes in interface Service.ServiceFactory

describeParams

default Map describeParams()

Description copied from interface: Service.ServiceFactory

Return a description of any service call parameters.

Specified by:

describeParams in interface Service.ServiceFactory

createService

default Service createService(boolean isStart,
                              Map params)

Description copied from interface: Service.ServiceFactory

Create a Service call instance.

Specified by:

createService in interface Service.ServiceFactory

Parameters:

isStart - true if the call is being used to start a traversal

params - the static params provided to service call (if any)

Returns:

the service call instance

execute

CloseableIterator<String> execute(Service.ServiceCallContext ctx,
                                  Map params)

List or describe any registered callable services.

Specified by:

execute in interface Service<I,String>

close

default void close()

Description copied from interface: Service

Services can implement cleanup/shutdown procedures here.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Service<I,String>

Specified by:

close in interface Service.ServiceFactory