net.tomp2p.p2p.builder

Class ShutdownBuilder

java.lang.Object

net.tomp2p.connection.DefaultConnectionConfiguration

net.tomp2p.p2p.builder.ShutdownBuilder

All Implemented Interfaces:

ConnectionConfiguration, SignatureBuilder<ShutdownBuilder>

public class ShutdownBuilder
extends DefaultConnectionConfiguration
implements SignatureBuilder<ShutdownBuilder>

Set the configuration options for the shutdown command. The shutdown does first a rounting, searches for its close peers and then send a quit message so that the other peers knows that this peer is offline.

Author:

Thomas Bocek

Constructor Summary

Constructors

Constructor and Description
ShutdownBuilder(Peer peer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ShutdownBuilder	forceRoutingOnlyToSelf()
ShutdownBuilder	forceRoutingOnlyToSelf(boolean forceRoutingOnlyToSelf)
boolean	isForceRoutingOnlyToSelf()
boolean	isSign()
KeyPair	keyPair()
ShutdownBuilder	keyPair(KeyPair keyPair)
RoutingConfiguration	routingConfiguration()
ShutdownBuilder	routingConfiguration(RoutingConfiguration routingConfiguration)
ShutdownBuilder	sign()
ShutdownBuilder	sign(boolean signMessage)
FutureDone<Void>	start() Start the shutdown.

Methods inherited from class net.tomp2p.connection.DefaultConnectionConfiguration

connectionTimeoutTCPMillis, connectionTimeoutTCPMillis, forceTCP, forceTCP, forceUDP, forceUDP, idleTCPSeconds, idleTCPSeconds, idleUDPSeconds, idleUDPSeconds, isForceTCP, isForceUDP, slowResponseTimeoutSeconds, slowResponseTimeoutSeconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShutdownBuilder

public ShutdownBuilder(Peer peer)

Constructor.

Parameters:

peer - The peer that runs the routing and quit messages

Method Detail

start

public FutureDone<Void> start()

Start the shutdown. This method returns immediately with a future object. The future object can be used to block or add a listener.

Returns:

The future object

isSign

public boolean isSign()

Specified by:

isSign in interface SignatureBuilder<ShutdownBuilder>

Returns:

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

sign

public ShutdownBuilder sign(boolean signMessage)

Specified by:

sign in interface SignatureBuilder<ShutdownBuilder>

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

sign

public ShutdownBuilder sign()

Specified by:

sign in interface SignatureBuilder<ShutdownBuilder>

Returns:

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

keyPair

public ShutdownBuilder keyPair(KeyPair keyPair)

Specified by:

keyPair in interface SignatureBuilder<ShutdownBuilder>

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

Returns:

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

routingConfiguration

public RoutingConfiguration routingConfiguration()

routingConfiguration

public ShutdownBuilder routingConfiguration(RoutingConfiguration routingConfiguration)

isForceRoutingOnlyToSelf

public boolean isForceRoutingOnlyToSelf()

forceRoutingOnlyToSelf

public ShutdownBuilder forceRoutingOnlyToSelf()

forceRoutingOnlyToSelf

public ShutdownBuilder forceRoutingOnlyToSelf(boolean forceRoutingOnlyToSelf)