Package com.illumon.iris.controller.handle

Interface PersistentQueryHandle

All Known Implementing Classes:
CommunityPersistentQueryHandle, DoNothingHandle, EnterprisePersistentQueryHandle
public interface PersistentQueryHandle
This interface defines a local handle to a remote Persistent Query. The query may be an Enterprise worker, or a Community worker.

  • Method Summary

    Modifier and Type
    Method
    Description
    PersistentQueryState
    getState()
    Get the current state object for the Persistent Query.
    long
    getVersion()
    Get the currently running version of the Persistent Query.
    void
    shutdown(String lastAuthenticatedUser, String lastEffectiveUser)
    Shutdown the worker, if it is running.
    void
    start()
    Start the worker.

  • Method Details

    • getVersion

      long getVersion()
      Get the currently running version of the Persistent Query.
      Returns:
      the version of the running query

    • getState

      PersistentQueryState getState()
      Get the current state object for the Persistent Query.
      Returns:
      the current state

    • start

      void start()
      Start the worker.

    • shutdown

      void shutdown(String lastAuthenticatedUser, String lastEffectiveUser)
      Shutdown the worker, if it is running.
      Parameters:
      lastAuthenticatedUser - the authenticating user requesting the shutdown
      lastEffectiveUser - the effective user requesting the shuutdown