概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.8.8.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.fukurou.process
クラス Process_LDAPReader

    java.lang.Object
      org.opengion.fukurou.process.AbstractProcess
          org.opengion.fukurou.process.Process_LDAPReader

すべての実装されたインタフェース:
  FirstProcess, HybsProcess

    public class Process_LDAPReader

extends AbstractProcess
implements FirstProcess

Process_LDAPReaderは、LDAPから読み取った内容を、LineModel に設定後、 下流に渡す、FirstProcess インターフェースの実装クラスです。 LDAPから読み取った内容より、LineModelを作成し、下流(プロセスチェインは、 チェインしているため、データは上流から下流へと渡されます。)に渡します。 引数文字列中にスペースを含む場合は、ダブルコーテーション("") で括って下さい。 引数文字列の 『=』の前後には、スペースは挟めません。必ず、-key=value の様に 繋げてください。

形式サンプル:

       Process_LDAPReader -attrs=uid,cn,officeName,ou,mail,belongOUID -orderBy=uid -filter=(&(objectClass=person)(|(belongOUID=61200)(belongOUID=61100)))

         [ -initctx=コンテキストファクトリ   ] ：初期コンテキストファクトリ (初期値:com.sun.jndi.ldap.LdapCtxFactory)
         [ -providerURL=サービスプロバイダリ ] ：サービスプロバイダリ       (初期値:ldap://ldap.opengion.org:389)
         [ -entrydn=取得元の名前             ] ：属性の取得元のオブジェクトの名前 (初期値:cn=inquiry-sys,o=opengion,c=JP)
         [ -password=取得元のパスワード      ] ：属性の取得元のパスワード   (初期値:******)
         [ -searchbase=コンテキストベース名  ] ：検索するコンテキストのベース名 (初期値:soouid=employeeuser,o=opengion,c=JP)
         [ -searchScope=検索範囲             ] ：検索範囲。『OBJECT』『ONELEVEL』『SUBTREE』のどれか(初期値:SUBTREE)
         [ -timeLimit=検索制限時間           ] ：結果が返されるまでのミリ秒数。0 の場合無制限(初期値:0)
         [ -attrs=属性の識別子               ] ：エントリと一緒に返される属性の識別子。null の場合すべての属性
         [ -columns=属性のカラム名           ] ：属性の識別子に対する別名。識別子と同じ場合は『,』のみで区切る。
         [ -maxRowCount=最大検索数           ] ：最大検索数(初期値:0[無制限])
         [ -match_XXXX=正規表現              ] ：指定のカラムと正規表現で一致時のみ処理( -match_LANG=ABC=[a-zA-Z]* など。)
         [ -filter=検索条件                  ] ：検索する LDAP に指定する条件
         [ -referral=REFERAL                 ] ：ignore/follow/throw
         [ -display=[false/true]             ] ：結果を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])
         [ -debug=[false/true]               ] ：デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])

バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

フィールドの概要

クラス org.opengion.fukurou.process.AbstractProcess から継承されたフィールド
`CR, TAB`

コンストラクタの概要
`Process_LDAPReader()` デフォルトコンストラクター。

メソッドの概要
`void` | `end(boolean isOK)` プロセスの終了を行います。
`void` | `init(ParamProcess paramProcess)` プロセスの初期化を行います。
`static void` | `main(String[] args)` このクラスは、main メソッドから実行できません。
`LineModel` | `makeLineModel(int rowNo)` 最初に、 行データである LineModel を作成します FirstProcess は、次々と処理をチェインしていく最初の行データを 作成して、後続の ChainProcess クラスに処理データを渡します。
`boolean` | `next()` このデータの処理において、次の処理が出来るかどうかを問い合わせます。
`String` | `report()` プロセスの処理結果のレポート表現を返します。
`String` | `usage()` このクラスの使用方法を返します。

クラス org.opengion.fukurou.process.AbstractProcess から継承されたメソッド
`getArgument, logging, println, putArgument, putArgument, setLoggerProcess, toString`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

インタフェース org.opengion.fukurou.process.HybsProcess から継承されたメソッド
`logging, println, putArgument, putArgument, setLoggerProcess`

コンストラクタの詳細

### Process_LDAPReader

    public Process_LDAPReader()

  デフォルトコンストラクター。 このクラスは、動的作成されます。デフォルトコンストラクターで、 super クラスに対して、必要な初期化を行っておきます。

メソッドの詳細

### init

    public void init(ParamProcess paramProcess)

  プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理(ファイルオープン、ＤＢオープン等)に使用します。

  定義:
    インタフェース `HybsProcess` 内の `init`
  パラメータ:
    `paramProcess` - データベースの接続先情報などを持っているオブジェクト
  変更履歴:

    4.2.2.0 (2008/05/10) LDAP パスワード取得対応
    5.3.4.0 (2011/04/01) StringUtil.nval ではなく、getProparty の 初期値機能を使う
    5.6.7.0 (2013/07/27) REFERRAL対応

### end

    public void end(boolean isOK)

  プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理(ファイルクローズ、ＤＢクローズ等)に使用します。

  定義:
    インタフェース `HybsProcess` 内の `end`
  パラメータ:
    `isOK` - トータルで、OKだったかどうか[true:成功/false:失敗]

### next

    public boolean next()

  このデータの処理において、次の処理が出来るかどうかを問い合わせます。 この呼び出し１回毎に、次のデータを取得する準備を行います。

  定義:
    インタフェース `FirstProcess` 内の `next`
  戻り値:
    処理できる:true / 処理できない:false

### makeLineModel

    public LineModel makeLineModel(int rowNo)

  最初に、 行データである LineModel を作成します FirstProcess は、次々と処理をチェインしていく最初の行データを 作成して、後続の ChainProcess クラスに処理データを渡します。

  定義:
    インタフェース `FirstProcess` 内の `makeLineModel`
  パラメータ:
    `rowNo` - 処理中の行番号
  戻り値:
    処理変換後のLineModel
  変更履歴:

    4.2.2.0 (2008/05/10) LDAP パスワード取得対応

### report

    public String report()

  プロセスの処理結果のレポート表現を返します。 処理プログラム名、入力件数、出力件数などの情報です。 この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような 形式で出してください。

  定義:
    インタフェース `HybsProcess` 内の `report`
  戻り値:
    処理結果のレポート

### usage

    public String usage()

  このクラスの使用方法を返します。

  定義:
    インタフェース `HybsProcess` 内の `usage`
  戻り値:
    このクラスの使用方法

### main

    public static void main(String[] args)

  このクラスは、main メソッドから実行できません。

  パラメータ:
    `args` - コマンド引数配列

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.8.8.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.