jp.co.denso.fa.jmscaosql

## クラス AbstructJmsClient

- java.lang.Object
- - jp.co.denso.fa.jmscaosql.AbstructJmsClient

- 直系の既知のサブクラス:
    JmsCaoSQLClient, JmsCaoSQLRmiClient

      public abstract class AbstructJmsClient
      extends Object

  jmsCaoSQLクライアントの抽象クラス
  バージョン:
    1.00
  作成者:
    DENSO WAVE

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected JmsCaoSQLConfigurator` | `config` 設定情報管理クラス。
    `protected boolean` | `isRunning` イベント監視状態。
    `protected String` | `KEY_CONTROLLER_NAMES` プロパティファイルのコントローラー名のKEY文字列
    `protected String` | `KEY_TOPIC_DELIMITER` Topicの区切り文字を取得するためのKEY文字列
    `protected String` | `KEY_TOPIC_PREFIX` Topic名の前に付与する文字列
    `protected JmsCaoSQLProducer` | `producer` JMSメッセージ送信実行オブジェクト

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `AbstructJmsClient()`

  - ### メソッドのサマリー

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `abstract void` | `attachListener(String ctrlName)` イベント監視対象コントローラーを追加
    `abstract void` | `detatchListener(String ctrlName)` コントローラーのイベント監視を解除します。
    `JmsCaoSQLProducer` | `getProducer()` JMSメッセージ送信実行オブジェクトを返します。
    `abstract List<String>` | `init()` 初期化処理を行います。
    `boolean` | `isRunning()` イベント監視状態を返します。
    `void` | `setProducer(JmsCaoSQLProducer producer)` JMSメッセージ送信実行オブジェクトを設定します。
    `protected void` | `sleep(int time)` 同期状態でスレッドを待機します。
    `abstract void` | `stop()` CaoSQLControllerのイベント監視を終了し、リソースを解放します。

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### フィールドの詳細

    - #### KEY_CONTROLLER_NAMES

          protected final String KEY_CONTROLLER_NAMES

      プロパティファイルのコントローラー名のKEY文字列
      関連項目:
        定数フィールド値

    - #### KEY_TOPIC_DELIMITER

          protected final String KEY_TOPIC_DELIMITER

      Topicの区切り文字を取得するためのKEY文字列
      関連項目:
        定数フィールド値

    - #### KEY_TOPIC_PREFIX

          protected final String KEY_TOPIC_PREFIX

      Topic名の前に付与する文字列
      関連項目:
        定数フィールド値

    - #### isRunning

          protected boolean isRunning

      イベント監視状態。

    - #### config

          protected JmsCaoSQLConfigurator config

      設定情報管理クラス。

    - #### producer

          @Autowired
          protected JmsCaoSQLProducer producer

      JMSメッセージ送信実行オブジェクト

  - ### コンストラクタの詳細

    - #### AbstructJmsClient

          public AbstructJmsClient()

  - ### メソッドの詳細

    - #### getProducer

          public JmsCaoSQLProducer getProducer()

      JMSメッセージ送信実行オブジェクトを返します。
      戻り値:
        JMSメッセージ送信実行オブジェクト

    - #### setProducer

          public void setProducer(JmsCaoSQLProducer producer)

      JMSメッセージ送信実行オブジェクトを設定します。
      パラメータ:
        `producer` - JMSメッセージ送信実行オブジェクト

    - #### isRunning

          public boolean isRunning()

      イベント監視状態を返します。
      戻り値:
        イベント監視状態

    - #### init

          public abstract List<String> init()
                                     throws Exception

      初期化処理を行います。
      jmscaosql.propertiesで指定されたCaoSQLControllerに対して、イベント監視を開始します。
      戻り値:
        イベント開始エラーとなったコントローラー名のリスト
      例外:
        `Exception`

    - #### stop

          public abstract void stop()

      CaoSQLControllerのイベント監視を終了し、リソースを解放します。

    - #### attachListener

          public abstract void attachListener(String ctrlName)
                                       throws Exception

      イベント監視対象コントローラーを追加
      パラメータ:
        `ctrlName` - コントローラー名
      例外:
        `Exception`

    - #### detatchListener

          public abstract void detatchListener(String ctrlName)
                                        throws Exception

      コントローラーのイベント監視を解除します。
      パラメータ:
        `ctrlName` - コントローラー名
      例外:
        `Exception`

    - #### sleep

          protected void sleep(int time)

      同期状態でスレッドを待機します。
      パラメータ:
        `time` - 待機時間(ミリ秒)

Copyright © 2017. All rights reserved.