Класс Rdn

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 не требует синхронизации.

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

Конструкторы

Rdn

public Rdn(Attributes attrSet)
    throws InvalidNameException

Параметры:

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.

См. также:

toString()

Методы

getValue

public Object getValue()

Возвращает:

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

getType

public String getType()

Возвращает:

Не нулевой тип атрибута.

toString

public String toString()

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

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

toString в классе Object

Возвращает:

Строковое представление Rdn.

compareTo

public int compareTo(Object obj)

Определено в:

compareTo в интерфейсе Comparable<Object>

Параметры:

obj - Не нулевой объект для сравнения.

Возвращает:

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

Исключения:

ClassCastException - если obj равен null или не является Rdn.

equals

public boolean equals(Object obj)

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

equals в классе Object

Параметры:

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

Возвращает:

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

См. также:

hashCode()

hashCode

public int hashCode()

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

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

hashCode в классе Object

Возвращает:

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

См. также:

equals(java.lang.Object)

toAttributes

public Attributes toAttributes()

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

Возвращает:

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

size

public int size()

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

Возвращает:

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

escapeValue

public static String escapeValue(Object val)

Параметры:

val - Не нулевой объект, который нужно экранировать.

Возвращает:

Экранированное строковое значение.

Исключения:

ClassCastException - если val не является String или массивом байтов.

unescapeValue

public static Object unescapeValue(String val)

Параметры:

val - Не нулевая строка, которую нужно раэкранировать.

Возвращает:

Разэкранированное значение.

Исключения:

IllegalArgumentException - Когда предоставлено незаконное значение.