freenet.clients.fcp

Class FCPServer

java.lang.Object

freenet.clients.fcp.FCPServer

All Implemented Interfaces:

DownloadCache, java.lang.Runnable

public class FCPServer
extends java.lang.Object
implements java.lang.Runnable, DownloadCache

FCP server process.

Field Summary

Fields

Modifier and Type	Field and Description
NodeClientCore	core
static int	DEFAULT_FCP_PORT
boolean	enabled
static long	QUEUE_MAX_DATA_SIZE
static int	QUEUE_MAX_RETRIES

Constructor Summary

Constructors

Constructor and Description
FCPServer(java.lang.String ipToBindTo, java.lang.String allowedHosts, java.lang.String allowedHostsFullAccess, int port, Node node, NodeClientCore core, boolean isEnabled, boolean assumeDDADownloadAllowed, boolean assumeDDAUploadAllowed, boolean neverDropAMessage, int maxMessageQueueLength, PersistentRequestRoot persistentRoot)

Method Summary

Modifier and Type	Method and Description
FCPPluginConnection	createFCPPluginConnectionForIntraNodeFCP(java.lang.String serverPluginName, FredPluginFCPMessageHandler.ClientSideFCPMessageHandler messageHandler) Creates and registers a FCPPluginConnection object for FCP connections between plugins running within the same node. In other words, the actual client application is NOT connected to the node by network, it is a plugin running within the node just like the server.
FetchResult	getCompletedRequestBlocking(FreenetURI key)
PersistentRequestClient	getForeverClient(java.lang.String name, NodeClientCore core, FCPConnectionHandler handler)
PersistentRequestClient	getGlobalForeverClient() Returns the global FCP client.
ClientRequest	getGlobalRequest(java.lang.String identifier)
RequestStatus[]	getGlobalRequests()
FCPPluginConnection	getPluginConnectionByID(java.util.UUID connectionID) The documentation of FCPPluginConnectionTracker.getConnection(UUID) applies to this function.
protected boolean	isDownloadDDAAlwaysAllowed()
protected boolean	isUploadDDAAlwaysAllowed()
void	load()
CacheFetchResult	lookup(FreenetURI key, boolean noFilter, ClientContext context, boolean mustCopy, Bucket preferred)
CacheFetchResult	lookupInstant(FreenetURI key, boolean noFilter, boolean mustCopy, Bucket preferred)
void	makePersistentGlobalRequest(FreenetURI fetchURI, boolean filterData, java.lang.String expectedMimeType, java.lang.String persistenceTypeString, java.lang.String returnTypeString, boolean realTimeFlag)
void	makePersistentGlobalRequest(FreenetURI fetchURI, boolean filterData, java.lang.String expectedMimeType, java.lang.String persistenceTypeString, java.lang.String returnTypeString, boolean realTimeFlag, java.io.File downloadsDir) Create a persistent globally-queued request for a file.
void	makePersistentGlobalRequestBlocking(FreenetURI fetchURI, boolean filterData, java.lang.String expectedMimeType, java.lang.String persistenceTypeString, java.lang.String returnTypeString, boolean realTimeFlag, java.io.File downloadsDir)
int	maxMessageQueueLength()
static FCPServer	maybeCreate(Node node, NodeClientCore core, Config config, PersistentRequestRoot root)
void	maybeStart()
boolean	modifyGlobalRequestBlocking(java.lang.String identifier, java.lang.String newToken, short newPriority)
boolean	neverDropAMessage()
PersistentRequestClient	registerForeverClient(java.lang.String name, NodeClientCore core, FCPConnectionHandler handler)
PersistentRequestClient	registerRebootClient(java.lang.String name, NodeClientCore core, FCPConnectionHandler handler)
boolean	removeAllGlobalRequestsBlocking()
boolean	removeGlobalRequestBlocking(java.lang.String identifier)
boolean	restartBlocking(java.lang.String identifier, boolean disableFilterData)
void	run()
void	setCompletionCallback(RequestCompletionCallback cb)
void	startBlocking(ClientRequest req, ClientContext context) Start a request on the global queue.
void	unregisterClient(PersistentRequestClient client)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FCP_PORT

public static final int DEFAULT_FCP_PORT

See Also:

Constant Field Values

core

public final NodeClientCore core

enabled

public final boolean enabled

QUEUE_MAX_RETRIES

