X500Principal (Java Platform SE 8 )

java.lang.Object
- javax.security.auth.x500.X500Principal

All Implemented Interfaces:

Serializable， Principal
```
public final class X500Principal
extends Object
implements Principal, Serializable
```
这类代表一个X.500 Principal。X500Principals是由著名的名字如“CN =公爵表示，欧= JavaSoft，O = Sun Microsystems，C =我们”。

这个类可以利用的可分辨名称的字符串表示形式实例化，或通过使用ASN.1 DER编码的1字节表示尊敬的名字。对于一个可分辨名称的字符串表示形式的现行规范中定义的RFC 2253: Lightweight Directory Access Protocol (v3): UTF-8 String Representation of Distinguished Names。然而这类，接受的字符串格式在RFC 2253和RFC 1779: A String Representation of Distinguished Names，又认识到属性类型关键词的OID（对象标识符）是指在RFC 3280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile。

这X500Principal的字符串表示形式可以通过调用getName方法获得。

注意，X509Certificate返回x500principals表示该证书的颁发者和学科领域的getSubjectX500Principal和getIssuerX500Principal方法。

从以下版本开始：

一点四

另请参见：

X509Certificate， Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CANONICAL` 规范的区分名称的字符串格式。
`static String`	`RFC1779` RFC 1779格式字符串的可分辨名称。
`static String`	`RFC2253` RFC 2253格式字符串的可分辨名称。

构造方法摘要

构造方法
Constructor and Description
`X500Principal(byte[] name)` 创建一个 `X500Principal`从尊贵的名字在ASN.1 DER编码的形式1。
`X500Principal(InputStream is)` 创建从一个 `InputStream` ASN.1中包含的识别名的 `X500Principal` 1 DER编码的形式。
`X500Principal(String name)` 创建从一个X.500的字符串表示一个 `X500Principal`识别名称（例如：“CN =公爵欧= JavaSoft，O = Sun Microsystems，C =我们”）。
`X500Principal(String name, Map<String,String> keywordMap)` 创建从一个X.500的字符串表示一个 `X500Principal`识别名称（例如：“CN =公爵欧= JavaSoft，O = Sun Microsystems，C =我们”）。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` 指定的 `Object`这个 `X500Principal`平等的比较。
`byte[]`	`getEncoded()` 返回可分辨名称在ASN.1 DER编码的形式1。
`String`	`getName()` 返回一个字符串表示的X.500可分辨名称使用在RFC 2253中定义的格式。
`String`	`getName(String format)` 返回一个字符串表示的X.500可分辨名称使用指定的格式。
`String`	`getName(String format, Map<String,String> oidMap)` 返回一个字符串表示的X.500可分辨名称使用指定的格式。
`int`	`hashCode()` 返回这个 `X500Principal`哈希代码。
`String`	`toString()` 返回此 `X500Principal`友好的字符串表示形式。

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal
implies

- Field Detail
  - RFC1779
```
public static final String RFC1779
```
    RFC 1779格式字符串的可分辨名称。
    
    另请参见：
    
    Constant Field Values
  - RFC2253
```
public static final String RFC2253
```
    RFC 2253格式字符串的可分辨名称。
    
    另请参见：
    
    Constant Field Values
  - CANONICAL
```
public static final String CANONICAL
```
    规范的区分名称的字符串格式。
    
    另请参见：
    
    Constant Field Values
- Constructor Detail
  - X500Principal
```
public X500Principal(String name)
```
    创建从一个X.500的字符串表示一个 X500Principal识别名称（例如：“CN =公爵欧= JavaSoft，O = Sun Microsystems，C =我们”）。可分辨名称必须使用在RFC 1779和RFC 2253中定义的语法指定（或格式是可以接受的）。
    此构造函数识别属性类型的关键词在RFC 1779和RFC 2253定义（列在getName(String format)），以及T、DNQ或dnqualifier，姓givenName，缩写，代，地址，和序列号关键词的对象标识符（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)
