net.tomp2p.dht

Class StorageRPC

java.lang.Object

net.tomp2p.rpc.DispatchHandler

net.tomp2p.dht.StorageRPC

public class StorageRPC
extends DispatchHandler

The RPC that deals with storage.

Author:

Thomas Bocek

Constructor Summary

Constructors

Constructor and Description
StorageRPC(PeerBean peerBean, ConnectionBean connectionBean, StorageLayer storageLayer) Register the store rpc for put, compare put, get, add, and remove.

Method Summary

Methods

Modifier and Type	Method and Description
FutureResponse	add(PeerAddress remotePeer, AddBuilder addBuilder, ChannelCreator channelCreator) Adds data on a remote peer.
FutureResponse	digest(PeerAddress remotePeer, DigestBuilder getBuilder, ChannelCreator channelCreator)
FutureResponse	get(PeerAddress remotePeer, GetBuilder getBuilder, ChannelCreator channelCreator)
FutureResponse	getLatest(PeerAddress remotePeer, GetBuilder getBuilder, ChannelCreator channelCreator, RPC.Commands command)
void	handleResponse(Message message, PeerConnection peerConnection, boolean sign, Responder responder)
FutureResponse	put(PeerAddress remotePeer, PutBuilder putBuilder, ChannelCreator channelCreator) Stores data on a remote peer.
FutureResponse	putConfirm(PeerAddress remotePeer, PutBuilder putBuilder, ChannelCreator channelCreator)
FutureResponse	putIfAbsent(PeerAddress remotePeer, PutBuilder putBuilder, ChannelCreator channelCreator) Stores data on a remote peer.
FutureResponse	putMeta(PeerAddress remotePeer, PutBuilder putBuilder, ChannelCreator channelCreator)
FutureResponse	remove(PeerAddress remotePeer, RemoveBuilder removeBuilder, ChannelCreator channelCreator) Removes data from a peer.
ReplicationListener	replicationListener()
StorageRPC	replicationListener(ReplicationListener replicationListener)

Methods inherited from class net.tomp2p.rpc.DispatchHandler

connectionBean, createMessage, createResponseMessage, createResponseMessage, forwardMessage, peerBean, register, sign

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageRPC

public StorageRPC(PeerBean peerBean,
          ConnectionBean connectionBean,
          StorageLayer storageLayer)

Register the store rpc for put, compare put, get, add, and remove.

Parameters:

peerBean - The peer bean

connectionBean - The connection bean

Method Detail

replicationListener

public StorageRPC replicationListener(ReplicationListener replicationListener)

replicationListener

public ReplicationListener replicationListener()

put

public FutureResponse put(PeerAddress remotePeer,
                 PutBuilder putBuilder,
                 ChannelCreator channelCreator)

Stores data on a remote peer. Overwrites data if the data already exists. This is an RPC.

Parameters:

remotePeer - The remote peer to store the data

locationKey - The location of the data

domainKey - The domain of the data

dataMap - The map with the content key and data

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.

protectEntry - Set to true if the entry 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.

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

channelCreator - The channel creator

forceUDP - Set to true if the communication should be UDP, default is TCP

Returns:

FutureResponse that stores which content keys have been stored.

putIfAbsent

public FutureResponse putIfAbsent(PeerAddress remotePeer,
                         PutBuilder putBuilder,
                         ChannelCreator channelCreator)

Stores data on a remote peer. Only stores data if the data does not already exist. This is an RPC.

Parameters:

remotePeer - The remote peer to store the data

locationKey - The location of the data

domainKey - The domain of the data

dataMap - The map with the content key and data

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.

protectEntry - Set to true if the entry 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.

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

channelCreator - The channel creator

forceUDP - Set to true if the communication should be UDP, default is TCP

Returns:

FutureResponse that stores which content keys have been stored.

putMeta

public FutureResponse putMeta(PeerAddress remotePeer,
                     PutBuilder putBuilder,
                     ChannelCreator channelCreator)

putConfirm

public FutureResponse putConfirm(PeerAddress remotePeer,
                        PutBuilder putBuilder,
                        ChannelCreator channelCreator)

add

public FutureResponse add(PeerAddress remotePeer,
                 AddBuilder addBuilder,
                 ChannelCreator channelCreator)

Adds data on a remote peer. The main difference to #put(PeerAddress, Number160, Number160, Map, Type, boolean, ChannelCreator, boolean) and #putIfAbsent(PeerAddress, Number160, Number160, Map, boolean, boolean, boolean, ChannelCreator, boolean) is that it will convert the data collection to map. The key for the map will be the SHA-1 hash of the data. This is an RPC.

Parameters:

remotePeer - The remote peer to store the data

locationKey - The location key

domainKey - The domain key

dataSet - The set with data. This will be converted to a map. The key for the map is the SHA-1 of the data.

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.

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

channelCreator - The channel creator

forceUDP - Set to true if the communication should be UDP, default is TCP

Returns:

FutureResponse that stores which content keys have been stored.

digest

public FutureResponse digest(PeerAddress remotePeer,
                    DigestBuilder getBuilder,
                    ChannelCreator channelCreator)

get

public FutureResponse get(PeerAddress remotePeer,
                 GetBuilder getBuilder,
                 ChannelCreator channelCreator)

getLatest

public FutureResponse getLatest(PeerAddress remotePeer,
                       GetBuilder getBuilder,
                       ChannelCreator channelCreator,
                       RPC.Commands command)

remove

public FutureResponse remove(PeerAddress remotePeer,
                    RemoveBuilder removeBuilder,
                    ChannelCreator channelCreator)

Removes data from a peer. This is an RPC.

Parameters:

remotePeer - The remote peer to send this request

locationKey - The location key

domainKey - The domain key

contentKeys - The content keys or null if requested all

sendBackResults - Set to true if the removed data should be sent back

signMessage - Adds a public key and signs the message. For protected entry and domains, this needs to be provided.

channelCreator - The channel creator that creates connections

forceUDP - Set to true if the communication should be UDP, default is TCP

Returns:

The future response to keep track of future events

handleResponse

public void handleResponse(Message message,
                  PeerConnection peerConnection,
                  boolean sign,
                  Responder responder)
                    throws Exception

Specified by:

handleResponse in class DispatchHandler

Throws:

Exception