Package com.marklogic.client.dataservices

Interface ExecCaller

All Superinterfaces:

IOEndpoint

All Known Subinterfaces:

ExecEndpoint

public interface ExecCaller
extends IOEndpoint

Provides an interface for calling an endpoint that doesn't take input data structures or return output data structures.

See Also:

Exec endpoints

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExecCaller.BulkExecCaller	Provides an interface for completing a unit of work by repeated calls to an endpoint that doesn't take input data structure or return output data structures.

Nested classes/interfaces inherited from interface com.marklogic.client.dataservices.IOEndpoint

IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

Method Summary

Modifier and Type	Method	Description
ExecCaller.BulkExecCaller	bulkCaller()	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
ExecCaller.BulkExecCaller	bulkCaller(IOEndpoint.CallContext callContext)	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
ExecCaller.BulkExecCaller	bulkCaller(IOEndpoint.CallContext[] callContexts)	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
ExecCaller.BulkExecCaller	bulkCaller(IOEndpoint.CallContext[] callContexts, int threadCount)	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
void	call()	Makes one call to an endpoint that doesn't take endpoint constants, endpoint state, or a session.
void	call(IOEndpoint.CallContext callContext)	Makes one call to the endpoint for the instance and sets the endpoint state in the Call Context.
static ExecCaller	on(DatabaseClient client, JSONWriteHandle apiDecl)	Constructs an instance of the ExecCaller interface for calling the specified endpoint.

Methods inherited from interface com.marklogic.client.dataservices.IOEndpoint

allowsEndpointConstants, allowsEndpointState, allowsInput, allowsSession, allowsWorkUnit, getEndpointPath, newCallContext, newSessionState

Method Detail

on

static ExecCaller on(DatabaseClient client,
                     JSONWriteHandle apiDecl)

Constructs an instance of the ExecCaller interface for calling the specified endpoint.

Parameters:

client - the database client to use for making calls

apiDecl - the JSON api declaration specifying how to call the endpoint

Returns:

the ExecCaller instance for calling the endpoint

call

void call()

Makes one call to an endpoint that doesn't take endpoint constants, endpoint state, or a session.

call

void call(IOEndpoint.CallContext callContext)

Makes one call to the endpoint for the instance and sets the endpoint state in the Call Context.

Parameters:

callContext - the context consisting of the optional endpointConstants, endpointState, and session

bulkCaller

ExecCaller.BulkExecCaller bulkCaller()

Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.

Returns:

the bulk caller for the endpoint

bulkCaller

ExecCaller.BulkExecCaller bulkCaller(IOEndpoint.CallContext callContext)

Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint. The calls occur in the current thread.

Parameters:

callContext - the context consisting of the optional endpointConstants, endpointState, and session

Returns:

the bulk caller for the endpoint

bulkCaller

ExecCaller.BulkExecCaller bulkCaller(IOEndpoint.CallContext[] callContexts)

Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint. The calls occur in worker threads.

Parameters:

callContexts - array of callContexts

Returns:

the bulk caller for the endpoint

bulkCaller

ExecCaller.BulkExecCaller bulkCaller(IOEndpoint.CallContext[] callContexts,
                                     int threadCount)

Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint. The calls occur in worker threads.

Parameters:

callContexts - array of callContexts

threadCount - the number of threads

Returns:

the bulk caller for the endpoint