クラス DistinguishedName

java.lang.ObjectSE
org.springframework.ldap.core.DistinguishedName
実装されているすべてのインターフェース:
SerializableSECloneableSEComparableSE<ObjectSE>NameSE

@DeprecatedSE public class DistinguishedName extends ObjectSE implements NameSE
使用すべきではありません。
2.0 では、代わりに LdapUtils のユーティリティメソッドと一緒に LdapNameSE を使用することをお勧めします。
LDAP パスに対応する NameSE のデフォルト実装。識別名操作の実装は JDK1.5 (LdapName) に含まれていますが、以前のリリースには含まれていません。DistinguishedName は、エスケープが処理されるため、LDAP パスを動的に構築または変更する場合に特に便利です。パスは複数の名前に分割されます。NameSE インターフェースは、最上位部分が位置 0 にあることを指定します。

例:

パス
uid=adam.skogman, ou= 人 , ou=EU
名前 [0]
ou=EU
名前 [1]
ou= 人
名前 [2]
uid=adam.skogman

Name インスタンス、DistinguishedName インスタンスは自然に変更可能であり、DistinguishedNames を構築するときに役立ちます。例:

 DistinguishedName path = new DistinguishedName("dc=jayway,dc=se");
 path.add("ou", "People");
 path.add("uid", "adam.skogman");
 String dn = path.toString();
 
uid=adam.skogman,ou=People,dc=jayway,dc=se をレンダリングします。

注意 : DistinguishedName インスタンスが変更可能であるという事実は、意図せずに変更される可能性があることを意味するため、慎重に考慮する必要があります。これは、DistinguishedName インスタンスが参照用 (ドメインエントリの識別など) または定数として保持される場合は常に、immutableDistinguishedName() または immutableDistinguishedName(String) を使用してインスタンスの不変コピーを取得することを検討する必要があることを意味します。

注意 : バージョン 1.3 以降、DistinguishedName のデフォルトの toString 表現は、それぞれの RDN 間にスペースがないコンパクトな表現にデフォルト設定されます。下位互換性を保つには、SPACED_DN_FORMAT_PROPERTY ( "org.springframework.ldap.core.spacedDnFormat" ) を true に設定してください。

