freenet.clients.fcp

Class FCPConnectionHandler

java.lang.Object

freenet.clients.fcp.FCPConnectionHandler

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class FCPConnectionHandler
extends java.lang.Object
implements java.io.Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FCPConnectionHandler.DDACheckJob

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	connectionIdentifier Deprecated. Use connectionIdentifierUUID instead.
protected java.util.UUID	connectionIdentifierUUID Random UUID unique for each instance of this class
RequestClient	connectionRequestClientBulk
RequestClient	connectionRequestClientRT
FCPConnectionOutputHandler	outputHandler

Constructor Summary

Constructors

Constructor and Description
FCPConnectionHandler(java.net.Socket s, FCPServer server)

Method Summary

Modifier and Type	Method and Description
void	addUSKSubscription(java.lang.String identifier, SubscribeUSK subscribeUSK)
protected boolean	allowDDAFrom(java.io.File filename, boolean writeRequest) That method ought to be called before any DirectDiskAccess operation is performed by the node
void	close()
void	closedInput()
void	closedOutput()
RequestClient	connectionRequestClient(boolean realTime)
protected PersistentRequestClient	createForeverClient(java.lang.String name)
protected FCPConnectionHandler.DDACheckJob	enqueueDDACheck(java.lang.String path, boolean read, boolean write) Return a DDACheckJob : the one we created and have enqueued
void	finishedClientRequest(ClientRequest get)
protected void	freeDDAJobs() Delete the files we have created using DDATest called by PersistentRequestClient.onDisconnect(handler)
java.lang.String	getClientName()
PersistentRequestClient	getForeverClient()
PersistentRequestClient	getRebootClient()
boolean	hasFullAccess()
boolean	isClosed()
boolean	isGlobalSubscribed()
protected FCPConnectionHandler.DDACheckJob	popDDACheck(java.lang.String path) Return a DDACheckJob or null if not found
protected void	registerTestDDAResult(java.lang.String path, boolean read, boolean write) SHOULD BE CALLED ONLY FROM TestDDAComplete!
ClientRequest	removeRequestByIdentifier(java.lang.String identifier, boolean kill)
void	send(FCPMessage message) Queues the message for sending at the FCPConnectionOutputHandler. ATTENTION: The function will return immediately before even trying to send the message, the message will be sent asynchronously. As a consequence, this function not throwing does not give any guarantee whatsoever that the message will ever be sent.
void	setClientName(java.lang.String name)
void	startClientGet(ClientGetMessage message) Start a ClientGet.
void	startClientPut(ClientPutMessage message)
void	startClientPutDir(ClientPutDirMessage message, java.util.HashMap<java.lang.String,java.lang.Object> buckets, boolean wasDiskPut)
void	unsubscribeUSK(java.lang.String identifier)

Methods inherited from class java.lang.Object

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

Field Detail

outputHandler

public final FCPConnectionOutputHandler outputHandler

connectionIdentifier

@Deprecated
public final java.lang.String connectionIdentifier

Deprecated. Use connectionIdentifierUUID instead.

16 random bytes hex-encoded as String. Unique for each instance of this class.

connectionIdentifierUUID

protected final java.util.UUID connectionIdentifierUUID

Random UUID unique for each instance of this class

connectionRequestClientBulk

public final RequestClient connectionRequestClientBulk

connectionRequestClientRT

public final RequestClient connectionRequestClientRT

Constructor Detail

FCPConnectionHandler

public FCPConnectionHandler(java.net.Socket s,
                            FCPServer server)

Method Detail

send

public final void send(FCPMessage message)

Queues the message for sending at the FCPConnectionOutputHandler.

ATTENTION: The function will return immediately before even trying to send the message, the message will be sent asynchronously.
As a consequence, this function not throwing does not give any guarantee whatsoever that the message will ever be sent.

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isClosed

public boolean isClosed()

closedInput

public void closedInput()

closedOutput

public void closedOutput()

setClientName

public void setClientName(java.lang.String name)

createForeverClient

protected PersistentRequestClient createForeverClient(java.lang.String name)

getClientName

public java.lang.String getClientName()

startClientGet

public void startClientGet(ClientGetMessage message)

Start a ClientGet. If there is an identifier collision, queue an IdentifierCollisionMessage. Hence, we can run stuff on other threads if we need to, as long as we send the right messages.

startClientPut

public void startClientPut(ClientPutMessage message)

startClientPutDir

public void startClientPutDir(ClientPutDirMessage message,
                              java.util.HashMap<java.lang.String,java.lang.Object> buckets,
                              boolean wasDiskPut)

getRebootClient

public PersistentRequestClient getRebootClient()

getForeverClient

public PersistentRequestClient getForeverClient()

finishedClientRequest

public void finishedClientRequest(ClientRequest get)

isGlobalSubscribed

public boolean isGlobalSubscribed()

hasFullAccess

public boolean hasFullAccess()

allowDDAFrom

protected boolean allowDDAFrom(java.io.File filename,
                               boolean writeRequest)

That method ought to be called before any DirectDiskAccess operation is performed by the node

Parameters:

filename -

writeRequest - : Are willing to write or to read ?

Returns:

boolean : allowed or not

registerTestDDAResult

protected void registerTestDDAResult(java.lang.String path,
                                     boolean read,
                                     boolean write)

SHOULD BE CALLED ONLY FROM TestDDAComplete!

Parameters:

path -

read -

write -

enqueueDDACheck

protected FCPConnectionHandler.DDACheckJob enqueueDDACheck(java.lang.String path,
                                                           boolean read,
                                                           boolean write)
                                                    throws java.lang.IllegalArgumentException

Return a DDACheckJob : the one we created and have enqueued

Parameters:

path -

read - : is Read access requested ?

write - : is Write access requested ?

Returns:

Throws:

java.lang.IllegalArgumentException - FIXME: Maybe we need to enqueue a PS job to delete the created file after something like ... 5 mins ?

popDDACheck

protected FCPConnectionHandler.DDACheckJob popDDACheck(java.lang.String path)
                                                throws java.lang.IllegalArgumentException

Return a DDACheckJob or null if not found

Parameters:

path -

Returns:

the DDACheckJob

Throws:

java.lang.IllegalArgumentException

freeDDAJobs

protected void freeDDAJobs()

Delete the files we have created using DDATest called by PersistentRequestClient.onDisconnect(handler)

removeRequestByIdentifier

public ClientRequest removeRequestByIdentifier(java.lang.String identifier,
                                               boolean kill)

addUSKSubscription

public void addUSKSubscription(java.lang.String identifier,
                               SubscribeUSK subscribeUSK)
                        throws IdentifierCollisionException

Throws:

IdentifierCollisionException

unsubscribeUSK

public void unsubscribeUSK(java.lang.String identifier)
                    throws MessageInvalidException

Throws:

MessageInvalidException

connectionRequestClient

public RequestClient connectionRequestClient(boolean realTime)