Package com.marklogic.client.dataservices

Interface OutputEndpoint

All Superinterfaces:

IOEndpoint, OutputCaller<java.io.InputStream>

Deprecated.

@Deprecated
public interface OutputEndpoint
extends OutputCaller<java.io.InputStream>

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OutputEndpoint.BulkOutputCaller	Deprecated.

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

IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

Method Summary

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

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

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

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

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

Method Detail

on

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

Deprecated.

Constructs an instance of the OutputEndpoint interface.

Parameters:

client - the database client to use for making calls

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

Returns:

the OutputEndpoint instance for calling the endpoint.

call

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

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)

Returns:

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

bulkCaller

@Deprecated
OutputEndpoint.BulkOutputCaller bulkCaller()

Deprecated.

Description copied from interface: OutputCaller

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

Specified by:

bulkCaller in interface OutputCaller<java.io.InputStream>

Returns:

the bulk caller for the output endpoint