関連事項:
  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final DistinguishedName
    使用すべきではありません。
    空の変更不可能な DistinguishedName。
    static final StringSE
    使用すべきではありません。
    static final StringSE
    使用すべきではありません。
    static final StringSE
    使用すべきではありません。
    DistinguishedName の作成がキーを小文字に変換するか、キーを大文字に変換するか、キーを元の文字列のままにするか (つまり none ) を決定するためにインスペクションされるシステムプロパティ。
    static final StringSE
    使用すべきではありません。
    static final StringSE
    使用すべきではありません。
    toString() が各コンマの後にスペースを含む DN をフォーマットするか、よりコンパクトな表現 (つまり、uid=adam.skogman,ou=People,dc=jayway,dc=se ではなく uid=adam.skogman, ou=People, dc=jayway, dc=se ) を使用するかを決定するためにインスペクションされるシステムプロパティ。
  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    使用すべきではありません。
    コンポーネントなしで新しい DistinguishedName を構築します。
    使用すべきではありません。
    String から新しい DistinguishedName を構築します。
    使用すべきではありません。
    提供された LdapRdn オブジェクトの List から新しい DistinguishedName を構築します。
    使用すべきではありません。
    提供された NameSE から新しい DistinguishedName を構築します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    add(int index, StringSE string)
    使用すべきではありません。
    void
    add(int idx, LdapRdn rdn)
    使用すべきではありません。
    提供された LdapRdn を指定されたインデックスに追加します。
    add(StringSE string)
    使用すべきではありません。
    void
    add(StringSE key, StringSE value)
    使用すべきではありません。
    提供されたキーと値を使用して、新しい LdapRdn を追加します。
    void
    使用すべきではありません。
    提供された LdapRdn を Rdn のリストの最後に追加します。
    addAll(int arg0, NameSE name)
    使用すべきではありません。
    使用すべきではありません。
    使用すべきではありません。
    提供されたキーと値を使用して、新しい LdapRdn を追加します。
    使用すべきではありません。
    この DistinguishedName の最後に LDAP パスを追加します。
    使用すべきではありません。
    int
    使用すべきではありません。
    このインスタンスを別のオブジェクトと比較します。
    boolean
    使用すべきではありません。
    この DistinguishedName パスに別のパスが含まれているかどうかを判断します。
    使用すべきではありません。
    DN として役立つ、ldap エンコードされた完全な LDAP パスを構築します。
    boolean
    使用すべきではありません。
    この DistinguishedName が特定のパスで終了しているかどうかを判断します。
    boolean
    使用すべきではありません。
    get(int index)
    使用すべきではありません。
    使用すべきではありません。
    getLdapRdn(int index)
    使用すべきではありません。
    指定した位置の LdapRdn を取得します。
    使用すべきではありません。
    指定されたキーを持つ LdapRdn を取得します。
    使用すべきではありません。
    List という名前を取得します。
    getPrefix(int index)
    使用すべきではありません。
    getSuffix(int index)
    使用すべきではありません。
    使用すべきではありません。
    指定したキー (属性値) を持つ LdapRdnComponent の値を取得します。
    int
    使用すべきではありません。
    使用すべきではありません。
    このインスタンスの不変のコピーを返します。
    static final DistinguishedName
    使用すべきではありません。
    定数として適した、不変の DistinguishedName インスタンスを作成します。
    boolean
    使用すべきではありません。
    protected final void
    使用すべきではありません。
    指定された String を解析し、このインスタンスが対応する識別名を表すようにします。
    void
    使用すべきではありません。
    この DistinguishedName に最初に LDAP パスを追加します。
    remove(int arg0)
    使用すべきではありません。
    使用すべきではありません。
    この DistinguishedName の最初の部分を削除します。
    void
    使用すべきではありません。
    このインスタンスが path で始まる場合は、この DistinguishedName の先頭から指定されたパスを削除します。
    使用すべきではありません。
    この DistinguishedName の最後の部分を削除します。
    int
    使用すべきではありません。
    boolean
    使用すべきではありません。
    使用すべきではありません。
    この DistinguishedName のコンパクトな String 表現を取得します。
    使用すべきではありません。
    この DistinguishedName の文字列表現を取得します。
    使用すべきではありません。
    LDAP と URL がエンコードされた完全な LDAP パスを構築します。

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

    finalize, getClass, notify, notifyAll, wait, waitSE, waitSE
  • フィールドの詳細

    • SPACED_DN_FORMAT_PROPERTY

      public static final StringSE SPACED_DN_FORMAT_PROPERTY
      使用すべきではありません。
      toString() が各コンマの後にスペースを使用して DN をフォーマットするか、よりコンパクトな表現 (すなわち、uid=adam.skogman,ou=People,dc=jayway,dc=se ではなく uid=adam.skogman, ou=People, dc=jayway, dc=se ) を使用するかを決定するためにインスペクションされるシステムプロパティ。null または空白以外の値を指定すると、スペース形式がトリガーされます。デフォルトはコンパクト表現です。

      有効な値:

      • 空白または null (プロパティが設定されていません)
      • 空白以外の値
      導入:
      1.3
      関連事項:
    • KEY_CASE_FOLD_PROPERTY

      public static final StringSE KEY_CASE_FOLD_PROPERTY
      使用すべきではありません。
      DistinguishedName の作成時にキーを小文字に変換するか、キーを大文字に変換するか、キーを元の String のままにするか、つまり none にするかを決定するためにインスペクションされるシステムプロパティ。デフォルトでは、キーが小文字に変換されます。

      有効な値:

      • 「下位」または空白または null (プロパティが設定されていません)
      • " アッパー "
      • "none"
      導入:
      1.3.1
      関連事項:
    • KEY_CASE_FOLD_LOWER

      public static final StringSE KEY_CASE_FOLD_LOWER
      使用すべきではありません。
      関連事項:
    • KEY_CASE_FOLD_UPPER

      public static final StringSE KEY_CASE_FOLD_UPPER
      使用すべきではありません。
      関連事項:
    • KEY_CASE_FOLD_NONE

      public static final StringSE KEY_CASE_FOLD_NONE
      使用すべきではありません。
      関連事項:
    • EMPTY_PATH

      public static final DistinguishedName EMPTY_PATH
      使用すべきではありません。
      空の変更不可能な DistinguishedName。
  • コンストラクターの詳細

    • DistinguishedName

      public DistinguishedName()
      使用すべきではありません。
      コンポーネントなしで新しい DistinguishedName を構築します。
    • DistinguishedName

      public DistinguishedName(StringSE path)
      使用すべきではありません。
      String から新しい DistinguishedName を構築します。
      パラメーター:
      path - (構文的に) 有効な LDAP パスに対応する文字列。
    • DistinguishedName

      public DistinguishedName(ListSE list)
      使用すべきではありません。
      提供された LdapRdn オブジェクトの List から新しい DistinguishedName を構築します。
      パラメーター:
      list - このインスタンスを構成するコンポーネント。
    • DistinguishedName

      public DistinguishedName(NameSE name)
      使用すべきではありません。
      提供された NameSE から新しい DistinguishedName を構築します。提供された NameSE の各部分は、構文的に正しい LdapRdn である必要があります。
      パラメーター:
      name - 新しい DistinguishedName を構築するための NameSE
  • メソッドの詳細

    • parse

      protected final void parse(StringSE path)
      使用すべきではありません。
      指定された String を解析し、このインスタンスが対応する識別名を表すようにします。
      パラメーター:
      path - 解析する LDAP パス。
    • getLdapRdn

      public LdapRdn getLdapRdn(int index)
      使用すべきではありません。
      指定した位置の LdapRdn を取得します。
      パラメーター:
      index - 取得する LdapRdn
      戻り値:
      LdapRdn をリクエストされた位置に配置します。
    • getLdapRdn

      public LdapRdn getLdapRdn(StringSE key)
      使用すべきではありません。
      指定されたキーを持つ LdapRdn を取得します。同じキーを持つ RdnSE が複数ある場合は、最初に見つかったものが (重要度の順に) 返されます。
      パラメーター:
      key - 取得する LdapRdn の属性名。
      戻り値:
      リクエストされたキーを持つ LdapRdn
      例外:
      IllegalArgumentExceptionSE - 指定されたキーに一致する Rdn がない場合。
    • getValue

      public StringSE getValue(StringSE key)
      使用すべきではありません。
      指定したキー (属性値) を持つ LdapRdnComponent の値を取得します。同じキーを持つ複数の Rdn がある場合は、最初に見つかった Rdn の値が (重要度の順に) 返されます。
      パラメーター:
      key - 取得する LdapRdn の属性名。
      戻り値:
      値。
      例外:
      IllegalArgumentExceptionSE - 指定されたキーに一致する Rdn がない場合。
    • getNames

      public ListSE getNames()
      使用すべきではありません。
      List という名前を取得します。
      戻り値:
      この DistinguishedName を構成する LdapRdn のリスト。
    • toCompactString

      public StringSE toCompactString()
      使用すべきではありません。
      この DistinguishedName のコンパクトな String 表現を取得します。コンパクトにするために、各カンマの後にスペースを追加しないでください。
      戻り値:
      構文的に正しく、適切にエスケープされた DistinguishedName の文字列表現。
    • encode

      public StringSE encode()
      使用すべきではありません。
      DN として役立つ、LDAP エンコードされた完全な LDAP パスを構築します。常に小文字を使用し、常に ","、つまりカンマとスペースで区切ります。
      戻り値:
      LDAP パス。
    • toUrl

      public StringSE toUrl()
      使用すべきではありません。
      LDAP と URL がエンコードされた完全な LDAP パスを構築します。"," のみで区切ります。
      戻り値:
      URL で使用する LDAP パス。
    • contains

      public boolean contains(DistinguishedName path)
      使用すべきではありません。
      この DistinguishedName パスに別のパスが含まれているかどうかを判断します。
      パラメーター:
      path - 確認するパス。
      戻り値:
      指定されたパスがこのインスタンスに含まれている場合は true、それ以外の場合は false
    • append

      public DistinguishedName append(DistinguishedName path)
      使用すべきではありません。
      この DistinguishedName の最後に LDAP パスを追加します。例:
       DistinguishedName name1 = new DistinguishedName("c=SE, dc=jayway, dc=se");
       DistinguishedName name2 = new DistinguishedName("ou=people");
       name1.append(name2);
       
      結果は ou=people, c=SE, dc=jayway, dc=se になります
      パラメーター:
      path - 追加するパス。
      戻り値:
      このインスタンス。
    • append

      public DistinguishedName append(StringSE key, StringSE value)
      使用すべきではありません。
      提供されたキーと値を使用して、新しい LdapRdn を追加します。
      パラメーター:
      key - LdapRdn のキー。
      value - LdapRdn の値。
      戻り値:
      このインスタンス。
    • prepend

      public void prepend(DistinguishedName path)
      使用すべきではありません。
      この DistinguishedName に最初に LDAP パスを追加します。例:
       DistinguishedName name1 = new DistinguishedName("ou=people");
       DistinguishedName name2 = new DistinguishedName("c=SE, dc=jayway, dc=se");
       name1.prepend(name2);
       
      結果は ou=people, c=SE, dc=jayway, dc=se になります
      パラメーター:
      path - 先頭に追加するパス。
    • removeFirst

      public LdapRdn removeFirst()
      使用すべきではありません。
      この DistinguishedName の最初の部分を削除します。
      戻り値:
      削除されたエントリ。
    • removeFirst

      public void removeFirst(NameSE path)
      使用すべきではありません。
      このインスタンスが path で始まる場合は、この DistinguishedName の先頭から指定されたパスを削除します。DistinguishedName からベースパスサフィックスを削除できます。
      パラメーター:
      path - このインスタンスの先頭から削除するパス。
    • clone

      public ObjectSE clone()
      使用すべきではありません。
      次で指定:
      インターフェース NameSEclone 
      オーバーライド:
      クラス ObjectSEclone 
      関連事項:
    • equals

      public boolean equals(ObjectSE obj)
      使用すべきではありません。
      オーバーライド:
      クラス ObjectSEequalsSE 
      関連事項:
    • hashCode

      public int hashCode()
      使用すべきではありません。
      オーバーライド:
      クラス ObjectSEhashCode 
      関連事項:
    • toString

      public StringSE toString()
      使用すべきではありません。
      この DistinguishedName の文字列表現を取得します。プロパティ org.springframework.ldap.core.spacedDnFormat の設定に応じて、結果を読みやすくするために、各カンマの後にスペースが追加されます。デフォルトはコンパクトな表現、つまりスペースなしです。
      オーバーライド:
      クラス ObjectSEtoString 
      戻り値:
      構文的に正しく、適切にエスケープされた DistinguishedName の文字列表現。
      関連事項:
    • compareTo

      public int compareTo(ObjectSE obj)
      使用すべきではありません。
      このインスタンスを別のオブジェクトと比較します。比較は重要度の順に行われるため、最も重要な Rdn が最初に比較され、次に 2 番目の Rdn が比較されることに注意してください。
      次で指定:
      インターフェース ComparableSE<ObjectSE>compareToSE 
      次で指定:
      インターフェース NameSEcompareToSE 
      関連事項:
    • size

      public int size()
      使用すべきではありません。
      次で指定:
      インターフェース NameSEsize 
    • isEmpty

      public boolean isEmpty()
      使用すべきではありません。
      次で指定:
      インターフェース NameSEisEmpty 
    • getAll

      public EnumerationSE getAll()
      使用すべきではありません。
      次で指定:
      インターフェース NameSEgetAll 
    • get

      public StringSE get(int index)
      使用すべきではありません。
      次で指定:
      インターフェース NameSEgetSE 
    • getPrefix

      public NameSE getPrefix(int index)
      使用すべきではありません。
      次で指定:
      インターフェース NameSEgetPrefixSE 
    • getSuffix

      public NameSE getSuffix(int index)
      使用すべきではありません。
      次で指定:
      インターフェース NameSEgetSuffixSE 
    • startsWith

      public boolean startsWith(NameSE name)
      使用すべきではありません。
      次で指定:
      インターフェース NameSEstartsWithSE 
    • endsWith

      public boolean endsWith(NameSE name)
      使用すべきではありません。
      この DistinguishedName が確実なパスで終了するかどうかを判断します。引数 path が空 (パス内に名前がない) の場合、このメソッドは false を返します。
      次で指定:
      インターフェース NameSEendsWithSE 
      パラメーター:
      name - チェックするサフィックス。
    • addAll

      public NameSE addAll(NameSE name) throws InvalidNameExceptionSE
      使用すべきではありません。
      次で指定:
      インターフェース NameSEaddAllSE 
      例外:
      InvalidNameExceptionSE
    • addAll

      public NameSE addAll(int arg0, NameSE name) throws InvalidNameExceptionSE
      使用すべきではありません。
      次で指定:
      インターフェース NameSEaddAllSE 
      例外:
      InvalidNameExceptionSE
    • add

      public NameSE add(StringSE string) throws InvalidNameExceptionSE
      使用すべきではありません。
      次で指定:
      インターフェース NameSEaddSE 
      例外:
      InvalidNameExceptionSE
    • add

      public NameSE add(int index, StringSE string) throws InvalidNameExceptionSE
      使用すべきではありません。
      次で指定:
      インターフェース NameSEaddSE 
      例外:
      InvalidNameExceptionSE
    • remove

      public ObjectSE remove(int arg0) throws InvalidNameExceptionSE
      使用すべきではありません。
      次で指定:
      インターフェース NameSEremoveSE 
      例外:
      InvalidNameExceptionSE
    • removeLast

      public LdapRdn removeLast()
      使用すべきではありません。
      この DistinguishedName の最後の部分を削除します。
      戻り値:
      取り外した LdapRdn
    • add

      public void add(StringSE key, StringSE value)
      使用すべきではありません。
      提供されたキーと値を使用して、新しい LdapRdn を追加します。
      パラメーター:
      key - LdapRdn のキー。
      value - LdapRdn の値。
    • add

      public void add(LdapRdn rdn)
      使用すべきではありません。
      提供された LdapRdn を Rdn のリストの最後に追加します。
      パラメーター:
      rdn - 追加する LdapRdn
    • add

      public void add(int idx, LdapRdn rdn)
      使用すべきではありません。
      提供された LdapRdn を指定されたインデックスに追加します。
      パラメーター:
      idx - LdapRdn を追加するインデックス。
      rdn - 追加する LdapRdn。
    • immutableDistinguishedName

      public DistinguishedName immutableDistinguishedName()
      使用すべきではありません。
      このインスタンスの不変のコピーを返します。返されたインスタンスに対して Rdn を追加または削除することはできず、それぞれの Rdn も不変になります。
      戻り値:
      不変のリストに裏付けられたこのインスタンスのコピー。
      導入:
      1.2
    • immutableDistinguishedName

      public static final DistinguishedName immutableDistinguishedName(StringSE dnString)
      使用すべきではありません。
      定数として適した、不変の DistinguishedName インスタンスを作成します。
      パラメーター:
      dnString - 解析する DN 文字列。
      戻り値:
      指定された DN 文字列に対応する不変の DistinguishedName。
      導入:
      1.3