DHTBuilder (TomP2P DHT 5.0-Alpha24 API)

java.lang.Object
- net.tomp2p.connection.DefaultConnectionConfiguration
- - net.tomp2p.dht.DHTBuilder<K>

Type Parameters:
K -

All Implemented Interfaces:

ConnectionConfiguration, BasicBuilder<K>, Builder, SignatureBuilder<K>

Direct Known Subclasses:

AddBuilder, DigestBuilder, GetBuilder, ParallelRequestBuilder, PutBuilder, RemoveBuilder, SendBuilder
```
public abstract class DHTBuilder<K extends DHTBuilder<K>>
extends DefaultConnectionConfiguration
implements BasicBuilder<K>, ConnectionConfiguration, SignatureBuilder<K>
```
Every DHT builder has those methods in common.

Author:

Thomas Bocek

Field Summary

Fields
Modifier and Type	Field and Description
`protected Number160`	`domainKey`
`protected FutureChannelCreator`	`futureChannelCreator`
`protected Number160`	`locationKey`
`protected PeerDHT`	`peer`
`protected RequestP2PConfiguration`	`requestP2PConfiguration`
`protected RoutingConfiguration`	`routingConfiguration`
`protected Number160`	`versionKey`

Constructor Summary

Constructors
Constructor and Description

DHTBuilder(PeerDHT peer, Number160 locationKey)

Constructors
Constructor and Description
`DHTBuilder(PeerDHT peer, Number160 locationKey)`

Method Summary

Methods
Modifier and Type	Method and Description
`K`	`addPeerFilter(PeerFilter peerFilter)`
`RoutingBuilder`	`createBuilder(RequestP2PConfiguration requestP2PConfiguration, RoutingConfiguration routingConfiguration)`
`Number160`	`domainKey()`
`K`	`domainKey(Number160 domainKey)`
`FutureChannelCreator`	`futureChannelCreator()`
`K`	`futureChannelCreator(FutureChannelCreator futureChannelCreator)`
`boolean`	`isProtectDomain()`
`boolean`	`isSign()`
`boolean`	`isStreaming()`
`KeyPair`	`keyPair()`
`K`	`keyPair(KeyPair keyPair)`
`Number160`	`locationKey()`
`Collection<PeerFilter>`	`peerFilters()`
`protected void`	`preBuild(String name)`
`K`	`protectDomain()`
`K`	`protectDomain(boolean protectDomain)`
`RequestP2PConfiguration`	`requestP2PConfiguration()`
`K`	`requestP2PConfiguration(RequestP2PConfiguration requestP2PConfiguration)`
`RoutingConfiguration`	`routingConfiguration()`
`K`	`routingConfiguration(RoutingConfiguration routingConfiguration)`
`void`	`self(K self)`
`K`	`sign()`
`K`	`sign(boolean signMessage)`
`K`	`streaming()` Set streaming to true.
`K`	`streaming(boolean streaming)` Set streaming.
`Number160`	`versionKey()`
`K`	`versionKey(Number160 versionKey)`

Methods inherited from class net.tomp2p.connection.DefaultConnectionConfiguration
connectionTimeoutTCPMillis, connectionTimeoutTCPMillis, forceTCP, forceTCP, forceUDP, forceUDP, idleTCPSeconds, idleTCPSeconds, idleUDPSeconds, idleUDPSeconds, isForceTCP, isForceUDP

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

Methods inherited from interface net.tomp2p.connection.ConnectionConfiguration
connectionTimeoutTCPMillis, idleTCPSeconds, idleUDPSeconds, isForceTCP, isForceUDP

Methods inherited from interface net.tomp2p.p2p.builder.Builder
start

- Field Detail
  - peer
```
protected final PeerDHT peer
```
  - locationKey
```
protected final Number160 locationKey
```
  - domainKey
```
protected Number160 domainKey
```
  - versionKey
```
protected Number160 versionKey
```
  - routingConfiguration
```
protected RoutingConfiguration routingConfiguration
```
  - requestP2PConfiguration
```
protected RequestP2PConfiguration requestP2PConfiguration
```
  - futureChannelCreator
```
protected FutureChannelCreator futureChannelCreator
```
- Constructor Detail
  - DHTBuilder
```
public DHTBuilder(PeerDHT peer,
          Number160 locationKey)
```
- Method Detail
  - self
```
public void self(K self)
```
  - locationKey
```
public Number160 locationKey()
```
    Specified by:
    
    locationKey in interface BasicBuilder<K extends DHTBuilder<K>>
    
    Returns:
    The location key
  - domainKey
```
public Number160 domainKey()
```
    Specified by:
    
    domainKey in interface BasicBuilder<K extends DHTBuilder<K>>
  - domainKey
```
public K domainKey(Number160 domainKey)
```
    Specified by:
    
    domainKey in interface BasicBuilder<K extends DHTBuilder<K>>
  - versionKey
