Package com.infoteria.asteria.flowengine2.thinclient

Class FlowDeployClient

java.lang.Object
com.infoteria.asteria.flowengine2.thinclient.AsteriaClient
com.infoteria.asteria.flowengine2.thinclient.FlowDeployClient
public class FlowDeployClient extends AsteriaClient
外部のJavaプログラムからフロー情報を取得するためのクライアントクラスです。

  • Field Summary

    Fields inherited from class com.infoteria.asteria.flowengine2.thinclient.AsteriaClient

    _sessionId

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlowDeployClient(AsteriaClient client)
    別のASTERIAクライアントから接続先情報とログイン状態を引き継いでクライアントを作成します。
    FlowDeployClient(String url)
    ASTERIAサーバーのURLを指定してクライアントを作成します。
    特に変更していない場合、URLは「http://<SERVERNAME>:21381/flow-rpc」となります。
    FlowDeployClient(String server, int port)
    ASTERIAサーバーのサーバー名とポート番号を指定してクライアントを作成します。

  • Method Summary

    Modifier and Type
    Method
    Description
    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)
    プロジェクトを登録解除します。
    unregisterProject(projectName, false)と同じです。
    boolean
    unregisterProject(String projectName, boolean bDeleteFile)
    プロジェクトを登録解除します。
    boolean
    unregisterTrigger(Trigger t)
    実行設定を削除します。
    引数となるTriggerはサーバーから取得したインスタンス(Trigger#isNewがfalse)である必要があります。
    boolean
    updateTrigger(Trigger t)
    実行設定を更新します。
    引数となるTriggerはサーバーから取得したインスタンス(Trigger#isNewがfalse)である必要があります。

    Methods inherited from class com.infoteria.asteria.flowengine2.thinclient.AsteriaClient

    login, login, logout, releaseSession, setSSLSocketFactory

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FlowDeployClient

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

    • FlowDeployClient

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

    • FlowDeployClient

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

  • Method Details

    • getProjectList

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

    • getFlowList

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

    • getFlowInfo

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

    • getProjectDocument

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

    • getTriggerList

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

    • getTriggerList

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

    • registerTrigger

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

    • unregisterTrigger

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

    • updateTrigger

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

    • registerProject

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

    • unregisterProject

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

    • unregisterProject

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