DatabaseLookupMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.i2np.I2NPMessageImpl
- - net.i2p.data.i2np.FastI2NPMessageImpl
  - - net.i2p.data.i2np.DatabaseLookupMessage

All Implemented Interfaces:
I2NPMessage
```
public class DatabaseLookupMessage
extends FastI2NPMessageImpl
```
Defines the message a router sends to another router to search for a key in the network database.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class DatabaseLookupMessage.Type
Database lookup type enumeration.
- Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl
  I2NPMessageImpl.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`DatabaseLookupMessage.Type` Database lookup type enumeration.

Field Summary
Fields
Modifier and Type Field and Description
static int MESSAGE_TYPE
MESSAGE_TYPE.
static boolean USE_ECIES_FF
USE_ECIES_FF.
- Fields inherited from class net.i2p.data.i2np.FastI2NPMessageImpl
  _checksum, _hasChecksum
- Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl
  _context, _expiration, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS, HEADER_LENGTH
- Fields inherited from interface net.i2p.data.i2np.I2NPMessage
  MAX_ID_VALUE, MAX_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`MESSAGE_TYPE` MESSAGE_TYPE.
`static boolean`	`USE_ECIES_FF` USE_ECIES_FF.

Constructor Summary

Constructors
Constructor and Description
`DatabaseLookupMessage(I2PAppContext context)` DatabaseLookupMessage.
`DatabaseLookupMessage(I2PAppContext context, boolean locallyCreated)` Lookup message for the given context.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDontIncludePeer(Hash peer)` Add to the set.
`void`	`addDontIncludePeers(Collection<Hash> peers)` Add to the set.
`protected int`	`calculateWrittenLength()` Calculates the length of the message body.
`boolean`	`equals(Object object)` Compares this message to another for equality of all fields.
`Set<Hash>`	`getDontIncludePeers()` Collection of peers that a lookup reply should NOT include.
`Hash`	`getFrom()` Contains the router who requested this lookup
`PublicKey`	`getRatchetPublicKey()` The included session key or null if unset.
`RatchetSessionTag`	`getRatchetReplyTag()` The included session tag or null if unset.
`SessionKey`	`getReplyKey()` The included session key or null if unset.
`SessionTag`	`getReplyTag()` The included session tag or null if unset.
`TunnelId`	`getReplyTunnel()` Contains the tunnel ID a reply should be sent to
`Hash`	`getSearchKey()` Defines the key being searched for
`DatabaseLookupMessage.Type`	`getSearchType()` Defines the type of data being searched for.
`int`	`getType()` The message type.
`int`	`hashCode()` Hash code calculated from the message fields.
`void`	`readMessage(byte[] data, int offset, int dataSize, int type)` Reads the message fields from the byte array.
`void`	`setDontIncludePeers(Collection<Hash> peers)` Replace the dontInclude set with this set.
`void`	`setFrom(Hash from)` Assigns the router who requested this lookup.
`void`	`setReplySession(PublicKey pubKey)` Ratchet.
`void`	`setReplySession(SessionKey encryptKey, RatchetSessionTag encryptTag)` Ratchet
`void`	`setReplySession(SessionKey encryptKey, SessionTag encryptTag)` Only worthwhile if sending reply via tunnel
`void`	`setReplyTunnel(TunnelId replyTunnel)` Assigns the tunnel a reply should be sent to.
`void`	`setSearchKey(Hash key)` Assigns the key being searched for.
`void`	`setSearchType(DatabaseLookupMessage.Type type)` Defines the type of data being searched for.
`static boolean`	`supportsEncryptedReplies(RouterInfo to)` Does this router support encrypted replies?
`static boolean`	`supportsRatchetReplies(RouterInfo to)` Does this router support ratchet replies?
`String`	`toString()` String form of the message, suitable for debugging.
`protected int`	`writeMessageBody(byte[] out, int curIndex)` Writes the message body to the output array, returning the new index.

Methods inherited from class net.i2p.data.i2np.FastI2NPMessageImpl
readBytes, toByteArray, toByteArrayWithSavedChecksum

Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, fromRawByteArrayNTCP2, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, getUniqueId, readBytes, readMessage, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toRawByteArray, toRawByteArrayNTCP2

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

- Field Detail
  - MESSAGE_TYPE
```
public static final int MESSAGE_TYPE
```
    MESSAGE_TYPE.
    See Also:
    Constant Field Values
  - USE_ECIES_FF
```
public static final boolean USE_ECIES_FF
```
    USE_ECIES_FF.
    See Also:
    Constant Field Values
- Constructor Detail
  - DatabaseLookupMessage
```
public DatabaseLookupMessage(I2PAppContext context)
```
    DatabaseLookupMessage.
  - DatabaseLookupMessage
```
public DatabaseLookupMessage(I2PAppContext context,
                             boolean locallyCreated)
