com.infoteria.asteria.flowengine2.client
Class FlowExecuteClientRest

java.lang.Object
  |
  +--com.infoteria.asteria.communication.client.AsteriaClientRest
        |
        +--com.infoteria.asteria.communication.client.AsteriaSessionClientRest
              |
              +--com.infoteria.asteria.flowengine2.client.FlowExecuteClientRest
All Implemented Interfaces:
com.infoteria.asteria.communication.client.ClientInterface, com.infoteria.asteria.flowengine2.client.ExecuteClient

public class FlowExecuteClientRest
extends com.infoteria.asteria.communication.client.AsteriaSessionClientRest
implements com.infoteria.asteria.flowengine2.client.ExecuteClient

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


Fields inherited from class com.infoteria.asteria.communication.client.AsteriaClientRest
_callHandler
 
Constructor Summary
FlowExecuteClientRest(com.infoteria.asteria.communication.client.AsteriaSessionClientRest client)
          他のclientのセッション(ログイン状態)を引き継いでクライアントを作成します。
FlowExecuteClientRest(com.infoteria.asteria.communication.client.CallHandlerInterface callHandler)
           
 
Method Summary
 FlowResponse execute(FlowRequest request)
          フローを実行します。
実行を開始したら、その終了を待って実行結果が返り値となります。
 com.infoteria.asteria.communication.client.CallHandlerInterface.ContextType getContextType()
           
 java.lang.String killFlow(java.lang.String requestId)
          killFlow(requestId, 5)と同じです。
 java.lang.String killFlow(java.lang.String requestId, int timeout)
          リクエストIDで指定された実行中のフローを強制終了します。
強制終了が指定のタイムアウトまでに終わらなかった場合(その時間内にひとつのコンポーネントから 次のコンポーネントに制御が移ることがなかった場合)はExceptionとなります。 timeout=0の場合はタイムアウトせずに処理が終了するまで待ち続けます。 timeout<0の場合はタイムアウト値としてリクエストしたフローのTimeoutプロパティの値が使用されます。
 java.lang.String login(java.lang.String username, Password password, long lifetime)
          ログインします。
 java.lang.String login(User user, long lifetime)
          ログインします。
 boolean logout()
          ログアウトします。
 java.lang.String post(FlowRequest request)
          フローの実行をポストします。
実行をリクエストした後は実行の終了を待たずに制御が返ります。
 java.lang.String postDebugRequest(FlowRequest request)
          フローのデバッグを予約します。
 boolean releaseSession(java.lang.String sessionid)
          サーバからセッションを削除します。
 java.lang.String rerun(java.lang.String yyyyMMdd, java.lang.String requestId)
          チェックポイントを実行します。
実行を開始したら、再実行したリクエストのリクエストIDが返り値となります。
 
Methods inherited from class com.infoteria.asteria.communication.client.AsteriaSessionClientRest
authenticate, authenticate, checkLogin, getLicenseInfo, getLoginUser, getPassword, getProductVersion, getRetryHandler, getSessionId, getUserName, invokeMethod, invokeMethod, invokeMethodNotLoggedIn, invokeMethodNotLoggedIn, isLoggedIn, isSessionAlived, login, reconnect, setPassword, setRetryHandler, setUserName
 
Methods inherited from class com.infoteria.asteria.communication.client.AsteriaClientRest
getCallHandler, invokeMethod, invokeMethod, setCallHandler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.infoteria.asteria.flowengine2.client.ExecuteClient
post, removeBreakInfo, resume, resume, setBreakInfo, showRequest, showRequest, step, step, stepOut, stepOut, stepOver, stepOver, suspend, suspend
 

Constructor Detail

FlowExecuteClientRest

public FlowExecuteClientRest(com.infoteria.asteria.communication.client.CallHandlerInterface callHandler)

FlowExecuteClientRest

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

getContextType

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

post

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

postDebugRequest

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

execute

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

login

public java.lang.String login(java.lang.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.AsteriaSessionClientRest
Parameters:
username - ドメインからのフルユーザ名
password - パスワード
lifetime - セッションライフタイム
Returns:
セッションID

login

public java.lang.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.AsteriaSessionClientRest
Parameters:
user - Userオブジェクト
lifetime - セッションライフタイム
Returns:
セッションID

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.AsteriaSessionClientRest
Returns:
ログアウトに成功した場合(サーバにログインセッションが存在しそれが削除された場合)はtrue

releaseSession

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

killFlow

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

killFlow

public java.lang.String killFlow(java.lang.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:
強制終了に成功した場合に最後に実行されたコンポーネント名

rerun

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