Interface IOEndpoint.CallContext

Enclosing interface:

IOEndpoint

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  BytesHandle

  getEndpointConstants()

  Gets the definition for constant inputs to the endpoint.

  BytesHandle

  getEndpointState()

  Gets the current snapshot of the mutable state of the endpoint.

  SessionState

  getSessionState()

  Returns an identifier for an endpoint to use when accessing a session cache on the server.

  IOEndpoint.CallContext

  withEndpointConstants(BufferableHandle constants)

  Sets the constant inputs prior to the first call to the endpoint.

  IOEndpoint.CallContext

  withEndpointConstantsAs(Object constants)

  Sets the constant inputs prior to the first call to the endpoint.

  IOEndpoint.CallContext

  withEndpointState(BufferableHandle endpointState)

  Initializes the stateful properties of the endpoint prior to the first call to the endpoint.

  IOEndpoint.CallContext

  withEndpointStateAs(Object endpointState)

  Initializes the stateful properties of the endpoint prior to the first call to the endpoint.

  IOEndpoint.CallContext

  withSessionState(SessionState sessionState)

  Sets an identifier for an endpoint to use when accessing a session cache on the server.

• Method Details

  • getEndpointState

    BytesHandle getEndpointState()
    Gets the current snapshot of the mutable state of the endpoint.

    Returns:

    the data structure with the endpoint state

  • withEndpointState

    IOEndpoint.CallContext withEndpointState(BufferableHandle endpointState)
    Initializes the stateful properties of the endpoint prior to the first call to the endpoint. The endpoint returns the state as the first value in the response. The caller resends the modified state on the next call to the endpoint.

    Parameters:

    endpointState - the data structure for the endpoint state in a representation supported by a bufferable content handle

    Returns:

    the callContext

  • withEndpointStateAs

    IOEndpoint.CallContext withEndpointStateAs(Object endpointState)
    Initializes the stateful properties of the endpoint prior to the first call to the endpoint. The endpoint returns the state as the first value in the response. The caller resends the modified state on the next call to the endpoint.

    Parameters:

    endpointState - the data structure for the endpoint state in a representation supported by a bufferable content handle

    Returns:

    the callContext

  • getEndpointConstants

    BytesHandle getEndpointConstants()
    Gets the definition for constant inputs to the endpoint.

    Returns:

    the data structure for the constants

  • withEndpointConstants

    IOEndpoint.CallContext withEndpointConstants(BufferableHandle constants)
    Sets the constant inputs prior to the first call to the endpoint. Examples of such constants might include the query when paging over a result set or the provenance when ingesting records.

    Parameters:

    constants - the data structure in a representation supported by a bufferable content handle

    Returns:

    the callContext

  • withEndpointConstantsAs

    IOEndpoint.CallContext withEndpointConstantsAs(Object constants)
    Sets the constant inputs prior to the first call to the endpoint. Examples of such constants might include the query when paging over a result set or the provenance when ingesting records.

    Parameters:

    constants - the data structure in a representation supported by a bufferable content handle

    Returns:

    the callContext

  • getSessionState

    SessionState getSessionState()
    Returns an identifier for an endpoint to use when accessing a session cache on the server.

    Returns:

    the endpoint identifier

  • withSessionState

    IOEndpoint.CallContext withSessionState(SessionState sessionState)
    Sets an identifier for an endpoint to use when accessing a session cache on the server.

    Parameters:

    sessionState - the identifier for the server cache of the endpoint

    Returns:

    the callContext

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