sun.security.x509

Class URIName

java.lang.Object

sun.security.x509.URIName

All Implemented Interfaces:

GeneralNameInterface

public class URIName
extends java.lang.Object
implements GeneralNameInterface

This class implements the URIName as required by the GeneralNames ASN.1 object.

[RFC3280] When the subjectAltName extension contains a URI, the name MUST be stored in the uniformResourceIdentifier (an IA5String). The name MUST be a non-relative URL, and MUST follow the URL syntax and encoding rules specified in [RFC 1738]. The name must include both a scheme (e.g., "http" or "ftp") and a scheme-specific-part. The scheme- specific-part must include a fully qualified domain name or IP address as the host.

As specified in [RFC 1738], the scheme name is not case-sensitive (e.g., "http" is equivalent to "HTTP"). The host part is also not case-sensitive, but other components of the scheme-specific-part may be case-sensitive. When comparing URIs, conforming implementations MUST compare the scheme and host without regard to case, but assume the remainder of the scheme-specific-part is case sensitive.

[RFC1738] In general, URLs are written as follows:

 :
 

A URL contains the name of the scheme being used () followed by a colon and then a string (the ) whose interpretation depends on the scheme.

While the syntax for the rest of the URL may vary depending on the particular scheme selected, URL schemes that involve the direct use of an IP-based protocol to a specified host on the Internet use a common syntax for the scheme-specific data:

 //:@:/
 

[RFC2732] specifies that an IPv6 address contained inside a URL must be enclosed in square brackets (to allow distinguishing the colons that separate IPv6 components from the colons that separate scheme-specific data.

Author:

Amit Kapoor, Hemma Prafullchandra, Sean Mullan, Steve Hanna

See Also:

GeneralName, GeneralNames, GeneralNameInterface

Field Summary

Fields inherited from interface sun.security.x509.GeneralNameInterface

NAME_ANY, NAME_DIFF_TYPE, NAME_DIRECTORY, NAME_DNS, NAME_EDI, NAME_IP, NAME_MATCH, NAME_NARROWS, NAME_OID, NAME_RFC822, NAME_SAME_TYPE, NAME_URI, NAME_WIDENS, NAME_X400

Constructor Summary

Constructors

Constructor and Description
URIName(DerValue derValue) Create the URIName object from the passed encoded Der value.
URIName(java.lang.String name) Create the URIName object with the specified name.

Method Summary

Methods

Modifier and Type	Method and Description
int	constrains(GeneralNameInterface inputName) Return type of constraint inputName places on this name: NAME_DIFF_TYPE = -1: input name is different type from name (i.e.
void	encode(DerOutputStream out) Encode the URI name into the DerOutputStream.
boolean	equals(java.lang.Object obj) Compares this name with another, for equality.
java.lang.String	getHost() Return the host name or IP address portion of the URIName
java.lang.Object	getHostObject() Return the host object type; if host name is a DNSName, then this host object does not include any initial "." on the name.
java.lang.String	getName() Returns this URI name.
java.lang.String	getScheme() Return the scheme name portion of a URIName
int	getType() Return the type of the GeneralName.
java.net.URI	getURI() Returns the URIName as a java.net.URI object
int	hashCode() Returns the hash code value for this object.
static URIName	nameConstraint(DerValue value) Create the URIName object with the specified name constraint.
int	subtreeDepth() Return subtree depth of this name for purposes of determining NameConstraints minimum and maximum bounds and for calculating path lengths in name subtrees.
java.lang.String	toString() Convert the name into user readable string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

URIName

public URIName(DerValue derValue)
        throws java.io.IOException

Create the URIName object from the passed encoded Der value.

Parameters:

derValue - the encoded DER URIName.

Throws:

java.io.IOException - on error.

URIName

public URIName(java.lang.String name)
        throws java.io.IOException

Create the URIName object with the specified name.

Parameters:

name - the URIName.

Throws:

java.io.IOException - if name is not a proper URIName

Method Detail

nameConstraint

public static URIName nameConstraint(DerValue value)
                              throws java.io.IOException

Create the URIName object with the specified name constraint. URI name constraints syntax is different than SubjectAltNames, etc. See 4.2.1.11 of RFC 3280.

Parameters:

value - the URI name constraint

Throws:

java.io.IOException - if name is not a proper URI name constraint

getType

public int getType()

Return the type of the GeneralName.

Specified by:

getType in interface GeneralNameInterface

encode

public void encode(DerOutputStream out)
            throws java.io.IOException

Encode the URI name into the DerOutputStream.

Specified by:

encode in interface GeneralNameInterface

Parameters:

out - the DER stream to encode the URIName to.

Throws:

java.io.IOException - on encoding errors.

toString

public java.lang.String toString()

Convert the name into user readable string.

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Compares this name with another, for equality.

Overrides:

equals in class java.lang.Object

Returns:

true iff the names are equivalent according to RFC2459.

getURI

public java.net.URI getURI()

Returns the URIName as a java.net.URI object

getName

public java.lang.String getName()

Returns this URI name.

getScheme

public java.lang.String getScheme()

Return the scheme name portion of a URIName

getHost

public java.lang.String getHost()

Return the host name or IP address portion of the URIName

getHostObject

public java.lang.Object getHostObject()

Return the host object type; if host name is a DNSName, then this host object does not include any initial "." on the name.

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

constrains

public int constrains(GeneralNameInterface inputName)
               throws java.lang.UnsupportedOperationException

Return type of constraint inputName places on this name:

• NAME_DIFF_TYPE = -1: input name is different type from name (i.e. does not constrain).
• NAME_MATCH = 0: input name matches name.
• NAME_NARROWS = 1: input name narrows name (is lower in the naming subtree)
• NAME_WIDENS = 2: input name widens name (is higher in the naming subtree)
• NAME_SAME_TYPE = 3: input name does not match or narrow name, but is same type.

. These results are used in checking NameConstraints during certification path verification.

RFC3280: For URIs, the constraint applies to the host part of the name. The constraint may specify a host or a domain. Examples would be "foo.bar.com"; and ".xyz.com". When the the constraint begins with a period, it may be expanded with one or more subdomains. That is, the constraint ".xyz.com" is satisfied by both abc.xyz.com and abc.def.xyz.com. However, the constraint ".xyz.com" is not satisfied by "xyz.com". When the constraint does not begin with a period, it specifies a host.

Specified by:

constrains in interface GeneralNameInterface

Parameters:

inputName - to be checked for being constrained

Throws:

java.lang.UnsupportedOperationException - if name is not exact match, but narrowing and widening are not supported for this name type.

subtreeDepth

public int subtreeDepth()
                 throws java.lang.UnsupportedOperationException

Return subtree depth of this name for purposes of determining NameConstraints minimum and maximum bounds and for calculating path lengths in name subtrees.

Specified by:

subtreeDepth in interface GeneralNameInterface

Throws:

java.lang.UnsupportedOperationException - if not supported for this name type