Package com.marklogic.client.dataservices

Interface OutputCaller<O>

Type Parameters:

O - The representation for document output

All Superinterfaces:

IOEndpoint

All Known Subinterfaces:

OutputEndpoint

public interface OutputCaller<O>
extends IOEndpoint

Provides an interface for calling an endpoint that returns output data structures.

See Also:

Output endpoints

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OutputCaller.BulkOutputCaller<O>	Provides an interface for completing a unit of work by repeated calls to the output endpoint.

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

IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

Method Summary

Modifier and Type	Method	Description
OutputCaller.BulkOutputCaller<O>	bulkCaller()	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
OutputCaller.BulkOutputCaller<O>	bulkCaller(IOEndpoint.CallContext callContext)	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
OutputCaller.BulkOutputCaller<O>	bulkCaller(IOEndpoint.CallContext[] callContexts)	Constructs an instance of a bulk caller, which completes a unit of work by repeated calls to the endpoint.
OutputCaller.BulkOutputCaller<O>	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.
O[]	call()	Makes one call to an endpoint that doesn't take endpoint constants, endpoint state, or a session.
O[]	call(IOEndpoint.CallContext callContext)	Makes one call to the endpoint for the instance and sets the endpoint state in the Call Context.
static <O> OutputCaller<O>	on(DatabaseClient client, JSONWriteHandle apiDecl, BufferableContentHandle<O,?> outputHandle)	Constructs an instance of the OutputCaller interface.
static <OC,OR,O extends BufferableContentHandle<OC,OR>> OutputCaller<O>	onHandles(DatabaseClient client, JSONWriteHandle apiDecl, O outputHandle)	Constructs an instance of the OutputCaller interface.

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

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

Method Detail

on

static <O> OutputCaller<O> on(DatabaseClient client,
                              JSONWriteHandle apiDecl,
                              BufferableContentHandle<O,?> outputHandle)

Constructs an instance of the OutputCaller interface.

Type Parameters:

O - the output content representation (such as byte[])

Parameters:

client - the database client to use for making calls

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

outputHandle - the handle for the representation of the output content (such as BytesHandle)

Returns:

the OutputCaller instance for calling the endpoint.

onHandles

static <OC,OR,O extends BufferableContentHandle<OC,OR>> OutputCaller<O> onHandles(DatabaseClient client,
                                                                                  JSONWriteHandle apiDecl,
                                                                                  O outputHandle)

Constructs an instance of the OutputCaller interface. This factory is useful primarily for parameters or return values of the anyDocument type.

Type Parameters:

OC - the content type of the output handle

OR - the type for the data received by the output handle

O - the output handle

Parameters:

client - the database client to use for making calls

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

outputHandle - the handles that provides the output content (such as BytesHandle)

Returns:

the InputOutputCaller instance for calling the endpoint.

call

O[] call()

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

Returns:

the response data from the endpoint

call

O[] 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

Returns:

the response data from the endpoint

bulkCaller

OutputCaller.BulkOutputCaller<O> 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 output endpoint

bulkCaller

OutputCaller.BulkOutputCaller<O> 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 current thread.

Parameters:

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

Returns:

the bulk caller for the output endpoint

bulkCaller

OutputCaller.BulkOutputCaller<O> 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 - the collection of callContexts

Returns:

the bulk caller for the output endpoint

bulkCaller

OutputCaller.BulkOutputCaller<O> 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 - the collection of callContexts

threadCount - the number of threads

Returns:

the bulk caller for the output endpoint