X500Principal (Платформа Java SE 8 b92)

java.lang. Объект
- javax.security.auth.x500. X500Principal

Все Реализованные Интерфейсы:

Сериализуемый, Основной
```
public final class X500Principal
extends Object
implements Principal, Serializable
```
Этот class представляет X.500 Principal. X500Principals представляются отличительными именами, такими как "CN=Duke, OU=JavaSoft, Микросистемы O=Sun, C=US".
Этот class можно инстанцировать при использовании строкового представления отличительного имени, или при использовании ASN.1 DER закодированное представление байта отличительного имени. Текущая спецификация для строкового представления отличительного имени определяется в RFC 2253: Легкий Протокол (v3) Доступа Каталога: Строковое Представление UTF-8 Отличительных имен. Этот class, однако, принимает строковые форматы и от RFC 2253 и от RFC 1779: Строковое Представление Отличительных имен, и также распознает ключевые слова типа атрибута, OID которых (Объектные Идентификаторы) определяются в RFC 3280: Интернет Сертификат Инфраструктуры управления открытыми ключами X.509 и Профиль CRL.
Строковое представление для этого X500Principal может быть получен, вызывая getName методы.
Отметьте что getSubjectX500Principal и getIssuerX500Principal методы X509Certificate возвратите X500Principals, представляющий выпускающего и предметные области сертификата.

С тех пор:

1.4

См. Также:

X509Certificate, Сериализированная Форма

Полевая Сводка

Поля
Модификатор и Тип	Поле и Описание
`static String`	`КАНОНИЧЕСКИЙ` Канонический Строковый формат Отличительных имен.
`static String`	`RFC1779` Строковый формат RFC 1779 Отличительных имен.
`static String`	`RFC2253` Строковый формат RFC 2253 Отличительных имен.

Сводка конструктора

Конструкторы
Конструктор и Описание
`X500Principal(byte[] name)` Создает `X500Principal` от отличительного имени в ASN.1 DER закодированная форма.
`X500Principal(InputStream is)` Создает `X500Principal` от `InputStream` содержа отличительное имя в ASN.1 DER закодированная форма.
`X500Principal(String name)` Создает `X500Principal` от строкового представления отличительного имени X.500 (исключая: "CN=Duke, OU=JavaSoft, Микросистемы O=Sun, C=US").
`X500Principal(String name, Map<String,String> keywordMap)` Создает `X500Principal` от строкового представления отличительного имени X.500 (исключая: "CN=Duke, OU=JavaSoft, Микросистемы O=Sun, C=US").

Сводка метода

Все Методы Методы экземпляра Конкретные Методы
Модификатор и Тип	Метод и Описание
`boolean`	`equals(Object o)` Сравнивает указанное `Object` с этим `X500Principal` для равенства.
`byte[]`	`getEncoded()` Возвращает отличительное имя в ASN.1 DER закодированная форма.
`Строка`	`getName()` Возвращает строковое представление отличительного имени X.500, используя формат, определенный в RFC 2253.
`Строка`	`getName(String format)` Возвращает строковое представление отличительного имени X.500, используя указанный формат.
`Строка`	`getName(String format, Map<String,String> oidMap)` Возвращает строковое представление отличительного имени X.500, используя указанный формат.
`int`	`hashCode()` Возвратите хэш-код для этого `X500Principal`.
`Строка`	`toString()` Возвратите удобное для пользователя строковое представление этого `X500Principal`.

Методы, наследованные от class java.lang. Объект
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Методы, наследованные от интерфейса java.security. Принципал
подразумевает

- Полевая Деталь
  - RFC1779
```
public static final String RFC1779
```
    Строковый формат RFC 1779 Отличительных имен.
    
    См. Также:
    
    Постоянные Значения полей
  - RFC2253
```
public static final String RFC2253
```
    Строковый формат RFC 2253 Отличительных имен.
    
    См. Также:
    
    Постоянные Значения полей
  - КАНОНИЧЕСКИЙ
```
public static final String CANONICAL
```
    Канонический Строковый формат Отличительных имен.
    
    См. Также:
    
    Постоянные Значения полей
- Деталь конструктора
  - X500Principal