public static final int QUEUE_MAX_RETRIES

See Also:

Constant Field Values

QUEUE_MAX_DATA_SIZE

public static final long QUEUE_MAX_DATA_SIZE

See Also:

Constant Field Values

Constructor Detail

FCPServer

public FCPServer(java.lang.String ipToBindTo,
                 java.lang.String allowedHosts,
                 java.lang.String allowedHostsFullAccess,
                 int port,
                 Node node,
                 NodeClientCore core,
                 boolean isEnabled,
                 boolean assumeDDADownloadAllowed,
                 boolean assumeDDAUploadAllowed,
                 boolean neverDropAMessage,
                 int maxMessageQueueLength,
                 PersistentRequestRoot persistentRoot)
          throws java.io.IOException,
                 InvalidConfigValueException

Throws:

java.io.IOException

InvalidConfigValueException

Method Detail

load

public void load()

maybeStart

public void maybeStart()

run

public void run()

Specified by:

run in interface java.lang.Runnable

maybeCreate

public static FCPServer maybeCreate(Node node,
                                    NodeClientCore core,
                                    Config config,
                                    PersistentRequestRoot root)
                             throws java.io.IOException,
                                    InvalidConfigValueException

Throws:

java.io.IOException

InvalidConfigValueException

neverDropAMessage

public boolean neverDropAMessage()

maxMessageQueueLength

public int maxMessageQueueLength()

createFCPPluginConnectionForIntraNodeFCP

public final FCPPluginConnection createFCPPluginConnectionForIntraNodeFCP(java.lang.String serverPluginName,
                                                                          FredPluginFCPMessageHandler.ClientSideFCPMessageHandler messageHandler)
                                                                   throws PluginNotFoundException

Creates and registers a FCPPluginConnection object for FCP connections between plugins running within the same node.
In other words, the actual client application is NOT connected to the node by network, it is a plugin running within the node just like the server.

The object is registered at the backend FCPPluginConnectionTracker and thus can be queried from this server by ID via the frontend getPluginConnectionByID(UUID) as long as something else keeps a strong reference to it.
Once it becomes weakly reachable, it will be garbage-collected from the backend FCPPluginConnectionTracker and getPluginConnectionByID(UUID) will not return it anymore.
In other words, you don't have to take care of registering or unregistering connections. You only have to take care of keeping a strong reference to them while they are in use.

ATTENTION: Only for internal use by the frontend function PluginRespirator.connectToOtherPlugin(String, FredPluginFCPMessageHandler.ClientSideFCPMessageHandler). Plugins must use that instead.

ATTENTION: Since this function is only to be used by the aforementioned connectToPlugin() which in turn is only to be used by clients, the returned connection will have a default send direction of FCPPluginConnection.SendDirection.ToServer.

Throws:

PluginNotFoundException

See Also:

The class JavaDoc of FCPPluginConnectionImpl explains the code path for both networked and non-networked FCP.

getPluginConnectionByID

public final FCPPluginConnection getPluginConnectionByID(java.util.UUID connectionID)
                                                  throws java.io.IOException

The documentation of FCPPluginConnectionTracker.getConnection(UUID) applies to this function.

ATTENTION: Only for internal use by the frontend function PluginRespirator.getPluginConnectionByID(UUID). Plugins must use that instead.

ATTENTION: Since this function is only to be used by the aforementioned getPluginConnectionByID() which in turn is only to be used by servers, the returned connection will have a default send direction of FCPPluginConnection.SendDirection.ToClient.

Throws:

java.io.IOException

See Also:

The JavaDoc of FCPPluginConnectionTracker explains the general purpose of this mechanism.

registerRebootClient

public PersistentRequestClient registerRebootClient(java.lang.String name,
                                                    NodeClientCore core,
                                                    FCPConnectionHandler handler)

registerForeverClient

public PersistentRequestClient registerForeverClient(java.lang.String name,
                                                     NodeClientCore core,
                                                     FCPConnectionHandler handler)

getForeverClient

public PersistentRequestClient getForeverClient(java.lang.String name,
                                                NodeClientCore core,
                                                FCPConnectionHandler handler)

unregisterClient

public void unregisterClient(PersistentRequestClient client)

getGlobalRequests

public RequestStatus[] getGlobalRequests()
                                  throws PersistenceDisabledException

Throws:

PersistenceDisabledException

