Interface InputCaller<I>

Type Parameters:

I - The representation for document input

All Superinterfaces:

IOEndpoint

See Also:

• Input endpoints

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Interface

  Description

  static interface 

  InputCaller.BulkInputCaller<I>

  Provides an interface for completing a unit of work by repeated calls to the input endpoint.

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

  IOEndpoint.BulkIOEndpointCaller, IOEndpoint.CallContext

• Method Summary

  All MethodsStatic MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  InputCaller.BulkInputCaller<I>

  bulkCaller()

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

  InputCaller.BulkInputCaller<I>

  bulkCaller(IOEndpoint.CallContext callContext)

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

  InputCaller.BulkInputCaller<I>

  bulkCaller(IOEndpoint.CallContext[] callContexts)

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

  InputCaller.BulkInputCaller<I>

  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.

  void

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

  Makes one call to the endpoint for the instance and sets the endpoint state in the Call Context.

  void

  call(I[] input)

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

  static <I> InputCaller<I>

  on(DatabaseClient client, JSONWriteHandle apiDecl, BufferableContentHandle<I,?> inputHandle)

  Constructs an instance of the InputCaller interface.

  static <IC, IR, I extends BufferableContentHandle<IC, IR>>
InputCaller<I>

  onHandles(DatabaseClient client, JSONWriteHandle apiDecl, I inputHandle)

  Constructs an instance of the InputCaller interface.

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

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

• Method Details

  • on

    static <I> InputCaller<I> on(DatabaseClient client, JSONWriteHandle apiDecl, BufferableContentHandle<I,?> inputHandle)
    Constructs an instance of the InputCaller interface.

    Type Parameters:

    I - the input content representation (such as String)

    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)

    Returns:

    the InputCaller instance for calling the endpoint.

  • onHandles

    static <IC, IR, I extends BufferableContentHandle<IC, IR>> InputCaller<I> onHandles(DatabaseClient client, JSONWriteHandle apiDecl, I inputHandle)
    Constructs an instance of the InputCaller 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

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

    Returns:

    the InputOutputCaller instance for calling the endpoint.

  • call

    void 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

  • call

    void call(IOEndpoint.CallContext callContext, I[] input)
    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

    input - the request data sent to the endpoint

  • bulkCaller

    InputCaller.BulkInputCaller<I> 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 endpoint

  • bulkCaller

    InputCaller.BulkInputCaller<I> 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 endpoint

  • bulkCaller

    InputCaller.BulkInputCaller<I> 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 endpoint

  • bulkCaller

    InputCaller.BulkInputCaller<I> 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 endpoint

Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.