net.tomp2p.p2p.builder

Class DHTBuilder<K extends DHTBuilder<K>>

java.lang.Object

net.tomp2p.connection.DefaultConnectionConfiguration

net.tomp2p.p2p.builder.DHTBuilder<K>

Type Parameters:

K -

All Implemented Interfaces:

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

Direct Known Subclasses:

AddBuilder, DigestBuilder, GetBuilder, ParallelRequestBuilder, PutBuilder, RemoveBuilder, SendBuilder, ShutdownBuilder

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 Peer	peer
protected RequestP2PConfiguration	requestP2PConfiguration
protected RoutingConfiguration	routingConfiguration
protected Number160	versionKey

Constructor Summary

Constructors

Constructor and Description
DHTBuilder(Peer peer, Number160 locationKey)

Method Summary

Methods

Modifier and Type	Method and Description
RoutingBuilder	createBuilder(RequestP2PConfiguration requestP2PConfiguration, RoutingConfiguration routingConfiguration)
Number160	getDomainKey()
FutureChannelCreator	getFutureChannelCreator()
Number160	getLocationKey()
RequestP2PConfiguration	getRequestP2PConfiguration()
RoutingConfiguration	getRoutingConfiguration()
Number160	getVersionKey()
boolean	isProtectDomain()
boolean	isSign()
boolean	isStreaming()
KeyPair	keyPair()
K	keyPair(KeyPair keyPair)
protected void	preBuild(String name)
void	self(K self)
K	setDomainKey(Number160 domainKey)
K	setFutureChannelCreator(FutureChannelCreator futureChannelCreator)
K	setProtectDomain()
K	setProtectDomain(boolean protectDomain)
K	setRequestP2PConfiguration(RequestP2PConfiguration requestP2PConfiguration)
K	setRoutingConfiguration(RoutingConfiguration routingConfiguration)
K	setSign()
K	setStreaming() Set streaming to true.
K	setStreaming(boolean streaming) Set streaming.
K	setVersionKey(Number160 versionKey)
K	sign(boolean signMessage)

Methods inherited from class net.tomp2p.connection.DefaultConnectionConfiguration

connectionTimeoutTCPMillis, connectionTimeoutTCPMillis, forceUDP, idleTCPSeconds, idleTCPSeconds, idleUDPSeconds, idleUDPSeconds, isForceTCP, isForceUDP, setForceTCP, setForceTCP, setForceUDP

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 Peer 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(Peer peer,
          Number160 locationKey)

Method Detail

self

public void self(K self)

getLocationKey

public Number160 getLocationKey()

Specified by:

getLocationKey in interface BasicBuilder<K extends DHTBuilder<K>>

Returns:

The location key

getDomainKey

public Number160 getDomainKey()

Specified by:

getDomainKey in interface BasicBuilder<K extends DHTBuilder<K>>

setDomainKey

public K setDomainKey(Number160 domainKey)

Specified by:

setDomainKey in interface BasicBuilder<K extends DHTBuilder<K>>

getVersionKey

public Number160 getVersionKey()

setVersionKey

public K setVersionKey(Number160 versionKey)

getRoutingConfiguration

public RoutingConfiguration getRoutingConfiguration()

Specified by:

getRoutingConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>

Returns:

The configuration for the routing options

setRoutingConfiguration

public K setRoutingConfiguration(RoutingConfiguration routingConfiguration)

Specified by:

setRoutingConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>

Parameters:

routingConfiguration - The configuration for the routing options

Returns:

This object

getRequestP2PConfiguration

public RequestP2PConfiguration getRequestP2PConfiguration()

Specified by:

getRequestP2PConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>

Returns:

The P2P request configuration options

setRequestP2PConfiguration

public K setRequestP2PConfiguration(RequestP2PConfiguration requestP2PConfiguration)

Specified by:

setRequestP2PConfiguration in interface BasicBuilder<K extends DHTBuilder<K>>

Parameters:

requestP2PConfiguration - The P2P request configuration options

Returns:

This object

getFutureChannelCreator

public FutureChannelCreator getFutureChannelCreator()

Returns:

The future of the created channel

setFutureChannelCreator

public K setFutureChannelCreator(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.

setProtectDomain

public K setProtectDomain(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

setProtectDomain

public K setProtectDomain()

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>>

Returns:

Set to true if the message should be signed. For protecting an entry, this needs to be set to true.

sign

public K sign(boolean signMessage)

Specified by:

sign in interface SignatureBuilder<K extends DHTBuilder<K>>

Parameters:

signMessage - Set to true if the message should be signed. For protecting an entry, this needs to be set to true.

Returns:

This class

setSign

public K setSign()

Specified by:

setSign in interface SignatureBuilder<K extends DHTBuilder<K>>

Returns:

Set to true if the message should be signed. For protecting an entry, this needs to be set to true.

keyPair

public K keyPair(KeyPair keyPair)

Specified by:

keyPair in interface SignatureBuilder<K extends DHTBuilder<K>>

Parameters:

keyPair - The keyPair to sing the complete message. The key will be attached to the message and stored potentially with a data object (if there is such an object in the message).

Returns:

This class

keyPair

public KeyPair keyPair()

Specified by:

keyPair in interface SignatureBuilder<K extends DHTBuilder<K>>

Returns:

The current keypair to sign the message. If null, no signature is applied.

isStreaming

public boolean isStreaming()

Returns:

True if streaming should be used

setStreaming

public K setStreaming(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

setStreaming

public K setStreaming()

Set streaming to true. See setStreaming(boolean)

Returns:

This class

preBuild

protected void preBuild(String name)

createBuilder

public RoutingBuilder createBuilder(RequestP2PConfiguration requestP2PConfiguration,
                           RoutingConfiguration routingConfiguration)

Specified by:

createBuilder in interface BasicBuilder<K extends DHTBuilder<K>>