removeGlobalRequestBlocking

public boolean removeGlobalRequestBlocking(java.lang.String identifier)
                                    throws MessageInvalidException,
                                           PersistenceDisabledException

Throws:

MessageInvalidException

PersistenceDisabledException

removeAllGlobalRequestsBlocking

public boolean removeAllGlobalRequestsBlocking()
                                        throws PersistenceDisabledException

Throws:

PersistenceDisabledException

makePersistentGlobalRequestBlocking

public void makePersistentGlobalRequestBlocking(FreenetURI fetchURI,
                                                boolean filterData,
                                                java.lang.String expectedMimeType,
                                                java.lang.String persistenceTypeString,
                                                java.lang.String returnTypeString,
                                                boolean realTimeFlag,
                                                java.io.File downloadsDir)
                                         throws NotAllowedException,
                                                java.io.IOException,
                                                PersistenceDisabledException

Throws:

NotAllowedException

java.io.IOException

PersistenceDisabledException

modifyGlobalRequestBlocking

public boolean modifyGlobalRequestBlocking(java.lang.String identifier,
                                           java.lang.String newToken,
                                           short newPriority)
                                    throws PersistenceDisabledException

Throws:

PersistenceDisabledException

makePersistentGlobalRequest

public void makePersistentGlobalRequest(FreenetURI fetchURI,
                                        boolean filterData,
                                        java.lang.String expectedMimeType,
                                        java.lang.String persistenceTypeString,
                                        java.lang.String returnTypeString,
                                        boolean realTimeFlag)
                                 throws NotAllowedException,
                                        java.io.IOException

Throws:

NotAllowedException

java.io.IOException

makePersistentGlobalRequest

public void makePersistentGlobalRequest(FreenetURI fetchURI,
                                        boolean filterData,
                                        java.lang.String expectedMimeType,
                                        java.lang.String persistenceTypeString,
                                        java.lang.String returnTypeString,
                                        boolean realTimeFlag,
                                        java.io.File downloadsDir)
                                 throws NotAllowedException,
                                        java.io.IOException

Create a persistent globally-queued request for a file.

Parameters:

fetchURI - The file to fetch.

persistenceTypeString - The persistence type.

returnTypeString - The return type.

downloadsDir - Target directory if downloading to disk. Must be valid!

Throws:

NotAllowedException

java.io.IOException

getGlobalForeverClient

public PersistentRequestClient getGlobalForeverClient()

Returns the global FCP client.

Returns:

The global FCP client

getGlobalRequest

public ClientRequest getGlobalRequest(java.lang.String identifier)

isDownloadDDAAlwaysAllowed

protected boolean isDownloadDDAAlwaysAllowed()

isUploadDDAAlwaysAllowed

protected boolean isUploadDDAAlwaysAllowed()

setCompletionCallback

public void setCompletionCallback(RequestCompletionCallback cb)

startBlocking

public void startBlocking(ClientRequest req,
                          ClientContext context)
                   throws IdentifierCollisionException,
                          PersistenceDisabledException

Start a request on the global queue. Return after it has started, e.g. it will show up on the queue page, it will persist after restart etc. Actually it won't persist until the next commit, but it's close...

Parameters:

req - The request (insert etc) to start.

container - The database handle. This method must be called on a DBJob.

context - The client layer context object.

Throws:

IdentifierCollisionException - If there is already a request with that identifier.

DatabaseDisabledException - If the database is disabled/broken/turned off, if we are shutting down, if we are waiting for the user to give us the decryption password etc.

PersistenceDisabledException

restartBlocking

public boolean restartBlocking(java.lang.String identifier,
                               boolean disableFilterData)
                        throws PersistenceDisabledException

Throws:

PersistenceDisabledException

getCompletedRequestBlocking

public FetchResult getCompletedRequestBlocking(FreenetURI key)
                                        throws PersistenceDisabledException

Throws:

PersistenceDisabledException

lookupInstant

public CacheFetchResult lookupInstant(FreenetURI key,
                                      boolean noFilter,
                                      boolean mustCopy,
                                      Bucket preferred)

Specified by:

lookupInstant in interface DownloadCache

lookup

public CacheFetchResult lookup(FreenetURI key,
                               boolean noFilter,
                               ClientContext context,
                               boolean mustCopy,
                               Bucket preferred)

Specified by:

lookup in interface DownloadCache