freenet.clients.fcp

Class FCPPluginServerMessage

java.lang.Object

freenet.clients.fcp.FCPMessage

freenet.clients.fcp.BaseDataCarryingMessage

freenet.clients.fcp.DataCarryingMessage

freenet.clients.fcp.FCPPluginServerMessage

public class FCPPluginServerMessage
extends DataCarryingMessage

This class produces the network format for a FCP message which is send from a FCP server plugin to a FCP client.
It is the inverse of FCPPluginClientMessage which parses the on-network format of client to server messages.

There is a similar class FCPPluginMessage which serves as a container of FCP plugin messages which are produced and consumed by the actual server and client plugin implementations. Consider this class here as an internal representation of FCP plugin messages used solely for encoding server-to-client messages, while the other one is the external representation used for both server and client messages. ATTENTION: The on-network name of this message is different: It is . The class previously had the same name but it was decided to rename it: Previously, it was only allowed for the server to send messages to the client as a direct reply to a message. Nowadays, the server can send messages to the client any time he wants, even if there hasn't been a client message for a long time. So the class was renamed to FCPPluginServerMessage to prevent the misconception that it would be reply only, and also to make the name symmetrical to class FCPPluginClientMessage. To stay backward compatible, it was decided to keep the raw network message name as is.
TODO: Would it technically be possible to add a second name to the on-network data so we can get rid of the old name after a transition period?

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_PREFIX

Fields inherited from class freenet.clients.fcp.DataCarryingMessage

bucket, freeOnSent

Fields inherited from class freenet.clients.fcp.FCPMessage

BUILD, BULK_CHK_INSERT_REJECTS, BULK_CHK_REQUEST_REJECTS, BULK_SSK_INSERT_REJECTS, BULK_SSK_REQUEST_REJECTS, CODE, HTL, IDENTIFIER, LINK_LENGTHS, LOCAL, LOCATION, OUTPUT_BANDWIDTH, OUTPUT_BANDWIDTH_CLASS, OVERALL_BULK_OUTPUT_CAPACITY_USAGE, PROBE_IDENTIFIER, STORE_SIZE, TYPE, UPTIME_PERCENT

Constructor Summary

Constructors

Constructor and Description
FCPPluginServerMessage(java.lang.String pluginname, FCPPluginMessage message)
FCPPluginServerMessage(java.lang.String pluginname, java.lang.String identifier2, SimpleFieldSet fs, Bucket bucket2) Deprecated. Use FCPPluginServerMessage(String, String, SimpleFieldSet, Bucket, Boolean, String, String). ATTENTION: Upon removal of this constructor, you should remove the backend constructor so the only remaining constructor is the one which consumes a FCPPluginMessage. Then you should remove all the member variables from this class which duplicate the members of that class, and instead store a reference to an object of the other class.
FCPPluginServerMessage(java.lang.String pluginname, java.lang.String identifier2, SimpleFieldSet fs, Bucket bucket2, java.lang.Boolean success, java.lang.String errorCode, java.lang.String errorMessage) The parameters match the member variables of FCPPluginMessage, and thus their JavaDoc applies.

Method Summary

Modifier and Type	Method and Description
SimpleFieldSet	getFieldSet()
java.lang.String	getName()
void	run(FCPConnectionHandler handler, Node node) Do whatever it is that we do with this type of message.

Methods inherited from class freenet.clients.fcp.DataCarryingMessage

getRandomAccessBucket, readFrom, writeData

Methods inherited from class freenet.clients.fcp.BaseDataCarryingMessage

send

Methods inherited from class freenet.clients.fcp.FCPMessage

create, create, withListRequestIdentifier

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_PREFIX

public static final java.lang.String PARAM_PREFIX

See Also:

Constant Field Values

Constructor Detail

FCPPluginServerMessage

@Deprecated
public FCPPluginServerMessage(java.lang.String pluginname,
                                          java.lang.String identifier2,
                                          SimpleFieldSet fs,
                                          Bucket bucket2)

Deprecated. Use FCPPluginServerMessage(String, String, SimpleFieldSet, Bucket, Boolean, String, String).

ATTENTION: Upon removal of this constructor, you should remove the backend constructor so the only remaining constructor is the one which consumes a FCPPluginMessage. Then you should remove all the member variables from this class which duplicate the members of that class, and instead store a reference to an object of the other class.

FCPPluginServerMessage

public FCPPluginServerMessage(java.lang.String pluginname,
                              FCPPluginMessage message)

Parameters:

pluginname - The class name of the plugin which is sending the message.
Must not be null.
See PluginManager.getPluginInfoByClassName(String).

FCPPluginServerMessage

public FCPPluginServerMessage(java.lang.String pluginname,
                              java.lang.String identifier2,
                              SimpleFieldSet fs,
                              Bucket bucket2,
                              java.lang.Boolean success,
                              java.lang.String errorCode,
                              java.lang.String errorMessage)

The parameters match the member variables of FCPPluginMessage, and thus their JavaDoc applies.

Method Detail

getFieldSet

public SimpleFieldSet getFieldSet()

Specified by:

getFieldSet in class FCPMessage

getName

public java.lang.String getName()

Specified by:

getName in class FCPMessage

run

public void run(FCPConnectionHandler handler,
                Node node)
         throws MessageInvalidException

Description copied from class: FCPMessage

Do whatever it is that we do with this type of message.

Specified by:

run in class FCPMessage

Throws:

MessageInvalidException