Package com.marklogic.client.dataservices

Interface ExecEndpoint

All Superinterfaces:

ExecCaller, IOEndpoint

Deprecated.

@Deprecated
public interface ExecEndpoint
extends ExecCaller

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ExecEndpoint.BulkExecCaller	Deprecated.

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

IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

Method Summary

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

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

bulkCaller, bulkCaller, bulkCaller, call, call

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

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

Method Detail

on

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

Deprecated.

Constructs an instance of the ExecEndpoint 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 ExecEndpoint 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 for the next call, if returned by the endpoint, or null

bulkCaller

@Deprecated
ExecEndpoint.BulkExecCaller bulkCaller()

Deprecated.

Description copied from interface: ExecCaller

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

Specified by:

bulkCaller in interface ExecCaller

Returns:

the bulk caller for the endpoint