Package de.uplanet.lucy.server.composer.asynchronous

Class AsynchronousRequestHandlerCallable

java.lang.Object
de.uplanet.lucy.server.composer.asynchronous.AsynchronousRequestHandlerCallable
@VelocityCallable("singleton") public final class AsynchronousRequestHandlerCallable extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    AsynchronousRequestHandlerCallable()
    Explicit default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    asynchronousTaskExists(String p_strId)
    Check if an asynchronous task with the given ID exists.
    de.uplanet.lucy.server.SharedState
    createSharedState()
     
    de.uplanet.lucy.server.composer.asynchronous.IAsynchronousRequestHandlerFuture
    getTask(String p_strId)
    Use peekTask(String) instead.
    boolean
    isServiceAvailable()
    Check if the Asynchronous Request Handler Service is available.
    de.uplanet.lucy.server.composer.asynchronous.IAsynchronousRequestHandlerFuture
    peekTask(String p_strId)
    Get the task with the given ID.
    String
    renderAsynchronously(de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm)
     
    String
    renderAsynchronously(de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm, Map<String,Object> p_vcVariables)
     
    String
    renderAsynchronously(String p_strId, de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm)
     
    String
    renderAsynchronously(String p_strId, de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm, Map<String,Object> p_vcVariables)
     
    de.uplanet.lucy.server.composer.asynchronous.IAsynchronousRequestHandlerFuture
    takeTask(String p_strId)
    Get the task with the given ID and remove it from the underlying collection.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AsynchronousRequestHandlerCallable

      public AsynchronousRequestHandlerCallable()
      Explicit default constructor.

  • Method Details

    • isServiceAvailable

      public boolean isServiceAvailable()
      Check if the Asynchronous Request Handler Service is available.
      Returns:
      true if the service is available, or false otherwise.

    • createSharedState

      public de.uplanet.lucy.server.SharedState createSharedState()

    • asynchronousTaskExists

      public boolean asynchronousTaskExists(String p_strId)
      Check if an asynchronous task with the given ID exists.
      Parameters:
      p_strId - The identifier.
      Returns:
      true if a task with the given ID exists, or false otherwise.

    • peekTask

      public de.uplanet.lucy.server.composer.asynchronous.IAsynchronousRequestHandlerFuture peekTask(String p_strId)
      Get the task with the given ID.

      The task is not being removed from the underlying collection.

      Parameters:
      p_strId - The identifier.
      Returns:
      The task with the given ID, or null if there's none.

    • getTask

      public de.uplanet.lucy.server.composer.asynchronous.IAsynchronousRequestHandlerFuture getTask(String p_strId)
      Use peekTask(String) instead.

    • takeTask

      public de.uplanet.lucy.server.composer.asynchronous.IAsynchronousRequestHandlerFuture takeTask(String p_strId)
      Get the task with the given ID and remove it from the underlying collection.

      If the task has not yet completed, the caller may wait until the Future's isDone method returns true.

      Parameters:
      p_strId - The identifier.
      Returns:
      The task with the given ID, or null if there's none.

    • renderAsynchronously

      public String renderAsynchronously(de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm)

    • renderAsynchronously

      public String renderAsynchronously(de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm, Map<String,Object> p_vcVariables)

    • renderAsynchronously

      public String renderAsynchronously(String p_strId, de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm)

    • renderAsynchronously

      public String renderAsynchronously(String p_strId, de.uplanet.lucy.server.session.ISession p_session, de.uplanet.lucy.server.connector.IServerBridgeRequest p_request, de.uplanet.lucy.server.engine.http.IViewData p_viewData, de.uplanet.lucy.server.SharedState p_sharedState, String p_strCharset, String p_strVm, Map<String,Object> p_vcVariables)