Package com.marklogic.client.dataservices

Interface InputOutputCaller<I,O>

Type Parameters:

I - The representation for document input

O - The representation for document output

All Superinterfaces:

IOEndpoint

All Known Subinterfaces:

InputOutputEndpoint

public interface InputOutputCaller<I,O>
extends IOEndpoint

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

See Also:

Input-output endpoints

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InputOutputCaller.BulkInputOutputCaller<I,O>	Provides an interface for completing a unit of work by repeated calls to the input-output endpoint.

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

IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

Method Summary

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

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

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

Method Detail

on

static <I,O> InputOutputCaller<I,O> on(DatabaseClient client,
                                       JSONWriteHandle apiDecl,
                                       BufferableContentHandle<I,?> inputHandle,
                                       BufferableContentHandle<O,?> outputHandle)

Constructs an instance of the InputOutputCaller interface.

Type Parameters:

I - the content representation (such as String)

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

inputHandle - the handle for the representation of the input content (such as StringHandle)

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

Returns:

the InputOutputCaller instance for calling the endpoint.

onHandles

static <IC,IR,OC,OR,I extends BufferableContentHandle<IC,IR>,O extends BufferableContentHandle<OC,OR>> InputOutputCaller<I,O> onHandles(DatabaseClient client,
                                                                                                                                        JSONWriteHandle apiDecl,
                                                                                                                                        I inputHandle,
                                                                                                                                        O outputHandle)

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

Type Parameters:

IC - the content type of the input handle

IR - the type for the data received by the input handle

OC - the content type of the output handle

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

I - the input 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

inputHandle - the handles that provides the input content (such as StringHandle)

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

Returns:

the InputOutputCaller instance for calling the endpoint.

call

O[] call(I[] input)

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

Parameters:

input - the request data sent to the endpoint

Returns:

the response data from the endpoint

call

O[] call(IOEndpoint.CallContext callContext,
         I[] input)

Makes one call to an endpoint that sets endpoint constants, endpoint state, or a session in the Call Context.

Parameters:

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

input - the request data sent to the endpoint

Returns:

the response data from the endpoint

bulkCaller

InputOutputCaller.BulkInputOutputCaller<I,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 input-output endpoint

bulkCaller

InputOutputCaller.BulkInputOutputCaller<I,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 the current thread.

Parameters:

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

Returns:

the bulk caller for the input-output endpoint

bulkCaller

InputOutputCaller.BulkInputOutputCaller<I,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 input-output endpoint

bulkCaller

InputOutputCaller.BulkInputOutputCaller<I,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 input-output endpoint