Java Doc for X500Principal.java in  » 6.0-JDK-Modules » j2me » javax » security » auth » x500 » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » javax.security.auth.x500 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

X500Principal
final public class X500Principal implements Principal,java.io.Serializable(Code)

This class represents an X.500 Principal. X500Principals are represented by distinguished names such as "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US".

This class can be instantiated by using a string representation of the distinguished name, or by using the ASN.1 DER encoded byte representation of the distinguished name. The current specification for the string representation of a distinguished name is defined in RFC 2253. This class, however, accepts string formats from both RFC 2253 and RFC 1779, and also recognizes attribute type keywords whose OIDs (Object Identifiers) are defined in RFC 2459.

The string representation for this X500Principal can be obtained by calling the getName methods.

Note that the getSubjectX500Principal and getIssuerX500Principal methods of X509Certificate return X500Principals representing the issuer and subject fields of the certificate.
version:
   1.22, 10/10/06
See Also:   java.security.cert.X509Certificate
since:
   1.4



Field Summary
final public static  StringCANONICAL
     Canonical String format of Distinguished Names.
final public static  StringRFC1779
     RFC 1779 String format of Distinguished Names.
final public static  StringRFC2253
     RFC 2253 String format of Distinguished Names.

Constructor Summary
 X500Principal(X500Name x500Name)
     Creates an X500Principal by wrapping an X500Name. NOTE: The constructor is package private.
public  X500Principal(String name)
     Creates an X500Principal from a string representation of an X.500 distinguished name (ex: "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US"). The distinguished name must be specified using the grammar defined in RFC 1779 or RFC 2253 (either format is acceptable).
public  X500Principal(byte[] name)
     Creates an X500Principal from a distinguished name in ASN.1 DER encoded form.
public  X500Principal(InputStream is)
     Creates an X500Principal from an InputStream containing the distinguished name in ASN.1 DER encoded form.

Method Summary
public  booleanequals(Object o)
     Compares the specified Object with this X500Principal for equality.
public  byte[]getEncoded()
     Returns the distinguished name in ASN.1 DER encoded form.
public  StringgetName()
     Returns a string representation of the X.500 distinguished name using the format defined in RFC 2253.
public  StringgetName(String format)
     Returns a string representation of the X.500 distinguished name using the specified format.
public  inthashCode()
     Return a hash code for this X500Principal.
public  StringtoString()
     Return a user-friendly string representation of this X500Principal.

Field Detail
CANONICAL
final public static String CANONICAL(Code)
Canonical String format of Distinguished Names.



RFC1779
final public static String RFC1779(Code)
RFC 1779 String format of Distinguished Names.



RFC2253
final public static String RFC2253(Code)
RFC 2253 String format of Distinguished Names.




Constructor Detail
X500Principal
X500Principal(X500Name x500Name)(Code)
Creates an X500Principal by wrapping an X500Name. NOTE: The constructor is package private. It is intended to be accessed using privileged reflection from classes in sun.security.*. Currently referenced from sun.security.x509.X500Name.asX500Principal().



X500Principal
public X500Principal(String name)(Code)
Creates an X500Principal from a string representation of an X.500 distinguished name (ex: "CN=Duke, OU=JavaSoft, O=Sun Microsystems, C=US"). The distinguished name must be specified using the grammar defined in RFC 1779 or RFC 2253 (either format is acceptable).

This constructor recognizes the attribute type keywords defined in RFC 1779 and RFC 2253 (and listed in X500Principal.getName(String format) getName(String format) ), as well as the T, DNQ or DNQUALIFIER, SURNAME, GIVENNAME, INITIALS, GENERATION, EMAILADDRESS, and SERIALNUMBER keywords whose OIDs are defined in RFC 2459 and its successor. Any other attribute type must be specified as an OID.
Parameters:
  name - an X.500 distinguished name in RFC 1779 or RFC 2253 format
exception:
  NullPointerException - if the nameis null
exception:
  IllegalArgumentException - if the nameis improperly specified




X500Principal
public X500Principal(byte[] name)(Code)
Creates an X500Principal from a distinguished name in ASN.1 DER encoded form. The ASN.1 notation for this structure is as follows.

 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)) }
 

Parameters:
  name - a byte array containing the distinguished name in ASN.1 DER encoded form
