Класс Rdn

java.lang.Object

javax.naming.ldap.Rdn

Все реализованные интерфейсы:: Serializable, Comparable<Object>

public class Rdn extends Object implements Serializable, Comparable<Object>

Этот класс представляет собой относительное отличительное имя (RDN), которое является компонентом отличительного имени, как указано в RFC 2253. Примером RDN является "OU=Sales+CN=J.Smith". В этом примере RDN состоит из нескольких пар типа/значения атрибута. RDN парсится, как описано в описании класса LdapName.

Класс Rdn представляет RDN как отображения типа/значения атрибута, которые можно просмотреть с помощью Attributes. Кроме того, он содержит вспомогательные методы, которые позволяют легко извлечь тип и значение, когда Rdn состоит из одной пары тип/значение, что является типичным вариантом использования. Он также содержит вспомогательные методы, которые позволяют экранировать неформатированное значение атрибута и отэкранировать значение, отформатированное в соответствии с синтаксисом экранирования, определённым в RFC2253. Для методов, которые принимают или возвращают значение атрибута в качестве объекта, значение является либо строкой (в неэкранированной форме), либо массивом байтов.

Rdn правильно проанализирует все допустимые RDN, но не пытается обнаружить все возможные нарушения при анализе недопустимых RDN. Он "щедр" в принятии недопустимых RDN. "Допустимость" имени определяется в конечном итоге, когда оно предоставляется серверу LDAP, который может принять или отклонить имя на основе таких факторов, как информация его схемы и соображения по межсетевому взаимодействию.

Следующий пример кода демонстрирует, как создать Rdn, используя конструктор, который принимает тип и значение в качестве аргументов:

      Rdn rdn = new Rdn("cn", "Juicy, Fruit");
      System.out.println(rdn.toString());

Последняя строка выведет cn=Juicy\, Fruit. Метод unescapeValue() можно использовать для отэкранирования экранированной запятой, что приведет к исходному значению "Juicy, Fruit". Метод escapeValue() добавляет обратно экранирование, предшествующее запятой.

Этот класс можно инициализировать строковым представлением RDN, определенным в RFC 2253, как показано в следующем примере кода:

      Rdn rdn = new Rdn("cn=Juicy\\, Fruit");
      System.out.println(rdn.toString());

Последняя строка выведет cn=Juicy\, Fruit.

Одновременный многопоточный чтение-только доступ к экземпляру Rdn не требует синхронизации.

Если не указано иное, поведение передачи null-аргумента в конструктор или метод в этом классе вызовет исключение NullPointerException.

С:

1.5

См. также:

Краткое описание конструкторов

Конструктор	Описание
`Rdn(String rdnString)`	Создаёт Rdn из заданной строки.
`Rdn(String type, Object value)`	Создаёт Rdn из заданного типа и значения атрибута.
`Rdn(Attributes attrSet)`	Создаёт Rdn из заданного набора атрибутов.
`Rdn(Rdn rdn)`	Создаёт Rdn из заданного `rdn`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`int`	`compareTo(Object obj)`	Сравнивает этот Rdn с указанным объектом для определения порядка.
`boolean`	`equals(Object obj)`	Сравнивает указанный объект с этим Rdn для проверки равенства.
`static String`	`escapeValue(Object val)`	Для заданного значения атрибута возвращает строку, экранированную в соответствии с правилами, указанными в RFC 2253.
`String`	`getType()`	Извлекает один из типов этого Rdn.
`Object`	`getValue()`	Извлекает одно из значений этого Rdn.
`int`	`hashCode()`	Возвращает хеш-код этого RDN.
`int`	`size()`	Извлекает количество пар тип/значение атрибута в этом Rdn.
`Attributes`	`toAttributes()`	Извлекает представление `Attributes` отображений тип/значение, содержащихся в этом Rdn.
`String`	`toString()`	Возвращает этот Rdn в виде строки, представленной в формате, определённом в RFC 2253 и описанном в описании класса для `LdapName`.
`static Object`	`unescapeValue(String val)`	Для заданной строки значения атрибута, отформатированной в соответствии с правилами, указанными в RFC 2253, возвращает неформатированное значение.

Методы, объявленные в классе java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

Rdn

public Rdn(Attributes attrSet) throws InvalidNameException

Создаёт Rdn из заданного набора атрибутов. См. Attributes.

Строковые значения атрибутов не интерпретируются как строки RDN в формате RFC 2253. То есть, значения используются буквально (не анализируются) и предполагается, что они не экранированы.

Параметры:: attrSet - Непустой и не нулевой набор атрибутов, содержащий соответствия тип/значение.
Исключения:: InvalidNameException - Если содержимое attrSet не может быть использовано для построения корректного RDN.

Rdn

public Rdn(String rdnString) throws InvalidNameException

Создаёт Rdn из заданной строки. Этот конструктор принимает строку, отформатированную в соответствии с правилами, определёнными в RFC 2253 и описанными в описании класса LdapName.

Параметры:: rdnString - Непустая и не нулевая строка в формате RFC2253.
Исключения:: InvalidNameException - Если при парсинге rdnString произошла синтаксическая ошибка.

Rdn

public Rdn(Rdn rdn)

Создаёт Rdn из заданного rdn. Содержимое rdn просто копируется в вновь созданный Rdn.

Параметры:: rdn - Не нулевой Rdn, который нужно скопировать.

Rdn

public Rdn(String type, Object value) throws InvalidNameException

