com.infoteria.asteria.flowengine2.client
クラス FlowExecuteClient

java.lang.Object
  |
  +--com.infoteria.asteria.communication.client.AsteriaClient
        |
        +--com.infoteria.asteria.flowengine2.client.FlowExecuteClient

すべての実装インタフェース:

com.infoteria.asteria.communication.CommunicationConstant, com.infoteria.asteria.flowengine2.client.ExecuteClient

public class FlowExecuteClient

extends com.infoteria.asteria.communication.client.AsteriaClient

implements com.infoteria.asteria.flowengine2.client.ExecuteClient

外部のJavaプログラムからフローを実行するためのクライアントクラスです。

クラス com.infoteria.asteria.communication.client.AsteriaClient から継承した内部クラス

com.infoteria.asteria.communication.client.AsteriaClient.Param

クラス com.infoteria.asteria.communication.client.AsteriaClient から継承したフィールド

_client, _sessionId

インタフェース com.infoteria.asteria.communication.CommunicationConstant から継承したフィールド

AAC_SOAP_ENCODING, AUTHENTICATE_URI, CONNECTION_SOAP_ENCODING, CONNECTION_URI, FILE_SOAP_ENCODING, FILE_URI, FLOW_ADMIN_URI, FLOW_DEPLOY_URI, FLOW_EXECUTE_URI, FLOW_FUNCTIONLIB_URI, FLOW_HTTPCONTEXT_URI, FLOW_REPOSITORY_URI, FLOW_SOAP_ENCODING, LOG_SOAP_ENCODING, LOG_URI, REPOSITORY_SOAP_ENCODING, REPOSITORY_URI, SCENARIO_CONTROL_URI, SCENARIO_DEPLOY_URI, SCENARIO_REPOSITORY_URI, SCENARIO_SOAP_ENCODING, WEBFLOW_CONTROL_URI, WEBFLOW_DEPLOY_URI, WEBFLOW_REPOSITORY_URI

コンストラクタの概要

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

FlowExecuteClient(String url)
ASTERIAサーバのURLを指定してクライアントを作成します。

メソッドの概要

FlowResponse	execute(FlowRequest request) フローを実行します。
String	killFlow(String requestId) killFlow(requestId, -1)と同じです。
String	killFlow(String requestId, int timeout) リクエストIDで指定された実行中のフローを強制終了します。
String	login(String username, Password password, long lifetime) ログインします。
String	login(User user, long lifetime) ログインします。
boolean	logout() ログアウトします。
String	post(FlowRequest request) フローの実行をポストします。
boolean	releaseSession(String sessionid) サーバからセッションを削除します。

クラス com.infoteria.asteria.communication.client.AsteriaClient から継承したメソッド

authenticate, authenticate, checkLogin, getLicenseInfo, getLoginUser, getPassword, getProductVersion, getRetryHandler, getSessionId, getTimeout, getURL, getUserName, init, isLogined, isSessionAlived, issueCommand, issueCommand, issueCommand, issueCommand, issueCommand, issueCommand, issueCommandEx, issueCommandWithoutLogin, login, reconnect, setPassword, setRetryHandler, setTimeout, setUserName

クラス java.lang.Object から継承したメソッド

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

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient から継承したメソッド

post, removeBreakInfo, resume, resume, setBreakInfo, showRequest, showRequest, step, step, stepOut, stepOut, stepOver, stepOver, suspend, suspend

コンストラクタの詳細

FlowExecuteClient

public FlowExecuteClient(String url)

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

FlowExecuteClient

public FlowExecuteClient(com.infoteria.asteria.communication.client.AsteriaClient client)

他のAsteriaClientのセッション(ログイン状態)を引き継いでクライアントを作成します。

メソッドの詳細

post

public String post(FlowRequest request)
            throws FlowClientException

フローの実行をポストします。
実行をリクエストした後は実行の終了を待たずに制御が返ります。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の post

パラメータ:

request - 実行リクエスト

戻り値:

リクエストID

execute

public FlowResponse execute(FlowRequest request)
                     throws FlowClientException

フローを実行します。
実行を開始したら、その終了を待って実行結果が返り値となります。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の execute

パラメータ:

request - 実行リクエスト

戻り値:

実行結果オブジェクト

login

public String login(String username,
                    Password password,
                    long lifetime)
             throws FlowClientException

ログインします。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の login

オーバーライド:

クラス com.infoteria.asteria.communication.client.AsteriaClient 内の login

パラメータ:

username - ドメインからのフルユーザ名

password - パスワード

lifetime - セッションライフタイム

戻り値:

セッションID

login

public String login(User user,
                    long lifetime)
             throws FlowClientException

ログインします。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の login

オーバーライド:

クラス com.infoteria.asteria.communication.client.AsteriaClient 内の login

パラメータ:

user - Userオブジェクト

lifetime - セッションライフタイム

戻り値:

セッションID

logout

public boolean logout()
               throws FlowClientException

ログアウトします。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の logout

オーバーライド:

クラス com.infoteria.asteria.communication.client.AsteriaClient 内の logout

戻り値:

ログアウトに成功した場合(サーバにログインセッションが存在しそれが削除された場合)はtrue

releaseSession

public boolean releaseSession(String sessionid)
                       throws FlowClientException

サーバからセッションを削除します。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の releaseSession

オーバーライド:

クラス com.infoteria.asteria.communication.client.AsteriaClient 内の releaseSession

パラメータ:

sessionid - セッションID

戻り値:

セッション削除に成功した場合はtrue

killFlow

public String killFlow(String requestId)
                throws FlowClientException

killFlow(requestId, -1)と同じです。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の killFlow

killFlow

public String killFlow(String requestId,
                       int timeout)
                throws FlowClientException

リクエストIDで指定された実行中のフローを強制終了します。
強制終了が指定のタイムアウトまでに終わらなかった場合(その時間内にひとつのコンポーネントから 次のコンポーネントに制御が移ることがなかった場合)はExceptionとなります。 timeout=0の場合はタイムアウトせずに処理が終了するまで待ち続けます。 timeout<0の場合はタイムアウト値としてリクエストしたフローのTimeoutプロパティの値が使用されます。

定義:

インタフェース com.infoteria.asteria.flowengine2.client.ExecuteClient 内の killFlow

パラメータ:

requestId - リクエストID

戻り値:

強制終了に成功した場合に最後に実行されたコンポーネント名