```
    Lookup message for the given context.
    Parameters:
    locallyCreated - ignored
- Method Detail
  - addDontIncludePeer
```
public void addDontIncludePeer(Hash peer)
```
    Add to the set. Invalidates the checksum.
    Parameters:
    peer - non-null
  - addDontIncludePeers
```
public void addDontIncludePeers(Collection<Hash> peers)
```
    Add to the set. Invalidates the checksum.
    Parameters:
    peers - non-null
  - calculateWrittenLength
```
protected int calculateWrittenLength()
```
    Calculates the length of the message body.
    Specified by:
    calculateWrittenLength in class I2NPMessageImpl
  - equals
```
public boolean equals(Object object)
```
    Compares this message to another for equality of all fields.
    Overrides:
    equals in class Object
  - getDontIncludePeers
```
public Set<Hash> getDontIncludePeers()
```
    Collection of peers that a lookup reply should NOT include. WARNING - returns a copy.
    Returns:
    Set of Hash objects, each of which is the H(routerIdentity) to skip, or null
  - getFrom
```
public Hash getFrom()
```
    Contains the router who requested this lookup
    Returns:
    the from
  - getRatchetPublicKey
```
public PublicKey getRatchetPublicKey()
```
    The included session key or null if unset. Preliminary, not fully supported, see proposal 154.
    Returns:
    the ratchet public key
  - getRatchetReplyTag
```
public RatchetSessionTag getRatchetReplyTag()
```
    The included session tag or null if unset.
    Returns:
    the ratchet reply tag
  - getReplyKey
```
public SessionKey getReplyKey()
```
    The included session key or null if unset. If non-null, either getReplyTag() or getRatchetReplyTag() is non-null.
    Returns:
    the reply key
  - getReplyTag
```
public SessionTag getReplyTag()
```
    The included session tag or null if unset.
    Returns:
    the reply tag
  - getReplyTunnel
```
public TunnelId getReplyTunnel()
```
    Contains the tunnel ID a reply should be sent to
    Returns:
    the reply tunnel
  - getSearchKey
```
public Hash getSearchKey()
```
    Defines the key being searched for
    Returns:
    the search key
  - getSearchType
```
public DatabaseLookupMessage.Type getSearchType()
```
    Defines the type of data being searched for. Default ANY.
    Returns:
    non-null
  - getType
```
public int getType()
```
    The message type.
    Returns:
    the type
  - hashCode
```
public int hashCode()
```
    Hash code calculated from the message fields.
    Overrides:
    hashCode in class Object
    Returns:
    the hash code
  - readMessage
```
public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException
```
    Reads the message fields from the byte array.
    Parameters:
    data - data to read from
    offset - where to start in the data array
    dataSize - how long into the data to read
    type - I2NP message type
    Throws:
    I2NPMessageException - if the stream doesn't contain a valid message that this class can read.
  - setDontIncludePeers
```
public void setDontIncludePeers(Collection<Hash> peers)
```
    Replace the dontInclude set with this set. WARNING - makes a copy. Invalidates the checksum.
    Parameters:
    peers - may be null
  - setFrom
```
public void setFrom(Hash from)
```
    Assigns the router who requested this lookup.
    Throws:
    IllegalStateException - if from previously set, to protect saved checksum
  - setReplySession
```
public void setReplySession(PublicKey pubKey)
```
    Ratchet. Preliminary, not fully supported, see proposal 154.
    Parameters:
    pubKey - non-null
    Throws:
    IllegalStateException - if key or tag previously set, to protect saved checksum
  - setReplySession
```
public void setReplySession(SessionKey encryptKey,
                            RatchetSessionTag encryptTag)
```
    Ratchet
    Parameters:
    encryptKey - non-null
    encryptTag - non-null
    Throws:
    IllegalStateException - if key or tag previously set, to protect saved checksum
  - setReplySession
```
public void setReplySession(SessionKey encryptKey,
                            SessionTag encryptTag)
```
    Only worthwhile if sending reply via tunnel
    Parameters:
    encryptKey - non-null
    encryptTag - non-null
    Throws:
    IllegalStateException - if key or tag previously set, to protect saved checksum
  - setReplyTunnel
```
public void setReplyTunnel(TunnelId replyTunnel)
```
    Assigns the tunnel a reply should be sent to.
    Throws:
    IllegalStateException - if tunnel previously set, to protect saved checksum
  - setSearchKey
```
public void setSearchKey(Hash key)
```
    Assigns the key being searched for.
    Throws:
    IllegalStateException - if key previously set, to protect saved checksum
  - setSearchType
```
public void setSearchType(DatabaseLookupMessage.Type type)
```
    Defines the type of data being searched for. Default ANY. Must be ANY for queried routers 0.9.5 or lower, but there are few if any floodfills that old left, so not even worth checking.
    Parameters:
    type - non-null
  - supportsEncryptedReplies
```
public static boolean supportsEncryptedReplies(RouterInfo to)
```
    Does this router support encrypted replies?
    Parameters:
    to - null OK returns true as of 0.9.69
  - supportsRatchetReplies
```
public static boolean supportsRatchetReplies(RouterInfo to)
```
    Does this router support ratchet replies?
    Parameters:
    to - null OK returns true as of 0.9.69
  - toString
```
public String toString()
```
    String form of the message, suitable for debugging.
    Overrides:
    toString in class Object
  - writeMessageBody
```
protected int writeMessageBody(byte[] out,
                               int curIndex)
                        throws I2NPMessageException
```
    Writes the message body to the output array, returning the new index.
    Specified by:
    writeMessageBody in class I2NPMessageImpl
    Returns:
    the index into the array after the last byte written (NOT the length)
    Throws:
    I2NPMessageException

Class DatabaseLookupMessage

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl

Field Summary

Fields inherited from class net.i2p.data.i2np.FastI2NPMessageImpl

Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl

Fields inherited from interface net.i2p.data.i2np.I2NPMessage

Constructor Summary

Method Summary

Methods inherited from class net.i2p.data.i2np.FastI2NPMessageImpl

Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE

USE_ECIES_FF

Constructor Detail

DatabaseLookupMessage

DatabaseLookupMessage

Method Detail

addDontIncludePeer

addDontIncludePeers

calculateWrittenLength

equals

getDontIncludePeers

getFrom

getRatchetPublicKey

getRatchetReplyTag

getReplyKey

getReplyTag

getReplyTunnel

getSearchKey

getSearchType

getType

hashCode

readMessage

setDontIncludePeers

setFrom

setReplySession

setReplySession

setReplySession

setReplyTunnel

setSearchKey

setSearchType

supportsEncryptedReplies

supportsRatchetReplies

toString

writeMessageBody