DnsName (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- org.minidns.util.SafeCharSequence
- - org.minidns.dnsname.DnsName

All Implemented Interfaces:
Serializable, CharSequence, Comparable<DnsName>
```
public final class DnsName
extends SafeCharSequence
implements Serializable, Comparable<DnsName>
```
A DNS name, also called "domain name". A DNS name consists of multiple 'labels' (see DnsLabel) and is subject to certain restrictions (see for example RFC 3696 § 2.).
Instances of this class can be created by using from(String).
This class holds three representations of a DNS name: ACE, raw ACE and IDN. ACE (ASCII Compatible Encoding), which can be accessed via ace, represents mostly the data that got send over the wire. But since DNS names are case insensitive, the ACE value is normalized to lower case. You can use getRawAce() to get the raw ACE data that was received, which possibly includes upper case characters. The IDN (Internationalized Domain Name), that is the DNS name as it should be shown to the user, can be retrieved using asIdn().
More information about Internationalized Domain Names can be found at:
- UTS #46 - Unicode IDNA Compatibility Processing
- RFC 8753 - Internationalized Domain Names for Applications (IDNA) Review for New Unicode Versions
See Also:
RFC 3696, DnsLabel, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`ace` The DNS name in ASCII Compatible Encoding (ACE).
`static DnsName`	`IN_ADDR_ARPA` IN_ADDR_ARPA.
`static DnsName`	`IP6_ARPA` IP6_ARPA.
`(package private) static int`	`MAX_DNSNAME_LENGTH_IN_OCTETS` See RFC 1035 § 2.3.4.
`static int`	`MAX_LABELS` MAX_LABELS.
`static DnsName`	`ROOT` ROOT.
`static boolean`	`VALIDATE` Whether or not the DNS name is validated on construction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`asIdn()` asIdn.
`int`	`compareTo(DnsName other)` compareTo.
`boolean`	`equals(Object other)` equals.
`static DnsName`	`from(CharSequence name)` from.
`static DnsName`	`from(CharSequence child, DnsName parent)` from.
`static DnsName`	`from(DnsLabel grandchild, DnsLabel child, DnsName parent)` from.
`static DnsName`	`from(DnsLabel child, DnsName parent)` from.
`static DnsName`	`from(DnsName... nameComponents)` from.
`static DnsName`	`from(DnsName child, DnsName parent)` Create a DNS name by "concatenating" the child under the parent name.
`static DnsName`	`from(String name)` from.
`static DnsName`	`from(String[] parts)` from.
`String`	`getAce()` Return the ACE (ASCII Compatible Encoding) version of this DNS name.
`byte[]`	`getBytes()` Serialize a domain name under IDN rules.
`String`	`getDomainpart()` Domainpart in ACE representation.
`String`	`getHostpart()` Hostpart in ACE representation.
`DnsLabel`	`getHostpartLabel()` getHostpartLabel.
`DnsLabel`	`getLabel(int labelNum)` getLabel.
`int`	`getLabelCount()` getLabelCount.
`DnsLabel[]`	`getLabels()` Get a copy of the labels of this DNS name.
`DnsName`	`getParent()` Return the parent of this DNS label.
`String`	`getRawAce()` Returns the raw ACE version of this DNS name.
`byte[]`	`getRawBytes()` getRawBytes.
`DnsLabel[]`	`getRawLabels()` Get a copy of the raw labels of this DNS name.
`int`	`hashCode()` hashCode.
`boolean`	`isChildOf(DnsName parent)` isChildOf.
`boolean`	`isDirectChildOf(DnsName parent)` isDirectChildOf.
`boolean`	`isRootLabel()` isRootLabel.
`static DnsName`	`parse(DataInputStream dis, byte[] data)` Parse a domain name starting at the current offset and moving the input stream pointer past this domain name (even if cross references occure).
`int`	`size()` size.
`DnsName`	`stripToLabels(int labelCount)` stripToLabels.
`String`	`toString()` toString.
`void`	`writeToStream(OutputStream os)` writeToStream.

Methods inherited from class org.minidns.util.SafeCharSequence
charAt, length, subSequence, toSafeString

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

Methods inherited from interface java.lang.CharSequence
chars, codePoints

- Field Detail
  - ace
```
public final String ace
```
    The DNS name in ASCII Compatible Encoding (ACE).
  - IN_ADDR_ARPA
```
public static final DnsName IN_ADDR_ARPA
```
    IN_ADDR_ARPA.
  - IP6_ARPA
```
public static final DnsName IP6_ARPA
```
    IP6_ARPA.
  - MAX_DNSNAME_LENGTH_IN_OCTETS
```
static final int MAX_DNSNAME_LENGTH_IN_OCTETS
```
    See RFC 1035 § 2.3.4.
    See Also:
    Constant Field Values
  - MAX_LABELS
```
public static final int MAX_LABELS
```
    MAX_LABELS.
    See Also:
    Constant Field Values
  - ROOT
```
public static final DnsName ROOT
```
    ROOT.
  - VALIDATE
```
public static boolean VALIDATE
```
    Whether or not the DNS name is validated on construction.
- Method Detail
  - asIdn
```
public String asIdn()
```
    asIdn.
  - compareTo
```
public int compareTo(DnsName other)
```
    compareTo.
    Specified by:
    compareTo in interface Comparable<DnsName>
  - equals
```
public boolean equals(Object other)
```
    equals.
    Overrides:
    equals in class Object
  - from
```
public static DnsName from(CharSequence name)
```
    from.
  - from
```
public static DnsName from(CharSequence child,
                           DnsName parent)
```
    from.
  - from
```
public static DnsName from(DnsLabel grandchild,
                           DnsLabel child,
                           DnsName parent)
```
    from.
  - from
```
public static DnsName from(DnsLabel child,
                           DnsName parent)
```
    from.
  - from
```
public static DnsName from(DnsName... nameComponents)
```
    from.
  - from
```
public static DnsName from(DnsName child,
                           DnsName parent)
```
    Create a DNS name by "concatenating" the child under the parent name. The child can also be seen as the "left" part of the resulting DNS name and the parent is the "right" part.
    For example using "i.am.the.child" as child and "of.this.parent.example" as parent, will result in a DNS name: "i.am.the.child.of.this.parent.example".
    Parameters:
    child - the child DNS name.
    parent - the parent DNS name.
    Returns:
    the resulting of DNS name.
  - from
```
public static DnsName from(String name)
```
    from.
  - from
```
public static DnsName from(String[] parts)
```
    from.
  - getAce
```
public String getAce()
```
    Return the ACE (ASCII Compatible Encoding) version of this DNS name. Note that this method may return a String containing null bytes. Those Strings are notoriously difficult to handle from a security perspective. Therefore it is recommended to use toString() instead, which will return a sanitized String.
    Returns:
    the ACE version of this DNS name.
  - getBytes
```
public byte[] getBytes()
```
    Serialize a domain name under IDN rules.
    Returns:
    The binary domain name representation.
  - getDomainpart
```
public String getDomainpart()
```
    Domainpart in ACE representation.
    Returns:
    the domainpart in ACE representation.
  - getHostpart
```
public String getHostpart()
```
    Hostpart in ACE representation.
    Returns:
    the hostpart in ACE representation.
  - getHostpartLabel
```
public DnsLabel getHostpartLabel()
```
    getHostpartLabel.
  - getLabel
```
public DnsLabel getLabel(int labelNum)
```
    getLabel.
  - getLabelCount
```
public int getLabelCount()
```
    getLabelCount.
  - getLabels
```
public DnsLabel[] getLabels()
```
    Get a copy of the labels of this DNS name. The resulting array will contain the labels in reverse order, that is, the top-level domain will be at res[0].
    Returns:
    an array of the labels in reverse order.
  - getParent
```
public DnsName getParent()
```
    Return the parent of this DNS label. Will return the root label if this label itself is the root label (because there is no parent of root).
    For example:
    - "foo.bar.org".getParent() == "bar.org"
    - ".".getParent() == "."
    Returns:
    the parent of this DNS label.
  - getRawAce
```
public String getRawAce()
```
    Returns the raw ACE version of this DNS name. That is, the version as it was received over the wire. Most notably, this version may include uppercase letters. Please refer to getAce() for a discussion of the security implications when working with the ACE representation of a DNS name.
    Returns:
    the raw ACE version of this DNS name.
    See Also:
    getAce()
  - getRawBytes
```
public byte[] getRawBytes()
```
    getRawBytes.
  - getRawLabels
```
public DnsLabel[] getRawLabels()
```
    Get a copy of the raw labels of this DNS name. The resulting array will contain the labels in reverse order, that is, the top-level domain will be at res[0].
    Returns:
    an array of the raw labels in reverse order.
  - hashCode
```
public int hashCode()
```
    hashCode.
    Overrides:
    hashCode in class Object
  - isChildOf
```
public boolean isChildOf(DnsName parent)
```
    isChildOf.
  - isDirectChildOf
```
public boolean isDirectChildOf(DnsName parent)
```
    isDirectChildOf.
  - isRootLabel
```
public boolean isRootLabel()
```
    isRootLabel.
  - parse
```
public static DnsName parse(DataInputStream dis,
                            byte[] data)
                     throws IOException
```
    Parse a domain name starting at the current offset and moving the input stream pointer past this domain name (even if cross references occure).
    Parameters:
    dis - The input stream.
    data - The raw data (for cross references).
    Returns:
    The domain name string.
    Throws:
    IOException - Should never happen.
  - size
```
public int size()
```
    size.
  - stripToLabels
```
public DnsName stripToLabels(int labelCount)
```
    stripToLabels.
  - toString
```
public String toString()
```
    toString.
    Specified by:
    toString in interface CharSequence
    Overrides:
    toString in class Object
  - writeToStream
```
public void writeToStream(OutputStream os)
                   throws IOException
```
    writeToStream.
    Throws:
    IOException

Class DnsName

Field Summary

Method Summary

Methods inherited from class org.minidns.util.SafeCharSequence

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Field Detail

ace

IN_ADDR_ARPA

IP6_ARPA

MAX_DNSNAME_LENGTH_IN_OCTETS

MAX_LABELS

ROOT

VALIDATE

Method Detail

asIdn

compareTo

equals

from

from

from

from

from

from

from

from

getAce

getBytes

getDomainpart

getHostpart

getHostpartLabel

getLabel

getLabelCount

getLabels

getParent

getRawAce

getRawBytes

getRawLabels

hashCode

isChildOf

isDirectChildOf

isRootLabel

parse

size

stripToLabels

toString

writeToStream