Package com.infoteria.asteria.flowengine2.client

Class FlowExecuteClient

java.lang.Object
com.infoteria.asteria.communication.client.AsteriaClient
com.infoteria.asteria.communication.client.AsteriaSessionClient
com.infoteria.asteria.flowengine2.client.FlowExecuteClient
All Implemented Interfaces:
com.infoteria.asteria.communication.client.SessionClient, com.infoteria.asteria.flowengine2.client.ExecuteClient
public class FlowExecuteClient extends com.infoteria.asteria.communication.client.AsteriaSessionClient implements com.infoteria.asteria.flowengine2.client.ExecuteClient
外部のJavaプログラムからフローを実行するためのクライアントクラスです。

  • Field Summary

    Fields inherited from class com.infoteria.asteria.communication.client.AsteriaSessionClient

    VERSION_EQUAL, VERSION_NEW, VERSION_OLD

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowExecuteClient(com.infoteria.asteria.communication.client.AsteriaSessionClient client)
    他のclientのセッション(ログイン状態)を引き継いでクライアントを作成します。
    FlowExecuteClient(String url)
    ASTERIAサーバのURLを指定してクライアントを作成します。
    特に変更していない場合、URLは「http://<SERVERNAME>:21381」となります。

  • Method Summary

    Modifier and Type
    Method
    Description
    FlowResponse
    execute(FlowRequest request)
    フローを実行します。
    実行を開始したら、その終了を待って実行結果が返り値となります。
    com.infoteria.asteria.communication.client.CallHandlerInterface.ContextType
    getContextType()
     
    String
    killFlow(String requestId)
    killFlow(requestId, 5)と同じです。
    String
    killFlow(String requestId, int timeout)
    リクエストIDで指定された実行中のフローを強制終了します。
    強制終了が指定のタイムアウトまでに終わらなかった場合(その時間内にひとつのコンポーネントから 次のコンポーネントに制御が移ることがなかった場合)はExceptionとなります。 timeout=0の場合はタイムアウトせずに処理が終了するまで待ち続けます。 timeout< 0の場合はタイムアウト値としてリクエストしたフローのTimeoutプロパティの値が使用されます。
    String
    login(User user, long lifetime)
    ログインします。
    String
    login(String username, Password password, long lifetime)
    ログインします。
    boolean
    logout()
    ログアウトします。
    String
    post(FlowRequest request)
    フローの実行をポストします。
    実行をリクエストした後は実行の終了を待たずに制御が返ります。
    String
    postDebugRequest(FlowRequest request)
    フローのデバッグを予約します。
    boolean
    releaseSession(String sessionid)
    サーバからセッションを削除します。
    String
    rerun(String yyyyMMdd, String requestId)
    チェックポイントを実行します。
    実行を開始したら、再実行したリクエストのリクエストIDが返り値となります。

    Methods inherited from class com.infoteria.asteria.communication.client.AsteriaSessionClient

    authenticate, authenticate, checkLogin, getLicenseInfo, getLoginUser, getPassword, getProductVersion, getRetryHandler, getSessionId, getUserName, invokeMethod, invokeMethod, invokeMethodNotLoggedIn, invokeMethodNotLoggedIn, isLoggedIn, isSessionAlived, login, reconnect, setPassword, setRetryHandler, setUserName, validateServerVersion, validateVersion

    Methods inherited from class com.infoteria.asteria.communication.client.AsteriaClient

    getCallHandler, getProxyHost, getProxyPassword, getProxyPort, getProxyUsername, getStrPassword, getTimeout, getUsername, invokeMethod, invokeMethod, invokeMethodWithRetry, invokeMethodWithRetry, invokeMethodWithRetry, invokeMethodWithRetry, setCallHandler, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setStrPassword, setTimeout, setUsername

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FlowExecuteClient

      public FlowExecuteClient(String url)
      ASTERIAサーバのURLを指定してクライアントを作成します。
      特に変更していない場合、URLは「http://<SERVERNAME>:21381」となります。

    • FlowExecuteClient

      public FlowExecuteClient(com.infoteria.asteria.communication.client.AsteriaSessionClient client)
      他のclientのセッション(ログイン状態)を引き継いでクライアントを作成します。

  • Method Details

    • getContextType

      public com.infoteria.asteria.communication.client.CallHandlerInterface.ContextType getContextType()
      Overrides:
      getContextType in class com.infoteria.asteria.communication.client.AsteriaSessionClient

    • post

      public String post(FlowRequest request) throws FlowClientException
      フローの実行をポストします。
      実行をリクエストした後は実行の終了を待たずに制御が返ります。
      Specified by:
      post in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Parameters:
      request - 実行リクエスト
      Returns:
      リクエストID
      Throws:
      FlowClientException

    • postDebugRequest

      public String postDebugRequest(FlowRequest request) throws FlowClientException
      フローのデバッグを予約します。
      Parameters:
      request - 実行リクエスト
      Returns:
      デバッグの予約ID
      Throws:
      FlowClientException

    • execute

      public FlowResponse execute(FlowRequest request) throws FlowClientException
      フローを実行します。
      実行を開始したら、その終了を待って実行結果が返り値となります。
      Specified by:
      execute in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Parameters:
      request - 実行リクエスト
      Returns:
      実行結果オブジェクト
      Throws:
      FlowClientException

    • login

      public String login(String username, Password password, long lifetime) throws FlowClientException
      ログインします。
      Specified by:
      login in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Overrides:
      login in class com.infoteria.asteria.communication.client.AsteriaSessionClient
      Parameters:
      username - ドメインからのフルユーザ名
      password - パスワード
      lifetime - セッションライフタイム
      Returns:
      セッションID
      Throws:
      FlowClientException

    • login

      public String login(User user, long lifetime) throws FlowClientException
      ログインします。
      Specified by:
      login in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Overrides:
      login in class com.infoteria.asteria.communication.client.AsteriaSessionClient
      Parameters:
      user - Userオブジェクト
      lifetime - セッションライフタイム
      Returns:
      セッションID
      Throws:
      FlowClientException

    • logout

      public boolean logout() throws FlowClientException
      ログアウトします。
      Specified by:
      logout in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Overrides:
      logout in class com.infoteria.asteria.communication.client.AsteriaSessionClient
      Returns:
      ログアウトに成功した場合(サーバにログインセッションが存在しそれが削除された場合)はtrue
      Throws:
      FlowClientException

    • releaseSession

      public boolean releaseSession(String sessionid) throws FlowClientException
      サーバからセッションを削除します。
      Specified by:
      releaseSession in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Overrides:
      releaseSession in class com.infoteria.asteria.communication.client.AsteriaSessionClient
      Parameters:
      sessionid - セッションID
      Returns:
      セッション削除に成功した場合はtrue
      Throws:
      FlowClientException

    • killFlow

      public String killFlow(String requestId) throws FlowClientException
      killFlow(requestId, 5)と同じです。
      Specified by:
      killFlow in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Throws:
      FlowClientException

    • killFlow

      public String killFlow(String requestId, int timeout) throws FlowClientException
      リクエストIDで指定された実行中のフローを強制終了します。
      強制終了が指定のタイムアウトまでに終わらなかった場合(その時間内にひとつのコンポーネントから 次のコンポーネントに制御が移ることがなかった場合)はExceptionとなります。 timeout=0の場合はタイムアウトせずに処理が終了するまで待ち続けます。 timeout< 0の場合はタイムアウト値としてリクエストしたフローのTimeoutプロパティの値が使用されます。
      Specified by:
      killFlow in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Parameters:
      requestId - リクエストID
      Returns:
      強制終了に成功した場合に最後に実行されたコンポーネント名
      Throws:
      FlowClientException

    • rerun

      public String rerun(String yyyyMMdd, String requestId) throws FlowClientException
      チェックポイントを実行します。
      実行を開始したら、再実行したリクエストのリクエストIDが返り値となります。
      Specified by:
      rerun in interface com.infoteria.asteria.flowengine2.client.ExecuteClient
      Parameters:
      yyyyMMdd - 年月日
      requestId - リクエストID
      Returns:
      リクエストID
      Throws:
      FlowClientException