```
public X500Principal(String name)
```
    Создает X500Principal от строкового представления отличительного имени X.500 (исключая: "CN=Duke, OU=JavaSoft, Микросистемы O=Sun, C=US"). Отличительное имя должно быть определено, используя грамматику, определенную в RFC 1779, или RFC 2253 (любой формат является приемлемым).
    Этот конструктор распознает ключевые слова типа атрибута, определенные в RFC 1779 и RFC 2253 (и перечисленный в getName(String format)), так же как T, DNQ или DNQUALIFIER, ФАМИЛИЯ, GIVENNAME, ИНИЦИАЛЫ, ГЕНЕРАЦИЯ, EMAILADDRESS, и ключевые слова SERIALNUMBER, Объектные Идентификаторы которых (OID) определяются в RFC 3280 и его преемнике. Любой другой тип атрибута должен быть определен как OID.
    Эта реализация осуществляет более рестриктивный синтаксис OID чем определенный в RFC 1779 и 2253. Это использует более корректный синтаксис, определенный в RFC 4512, который определяет, что OID содержат по крайней мере 2 цифры:
    numericoid = number 1*( DOT number )
    
    Параметры:
    
    name - отличительное имя X.500 в формате RFC 1779 или RFC 2253
    
    Броски:
    
    NullPointerException - если name null
    
    IllegalArgumentException - если name ненадлежащим образом определяется
  - X500Principal
```
public X500Principal(String name,
                     Map<String,String> keywordMap)
```
    Создает X500Principal от строкового представления отличительного имени X.500 (исключая: "CN=Duke, OU=JavaSoft, Микросистемы O=Sun, C=US"). Отличительное имя должно быть определено, используя грамматику, определенную в RFC 1779, или RFC 2253 (любой формат является приемлемым).
    Этот конструктор распознает ключевые слова типа атрибута, определенные в X500Principal(String) и также распознает дополнительные ключевые слова, у которых есть записи в keywordMap параметр. Записи ключевого слова в keywordMap имеют приоритет по ключевым словам значения по умолчанию, распознанным X500Principal(String). Ключевые слова ДОЛЖНЫ быть определены во всем верхнем регистре, иначе они будут проигнорированы. Игнорируются ненадлежащим образом указанные ключевые слова; однако, если ключевое слово на имя отображается на ненадлежащим образом указанный Объектный Идентификатор (OID), IllegalArgumentException бросается. Допустимо иметь 2 различных ключевых слова, которые отображаются на тот же самый OID.
    Эта реализация осуществляет более рестриктивный синтаксис OID чем определенный в RFC 1779 и 2253. Это использует более корректный синтаксис, определенный в RFC 4512, который определяет, что OID содержат по крайней мере 2 цифры:
    numericoid = number 1*( DOT number )
    
    Параметры:
    
    name - отличительное имя X.500 в формате RFC 1779 или RFC 2253
    
    keywordMap - карта ключевого слова типа атрибута, где каждым ключом является Строка ключевого слова, которая отображается на соответствующий объектный идентификатор в Строковой форме (последовательность неотрицательных целых чисел, разделенных периодами). Карта может быть пустой, но никогда null.
    
    Броски:
    
    NullPointerException - если name или keywordMap null
    
    IllegalArgumentException - если name ненадлежащим образом определяется или ключевое слово в name карты к OID, который не находится в корректной форме
    
    С тех пор:
    
    1.6
  - X500Principal
```
public X500Principal(byte[] name)
```
    Создает X500Principal от отличительного имени в ASN.1 DER закодированная форма. Нотация ASN.1 для этой структуры следующие.
```
 Name ::= CHOICE {
   RDNSequence }

 RDNSequence ::= SEQUENCE OF RelativeDistinguishedName

 RelativeDistinguishedName ::=
   SET SIZE (1 .. MAX) OF AttributeTypeAndValue

 AttributeTypeAndValue ::= SEQUENCE {
   type     AttributeType,
   value    AttributeValue }

 AttributeType ::= OBJECT IDENTIFIER

 AttributeValue ::= ANY DEFINED BY AttributeType
 ....
 DirectoryString ::= CHOICE {
       teletexString           TeletexString (SIZE (1..MAX)),
       printableString         PrintableString (SIZE (1..MAX)),
       universalString         UniversalString (SIZE (1..MAX)),
       utf8String              UTF8String (SIZE (1.. MAX)),
       bmpString               BMPString (SIZE (1..MAX)) }
 
```
    Параметры:
    
    name - байтовый массив, содержащий отличительное имя в ASN.1 DER закодированная форма
    
    Броски:
    
    IllegalArgumentException - если ошибка кодирования происходит (неправильная форма для DN)
  - X500Principal
