Package com.yahoo.documentapi

Interface VisitorSession

All Superinterfaces:
VisitorControlSession
All Known Implementing Classes:
LocalVisitorSession, MessageBusVisitorSession
public interface VisitorSession extends VisitorControlSession
A session for tracking progress for and potentially receiving data from a visitor.
Author:
Thomas Gundersen

  • Method Summary

    Modifier and Type
    Method
    Description
    ProgressToken
    getProgress()
    Retrieves the last progress token gotten for this visitor.
    com.yahoo.messagebus.Trace
    getTrace()
    Returns the tracing information so far about the visitor.
    boolean
    isDone()
    Checks if visiting is done.
    boolean
    waitUntilDone(long timeoutMs)
    Waits until visiting is done, or the given timeout (in ms) expires.

    Methods inherited from interface com.yahoo.documentapi.VisitorControlSession

    abort, ack, destroy, getNext, getNext

  • Method Details

    • isDone

      boolean isDone()
      Checks if visiting is done.
      Returns:
      True if visiting is done (either by error or success).

    • getProgress

      ProgressToken getProgress()
      Retrieves the last progress token gotten for this visitor.
      Returns:
      The progress token.

    • getTrace

      com.yahoo.messagebus.Trace getTrace()
      Returns the tracing information so far about the visitor.
      Returns:
      Returns the trace.

    • waitUntilDone

      boolean waitUntilDone(long timeoutMs) throws InterruptedException
      Waits until visiting is done, or the given timeout (in ms) expires. Will wait forever if timeout is 0.
      Parameters:
      timeoutMs - The maximum amount of milliseconds to wait.
      Returns:
      True if visiting is done (either by error or success).
      Throws:
      InterruptedException - If an interrupt signal was received while waiting.