クラス DistinguishedName
java.lang.ObjectSE
org.springframework.ldap.core.DistinguishedName
- 実装されているすべてのインターフェース:
SerializableSE、CloneableSE、ComparableSE<ObjectSE>、NameSE
使用すべきではありません。
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 を構築します。DistinguishedName(StringSE path) 使用すべきではありません。String から新しいDistinguishedNameを構築します。DistinguishedName(ListSE list) 使用すべきではありません。DistinguishedName(NameSE name) 使用すべきではありません。提供されたNameSE から新しいDistinguishedNameを構築します。メソッドのサマリー
修飾子と型メソッド説明使用すべきではありません。void使用すべきではありません。提供されたLdapRdnを指定されたインデックスに追加します。使用すべきではありません。void使用すべきではありません。提供されたキーと値を使用して、新しいLdapRdnを追加します。void使用すべきではありません。提供されたLdapRdnを Rdn のリストの最後に追加します。使用すべきではありません。使用すべきではありません。使用すべきではありません。提供されたキーと値を使用して、新しいLdapRdnを追加します。append(DistinguishedName path) 使用すべきではありません。この DistinguishedName の最後に LDAP パスを追加します。clone()使用すべきではありません。int使用すべきではありません。このインスタンスを別のオブジェクトと比較します。booleancontains(DistinguishedName path) 使用すべきではありません。このDistinguishedNameパスに別のパスが含まれているかどうかを判断します。encode()使用すべきではありません。DN として役立つ、ldap エンコードされた完全な LDAP パスを構築します。boolean使用すべきではありません。このDistinguishedNameが特定のパスで終了しているかどうかを判断します。boolean使用すべきではありません。get(int index) 使用すべきではありません。getAll()使用すべきではありません。getLdapRdn(int index) 使用すべきではありません。指定した位置のLdapRdnを取得します。getLdapRdn(StringSE key) 使用すべきではありません。指定されたキーを持つLdapRdnを取得します。getNames()使用すべきではありません。Listという名前を取得します。getPrefix(int index) 使用すべきではありません。getSuffix(int index) 使用すべきではありません。使用すべきではありません。指定したキー (属性値) を持つLdapRdnComponentの値を取得します。inthashCode()使用すべきではありません。使用すべきではありません。このインスタンスの不変のコピーを返します。static final DistinguishedNameimmutableDistinguishedName(StringSE dnString) 使用すべきではありません。定数として適した、不変の DistinguishedName インスタンスを作成します。booleanisEmpty()使用すべきではありません。protected final void使用すべきではありません。指定された String を解析し、このインスタンスが対応する識別名を表すようにします。voidprepend(DistinguishedName path) 使用すべきではありません。この DistinguishedName に最初に LDAP パスを追加します。remove(int arg0) 使用すべきではありません。使用すべきではありません。このDistinguishedNameの最初の部分を削除します。voidremoveFirst(NameSE path) 使用すべきではありません。このインスタンスがpathで始まる場合は、このDistinguishedNameの先頭から指定されたパスを削除します。使用すべきではありません。このDistinguishedNameの最後の部分を削除します。intsize()使用すべきではありません。booleanstartsWith(NameSE name) 使用すべきではありません。使用すべきではありません。このDistinguishedNameのコンパクトな String 表現を取得します。toString()使用すべきではありません。このDistinguishedNameの文字列表現を取得します。toUrl()使用すべきではありません。LDAP と URL がエンコードされた完全な LDAP パスを構築します。
フィールドの詳細
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
使用すべきではありません。DistinguishedName の作成時にキーを小文字に変換するか、キーを大文字に変換するか、キーを元の String のままにするか、つまり none にするかを決定するためにインスペクションされるシステムプロパティ。デフォルトでは、キーが小文字に変換されます。有効な値:
- 「下位」または空白または null (プロパティが設定されていません)
- " アッパー "
- "none"
KEY_CASE_FOLD_LOWER
使用すべきではありません。- 関連事項:
KEY_CASE_FOLD_UPPER
使用すべきではありません。- 関連事項:
KEY_CASE_FOLD_NONE
使用すべきではありません。- 関連事項:
EMPTY_PATH
使用すべきではありません。空の変更不可能な DistinguishedName。
コンストラクターの詳細
DistinguishedName
public DistinguishedName()使用すべきではありません。コンポーネントなしで新しい DistinguishedName を構築します。DistinguishedName
使用すべきではありません。String から新しいDistinguishedNameを構築します。- パラメーター:
path- (構文的に) 有効な LDAP パスに対応する文字列。
DistinguishedName
使用すべきではありません。- パラメーター:
list- このインスタンスを構成するコンポーネント。
DistinguishedName
使用すべきではありません。- パラメーター:
name- 新しいDistinguishedNameを構築するためのNameSE。
メソッドの詳細
parse
使用すべきではありません。指定された String を解析し、このインスタンスが対応する識別名を表すようにします。- パラメーター:
path- 解析する LDAP パス。
getLdapRdn
使用すべきではありません。指定した位置のLdapRdnを取得します。getLdapRdn
使用すべきではありません。- パラメーター:
key- 取得するLdapRdnの属性名。- 戻り値:
- リクエストされたキーを持つ
LdapRdn。 - 例外:
IllegalArgumentExceptionSE- 指定されたキーに一致する Rdn がない場合。
getValue
使用すべきではありません。指定したキー (属性値) を持つLdapRdnComponentの値を取得します。同じキーを持つ複数の Rdn がある場合は、最初に見つかった Rdn の値が (重要度の順に) 返されます。- パラメーター:
key- 取得するLdapRdnの属性名。- 戻り値:
- 値。
- 例外:
IllegalArgumentExceptionSE- 指定されたキーに一致する Rdn がない場合。
getNames
使用すべきではありません。Listという名前を取得します。- 戻り値:
- この
DistinguishedNameを構成するLdapRdnのリスト。
toCompactString
使用すべきではありません。このDistinguishedNameのコンパクトな String 表現を取得します。コンパクトにするために、各カンマの後にスペースを追加しないでください。- 戻り値:
- 構文的に正しく、適切にエスケープされた
DistinguishedNameの文字列表現。
encode
使用すべきではありません。DN として役立つ、LDAP エンコードされた完全な LDAP パスを構築します。常に小文字を使用し、常に ","、つまりカンマとスペースで区切ります。- 戻り値:
- LDAP パス。
toUrl
使用すべきではありません。LDAP と URL がエンコードされた完全な LDAP パスを構築します。"," のみで区切ります。- 戻り値:
- URL で使用する LDAP パス。
contains
使用すべきではありません。このDistinguishedNameパスに別のパスが含まれているかどうかを判断します。- パラメーター:
path- 確認するパス。- 戻り値:
- 指定されたパスがこのインスタンスに含まれている場合は
true、それ以外の場合はfalse。
append
使用すべきではありません。この 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
使用すべきではありません。提供されたキーと値を使用して、新しいLdapRdnを追加します。prepend
使用すべきではありません。この 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
使用すべきではありません。このDistinguishedNameの最初の部分を削除します。- 戻り値:
- 削除されたエントリ。
removeFirst
使用すべきではありません。このインスタンスがpathで始まる場合は、このDistinguishedNameの先頭から指定されたパスを削除します。DistinguishedNameからベースパスサフィックスを削除できます。- パラメーター:
path- このインスタンスの先頭から削除するパス。
clone
使用すべきではありません。equals
使用すべきではありません。hashCode
public int hashCode()使用すべきではありません。toString
使用すべきではありません。このDistinguishedNameの文字列表現を取得します。プロパティorg.springframework.ldap.core.spacedDnFormatの設定に応じて、結果を読みやすくするために、各カンマの後にスペースが追加されます。デフォルトはコンパクトな表現、つまりスペースなしです。compareTo
使用すべきではありません。このインスタンスを別のオブジェクトと比較します。比較は重要度の順に行われるため、最も重要な Rdn が最初に比較され、次に 2 番目の Rdn が比較されることに注意してください。- 次で指定:
- インターフェース
ComparableSE<ObjectSE>のcompareToSE - 次で指定:
- インターフェース
NameSEのcompareToSE - 関連事項:
size
public int size()使用すべきではありません。isEmpty
public boolean isEmpty()使用すべきではありません。getAll
使用すべきではありません。get
使用すべきではありません。getPrefix
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのgetPrefixSE
getSuffix
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのgetSuffixSE
startsWith
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのstartsWithSE
endsWith
使用すべきではありません。このDistinguishedNameが確実なパスで終了するかどうかを判断します。引数 path が空 (パス内に名前がない) の場合、このメソッドはfalseを返します。- 次で指定:
- インターフェース
NameSEのendsWithSE - パラメーター:
name- チェックするサフィックス。
addAll
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのaddAllSE - 例外:
InvalidNameExceptionSE
addAll
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのaddAllSE - 例外:
InvalidNameExceptionSE
add
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのaddSE - 例外:
InvalidNameExceptionSE
add
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのaddSE - 例外:
InvalidNameExceptionSE
remove
使用すべきではありません。- 次で指定:
- インターフェース
NameSEのremoveSE - 例外:
InvalidNameExceptionSE
removeLast
使用すべきではありません。このDistinguishedNameの最後の部分を削除します。- 戻り値:
- 取り外した
LdapRdn。
add
使用すべきではありません。提供されたキーと値を使用して、新しいLdapRdnを追加します。add
使用すべきではありません。提供されたLdapRdnを Rdn のリストの最後に追加します。- パラメーター:
rdn- 追加するLdapRdn
add
使用すべきではありません。提供されたLdapRdnを指定されたインデックスに追加します。- パラメーター:
idx- LdapRdn を追加するインデックス。rdn- 追加する LdapRdn。
immutableDistinguishedName
使用すべきではありません。このインスタンスの不変のコピーを返します。返されたインスタンスに対して Rdn を追加または削除することはできず、それぞれの Rdn も不変になります。- 戻り値:
- 不変のリストに裏付けられたこのインスタンスのコピー。
- 導入:
- 1.2
immutableDistinguishedName
使用すべきではありません。定数として適した、不変の DistinguishedName インスタンスを作成します。- パラメーター:
dnString- 解析する DN 文字列。- 戻り値:
- 指定された DN 文字列に対応する不変の DistinguishedName。
- 導入:
- 1.3
LdapUtilsのユーティリティメソッドと一緒にLdapNameSE を使用することをお勧めします。