```
    创建从一个X.500的字符串表示一个 X500Principal识别名称（例如：“CN =公爵欧= JavaSoft，O = Sun Microsystems，C =我们”）。可分辨名称必须使用在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 -属性类型关键字Map，其中每个键是一个字符串关键字映射到相应的对象标识符字符串形式（一个非负整数序列相隔时间）。Map可能是空的但不 null。
    
    异常
    
    NullPointerException -如果 name或 keywordMap是 null
    
    IllegalArgumentException -如果 name是正确指定的或在 nameMap关键字一个OID，形式不正确
    
    从以下版本开始：
    
    一点六
  - X500Principal
```
public X500Principal(byte[] name)
```
    创建一个 X500Principal从尊贵的名字在ASN.1 DER编码的形式1。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 - 1含专有名称的字节数组1 DER编码的形式。
    
    异常
    
    IllegalArgumentException如果编码发生错误（DN不正确的形式）
  - X500Principal
```
public X500Principal(InputStream is)
```
    创建从一个 InputStream ASN.1中包含的识别名的 X500Principal 1 DER编码的形式。ASN。这个结构表示1是在 X500Principal(byte[] name)
    输入流的读取位置被定位到下一个可用字节后编码的著名名称。
    提供的文件。
    
    参数
    
    is - InputStream ASN.1中含有的可分辨名称。1 DER编码的形式
    
    异常
    
    NullPointerException -如果 InputStream是 null
    
    IllegalArgumentException如果编码发生错误（DN不正确的形式）
- 方法详细信息
  - getName
```
public String getName()
```
    返回一个字符串表示的X.500可分辨名称使用在RFC 2253中定义的格式。
    这种方法相当于调用getName(X500Principal.RFC2253)。
    
    Specified by:
    
    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的字符串表示形式与下列附加canonicalizations：
    1. 前导零的编码为十进制OID属性类型删除
    2. directorystring属性值的类型printablestring和utf8string不是十六进制格式输出
    3. directorystring属性值类型以外的其他printablestring和utf8string是十六进制格式输出
    4. 前导和尾随空格字符是非进制属性值删除（除非价值完全由空格字符）
    5. 一个或多个空格字符内部的子字符串转换为一个单一的空间非进制属性值
    6. 相对可分辨名称包含多个属性值的断言（AVA）按以下顺序输出：一个按字母顺序的标准含关键词无序，后跟一个数字排序包含OID关键词无。
    7. 在逃脱了属性值唯一的人物是那些2.4节RFC 2253的状态必须被转义（他们逃脱了使用前的反斜杠字符）
    8. 整个名称转换为大写的使用String.toUpperCase(Locale.US)
    9. 整个名称转换为小写使用String.toLowerCase(Locale.US)
    10. 名字是最后归一化归一化形式KD，如Unicode标准和统一# 15
    额外的标准格式可能会在未来推出。
    参数
    
    format -格式
    
    结果
    
    使用指定的格式字符串表示这 X500Principal
    
    异常
    
    IllegalArgumentException -如果指定的格式无效或无效
  - getName
```
public String getName(String format,
                      Map<String,String> oidMap)
```
    返回一个字符串表示的X.500可分辨名称使用指定的格式。对于格式的有效值是“rfc1779”和“rfc2253”（不区分大小写）。”规范”是不允许的， IllegalArgumentException将抛出。
    此方法返回字符串的格式指定的getName(String)也发出额外的属性类型的关键词，在oidMap参数有输入OID。在oidmap OID项优先于默认的OID被getName(String)。正确指定的OID是忽略的；但是如果在名称映射一个OID的正确指定的关键词，一个IllegalArgumentException抛出。
    
    额外的标准格式可能会在未来推出。
    
    警告：附加属性类型的关键字可能不被其他实现所识别；因此如果您不确定这些关键字是否将被其他实现所识别，则不使用此方法。
    
    参数
    
    format -格式
    
    oidMap -一个老Map，其中每个键的字符串形式的对象标识符（一个非负整数序列相隔时间）映射到相应的属性类型关键字字符串。Map可能是空的但不 null。
    
    结果
    
    使用指定的格式字符串表示这 X500Principal
    
    异常
    
    IllegalArgumentException -如果指定的格式是无效的，无效的，或一个OID的名称映射到正确指定的关键词
    
    如果是 null oidMap NullPointerException
    
    从以下版本开始：
    
    一点六
  - getEncoded
```
public byte[] getEncoded()
```
    返回可分辨名称在ASN.1 DER编码的形式1。ASN。这个结构表示1是在 X500Principal(byte[] name)
    请注意，返回的字节数组被克隆，以防止后续的修改。
    提供的文件。
    
    结果
    
    一个字节数组包含识别名ASN.1 DER编码的形式1
  - toString
```
public String toString()
```
    返回此 X500Principal友好的字符串表示形式。
    
    Specified by:
    
    toString 接口 Principal
    
    重写：
    
    toString 方法重写，继承类 Object
    
    结果
    
    这 X500Principal字符串表示形式
  - equals
```
public boolean equals(Object o)
```
    指定的 Object这个 X500Principal平等的比较。
    具体而言，该方法返回true如果Object O是一个X500Principal如果各自典型的字符串表示形式（通过getName(X500Principal.CANONICAL)方法获得）这个对象和O是平等的。
    
    这个实现是符合RFC 3280的要求。
    
    Specified by:
    
    equals 接口 Principal
    
    重写：
    
    equals 方法重写，继承类 Object
    
    参数
    
    o对象进行比较，这 X500Principal平等
    
    结果
    
    true如果指定 Object等于这 X500Principal， false否则
    
    另请参见：
    
    Object.hashCode()， HashMap
  - hashCode
```
public int hashCode()
```
    返回这个 X500Principal哈希代码。
    哈希码的计算通过：getName(X500Principal.CANONICAL).hashCode()
    
    Specified by:
    
    hashCode 接口 Principal
    
    重写：
    
    hashCode 方法重写，继承类 Object
    
    结果
    
    这 X500Principal哈希代码
    
    另请参见：
    
    Object.equals(java.lang.Object)， System.identityHashCode(java.lang.Object)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

Class X500Principal

Field Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

Methods inherited from interface java.security.Principal

Field Detail

RFC1779

RFC2253

CANONICAL

Constructor Detail

X500Principal

X500Principal

X500Principal

X500Principal

方法详细信息

getName

getName

getName

getEncoded

toString

equals

hashCode