net.rim.device.api.crypto.certificate
Interface DistinguishedName

All Superinterfaces:

Persistable

All Known Implementing Classes:

WTLSDistinguishedName, X509DistinguishedName

public interface DistinguishedName
extends Persistable

Represents a Distinguished Name used in a certificate.

See Also:

Certificate

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Method Summary
	String	getCommonName() Retrieve the common name attribute associated with this distinguished name.
	String	getCountry() Retrieve the country attribute associated with this distinguished name.
	String	getEmailAddress() Retrieve the email attribute associated with this distinguished name.
	byte[]	getEncoding() Returns the encoding of the DistinguishedName.
	String	getLocality() Retrieve the locality attribute associated with this distinguished name.
	Enumeration	getOIDs() Returns an enumeration of all the OIDs in the name.
	String	getOrganization() Retrieve the organization attribute associated with this distinguished name.
	String	getOrganizationalUnit() Retrieve the organization unit attribute associated with this distinguished name.
	String	getStateOrProvince() Retrieve the state-or-province attribute associated with this distinguished name.
	String	getString(OID oid) Retrieve the String associated with this object identifier (OID).
	String	getSurname() Retrieve the surname attribute associated with this distinguished name.
	String	toString() Convert the DistinguishedName to a standard string format.

Method Detail

getString

String getString(OID oid)

Retrieve the String associated with this object identifier (OID).

Parameters:

oid - The specified oid.

Returns:

A String representing the name. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getCommonName

String getCommonName()

Retrieve the common name attribute associated with this distinguished name.

Returns:

A String representing the common name. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getEmailAddress

String getEmailAddress()

Retrieve the email attribute associated with this distinguished name.

Returns:

A String representing the email address. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getSurname

String getSurname()

Retrieve the surname attribute associated with this distinguished name.

Returns:

A String representing the surname. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getCountry

String getCountry()

Retrieve the country attribute associated with this distinguished name.

Returns:

A String representing the country name. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getLocality

String getLocality()

Retrieve the locality attribute associated with this distinguished name.

Returns:

A String representing the locality. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getStateOrProvince

String getStateOrProvince()

Retrieve the state-or-province attribute associated with this distinguished name.

Returns:

A String representing the state or province name. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getOrganization

String getOrganization()

Retrieve the organization attribute associated with this distinguished name.

Returns:

A String representing the organization name. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getOrganizationalUnit

String getOrganizationalUnit()

Retrieve the organization unit attribute associated with this distinguished name.

Returns:

A String representing the name of the organizational unit. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

toString

String toString()

Convert the DistinguishedName to a standard string format.

Example output would be "CN=Joe Johnson, O=Company X, C=US".

Overrides:

toString in class Object

Returns:

A String.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getOIDs

Enumeration getOIDs()

Returns an enumeration of all the OIDs in the name.

Returns:

An Enumeration of OIDs.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getEncoding

byte[] getEncoding()

Returns the encoding of the DistinguishedName.

Returns:

A byte array containing the encoding. May be null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0