```
public X500Principal(InputStream is)
```
    Создает X500Principal от InputStream содержа отличительное имя в ASN.1 DER закодированная форма. Нотация ASN.1 для этой структуры предоставляется в документации для X500Principal(byte[] name).
    Позиция чтения входного потока располагается в следующий доступный байт после закодированного отличительного имени.
    
    Параметры:
    
    is - InputStream содержа отличительное имя в ASN.1 DER закодированная форма
    
    Броски:
    
    NullPointerException - если InputStream null
    
    IllegalArgumentException - если ошибка кодирования происходит (неправильная форма для DN)
- Деталь метода
  - getName
```
public String getName()
```
    Возвращает строковое представление отличительного имени X.500, используя формат, определенный в RFC 2253.
    Этот метод эквивалентен вызову getName(X500Principal.RFC2253).
    
    Определенный:
    
    getName в интерфейсе Principal
    
    Возвраты:
    
    отличительное имя этого X500Principal
  - getName
```
public String getName(String format)
```
    Возвращает строковое представление отличительного имени X.500, используя указанный формат. Допустимые значения для формата являются "RFC1779", "RFC2253", и "КАНОНИЧЕСКИЙ" (нечувствительный к регистру).
    Если "RFC1779" определяется как формат, этот метод испускает ключевые слова типа атрибута, определенные в RFC 1779 (CN, L, ST, O, OU, C, УЛИЦА). Любой другой тип атрибута испускается как OID.
    Если "RFC2253" определяется как формат, этот метод испускает ключевые слова типа атрибута, определенные в RFC 2253 (CN, L, ST, O, OU, C, УЛИЦА, DC, UID). Любой другой тип атрибута испускается как OID. При строгом чтении RFC 2253 только определяет строковое представление UTF-8. Строка, возвращенная этим методом, является строкой Unicode, достигнутой, декодируя это представление UTF-8.
    Если "КАНОНИЧЕСКИЙ" определяется как формат, этот метод возвращает RFC 2253 совместимое строковое представление со следующими дополнительными канонизациями:
    1. Начальные нули удаляются из типов атрибута, которые кодируются как отмеченные точкой десятичные OID
    2. Значения атрибута DirectoryString типа PrintableString и UTF8String не выводятся в шестнадцатеричном формате
    3. Значения атрибута DirectoryString типов кроме PrintableString и UTF8String выводятся в шестнадцатеричном формате
    4. Ведя и запаздывая пробельные символы удаляются из нешестнадцатеричных значений атрибута (если значение не состоит полностью из пробельных символов),
    5. Внутренние подстроки одного или более пробельных символов преобразовываются в одинарный интервал в нешестнадцатеричных значениях атрибута
    6. Относительные Отличительные имена, содержащие больше чем одну Проверку значения атрибута (AVA), выводятся в следующем порядке: алфавитное упорядочивание AVA, содержащих стандартные ключевые слова, сопровождаемые числовым упорядочиванием AVA, содержащих ключевые слова OID.
    7. Единственные символы в значениях атрибута, которых оставляют, являются теми, какой раздел 2.4 из состояний RFC 2253 нужно оставить (их оставляют, используя предыдущий символ наклонной черты влево),
    8. Все имя преобразовывается в прописное использование String.toUpperCase(Locale.US)
    9. Все имя преобразовывается в использование нижнего регистра String.toLowerCase(Locale.US)
    10. Имя наконец нормализуется, используя KD формы нормализации, как описано в Стандарте Unicode и UAX #15
    Дополнительные стандартные форматы могут быть представлены в будущем.
    Параметры:
    
    format - формат, чтобы использовать
    
    Возвраты:
    
    строковое представление этого X500Principal использование указанного формата
    
    Броски:
    
    IllegalArgumentException - если указанный формат является недопустимым или нулевым
  - getName