throws:
  IllegalArgumentException - if an encoding error occurs(incorrect form for DN)



X500Principal
public X500Principal(InputStream is)(Code)
Creates an X500Principal from an InputStream containing the distinguished name in ASN.1 DER encoded form. The ASN.1 notation for this structure is supplied in the documentation for X500Principal.X500Principal(byte[] name) X500Principal(byte[] name) .

The read position of the input stream is positioned to the next available byte after the encoded distinguished name.
Parameters:
  is - an InputStream containing the distinguishedname in ASN.1 DER encoded form
exception:
  NullPointerException - if the InputStreamis null
exception:
  IllegalArgumentException - if an encoding error occurs(incorrect form for DN)





Method Detail
equals
public boolean equals(Object o)(Code)
Compares the specified Object with this X500Principal for equality.

Specifically, this method returns true if the Object o is an X500Principal and if the respective canonical string representations (obtained via the getName(X500Principal.CANONICAL) method) of this object and o are equal.

This implementation is compliant with the requirements of RFC 2459.
Parameters:
  o - Object to be compared for equality with thisX500Principal true if the specified Object is equal to this X500Principal, false otherwise




getEncoded
public byte[] getEncoded()(Code)
Returns the distinguished name in ASN.1 DER encoded form. The ASN.1 notation for this structure is supplied in the documentation for X500Principal.X500Principal(byte[] name) X500Principal(byte[] name) .

Note that the byte array returned is cloned to protect against subsequent modifications. a byte array containing the distinguished name in ASN.1 DER encoded form




getName
public String getName()(Code)
Returns a string representation of the X.500 distinguished name using the format defined in RFC 2253.

This method is equivalent to calling getName(X500Principal.RFC2253). the distinguished name of this X500Principal




getName
public String getName(String format)(Code)
Returns a string representation of the X.500 distinguished name using the specified format. Valid values for the format are "RFC1779", "RFC2253", and "CANONICAL" (case insensitive).

If "RFC1779" is specified as the format, this method emits the attribute type keywords defined in RFC 1779 (CN, L, ST, O, OU, C, STREET). Any other attribute type is emitted as an OID.

If "RFC2253" is specified as the format, this method emits the attribute type keywords defined in RFC 2253 (CN, L, ST, O, OU, C, STREET, DC, UID). Any other attribute type is emitted as an OID. Under a strict reading, RFC 2253 only specifies a UTF-8 string representation. The String returned by this method is the Unicode string achieved by decoding this UTF-8 representation.

If "CANONICAL" is specified as the format, this method returns an RFC 2253 conformant string representation with the following additional canonicalizations:

  1. Leading zeros are removed from attribute types that are encoded as dotted decimal OIDs
  2. DirectoryString attribute values of type PrintableString and UTF8String are not output in hexadecimal format
  3. DirectoryString attribute values of types other than PrintableString and UTF8String are output in hexadecimal format
  4. Leading and trailing white space characters are removed from non-hexadecimal attribute values (unless the value consists entirely of white space characters)
  5. Internal substrings of one or more white space characters are converted to a single space in non-hexadecimal attribute values
  6. Relative Distinguished Names containing more than one Attribute Value Assertion (AVA) are output in the following order: an alphabetical ordering of AVAs containing standard keywords, followed by a numeric ordering of AVAs containing OID keywords.
  7. The only characters in attribute values that are escaped are those which section 2.4 of RFC 2253 states must be escaped (they are escaped using a preceding backslash character)
  8. The entire name is converted to upper case using String.toUpperCase(Locale.US)
  9. The entire name is converted to lower case using String.toLowerCase(Locale.US)
  10. The name is finally normalized using normalization form KD, as described in the Unicode Standard and UAX #15

Additional standard formats may be introduced in the future.
Parameters:
  format - the format to use a string representation of this X500Principalusing the specified format
throws:
  IllegalArgumentException - if the specified format is invalid




hashCode
public int hashCode()(Code)
Return a hash code for this X500Principal.

The hash code is calculated via: getName(X500Principal.CANONICAL).hashCode() a hash code for this X500Principal




toString
public String toString()(Code)
Return a user-friendly string representation of this X500Principal. a string representation of this X500Principal



Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.