Package de.aristaflow.adept2.core.runtimeservice

Interface RemoteProgressMonitor

  • public interface RemoteProgressMonitor
    The interface provides ProgressMonitors for clients executing activities proprietarily not using ExecutableComponent. Usually this interface is called remotely.

    Since this handles several progress monitors, each method requires the sessionID of the execution. If the designated session ID does not exist, an UnknownSessionException will be thrown for each method. This usually indicates that the execution has been terminated from server side but the executing client has not responded in time. Clients should check the state of the corresponding process step.
    If the session token does not match the designated session ID, that is the session token has not the same credentials as the starting token, a ServiceAccessControlException will be thrown.

    Besides the session token and the session ID the methods are identical to ProgressMonitor.

    Author:
    Ulrich Kreher

    • Method Detail

      • beginTask

        void beginTask​(SessionToken token,
               String sessionID)
        throws UnknownSessionException
        ProgressMonitor.beginTask()
        Parameters:
        token - The session token which is used to check for access rights on this method. This has to be a session token having the same credentials (top-level session token) as the session token used for starting the corresponding activity.
        sessionID - The session ID of the execution. This is the same session ID provided to an ExecutableComponent.
        Throws:
        UnknownSessionException - If the designated session is not known, an UnknownSessionException will be thrown. This usually indicates that the server has terminated the execution because the client did not respond in time.
        ServiceAccessControlException - If the designated token does not match the designated session ID, that is the session token has not the same credentials as the token starting the designated execution session, a ServiceAccessControlException will be thrown.

      • beginTask

        void beginTask​(SessionToken token,
               String sessionID,
               int overallWorkUnits)
        throws UnknownSessionException
        ProgressMonitor.beginTask(int)
        Parameters:
        token - The session token which is used to check for access rights on this method. This has to be a session token having the same credentials (top-level session token) as the session token used for starting the corresponding activity.
        sessionID - The session ID of the execution. This is the same session ID provided to an ExecutableComponent.
        overallWorkUnits - The amount of work units to be done during the job.
        Throws:
        UnknownSessionException - If the designated session ID is not known, an UnknownSessionException will be thrown. This usually indicates that the server has terminated the execution because the client did not respond in time.
        ServiceAccessControlException - If the designated token does not match the designated session ID, that is the session token has not the same credentials as the token starting the designated execution session, a ServiceAccessControlException will be thrown.

      • progress

        void progress​(SessionToken token,
              String sessionID)
       throws UnknownSessionException
        ProgressMonitor.progress()
        Parameters:
        token - The session token which is used to check for access rights on this method. This has to be a session token having the same credentials (top-level session token) as the session token used for starting the corresponding activity.
        sessionID - The session ID of the execution. This is the same session ID provided to an ExecutableComponent.
        Throws:
        UnknownSessionException - If the designated session ID is not known, an UnknownSessionException will be thrown. This usually indicates that the server has terminated the execution because the client did not respond in time.
        ServiceAccessControlException - If the designated token does not match the designated session ID, that is the session token has not the same credentials as the token starting the designated execution session, a ServiceAccessControlException will be thrown.

      • endTask

        void endTask​(SessionToken token,
             String sessionID)
      throws UnknownSessionException
        ProgressMonitor.endTask()
        Parameters:
        token - The session token which is used to check for access rights on this method. This has to be a session token having the same credentials (top-level session token) as the session token used for starting the corresponding activity.
        sessionID - The session ID of the execution. This is the same session ID provided to an ExecutableComponent.
        Throws:
        UnknownSessionException - If the designated session ID is not known, an UnknownSessionException will be thrown. This usually indicates that the server has terminated the execution because the client did not respond in time.
        ServiceAccessControlException - If the designated token does not match the designated session ID, that is the session token has not the same credentials as the token starting the designated execution session, a ServiceAccessControlException will be thrown.

      • setTaskState

        void setTaskState​(SessionToken token,
                  String sessionID,
                  TaskState taskState)
           throws UnknownSessionException
        ProgressMonitor.setTaskState(TaskState)
        Parameters:
        token - The session token which is used to check for access rights on this method. This has to be a session token having the same credentials (top-level session token) as the session token used for starting the corresponding activity.
        sessionID - The session ID of the execution. This is the same session ID provided to an ExecutableComponent.
        taskState - the state of the task
        Throws:
        UnknownSessionException - If the designated session ID is not known, an UnknownSessionException will be thrown. This usually indicates that the server has terminated the execution because the client did not respond in time.
        ServiceAccessControlException - If the designated token does not match the designated session ID, that is the session token has not the same credentials as the token starting the designated execution session, a ServiceAccessControlException will be thrown.