HostTxtEntry (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.client.naming.HostTxtEntry

```
public class HostTxtEntry
extends Object
```
A hostname, b64 destination, and optional properties. Includes methods to sign and verify the entry. Used by addressbook to parse subscription data, and by i2ptunnel to generate signed metadata.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_ADDDEST` Action value: add a new destination
`static String`	`ACTION_ADDNAME` Action value: add a new hostname
`static String`	`ACTION_ADDSUBDOMAIN` Action value: add a subdomain entry
`static String`	`ACTION_CHANGEDEST` Action value: change an existing destination
`static String`	`ACTION_CHANGENAME` Action value: change an existing hostname
`static String`	`ACTION_REMOVE` Action value: remove an entry
`static String`	`ACTION_REMOVEALL` Action value: remove all entries
`static String`	`ACTION_UPDATE` Action value: update an existing entry
`static char`	`KV_SEPARATOR` Separator between name and destination in the hosts.txt line
`static String`	`PROP_ACTION` Property key for the action type (e.g.
`static String`	`PROP_DATE` Property key for the date timestamp (seconds since epoch)
`static String`	`PROP_DEST` Property key for the destination Base64 string
`static String`	`PROP_EXPIRES` Property key for the expiry time
`static String`	`PROP_NAME` Property key for the hostname
`static String`	`PROP_OLDDEST` Property key for the old destination (used in change operations)
`static String`	`PROP_OLDNAME` Property key for the old hostname (used in rename operations)
`static String`	`PROP_OLDSIG` Property key for the old signature for inner verification
`static char`	`PROP_SEPARATOR` Separator between individual properties
`static String`	`PROP_SIG` Property key for the signature
`static String`	`PROPS_SEPARATOR` Separator between the destination part and the properties part

Constructor Summary

Constructors
Constructor and Description
`HostTxtEntry(String sprops)` A 'remove' entry.
`HostTxtEntry(String name, String dest)` Create a new host text entry with name and destination, no properties.
`HostTxtEntry(String name, String dest, OrderedProperties props)` Create a new host text entry with optional properties.
`HostTxtEntry(String name, String dest, String sprops)` Create a new host text entry with name, destination, and serialized properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Compares Destination only, not properties
`String`	`getDest()` Return the Base64 destination.
`String`	`getName()` Return the hostname.
`OrderedProperties`	`getProps()` Return the properties, or null.
`int`	`hashCode()`
`boolean`	`hasValidInnerSig()` Verify with the "olddest" property's public key using the "oldsig" property
`boolean`	`hasValidRemoveSig()` Verify with the "dest" property's public key using the "sig" property
`boolean`	`hasValidSig()` Verify with the dest public key using the "sig" property
`void`	`sign(SigningPrivateKey spk)` Sign and set the "sig" property Must have been constructed with non-null properties.
`void`	`signInner(SigningPrivateKey spk)` Sign and set the "oldsig" property Must have been constructed with non-null properties.
`void`	`signRemove(SigningPrivateKey spk)` Sign as a "remove" line #!dest=dest#name=name#k1=v1#sig=sig...] Must have been constructed with non-null properties.
`void`	`write(BufferedWriter out)` Write as a standard line name=dest[#!k1=v1#k2=v2...] Includes newline.
`void`	`write(Writer out)` Write as a standard line name=dest[#!k1=v1#k2=v2...] Does not include newline.
`void`	`writeProps(Writer out)` Write the props part (if any) only, without newline.
`void`	`writeRemove(Writer out)` Write as a "remove" line #!dest=dest#name=name#k1=v1#sig=sig...] This works whether constructed with name and dest, or just properties.
`void`	`writeRemoveLine(BufferedWriter out)` Write as a "remove" line #!dest=dest#name=name#k1=v1#sig=sig...] This works whether constructed with name and dest, or just properties.

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

- Field Detail
  - ACTION_ADDDEST
```
public static final String ACTION_ADDDEST
```
    Action value: add a new destination
    See Also:
    Constant Field Values
  - ACTION_ADDNAME
```
public static final String ACTION_ADDNAME
```
    Action value: add a new hostname
    See Also:
    Constant Field Values
  - ACTION_ADDSUBDOMAIN
```
public static final String ACTION_ADDSUBDOMAIN
```
    Action value: add a subdomain entry
    See Also:
    Constant Field Values
  - ACTION_CHANGEDEST
```
public static final String ACTION_CHANGEDEST
```
    Action value: change an existing destination
    See Also:
    Constant Field Values
  - ACTION_CHANGENAME
```
public static final String ACTION_CHANGENAME
```
    Action value: change an existing hostname
    See Also:
    Constant Field Values
  - ACTION_REMOVE
```
public static final String ACTION_REMOVE
```
    Action value: remove an entry
    See Also:
    Constant Field Values
  - ACTION_REMOVEALL
```
public static final String ACTION_REMOVEALL
```
    Action value: remove all entries
    See Also:
    Constant Field Values
  - ACTION_UPDATE
```
public static final String ACTION_UPDATE
```
    Action value: update an existing entry
    See Also:
    Constant Field Values
  - KV_SEPARATOR
```
public static final char KV_SEPARATOR
```
    Separator between name and destination in the hosts.txt line
    See Also:
    Constant Field Values
  - PROP_ACTION
```
public static final String PROP_ACTION
```
    Property key for the action type (e.g. adddest, remove)
    See Also:
    Constant Field Values
  - PROP_DATE
```
public static final String PROP_DATE
```
    Property key for the date timestamp (seconds since epoch)
    See Also:
    Constant Field Values
  - PROP_DEST
```
public static final String PROP_DEST
```
    Property key for the destination Base64 string
    See Also:
    Constant Field Values
  - PROP_EXPIRES
```
public static final String PROP_EXPIRES
```
    Property key for the expiry time
    See Also:
    Constant Field Values
  - PROP_NAME
```
public static final String PROP_NAME
```
    Property key for the hostname
    See Also:
    Constant Field Values
  - PROP_OLDDEST
```
public static final String PROP_OLDDEST
```
    Property key for the old destination (used in change operations)
    See Also:
    Constant Field Values
  - PROP_OLDNAME
```
public static final String PROP_OLDNAME
```
    Property key for the old hostname (used in rename operations)
    See Also:
    Constant Field Values
  - PROP_OLDSIG
```
public static final String PROP_OLDSIG
```
    Property key for the old signature for inner verification
    See Also:
    Constant Field Values
  - PROP_SEPARATOR
```
public static final char PROP_SEPARATOR
```
    Separator between individual properties
    See Also:
    Constant Field Values
  - PROP_SIG
```
public static final String PROP_SIG
```
    Property key for the signature
    See Also:
    Constant Field Values
  - PROPS_SEPARATOR
```
public static final String PROPS_SEPARATOR
```
    Separator between the destination part and the properties part
    See Also:
    Constant Field Values
- Constructor Detail
  - HostTxtEntry
```
public HostTxtEntry(String sprops)
             throws IllegalArgumentException
```
    A 'remove' entry. Name and Dest will be null.
    Parameters:
    sprops - line part after the #!, non-null
    Throws:
    IllegalArgumentException - on dup key in sprops and other errors
  - HostTxtEntry
```
public HostTxtEntry(String name,
                    String dest)
```
    Create a new host text entry with name and destination, no properties.
    Parameters:
    name - the hostname
    dest - the Base64 destination
  - HostTxtEntry
```
public HostTxtEntry(String name,
                    String dest,
                    OrderedProperties props)
```
    Create a new host text entry with optional properties.
    Parameters:
    name - the hostname
    dest - the Base64 destination
    props - may be null
  - HostTxtEntry
```
public HostTxtEntry(String name,
                    String dest,
                    String sprops)
             throws IllegalArgumentException
```
    Create a new host text entry with name, destination, and serialized properties.
    Parameters:
    name - the hostname
    dest - the Base64 destination
    sprops - line part after the #!, non-null
    Throws:
    IllegalArgumentException - on dup key in sprops and other errors
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Compares Destination only, not properties
    Overrides:
    equals in class Object
  - getDest
```
public String getDest()
```
    Return the Base64 destination.
    Returns:
    the Base64 destination
  - getName
```
public String getName()
```
    Return the hostname.
    Returns:
    the hostname
  - getProps
```
public OrderedProperties getProps()
```
    Return the properties, or null.
    Returns:
    the properties, or null
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
  - hasValidInnerSig
```
public boolean hasValidInnerSig()
```
    Verify with the "olddest" property's public key using the "oldsig" property
    Returns:
    whether valid inner sig is present
  - hasValidRemoveSig
```
public boolean hasValidRemoveSig()
```
    Verify with the "dest" property's public key using the "sig" property
    Returns:
    whether valid remove sig is present
  - hasValidSig
```
public boolean hasValidSig()
```
    Verify with the dest public key using the "sig" property
    Returns:
    whether valid sig is present
  - sign
```
public void sign(SigningPrivateKey spk)
```
    Sign and set the "sig" property Must have been constructed with non-null properties.
  - signInner
```
public void signInner(SigningPrivateKey spk)
```
    Sign and set the "oldsig" property Must have been constructed with non-null properties.
  - signRemove
```
public void signRemove(SigningPrivateKey spk)
```
    Sign as a "remove" line #!dest=dest#name=name#k1=v1#sig=sig...] Must have been constructed with non-null properties.
  - write
```
public void write(BufferedWriter out)
           throws IOException
```
    Write as a standard line name=dest[#!k1=v1#k2=v2...] Includes newline.
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if writing fails
  - write
```
public void write(Writer out)
           throws IOException
```
    Write as a standard line name=dest[#!k1=v1#k2=v2...] Does not include newline.
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if writing fails
  - writeProps
```
public void writeProps(Writer out)
                throws IOException
```
    Write the props part (if any) only, without newline.
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if writing fails
  - writeRemove
```
public void writeRemove(Writer out)
                 throws IOException
```
    Write as a "remove" line #!dest=dest#name=name#k1=v1#sig=sig...] This works whether constructed with name and dest, or just properties. Does not include newline. Must have been constructed with non-null properties.
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if writing fails
  - writeRemoveLine
```
public void writeRemoveLine(BufferedWriter out)
                     throws IOException
```
    Write as a "remove" line #!dest=dest#name=name#k1=v1#sig=sig...] This works whether constructed with name and dest, or just properties. Includes newline. Must have been constructed with non-null properties.
    Parameters:
    out - the writer to write to
    Throws:
    IOException - if writing fails

Class HostTxtEntry

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_ADDDEST

ACTION_ADDNAME

ACTION_ADDSUBDOMAIN

ACTION_CHANGEDEST

ACTION_CHANGENAME

ACTION_REMOVE

ACTION_REMOVEALL

ACTION_UPDATE

KV_SEPARATOR

PROP_ACTION

PROP_DATE

PROP_DEST

PROP_EXPIRES

PROP_NAME

PROP_OLDDEST

PROP_OLDNAME

PROP_OLDSIG

PROP_SEPARATOR

PROP_SIG

PROPS_SEPARATOR

Constructor Detail

HostTxtEntry

HostTxtEntry

HostTxtEntry

HostTxtEntry

Method Detail

equals

getDest

getName

getProps

hashCode

hasValidInnerSig

hasValidRemoveSig

hasValidSig

sign

signInner

signRemove

write

write

writeProps

writeRemove

writeRemoveLine