```
public Number160 versionKey()
```
  - versionKey
```
public K versionKey(Number160 versionKey)
```
  - routingConfiguration
```
public RoutingConfiguration routingConfiguration()
```
    Specified by:
    
    routingConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>
    
    Returns:
    The configuration for the routing options
  - routingConfiguration
```
public K routingConfiguration(RoutingConfiguration routingConfiguration)
```
    Specified by:
    
    routingConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>
    
    Parameters:
    routingConfiguration - The configuration for the routing options
    
    Returns:
    This object
  - requestP2PConfiguration
```
public RequestP2PConfiguration requestP2PConfiguration()
```
    Specified by:
    
    requestP2PConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>
    
    Returns:
    The P2P request configuration options
  - requestP2PConfiguration
```
public K requestP2PConfiguration(RequestP2PConfiguration requestP2PConfiguration)
```
    Specified by:
    
    requestP2PConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>
    
    Parameters:
    requestP2PConfiguration - The P2P request configuration options
    
    Returns:
    This object
  - futureChannelCreator
```
public FutureChannelCreator futureChannelCreator()
```
    Returns:
    The future of the created channel
  - futureChannelCreator
```
public K futureChannelCreator(FutureChannelCreator futureChannelCreator)
```
    Parameters:
    futureChannelCreator - The future of the created channel
    
    Returns:
    This object
  - isProtectDomain
```
public boolean isProtectDomain()
```
    Returns:
    Set to true if the domain should be set to protected. This means that this domain is flagged an a public key is stored for this entry. An update or removal can only be made with the matching private key.
  - protectDomain
```
public K protectDomain(boolean protectDomain)
```
    Parameters:
    protectDomain - Set to true if the domain should be set to protected. This means that this domain is flagged an a public key is stored for this entry. An update or removal can only be made with the matching private key.
    
    Returns:
    This class
  - protectDomain
```
public K protectDomain()
```
    Returns:
    Set to true if the domain should be set to protected. This means that this domain is flagged an a public key is stored for this entry. An update or removal can only be made with the matching private key.
  - isSign
```
public boolean isSign()
```
    Specified by:
    
    isSign in interface SignatureBuilder<K extends DHTBuilder<K>>
  - sign
```
public K sign(boolean signMessage)
```
    Specified by:
    
    sign in interface SignatureBuilder<K extends DHTBuilder<K>>
  - sign
```
public K sign()
```
    Specified by:
    
    sign in interface SignatureBuilder<K extends DHTBuilder<K>>
  - keyPair
```
public K keyPair(KeyPair keyPair)
```
    Specified by:
    
    keyPair in interface SignatureBuilder<K extends DHTBuilder<K>>
  - keyPair
```
public KeyPair keyPair()
```
    Specified by:
    
    keyPair in interface SignatureBuilder<K extends DHTBuilder<K>>
  - isStreaming
```
public boolean isStreaming()
```
    Returns:
    True if streaming should be used
  - streaming
```
public K streaming(boolean streaming)
```
    Set streaming. If streaming is set to true, than the data can be added after Builder.start() has been called.
    
    Parameters:
    streaming - True if streaming should be used
    
    Returns:
    This class
  - streaming
```
public K streaming()
```
    Set streaming to true. See streaming(boolean)
    
    Returns:
    This class
  - addPeerFilter
```
public K addPeerFilter(PeerFilter peerFilter)
```
  - peerFilters
```
public Collection<PeerFilter> peerFilters()
```
    Specified by:
    
    peerFilters in interface BasicBuilder<K extends DHTBuilder<K>>
  - preBuild
```
protected void preBuild(String name)
```
  - createBuilder
```
public RoutingBuilder createBuilder(RequestP2PConfiguration requestP2PConfiguration,
                           RoutingConfiguration routingConfiguration)
```
    Specified by:
    
    createBuilder in interface BasicBuilder<K extends DHTBuilder<K>>

Class DHTBuilder<K extends DHTBuilder<K>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.tomp2p.connection.DefaultConnectionConfiguration

Methods inherited from class java.lang.Object

Methods inherited from interface net.tomp2p.connection.ConnectionConfiguration

Methods inherited from interface net.tomp2p.p2p.builder.Builder

Field Detail

peer

locationKey

domainKey

versionKey

routingConfiguration

requestP2PConfiguration

futureChannelCreator

Constructor Detail

DHTBuilder

Method Detail

self

locationKey

domainKey

domainKey

versionKey

versionKey

routingConfiguration

routingConfiguration

requestP2PConfiguration

requestP2PConfiguration

futureChannelCreator

futureChannelCreator

isProtectDomain

protectDomain

protectDomain

isSign

sign

sign

keyPair

keyPair

isStreaming

streaming

streaming

addPeerFilter

peerFilters

preBuild

createBuilder