パッケージ org.iplass.mtp.runtime

インタフェース EntryPoint

すべてのスーパーインタフェース:
AutoCloseable
public interface EntryPoint extends AutoCloseable

EntryPointを利用し、Servletコンテナ外のコード上から、 直接iPLAssの初期化・破棄、また特定のテナント・ユーザーを指定してのロジックの実行を行うことが可能です。 EntryPointは当該クラスがロードされるクラスローダ単位に一つのみ存在可能です。

EntryPointの利用例
   //initialize EntryPoint on application startup
   EntryPoint entryPoint = EntryPoint.builder()
       .config("/backend-service-config.xml")
       .serverRole("backendService")
       .build();
   
   :
   :
   
   //do process some logic while application is running
   entryPoint.withTenant(tenantId).withLang("en").run(() -> {
   
     :
     :
     
     Entity e = entityManager.load(oid, "SomeEntity");
     
     :
     :
     
   });
   
   :
   :
   
   //destroy EntryPoint when application is shutdown
   entryPoint.destroy();

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    static EntryPointBuilder
    builder()
    EntryPointのBuilderを取得します。
    default void
    close()
    AutoCloseableインタフェースのclose()メソッドの実装です。
    void
    destroy()
    EntryPointを破棄し、iPLAssが管理しているリソースを開放します。
    static EntryPoint
    getInstance()
    EntryPointのインスタンスを取得します。
    static EntryPoint
    init()
    EntryPointを初期化し、そのインスタンスを取得します。
    static boolean
    isInited()
    EntryPointがすでに初期化済みか否かを取得します。
    Runner
    runner()
    iPLAss内でロジックを実行するためのRunnerを取得します。
    default Runner
    withAuth(Credential credential)
    Credentialでログインした状態のRunnerのインスタンスを取得します。
    default Runner
    withLang(String lang)
    言語を指定した状態のRunnerのインスタンスを取得します。
    default Runner
    withTenant(Integer tenantId)
    テナントを指定した状態のRunnerのインスタンスを取得します。
    default Runner
    withTenant(String tenantUrl)
    テナントを指定した状態のRunnerのインスタンスを取得します。

  • メソッドの詳細

    • getInstance

      static EntryPoint getInstance()
      EntryPointのインスタンスを取得します。 EntryPointがまだ初期化されていない場合、 初期化したのちにそのインスタンスを取得します。
      戻り値:

    • init

      static EntryPoint init()
      EntryPointを初期化し、そのインスタンスを取得します。 すでに初期化済みのEntryPointが存在する場合、 AlreadyInitializedExceptionがスローされます。
      戻り値:
      EntryPointのインスタンス
      例外:
      AlreadyInitializedException - EntryPointが既に初期化済みの場合

    • builder

      static EntryPointBuilder builder()
      EntryPointのBuilderを取得します。 Builder経由で、EntryPointを構築する際のパラメータを指定可能です。
      戻り値:

    • isInited

      static boolean isInited()
      EntryPointがすでに初期化済みか否かを取得します。
      戻り値:

    • runner

      Runner runner()
      iPLAss内でロジックを実行するためのRunnerを取得します。
      戻り値:

    • withLang

      default Runner withLang(String lang)
      言語を指定した状態のRunnerのインスタンスを取得します。
      パラメータ:
      lang -
      戻り値:

    • withAuth

      default Runner withAuth(Credential credential)
      Credentialでログインした状態のRunnerのインスタンスを取得します。
      パラメータ:
      credential -
      戻り値:

    • withTenant

      default Runner withTenant(String tenantUrl)
      テナントを指定した状態のRunnerのインスタンスを取得します。
      パラメータ:
      tenantUrl - テナントURL（テナントのパス）
      戻り値:

    • withTenant

      default Runner withTenant(Integer tenantId)
      テナントを指定した状態のRunnerのインスタンスを取得します。
      パラメータ:
      tenantId - テナントID
      戻り値:

    • destroy

      void destroy()
      EntryPointを破棄し、iPLAssが管理しているリソースを開放します。

    • close

      default void close()
      AutoCloseableインタフェースのclose()メソッドの実装です。 destroy()を呼び出します。
      定義:
      close インタフェース内 AutoCloseable