パッケージ org.springframework
インターフェース LdapDataEntry
- すべての既知のサブインターフェース:
DirContextOperations
- すべての既知の実装クラス:
DirContextAdapter
public interface LdapDataEntry
LDAP ツリーのエントリに対する一般的なデータアクセス方法。
- 導入:
- 2.0
方法の概要
修飾子と型メソッド説明voidaddAttributeValue(StringSE name, ObjectSE value) 指定された名前の属性に値を追加します。voidaddAttributeValue(StringSE name, ObjectSE value, boolean addIfDuplicateExists) 指定された名前の属性に値を追加します。booleanattributeExists(StringSE name) 値があるかどうかに関係なく、オブジェクト属性が存在するかどうかを確認します。すべての属性を取得します。属性のすべての文字列値をSortedSetとして取得します。getDn()ベースパスに相対的な DN を返します。getObjectAttribute(StringSE name) オブジェクト属性の値を取得します。ObjectSE[]getObjectAttributes(StringSE name) オブジェクト属性のすべての値を取得します。getStringAttribute(StringSE name) 文字列属性の値を取得します。StringSE[]getStringAttributes(StringSE name) String 属性のすべての値を取得します。voidremoveAttributeValue(StringSE name, ObjectSE value) 指定された名前の属性から値を削除します。voidsetAttributeValue(StringSE name, ObjectSE value) nameという名前の をvalueに設定します。voidsetAttributeValues(StringSE name, ObjectSE[] values) 値の順序を無視して、複数値属性を設定します。voidsetAttributeValues(StringSE name, ObjectSE[] values, boolean orderMatters) 複数値属性を設定します。
メソッドの詳細
getStringAttribute
文字列属性の値を取得します。指定した属性に複数の属性値が存在する場合、最初の値のみが返されます。属性に値がない場合、nullが返されます。- パラメーター:
name- 属性の名前。- 戻り値:
- 存在する場合は属性の値、属性が存在しない場合、存在するが値がない場合は
null。 - 例外:
ClassCastExceptionSE- エントリの値が文字列でない場合。
getObjectAttribute
オブジェクト属性の値を取得します。指定した属性に複数の属性値が存在する場合、最初の値のみが返されます。属性に値がない場合、nullが返されます。- パラメーター:
name- 属性の名前。- 戻り値:
- 存在する場合はオブジェクトとしての属性値、または属性が存在しない場合、存在するが値がない場合は
null。
attributeExists
値があるかどうかに関係なく、オブジェクト属性が存在するかどうかを確認します。- パラメーター:
name- 属性の名前- 戻り値:
- 属性が存在する場合は
true、存在しない場合はfalse
setAttributeValue
- パラメーター:
name- 属性の名前。value- 属性に設定する値。- 例外:
IllegalArgumentExceptionSE- 値がNameSE インスタンスであり、現在存在する属性値の 1 つまたは複数がNameSE インスタンスまたは有効な識別名を表す文字列ではない場合。
setAttributeValues
値の順序を無視して、複数値属性を設定します。value が null または value.length == 0 の場合、属性は削除されます。更新モードの場合、配列に含まれるオブジェクトの数が多い場合または少ない場合、または 1 つ以上のオブジェクトが変更された場合にのみ変更が行われます。オブジェクトを並べ替えても、更新は行われません。値がNameSE インスタンスの場合、識別名の等価性が属性変更の計算に使用されます。- パラメーター:
name- 属性の ID。values- 属性値。- 例外:
IllegalArgumentExceptionSE- 値がNameSE インスタンスであり、現在存在する属性値の 1 つまたは複数がNameSE インスタンスまたは有効な識別名を表す文字列ではない場合。
setAttributeValues
複数値属性を設定します。値が null または value.length == 0 の場合、属性は削除されます。更新モードの場合、配列のオブジェクトの数が増減するか、1 つ以上の文字列が変更されると、変更が行われます。オブジェクトの順序を変更すると、orderMatters が true に設定されている場合にのみ更新が行われます。値がNameSE インスタンスの場合、属性の変更を計算するために識別名の等価性が使用されます。- パラメーター:
name- 属性の ID。values- 属性値。orderMatters-trueの場合、データが並べ替えられただけでも変更されます。- 例外:
IllegalArgumentExceptionSE- 値がNameSE インスタンスであり、現在存在する属性値の 1 つまたは複数がNameSE インスタンスまたは有効な識別名を表す文字列ではない場合。
addAttributeValue
指定された名前の属性に値を追加します。属性が存在しない場合は作成されます。このメソッドは、追加された値の重複がないことを確認します。値が存在する場合、再度追加されることはありません。値がNameSE インスタンスの場合、識別名の等価性が属性変更の計算に使用されます。- パラメーター:
name- 指定された値を追加する属性の名前。value- 追加する属性値。- 例外:
IllegalArgumentExceptionSE- 値がNameSE インスタンスであり、現在存在する属性値の 1 つまたは複数がNameSE インスタンスまたは有効な識別名を表す文字列ではない場合。
addAttributeValue
指定された名前の属性に値を追加します。属性が存在しない場合は作成されます。addIfDuplicateExistsパラメーターは、重複の処理を制御します。falseの場合、このメソッドは、追加された値の重複がないことを確認します。値が存在する場合、再度追加されることはありません。値がNameSE インスタンスの場合、識別名の等価性が属性変更の計算に使用されます。- パラメーター:
name- 指定された値を追加する属性の名前。value- 追加する属性値。addIfDuplicateExists-trueは、同じ値がすでに存在するかどうかに関係なく値を追加し、属性値の重複を許可します。値がすでに存在する場合、falseは値を追加しません。- 例外:
IllegalArgumentExceptionSE- 値がNameSE インスタンスであり、現在存在する属性値の 1 つまたは複数がNameSE インスタンスまたは有効な識別名を表す文字列ではない場合。
removeAttributeValue
指定された名前の属性から値を削除します。属性が存在しない場合は、何もしません。値がNameSE インスタンスの場合、識別名の等価性が属性変更の計算に使用されます。- パラメーター:
name- 指定された値を削除する属性の名前。value- 削除する値。- 例外:
IllegalArgumentExceptionSE- 値がNameSE インスタンスであり、現在存在する属性値の 1 つまたは複数がNameSE インスタンスまたは有効な識別名を表す文字列ではない場合。
getStringAttributes
String 属性のすべての値を取得します。- パラメーター:
name- 属性の名前。- 戻り値:
- 属性が定義されている場合は属性のすべての登録値を文字列として含む (場合によっては空の) 配列、それ以外の場合は
null。 - 例外:
IllegalArgumentExceptionSE- 属性値のいずれかが文字列でない場合。
getObjectAttributes
オブジェクト属性のすべての値を取得します。- パラメーター:
name- 属性の名前。- 戻り値:
- 属性が定義されている場合はその属性のすべての登録値を含む (場合によっては空の) 配列、それ以外の場合は
null。 - 導入:
- 1.3
getAttributeSortedStringSet
属性のすべての文字列値をSortedSetとして取得します。- パラメーター:
name- 属性の名前。- 戻り値:
- 属性のすべての値を含む
SortedSet、または属性が存在しない場合はnull。 - 例外:
IllegalArgumentExceptionSE- 見つかった属性値の 1 つを文字列にキャストできない場合。
getDn
NameSE getDn()ベースパスに相対的な DN を返します。 注意 : バージョン 2.0 以降、返される名前は LdapName インスタンスになります。- 戻り値:
- 現在のコンテキストの識別名。
- 関連事項:
getAttributes
AttributesSE getAttributes()すべての属性を取得します。- 戻り値:
- すべての属性。
- 導入:
- 1.3