Author: jflesch
Date: 2007-07-08 17:35:21 +0000 (Sun, 08 Jul 2007)
New Revision: 13994
Modified:
trunk/apps/Thaw/src/thaw/fcp/FCPClientGet.java
trunk/apps/Thaw/src/thaw/fcp/FCPClientPut.java
trunk/apps/Thaw/src/thaw/fcp/FCPQueueLoader.java
trunk/apps/Thaw/src/thaw/plugins/fetchPlugin/FetchPanel.java
trunk/apps/Thaw/src/thaw/plugins/index/Comment.java
trunk/apps/Thaw/src/thaw/plugins/index/File.java
trunk/apps/Thaw/src/thaw/plugins/index/Index.java
trunk/apps/Thaw/src/thaw/plugins/insertPlugin/InsertPanel.java
Log:
Make the FCP API more readable
Modified: trunk/apps/Thaw/src/thaw/fcp/FCPClientGet.java
===================================================================
--- trunk/apps/Thaw/src/thaw/fcp/FCPClientGet.java 2007-07-08 16:56:02 UTC
(rev 13993)
+++ trunk/apps/Thaw/src/thaw/fcp/FCPClientGet.java 2007-07-08 17:35:21 UTC
(rev 13994)
@@ -10,6 +10,13 @@
import thaw.core.Logger;
public class FCPClientGet extends Observable implements Observer,
FCPTransferQuery {
+ public final static int DEFAULT_PRIORITY = 4;
+
+ public final static int PERSISTENCE_FOREVER = 0;
+ public final static int PERSISTENCE_UNTIL_NODE_REBOOT = 1;
+ public final static int PERSISTENCE_UNTIL_DISCONNECT = 2;
+
+
private int maxRetries = -1;
private final static int PACKET_SIZE = 1024;
private final static int BLOCK_SIZE = 16384;
@@ -19,9 +26,9 @@
private String key = null;
private String filename = null; /* Extract from the key */
- private int priority = 6;
- private int persistence = 0;
- private boolean globalQueue = false;
+ private int priority = DEFAULT_PRIORITY;
+ private int persistence = PERSISTENCE_FOREVER;
+ private boolean globalQueue = true;
private String destinationDir = null;
private String finalPath = null;
@@ -144,7 +151,7 @@
/**
* Entry point: Only for initial queries
* @param destinationDir if null => temporary file
- * @param persistence 0 = Forever ; 1 = Until node reboot ; 2 = Until
the app disconnect
+ * @param persistence PERSISTENCE_FOREVER ;
PERSISTENCE_UNTIL_NODE_REBOOT ; PERSISTENCE_UNTIL_DISCONNECT
*/
public FCPClientGet(final String key, final int priority,
final int persistence, boolean globalQueue,
@@ -152,7 +159,7 @@
String destinationDir) {
- if(globalQueue && (persistence >= 2))
+ if (globalQueue && (persistence >=
PERSISTENCE_UNTIL_DISCONNECT))
globalQueue = false; /* else protocol error */
progressReliable = false;
@@ -265,11 +272,11 @@
if(destinationDir != null)
queryMessage.setValue("ClientToken", destinationDir);
- if(persistence == 0)
+ if(persistence == PERSISTENCE_FOREVER)
queryMessage.setValue("Persistence", "forever");
- if(persistence == 1)
+ if(persistence == PERSISTENCE_UNTIL_NODE_REBOOT)
queryMessage.setValue("Persistence", "reboot");
- if(persistence == 2)
+ if(persistence == PERSISTENCE_UNTIL_DISCONNECT)
queryMessage.setValue("Persistence", "connection");
if(globalQueue)
@@ -1055,7 +1062,7 @@
successful =
Boolean.valueOf((String)parameters.get("Successful")).booleanValue();
maxRetries =
Integer.parseInt((String)parameters.get("MaxRetries"));
- if((persistence == 2) && !isFinished()) {
+ if((persistence == PERSISTENCE_UNTIL_DISCONNECT) &&
!isFinished()) {
progress = 0;
running = false;
status = "Waiting";
@@ -1066,7 +1073,7 @@
public boolean isPersistent() {
- return (persistence < 2);
+ return (persistence < PERSISTENCE_UNTIL_DISCONNECT);
}
Modified: trunk/apps/Thaw/src/thaw/fcp/FCPClientPut.java
===================================================================
--- trunk/apps/Thaw/src/thaw/fcp/FCPClientPut.java 2007-07-08 16:56:02 UTC
(rev 13993)
+++ trunk/apps/Thaw/src/thaw/fcp/FCPClientPut.java 2007-07-08 17:35:21 UTC
(rev 13994)
@@ -14,20 +14,28 @@
* Allow to insert a simple file.
*/
public class FCPClientPut extends Observable implements FCPTransferQuery,
Observer {
- public final static int DEFAULT_INSERTION_PRIORITY = 4;
+ public final static int DEFAULT_PRIORITY = 4;
+ public final static int KEY_TYPE_CHK = 0;
+ public final static int KEY_TYPE_KSK = 1;
+ public final static int KEY_TYPE_SSK = 2; /* also USK */
+
+ public final static int PERSISTENCE_FOREVER = 0;
+ public final static int PERSISTENCE_UNTIL_NODE_REBOOT = 1;
+ public final static int PERSISTENCE_UNTIL_DISCONNECT = 2;
+
private FCPQueueManager queueManager;
private File localFile;
private long fileSize = 0;
- private int keyType = 0;
+ private int keyType = KEY_TYPE_CHK;
private int rev = 0;
private String name;
private String privateKey; /* must finish by '/' (cf SSKKeypair) */
private String publicKey; /* publicKey contains the filename etc */
- private int priority = -1;
+ private int priority = DEFAULT_PRIORITY;
private boolean global = true;
- private int persistence = 2;
+ private int persistence = PERSISTENCE_FOREVER;
private boolean getCHKOnly = false;
private int progress = 0;
@@ -62,18 +70,17 @@
/**
* To start a new insertion.
- * @param keyType : 0 = CHK ; 1 = KSK ; 2 = SSK
+ * @param keyType : KEY_TYPE_CHK ; KEY_TYPE_KSK ; KEY_TYPE_SSK
* @param rev : ignored if key == CHK
* @param name : ignored if key == CHK
* @param privateKey : ignored if key == CHK/KSK ; can be null if it
has to be generated ; USK@[...]/
- * @param persistence 0 = Forever ; 1 = Until node reboot ; 2 = Until
the app disconnect
+ * @param persistence PERSISTENCE_FOREVER ;
PERSISTENCE_UNTIL_NODE_REBOOT ; PERSISTENCE_UNTIL_DISCONNEC
*/
public FCPClientPut(final File file, final int keyType,
final int rev, final String name,
final String privateKey, final int priority,
final boolean global, final int persistence) {
- this(file, keyType, rev, name, privateKey, priority, global,
persistence,
- false);
+ this(file, keyType, rev, name, privateKey, priority, global,
persistence, false);
}
/**
@@ -143,13 +150,13 @@
this.identifier = identifier;
if(publicKey.startsWith("CHK"))
- keyType = 0;
- if(publicKey.startsWith("KSK"))
- keyType = 1;
- if(publicKey.startsWith("SSK"))
- keyType = 2;
- if(publicKey.startsWith("USK"))
- keyType = 2;
+ keyType = KEY_TYPE_CHK;
+ else if(publicKey.startsWith("KSK"))
+ keyType = KEY_TYPE_KSK;
+ else if(publicKey.startsWith("SSK"))
+ keyType = KEY_TYPE_SSK;
+ else if(publicKey.startsWith("USK"))
+ keyType = KEY_TYPE_SSK;
this.publicKey = publicKey;
@@ -229,11 +236,11 @@
public boolean startProcess() {
- if((keyType == 2) && (privateKey == null)) {
+ if((keyType == KEY_TYPE_SSK) && (privateKey == null)) {
generateSSK();
}
- if( ((keyType == 2) && (privateKey != null)) || (keyType != 2))
{
+ if( ((keyType == KEY_TYPE_SSK) && (privateKey != null)) ||
(keyType != KEY_TYPE_SSK)) {
startInsert();
}
@@ -346,10 +353,10 @@
msg.setValue("ClientToken", localFile.getPath());
switch(persistence) {
- case(0): msg.setValue("Persistence", "forever"); break;
- case(1): msg.setValue("Persistence", "reboot"); break;
- case(2): msg.setValue("Persistence", "connection"); break;
- default: Logger.notice(this, "Unknow persistence !?"); break;
+ case(PERSISTENCE_FOREVER): msg.setValue("Persistence",
"forever"); break;
+ case(PERSISTENCE_UNTIL_NODE_REBOOT):
msg.setValue("Persistence", "reboot"); break;
+ case(PERSISTENCE_UNTIL_DISCONNECT): msg.setValue("Persistence",
"connection"); break;
+ default: Logger.error(this, "Unknow persistence !?"); break;
}
if (localFile != null)
@@ -591,9 +598,9 @@
publicKey = publicKey.replaceAll("freenet:",
"");
- if(keyType == 1)
+ if(keyType == KEY_TYPE_KSK)
publicKey = "KSK@"+name+"-" +
Integer.toString(rev);
- //if(keyType == 2)
+ //if(keyType == KEY_TYPE_SSK)
// publicKey = publicKey + "/" + name +
"-" + Integer.toString(rev);
@@ -879,15 +886,19 @@
public String getInsertionKey() {
String key = null;
- if ((keyType == 0) && (publicKey != null))
+ if ((keyType == KEY_TYPE_CHK) && (publicKey != null))
key = publicKey;
- if ((keyType == 0) && (publicKey == null))
+
+ else if ((keyType == KEY_TYPE_CHK) && (publicKey == null))
key = "CHK@";
- if (keyType == 1)
+
+ else if (keyType == KEY_TYPE_KSK)
key = "KSK@" + name + "-"+ Integer.toString(rev);
- if (keyType == 2 && privateKey.startsWith("SSK"))
+
+ else if (keyType == KEY_TYPE_SSK &&
privateKey.startsWith("SSK"))
key = privateKey + name+"-"+rev;
- if (keyType == 2 && privateKey.startsWith("USK"))
+
+ else if (keyType == KEY_TYPE_SSK &&
privateKey.startsWith("USK"))
key = privateKey + name + "/" + rev;
if (key == null) {
@@ -1009,7 +1020,7 @@
successful =
Boolean.valueOf((String)parameters.get("successful")).booleanValue();
finished =
Boolean.valueOf((String)parameters.get("finished")).booleanValue();
- if((persistence == 2) && !isFinished()) {
+ if ((persistence == PERSISTENCE_UNTIL_DISCONNECT) &&
!isFinished()) {
progress = 0;
status = "Waiting";
}
Modified: trunk/apps/Thaw/src/thaw/fcp/FCPQueueLoader.java
===================================================================
--- trunk/apps/Thaw/src/thaw/fcp/FCPQueueLoader.java 2007-07-08 16:56:02 UTC
(rev 13993)
+++ trunk/apps/Thaw/src/thaw/fcp/FCPQueueLoader.java 2007-07-08 17:35:21 UTC
(rev 13994)
@@ -50,10 +50,12 @@
if("PersistentGet".equals( msg.getMessageName() )) {
Logger.info(this, "Resuming from PersistentGet");
- int persistence = 0;
+ int persistence = FCPClientGet.PERSISTENCE_FOREVER;
if("reboot".equals( msg.getValue("PersistenceType") ))
- persistence = 1;
+ persistence =
FCPClientGet.PERSISTENCE_UNTIL_NODE_REBOOT;
+ else if ("connection".equals(
msg.getValue("PersistenceType") ))
+ persistence =
FCPClientGet.PERSISTENCE_UNTIL_DISCONNECT;
boolean global = true;
@@ -86,11 +88,12 @@
if("PersistentPut".equals( msg.getMessageName() )) {
Logger.info(this, "Resuming from PersistentPut");
- int persistence = 0;
+ int persistence = FCPClientGet.PERSISTENCE_FOREVER;
- if((msg.getValue("PersistenceType") != null)
- && msg.getValue("PersistenceType").equals("reboot"))
- persistence = 1;
+ if("reboot".equals( msg.getValue("PersistenceType") ))
+ persistence =
FCPClientGet.PERSISTENCE_UNTIL_NODE_REBOOT;
+ else if ("connection".equals(
msg.getValue("PersistenceType") ))
+ persistence =
FCPClientGet.PERSISTENCE_UNTIL_DISCONNECT;
boolean global = true;
@@ -121,10 +124,14 @@
final FCPClientPut clientPut = new
FCPClientPut(msg.getValue("Identifier"),
msg.getValue("URI"), // key
-
priority, persistence, global,
+
priority,
+
persistence,
+ global,
filePath,
fileName,
-
"Inserting", 0, fileSize,
+
"Inserting",
+ 0, /*
progress */
+
fileSize,
queueManager);
Modified: trunk/apps/Thaw/src/thaw/plugins/fetchPlugin/FetchPanel.java
===================================================================
--- trunk/apps/Thaw/src/thaw/plugins/fetchPlugin/FetchPanel.java
2007-07-08 16:56:02 UTC (rev 13993)
+++ trunk/apps/Thaw/src/thaw/plugins/fetchPlugin/FetchPanel.java
2007-07-08 17:35:21 UTC (rev 13994)
@@ -223,8 +223,8 @@
fetchPlugin.fetchFiles(fileList.getText().split("\n"),
- priority, 0, globalQueue,
- destinationField.getText());
+ priority,
thaw.fcp.FCPClientGet.PERSISTENCE_FOREVER,
+ globalQueue,
destinationField.getText());
fileList.setText("");
}
Modified: trunk/apps/Thaw/src/thaw/plugins/index/Comment.java
===================================================================
--- trunk/apps/Thaw/src/thaw/plugins/index/Comment.java 2007-07-08 16:56:02 UTC
(rev 13993)
+++ trunk/apps/Thaw/src/thaw/plugins/index/Comment.java 2007-07-08 17:35:21 UTC
(rev 13994)
@@ -470,9 +470,14 @@
if (xmlFile == null)
return false;
- FCPClientPut put = new FCPClientPut(xmlFile, 2, 0, "comment",
+ FCPClientPut put = new FCPClientPut(xmlFile,
+ FCPClientPut.KEY_TYPE_SSK,
+ 0, /* rev : as we insert as
USK => EDONTCARE */
+ "comment", /* filename (not
really used anymore) */
FreenetURIHelper.convertSSKtoUSK(privateKey)+"/", /* the convertion fonction
forget the '/' */
- 2, false, 0);
+ 2, /* priority */
+ false, /* global */
+
FCPClientPut.PERSISTENCE_FOREVER ); /* persistence */
put.addObserver(this);
return queueManager.addQueryToTheRunningQueue(put);
@@ -797,7 +802,8 @@
publicKey += "comment-"+Integer.toString(rev)+"/comment.xml";
- FCPClientGet get = new FCPClientGet(publicKey, 2 /* priority
*/, 2 /* persistence */,
+ FCPClientGet get = new FCPClientGet(publicKey, 2 /* priority */,
+
FCPClientGet.PERSISTENCE_UNTIL_DISCONNECT /* persistence */,
false /* global queue */, 3
/* max retries */,
System.getProperty("java.io.tmpdir"),
MAX_SIZE, true /* no DDA
*/);
Modified: trunk/apps/Thaw/src/thaw/plugins/index/File.java
===================================================================
--- trunk/apps/Thaw/src/thaw/plugins/index/File.java 2007-07-08 16:56:02 UTC
(rev 13993)
+++ trunk/apps/Thaw/src/thaw/plugins/index/File.java 2007-07-08 17:35:21 UTC
(rev 13994)
@@ -286,7 +286,12 @@
return null;
}
- final FCPClientGet clientGet = new FCPClientGet(publicKey, 4,
0, true, -1, targetPath);
+ final FCPClientGet clientGet = new FCPClientGet(publicKey,
+
FCPClientGet.DEFAULT_PRIORITY,
+
FCPClientGet.PERSISTENCE_FOREVER,
+ true, /* <=
global queue */
+ -1, /* <= max
retries */
+ targetPath);
queueManager.addQueryToThePendingQueue(clientGet);
@@ -311,7 +316,13 @@
}
final FCPClientPut clientPut = new FCPClientPut(new
java.io.File(localPath),
- 0, 0, null,
null, 4, true, 0);
+
FCPClientPut.KEY_TYPE_CHK,
+ 0, /* rev
: EDONTCARE */
+ null, /* name
: EDONTCARE */
+ null, /*
privateKey : EDONTCARE */
+
FCPClientPut.DEFAULT_PRIORITY,
+ true, /* global
queue */
+
FCPClientPut.PERSISTENCE_FOREVER);
queueManager.addQueryToThePendingQueue(clientPut);
clientPut.addObserver(this);
Modified: trunk/apps/Thaw/src/thaw/plugins/index/Index.java
===================================================================
--- trunk/apps/Thaw/src/thaw/plugins/index/Index.java 2007-07-08 16:56:02 UTC
(rev 13993)
+++ trunk/apps/Thaw/src/thaw/plugins/index/Index.java 2007-07-08 17:35:21 UTC
(rev 13994)
@@ -707,7 +707,10 @@
rev++;
- put = new FCPClientPut(targetFile, 2, rev, realName,
privateKey, 2, true, 0);
+ put = new FCPClientPut(targetFile,
FCPClientPut.KEY_TYPE_SSK,
+ rev, realName, privateKey, 2
/*priority*/,
+ true /* global queue */,
+
FCPClientPut.PERSISTENCE_FOREVER);
put.setMetadata("ContentType",
"application/x-freenet-index");
if (indexBrowser != null && indexBrowser.getIndexTree()
!= null)
@@ -826,9 +829,14 @@
Logger.debug(this, "Key asked: "+key);
- clientGet = new FCPClientGet(key, 2, 2, false, 5,
-
System.getProperty("java.io.tmpdir"),
- MAX_SIZE, true /* <= noDDA */);
+ clientGet = new FCPClientGet(key,
+ 2, /* <= priority */
+
FCPClientGet.PERSISTENCE_UNTIL_DISCONNECT,
+ false, /* <= globalQueue */
+ 5, /* maxRetries */
+
System.getProperty("java.io.tmpdir"), /* destination directory */
+ MAX_SIZE, /* max size */
+ true /* <= noDDA */);
/*
* These requests are usually quite fast, and don't consume too
much
Modified: trunk/apps/Thaw/src/thaw/plugins/insertPlugin/InsertPanel.java
===================================================================
--- trunk/apps/Thaw/src/thaw/plugins/insertPlugin/InsertPanel.java
2007-07-08 16:56:02 UTC (rev 13993)
+++ trunk/apps/Thaw/src/thaw/plugins/insertPlugin/InsertPanel.java
2007-07-08 17:35:21 UTC (rev 13994)
@@ -300,7 +300,7 @@
return;
}
- if((keyType == 1) || (keyType == 2)) {
+ if((keyType == FCPClientPut.KEY_TYPE_KSK) || (keyType
== FCPClientPut.KEY_TYPE_SSK)) {
if((nameField.getText() == null)
|| "".equals( nameField.getText() )
|| (revField.getText() == null)
@@ -314,7 +314,7 @@
name = nameField.getText();
}
- if(keyType == 2) {
+ if(keyType == FCPClientPut.KEY_TYPE_SSK) {
if((privateKeyField.getText() != null)
&& !"".equals( privateKeyField.getText() )) {
privateKey = privateKeyField.getText();
@@ -349,7 +349,7 @@
insertPlugin.insertFile(selectedFiles.getText(),
keyType, rev, name, privateKey,
priority,
- global, 0, mimeType);
+ global,
FCPClientPut.PERSISTENCE_FOREVER, mimeType);
selectedFiles.setText("");
}
@@ -399,7 +399,7 @@
selectedFiles.setText(fileList);
- if(keyType != 0)
+ if(keyType != FCPClientPut.KEY_TYPE_CHK)
nameField.setText(getFileNameFromPath());
}
}
@@ -422,7 +422,7 @@
resetOptionalFields();
- keyType = 0;
+ keyType = FCPClientPut.KEY_TYPE_CHK;
return;
}
@@ -434,7 +434,7 @@
resetOptionalFields();
- keyType = 1;
+ keyType = FCPClientPut.KEY_TYPE_KSK;
return;
}
@@ -445,7 +445,7 @@
resetOptionalFields();
- keyType = 2;
+ keyType = FCPClientPut.KEY_TYPE_SSK;
return;
}
}
