Класс LdapName
- Все реализованные интерфейсы:
Serializable, Cloneable, Comparable<Object>, Name
public class LdapName extends Object implements Name
Этот класс разрешает некоторые неоднозначности RFC 2253 следующим образом:
- В RFC 2253 термин «пробельный символ» не определён. Вместо него используется символ ASCII-пробела 0x20 (« »).
- Пробелы допускаются по обе стороны от ',', ';', '=' и '+'. Такие пробелы допускаются, но не создаются этим кодом и игнорируются при сравнении имён.
- Допускаются строки AttributeValue, содержащие '=' или символы '#' (не в начальной позиции), если они не экранированы.
Строковые имена, передаваемые в LdapName или возвращаемые им, используют полный набор символов Unicode. Они также могут содержать символы, закодированные в UTF-8, где каждый октет представлен подстрокой из трёх символов, например "\\B4". Однако они не могут содержать символы, закодированные в UTF-8, где каждый октет представлен одним символом в строке: в таком случае смысл был бы неоднозначным.
LdapName корректно разбирает все допустимые имена, но при разборе недопустимых имён не пытается выявить все возможные нарушения. При принятии недопустимых имён он действует «снисходительно». Окончательно «допустимость» имени определяется при его передаче LDAP-серверу, который может принять или отклонить имя в зависимости от таких факторов, как сведения о его схеме и требования взаимодействия систем.
При проверке имён на равенство типы атрибутов, как двоичные, так и строковые значения, не учитывают регистр. Строковые значения с разными, но эквивалентными вариантами использования кавычек, экранирования или шестнадцатеричного кодирования UTF-8 считаются равными. Порядок компонентов в RDN с несколькими значениями (например, "ou=Sales+cn=Bob") не имеет значения.
Компоненты имени LDAP, то есть RDN, пронумерованы. Индексы имени LDAP с n компонентами RDN находятся в диапазоне от 0 до n-1. Этот диапазон можно записать как [0,n). Самый правый RDN имеет индекс 0, а самый левый RDN — индекс n-1. Например, отличительное имя "CN=Steve Kille, O=Isode Limited, C=GB" нумеруется в следующем порядке в диапазоне от 0 до 2: {C=GB, O=Isode Limited, CN=Steve Kille}. Пустое имя LDAP представлено пустым списком RDN.
Для параллельного многопоточного доступа только для чтения к экземпляру LdapName синхронизация не требуется.
Если не указано иное, передача аргумента null конструктору или методу этого класса приводит к выбрасыванию NullPointerException.
- Начиная с:
- 1.5
- См. также:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
LdapName |
Создаёт имя LDAP из указанного отличительного имени. |
LdapName |
Создаёт имя LDAP из его разобранных компонентов RDN. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Name |
add |
Добавляет один компонент в указанную позицию этого имени LDAP. |
Name |
add |
Добавляет один RDN в указанную позицию этого имени LDAP. |
Name |
add |
Добавляет один компонент в конец этого имени LDAP. |
Name |
add |
Добавляет один RDN в конец этого имени LDAP. |
Name |
addAll |
Добавляет RDN имени в указанную позицию этого имени, сохраняя их порядок. |
Name |
addAll |
Добавляет компоненты имени в указанную позицию этого имени, сохраняя их порядок. |
Name |
addAll |
Добавляет RDN имени в конец этого имени, сохраняя их порядок. |
Name |
addAll |
Добавляет компоненты имени в конец этого имени, сохраняя их порядок. |
Object |
clone() |
Создаёт новую копию этого имени. |
int |
compareTo |
Сравнивает это имя LdapName с указанным объектом, определяя порядок. |
boolean |
endsWith |
Определяет, образует ли указанная последовательность RDN суффикс этого имени LDAP. |
boolean |
endsWith |
Определяет, заканчивается ли это имя LDAP указанным суффиксом имени LDAP. |
boolean |
equals |
Определяет, равны ли два имени LDAP. |
String |
get |
Получает компонент этого имени LDAP в виде строки. |
Enumeration |
getAll() |
Получает компоненты этого имени в виде перечисления строк. |
Name |
getPrefix |
Создаёт имя, компоненты которого состоят из префикса компонентов этого имени LDAP. |
Rdn |
getRdn |
Получает RDN этого имени LDAP в виде Rdn. |
List |
getRdns() |
Получает список относительных отличительных имён. |
Name |
getSuffix |
Создаёт имя, компоненты которого состоят из суффикса компонентов этого имени LDAP. |
int |
hashCode() |
Вычисляет хеш-код этого имени LDAP. |
boolean |
isEmpty() |
Определяет, является ли это имя LDAP пустым. |
Object |
remove |
Удаляет компонент из этого имени LDAP. |
int |
size() |
Получает количество компонентов в этом имени LDAP. |
boolean |
startsWith |
Определяет, образует ли указанная последовательность RDN префикс этого имени LDAP. |
boolean |
startsWith |
Определяет, начинается ли это имя LDAP с указанного префикса имени LDAP. |
String |
toString() |
Возвращает строковое представление этого имени LDAP в формате, заданном RFC 2253 и описанном в описании класса. |
Подробное описание конструкторов
LdapName
public LdapName(String name) throws InvalidNameException
- Параметры:
-
name— отличительное имя, не равное null и отформатированное в соответствии с правилами, заданными в RFC 2253. - Выбрасывает:
-
InvalidNameException— если обнаружено нарушение синтаксиса. - См. также:
LdapName
public LdapName(List<Rdn> rdns)
Индексация RDN в списке соответствует нумерации RDN, описанной в описании класса.
- Параметры:
-
rdns— списокRdn, образующих это имя LDAP, не равный null.
Подробное описание методов
size
isEmpty
getAll
public Enumeration<String> getAll()
get
public String get(int posn)
- Определяется в:
-
getв интерфейсеName - Параметры:
-
posn— индекс компонента для получения, начиная с 0. Должен находиться в диапазоне [0,size()). - Возвращает:
- Компонент по индексу posn, не равный null.
- Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
getRdn
public Rdn getRdn(int posn)
- Параметры:
-
posn— индекс RDN для получения, начиная с 0. Должен находиться в диапазоне [0,size()). - Возвращает:
- RDN по индексу posn, не равный null.
- Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
getPrefix
public Name getPrefix(int posn)
- Определяется в:
-
getPrefixв интерфейсеName - Параметры:
-
posn— индекс компонента, на котором следует остановиться, начиная с 0. Должен находиться в диапазоне [0,size()]. - Возвращает:
- Экземпляр
LdapName, состоящий из компонентов с индексами в диапазоне [0,posn). Если posn равен нулю, возвращается пустое имя LDAP. - Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
getSuffix
public Name getSuffix(int posn)
- Определяется в:
-
getSuffixв интерфейсеName - Параметры:
-
posn— индекс компонента, с которого следует начать, начиная с 0. Должен находиться в диапазоне [0,size()]. - Возвращает:
- Экземпляр
LdapName, состоящий из компонентов с индексами в диапазоне [posn,size()). Если posn равен size(), возвращается пустое имя LDAP. - Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
startsWith
public boolean startsWith(Name n)
n является префиксом, если оно равно getPrefix(n.size()), то есть если это имя LDAP начинается с 'n'. Если n равно null или не является именем, отформатированным в соответствии с RFC2253, как описано в описании класса, возвращается false.- Определяется в:
-
startsWithв интерфейсеName - Параметры:
-
n— имя LDAP для проверки. - Возвращает:
- true, если
nявляется префиксом этого имени LDAP, иначе false. - См. также:
startsWith
public boolean startsWith(List<Rdn> rdns)
- Параметры:
-
rdns— проверяемая последовательностьRdn. - Возвращает:
- true, если
rdnsобразуют префикс этого имени LDAP, иначе false.
endsWith
public boolean endsWith(Name n)
n является суффиксом, если оно равно getSuffix(size()-n.size()), то есть если это имя LDAP заканчивается на 'n'. Если n равно null или не является именем, отформатированным в соответствии с RFC2253, как описано в описании класса, возвращается false.endsWith
public boolean endsWith(List<Rdn> rdns)
- Параметры:
-
rdns— проверяемая последовательностьRdn. - Возвращает:
- true, если
rdnsобразуют суффикс этого имени LDAP, иначе false.
addAll
public Name addAll(Name suffix) throws InvalidNameException
- Определяется в:
-
addAllв интерфейсеName - Параметры:
-
suffix— добавляемые компоненты, не равные null. - Возвращает:
- Обновлённое имя (не новый экземпляр).
- Выбрасывает:
-
InvalidNameException— еслиsuffixне является допустимым именем LDAP или добавление компонентов нарушает синтаксические правила этого имени LDAP.
addAll
public Name addAll(List<Rdn> suffixRdns)
- Параметры:
-
suffixRdns— добавляемые RDN суффиксаRdn, не равные null. - Возвращает:
- Обновлённое имя (не новый экземпляр).
addAll
public Name addAll(int posn, Name suffix) throws InvalidNameException
- Определяется в:
-
addAllв интерфейсеName - Параметры:
-
posn— индекс, в который нужно добавить новый компонент. Должен находиться в диапазоне [0,size()]. -
suffix— добавляемые компоненты, не равные null. - Возвращает:
- Обновлённое имя (не новый экземпляр).
- Выбрасывает:
-
InvalidNameException— еслиsuffixне является допустимым именем LDAP или добавление компонентов нарушает синтаксические правила этого имени LDAP. -
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
addAll
public Name addAll(int posn, List<Rdn> suffixRdns)
- Параметры:
-
posn— индекс, в который нужно добавить RDN суффикса. Должен находиться в диапазоне [0,size()]. -
suffixRdns— добавляемые RDN суффиксаRdn, не равные null. - Возвращает:
- Обновлённое имя (не новый экземпляр).
- Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
add
public Name add(String comp) throws InvalidNameException
- Определяется в:
-
addв интерфейсеName - Параметры:
-
comp— добавляемый компонент, не равный null. - Возвращает:
- Обновлённое имя LdapName (не новый экземпляр). Не может быть равно null.
- Выбрасывает:
-
InvalidNameException— если добавление comp в конец имени нарушает синтаксис имени.
add
public Name add(Rdn comp)
- Параметры:
-
comp— добавляемый RDN, не равный null. - Возвращает:
- Обновлённое имя LdapName (не новый экземпляр). Не может быть равно null.
add
public Name add(int posn, String comp) throws InvalidNameException
- Определяется в:
-
addв интерфейсеName - Параметры:
-
posn— индекс, в который нужно добавить новый компонент. Должен находиться в диапазоне [0,size()]. -
comp— добавляемый компонент, не равный null. - Возвращает:
- Обновлённое имя LdapName (не новый экземпляр). Не может быть равно null.
- Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона. -
InvalidNameException— если добавление comp в указанную позицию нарушает синтаксис имени.
add
public Name add(int posn, Rdn comp)
- Параметры:
-
posn— индекс, в который нужно добавить новый RDN. Должен находиться в диапазоне [0,size()]. -
comp— добавляемый RDN, не равный null. - Возвращает:
- Обновлённое имя LdapName (не новый экземпляр). Не может быть равно null.
- Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона.
remove
public Object remove(int posn) throws InvalidNameException
- Определяется в:
-
removeв интерфейсеName - Параметры:
-
posn— индекс удаляемого компонента. Должен находиться в диапазоне [0,size()). - Возвращает:
- Удалённый компонент (String).
- Выбрасывает:
-
IndexOutOfBoundsException— если posn находится вне указанного диапазона. -
InvalidNameException— если удаление компонента нарушает синтаксические правила имени.
getRdns
public List<Rdn> getRdns()
- Возвращает:
- Имя в виде списка RDN, являющихся экземплярами класса
Rdn.
clone
toString
equals
public boolean equals(Object obj)
Два имени LDAP равны, если каждый RDN одного имени равен соответствующему RDN другого. Это означает, что оба имени содержат одинаковое количество RDN и проверка equals() для каждого RDN относительно соответствующего RDN другого имени возвращает true. Определение равенства RDN см. в разделе Rdn.equals(Object obj).
compareTo
public int compareTo(Object obj)
Если obj равно null или не является экземпляром LdapName, выбрасывается ClassCastException.
Порядок имён LDAP определяется лексикографическими правилами сравнения строк с расширением, согласно которому сравнение применяется ко всем RDN в имени LDAP. Все RDN выстраиваются в заданном порядке и сравниваются лексикографически. Правила сравнения RDN см. в разделе Rdn.compareTo(Object obj).
Если это имя LDAP лексикографически меньше obj, возвращается отрицательное число. Если это имя LDAP лексикографически больше obj, возвращается положительное число.
- Определяется в:
-
compareToв интерфейсеComparable<Object> - Определяется в:
-
compareToв интерфейсеName - Параметры:
-
obj— экземпляр LdapName для сравнения, не равный null. - Возвращает:
- Отрицательное целое число, ноль или положительное целое число, если это имя меньше, равно или больше указанного obj соответственно.
- Выбрасывает:
-
ClassCastException— если obj равно null или не является LdapName. - См. также:
hashCode
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.naming/javax/naming/ldap/LdapName.html