Package com.marklogic.client.dataservices

Interface InputOutputEndpoint

All Superinterfaces:

InputOutputCaller<java.io.InputStream,java.io.InputStream>, IOEndpoint

Deprecated.

@Deprecated
public interface InputOutputEndpoint
extends InputOutputCaller<java.io.InputStream,java.io.InputStream>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InputOutputEndpoint.BulkInputOutputCaller	Deprecated.

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

IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

Method Summary

Modifier and Type	Method	Description
InputOutputEndpoint.BulkInputOutputCaller	bulkCaller()	Deprecated.
java.io.InputStream[]	call(java.io.InputStream endpointState, SessionState session, java.io.InputStream workUnit, java.io.InputStream[] input)	Deprecated.
static InputOutputEndpoint	on(DatabaseClient client, JSONWriteHandle apiDecl)	Deprecated.

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

bulkCaller, bulkCaller, bulkCaller, call, call, on, onHandles

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

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

Method Detail

on

@Deprecated
static InputOutputEndpoint on(DatabaseClient client,
                              JSONWriteHandle apiDecl)

Deprecated.

Constructs an instance of the InputOutputEndpoint interface.

Parameters:

client - the database client to use for making calls

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

Returns:

the InputOutputEndpoint instance for calling the endpoint.

call

@Deprecated
java.io.InputStream[] call(java.io.InputStream endpointState,
                           SessionState session,
                           java.io.InputStream workUnit,
                           java.io.InputStream[] input)

Deprecated.

Makes one call to the endpoint for the instance

Parameters:

endpointState - the current mutable state of the endpoint (which must be null if not accepted by the endpoint)

session - the identifier for the server cache of the endpoint (which must be null if not accepted by the endpoint)

workUnit - the definition of a unit of work (which must be null if not accepted by the endpoint)

input - the request data sent to the endpoint

Returns:

the endpoint state if produced by the endpoint followed by the response data from the endpoint

bulkCaller

@Deprecated
InputOutputEndpoint.BulkInputOutputCaller bulkCaller()

Deprecated.

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

Specified by:

bulkCaller in interface InputOutputCaller<java.io.InputStream,java.io.InputStream>

Returns:

the bulk caller for the input-output endpoint