com.infoteria.asteria.flowengine2.thinclient
クラス FlowDeployClient

java.lang.Object
  |
  +--com.infoteria.asteria.flowengine2.thinclient.AsteriaClient
        |
        +--com.infoteria.asteria.flowengine2.thinclient.FlowDeployClient

public class FlowDeployClient
extends AsteriaClient

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


クラス com.infoteria.asteria.flowengine2.thinclient.AsteriaClient から継承したフィールド
_sessionId
 
コンストラクタの概要
FlowDeployClient(AsteriaClient client)
          別のASTERIAクライアントから接続先情報とログイン状態を引き継いでクライアントを作成します。
FlowDeployClient(String url)
          ASTERIAサーバーのURLを指定してクライアントを作成します。
FlowDeployClient(String server, int port)
          ASTERIAサーバーのサーバー名とポート番号を指定してクライアントを作成します。
 
メソッドの概要
 FlowInfo getFlowInfo(String projectName, String flowName)
          指定のプロジェクトにあるフローの情報を取得します。
 String[] getFlowList(String projectName)
          指定のプロジェクトにあるフロー名の一覧を取得します。
 Document getProjectDocument(String projectName)
          指定のプロジェクトのDocument(xfp)を取得します。
 String[] getProjectList()
          ログインユーザーのプロジェクト名の一覧を取得します。
 Trigger[] getTriggerList()
          すべての実行設定の一覧を取得します。
 Trigger[] getTriggerList(TriggerType type)
          種別を指定して実行設定の一覧を取得します。
 boolean registerProject(Document doc, String filepath)
          プロジェクトを登録します。
 Trigger registerTrigger(Trigger t)
          新規の実行設定を登録します。
 boolean unregisterProject(String projectName)
          プロジェクトを登録解除します。
 boolean unregisterProject(String projectName, boolean bDeleteFile)
          プロジェクトを登録解除します。
 boolean unregisterTrigger(Trigger t)
          実行設定を削除します。
 boolean updateTrigger(Trigger t)
          実行設定を更新します。
 
クラス com.infoteria.asteria.flowengine2.thinclient.AsteriaClient から継承したメソッド
login, login, logout, releaseSession
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

FlowDeployClient

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

FlowDeployClient

public FlowDeployClient(String server,
                        int port)
                 throws MalformedURLException
ASTERIAサーバーのサーバー名とポート番号を指定してクライアントを作成します。
パラメータ:
server - サーバー名またはIPアドレス
port - ポート番号

FlowDeployClient

public FlowDeployClient(AsteriaClient client)
別のASTERIAクライアントから接続先情報とログイン状態を引き継いでクライアントを作成します。
パラメータ:
client - ログイン済みのAsteriaClient
メソッドの詳細

getProjectList

public String[] getProjectList()
                        throws FlowClientException
ログインユーザーのプロジェクト名の一覧を取得します。
戻り値:
プロジェクト名の配列

getFlowList

public String[] getFlowList(String projectName)
                     throws FlowClientException
指定のプロジェクトにあるフロー名の一覧を取得します。
戻り値:
フロー名の配列

getFlowInfo

public FlowInfo getFlowInfo(String projectName,
                            String flowName)
                     throws FlowClientException
指定のプロジェクトにあるフローの情報を取得します。
戻り値:
フロー情報

getProjectDocument

public Document getProjectDocument(String projectName)
                            throws FlowClientException
指定のプロジェクトのDocument(xfp)を取得します。
戻り値:
プロジェクトのDocument

getTriggerList

public Trigger[] getTriggerList()
                         throws FlowClientException
すべての実行設定の一覧を取得します。
戻り値:
実行設定の配列

getTriggerList

public Trigger[] getTriggerList(TriggerType type)
                         throws FlowClientException
種別を指定して実行設定の一覧を取得します。
戻り値:
実行設定の配列

registerTrigger

public Trigger registerTrigger(Trigger t)
                        throws FlowClientException
新規の実行設定を登録します。
それぞれの実行設定でキーとなる項目が重複している場合は重複エラーになります。
戻り値:
登録された実行設定。ScheduleTriggerの場合にはScheduleIdが設定されているなど引数としたTriggerとは別のインスタンスになります。

unregisterTrigger

public boolean unregisterTrigger(Trigger t)
                          throws FlowClientException
実行設定を削除します。
引数となるTriggerはサーバーから取得したインスタンス(Trigger#isNewがfalse)である必要があります。
戻り値:
削除に成功した場合はtrue

updateTrigger

public boolean updateTrigger(Trigger t)
                      throws FlowClientException
実行設定を更新します。
引数となるTriggerはサーバーから取得したインスタンス(Trigger#isNewがfalse)である必要があります。
戻り値:
更新に成功した場合はtrue

registerProject

public boolean registerProject(Document doc,
                               String filepath)
                        throws FlowClientException
プロジェクトを登録します。
パラメータ:
doc - xfpファイルのDocument
filepath - プロジェクトを保存するパス(ホームディレクトリからの相対パス)
戻り値:
更新に成功した場合はtrue

unregisterProject

public boolean unregisterProject(String projectName)
                          throws FlowClientException
プロジェクトを登録解除します。
unregisterProject(projectName, false)と同じです。
戻り値:
登録解除に成功した場合はtrue

unregisterProject

public boolean unregisterProject(String projectName,
                                 boolean bDeleteFile)
                          throws FlowClientException
プロジェクトを登録解除します。
パラメータ:
project - プロジェクト名
bDeleteFile - xfpファイルを削除する場合はtrue
戻り値:
登録解除に成功した場合はtrue