Создаёт Rdn из заданного типа атрибута и значения. Строковые значения атрибутов не интерпретируются как строки RDN в формате RFC 2253. То есть, значения используются буквально (не анализируются) и предполагается, что они не экранированы.

Параметры:

type - Непустой и не нулевой строковый тип атрибута.

value - Непустой и не нулевой атрибут значение.

Исключения:

InvalidNameException - Если тип/значение не может быть использовано для построения корректного RDN.

См. также:

Подробное описание методов

getValue

public Object getValue()

Возвращает одно из значений этого Rdn. Это удобный метод для получения значения, когда RDN содержит одно соответствие тип/значение, что является распространённым использованием RDN.

Для многозначного RDN этот метод возвращает значение, соответствующее типу, возвращённому методом getType().

Возвращает:: Не нулевое значение атрибута.

getType

public String getType()

Возвращает один из типов этого Rdn. Это удобный метод для получения типа, когда RDN содержит одно соответствие тип/значение, что является распространённым использованием RDN.

Для многозначного RDN пары тип/значение не имеют определённого порядка. В этом случае этот метод возвращает тип одной из пар тип/значение. Метод getValue() возвращает значение, соответствующее типу, возвращённому этим методом.

Возвращает:: Не нулевой тип атрибута.

toString

public String toString()

Возвращает этот Rdn в виде строки, представленной в формате, определённом в RFC 2253 и описанном в описании класса LdapName.

Переопределяет:: toString в классе Object
Возвращает:: Строковое представление Rdn.

compareTo

public int compareTo(Object obj)

Сравнивает этот Rdn с заданным объектом для определения порядка. Возвращает отрицательное целое число, ноль или положительное целое число, в зависимости от того, меньше, равен или больше этот Rdn, чем заданный объект.

Если obj равен null или не является экземпляром Rdn, выбрасывается ClassCastException.

Пары тип/значение RDN сравниваются лексикографически. Порядок компонентов в многозначных Rdn (например, "ou=Sales+cn=Bob") не имеет значения.

Указано в:: compareTo в интерфейсе Comparable<Object>
Параметры:: obj - Не нулевой объект для сравнения.
Возвращает:: Отрицательное целое число, ноль или положительное целое число, в зависимости от того, меньше, равен или больше этот Rdn, чем заданный объект.
Исключения:: ClassCastException - если obj равен null или не является Rdn.

equals

public boolean equals(Object obj)

Сравнивает заданный объект с этим Rdn на равенство. Возвращает true, если заданный объект также является Rdn и два Rdn представляют одинаковые соответствия тип/значение. Порядок компонентов в многозначных Rdn (таких как "ou=Sales+cn=Bob") не имеет значения.

Сопоставление типов и значений на равенство выполняется следующим образом:

Типы сравниваются на равенство без учёта регистра.
Строковые значения с различными, но эквивалентными способами использования кавычек, экранирования или кодирования UTF8 в шестнадцатеричном формате считаются равными. При сравнении регистр значений игнорируется.

Если obj равен null или не является экземпляром Rdn, возвращается false.

Переопределяет:

equals в классе Object

Параметры:

obj - Объект для сравнения на равенство с этим Rdn.

Возвращает:

true, если заданный объект равен этому Rdn.

См. также:

hashCode

public int hashCode()

Возвращает хэш-код этого RDN. Два RDN, равные друг другу (в соответствии с методом equals), будут иметь одинаковый хэш-код.

Переопределяет:

hashCode в классе Object

Возвращает:

Целое число, представляющее хэш-код этого Rdn.

См. также:

toAttributes

public Attributes toAttributes()

Возвращает представление Attributes соответствий тип/значение, содержащихся в этом Rdn.

Возвращает:: Не нулевой набор атрибутов, содержащих соответствия тип/значение этого Rdn.

size

public int size()

Возвращает количество пар тип/значение атрибута в этом Rdn.

Возвращает:: Неотрицательное число пар тип/значение в этом Rdn.

escapeValue

public static String escapeValue(Object val)

Для заданного значения атрибута возвращает строку, экранированную в соответствии с правилами, указанными в RFC 2253.

Например, если val равно "Sue, Grabbit and Runn", экранированное значение, возвращаемое этим методом, равно "Sue\, Grabbit and Runn".

Строковое значение представляется как String, бинарное значение как массив байтов.

Параметры:: val - Не нулевой объект, подлежащий экранированию.
Возвращает:: Экранированное строковое значение.
Исключения:: ClassCastException - если val не является строкой или массивом байтов.

unescapeValue

public static Object unescapeValue(String val)

Для заданной строкового значения атрибута, отформатированного в соответствии с правилами, указанными в RFC 2253, возвращает неотформатированное значение. Экранированные символы и кавычки удаляются, а шестнадцатеричное кодирование UTF-8 преобразуется в эквивалентные символы UTF-16. Возвращает строковое значение как String, и бинарное значение как массив байтов.

Законные и незаконные значения определены в RFC 2253. Этот метод достаточно лоялен к значениям и не ловит все незаконные значения. Поэтому передача незаконного значения необязательно вызовет IllegalArgumentException.

Параметры:: val - Не нулевая строка, подлежащая разэкранированию.
Возвращает:: Разэкранированное значение.
Исключения:: IllegalArgumentException - Когда предоставлено незаконное значение.

© 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://download.java.net/java/early_access/jdk24/docs/api/java.naming/javax/naming/ldap/Rdn.html