```
public String getName(String format,
                      Map<String,String> oidMap)
```
    Возвращает строковое представление отличительного имени X.500, используя указанный формат. Допустимые значения для формата являются "RFC1779" и (нечувствительным к регистру) "RFC2253". "КАНОНИЧЕСКИЙ" не разрешается и IllegalArgumentException будет брошен.
    Этот метод возвращает Строки в формате как определено в getName(String) и также испускает дополнительные ключевые слова типа атрибута для OID, у которых есть записи в oidMap параметр. Записи OID в oidMap имеют приоритет по OID значения по умолчанию, распознанным getName(String). Игнорируются ненадлежащим образом указанные OID; однако, если OID на имя отображается на ненадлежащим образом указанное ключевое слово, IllegalArgumentException бросается.
    Дополнительные стандартные форматы могут быть представлены в будущем.
    Предупреждение: дополнительные ключевые слова типа атрибута не могут быть распознаны другими реализациями; поэтому не используйте этот метод, если Вы неуверены, если эти ключевые слова будут распознаны другими реализациями.
    
    Параметры:
    
    format - формат, чтобы использовать
    
    oidMap - карта OID, где каждый ключ является объектным идентификатором в Строковой форме (последовательность неотрицательных целых чисел, разделенных периодами), который отображается на соответствующую Строку ключевого слова типа атрибута. Карта может быть пустой, но никогда null.
    
    Возвраты:
    
    строковое представление этого X500Principal использование указанного формата
    
    Броски:
    
    IllegalArgumentException - если указанный формат является недопустимым, нулевым, или OID на имя отображается на ненадлежащим образом указанное ключевое слово
    
    NullPointerException - если oidMap null
    
    С тех пор:
    
    1.6
  - getEncoded
```
public byte[] getEncoded()
```
    Возвращает отличительное имя в ASN.1 DER закодированная форма. Нотация ASN.1 для этой структуры предоставляется в документации для X500Principal(byte[] name).
    Отметьте, что возвращенный байтовый массив клонируется, чтобы защитить от последующих модификаций.
    
    Возвраты:
    
    байтовый массив, содержащий отличительное имя в ASN.1 DER закодированная форма
  - toString
```
public String toString()
```
    Возвратите удобное для пользователя строковое представление этого X500Principal.
    
    Определенный:
    
    toString в интерфейсе Principal
    
    Переопределения:
    
    toString в class Object
    
    Возвраты:
    
    строковое представление этого X500Principal
  - равняется
```
public boolean equals(Object o)
```
    Сравнивает указанное Object с этим X500Principal для равенства.
    Определенно, этот метод возвраты true если Object o X500Principal и если соответствующие канонические строковые представления (полученный через getName(X500Principal.CANONICAL) метод) этого объекта и o равны.
    Эта реализация совместима с требованиями RFC 3280.
    
    Определенный:
    
    equals в интерфейсе Principal
    
    Переопределения:
    
    equals в class Object
    
    Параметры:
    
    o - Объект, который будет сравнен для равенства с этим X500Principal
    
    Возвраты:
    
    true если указанное Object равно этому X500Principal, false иначе
    
    См. Также:
    
    Object.hashCode(), HashMap
  - хэш-код
```
public int hashCode()
```
    Возвратите хэш-код для этого X500Principal.
    Хэш-код вычисляется через: getName(X500Principal.CANONICAL).hashCode()
    
    Определенный:
    
    hashCode в интерфейсе Principal
    
    Переопределения:
    
    hashCode в class Object
    
    Возвраты:
    
    хэш-код для этого X500Principal
    
    См. Также:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2013, Oracle и/или его филиалы. Все права защищены.
Проект сборка-b92

Класс X500Principal

Полевая Сводка

Сводка конструктора

Сводка метода

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

Методы, наследованные от интерфейса java.security. Принципал

Полевая Деталь

RFC1779

RFC2253

КАНОНИЧЕСКИЙ

Деталь конструктора

X500Principal

X500Principal

X500Principal

X500Principal

Деталь метода

getName

getName

getName

getEncoded

toString

равняется

хэш-код