/*
- * jSite2 - ClientPut.java -
- * Copyright © 2008 David Roden
+ * jFCPlib - ClientPut.java - Copyright © 2008 David Roden
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
/**
* A “ClientPut” requests inserts a single file into freenet, either uploading
* it directly with this messge ({@link UploadFrom#direct}), uploading it from
- * disk ({@link UploadFrom#disk}) or by creating a redirect to another URI ({@link UploadFrom#redirect}).
- *
+ * disk ({@link UploadFrom#disk}) or by creating a redirect to another URI (
+ * {@link UploadFrom#redirect}).
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
- * @version $Id$
*/
public class ClientPut extends FcpMessage {
* constructor is the same as using
* {@link #ClientPut(String, String, UploadFrom)} with
* {@link UploadFrom#direct} as third parameter.
- *
+ *
* @param uri
* The URI to insert the file to
* @param identifier
/**
* Creates a new “ClientPut” message that inserts a file to the given URI.
- * Depending on <code>uploadFrom</code> the file data has to be supplied
- * in different ways: If <code>uploadFrom</code> is
- * {@link UploadFrom#direct}, use
- * {@link #setPayloadInputStream(java.io.InputStream)} to supply the input
- * data. If <code>uploadFrom</code> is {@link UploadFrom#disk}, use
+ * Depending on <code>uploadFrom</code> the file data has to be supplied in
+ * different ways: If <code>uploadFrom</code> is {@link UploadFrom#direct},
+ * use {@link #setPayloadInputStream(java.io.InputStream)} to supply the
+ * input data. If <code>uploadFrom</code> is {@link UploadFrom#disk}, use
* {@link #setFilename(String)} to supply the file to upload. You have to
* test your direct-disk access (see {@link TestDDARequest},
* {@link TestDDAReply}, {@link TestDDAResponse}, {@link TestDDAComplete})
* before using this option! If <code>uploadFrom</code> is
- * {@link UploadFrom#redirect}, use {@link #setTargetURI(String)} to set
- * the target URI of the redirect.
- *
+ * {@link UploadFrom#redirect}, use {@link #setTargetURI(String)} to set the
+ * target URI of the redirect.
+ *
* @param uri
* The URI to insert to
* @param identifier
/**
* The MIME type of the content.
- *
+ *
* @param metadataContentType
* The MIME type of the content
*/
* The verbosity of the request. Depending on this parameter you will
* received only the bare minimum of messages for the request (i.e. “it
* completed”) or a whole lot more.
- *
+ *
* @see Verbosity
* @param verbosity
* The verbosity of the request
/**
* The number of retries for a request if the initial try failed.
- *
+ *
* @param maxRetries
* The maximum number of retries after failure, or
* <code>-1</code> to retry forever.
/**
* Sets the priority of the request.
- *
+ *
* @param priority
* The priority of the request
*/
/**
* Determines whether the node should really insert the data or generate the
* final CHK only.
- *
+ *
* @param getCHKOnly
* <code>true</code> to generate the final CHK only,
* <code>false</code> to really insert the data
/**
* Determines whether this request appears on the global queue.
- *
+ *
* @param global
* <code>true</code> to put the request on the global queue,
* <code>false</code> for the client-local queue.
/**
* Determines whether the node should skip compression because the file has
* already been compressed.
- *
+ *
* @param dontCompress
- * <code>true</code> to skip compression of the data in the
- * node, <code>false</code> to allow compression
+ * <code>true</code> to skip compression of the data in the node,
+ * <code>false</code> to allow compression
*/
public void setDontCompress(boolean dontCompress) {
setField("DontCompress", String.valueOf(dontCompress));
* Sets an optional client token. This client token is mentioned in progress
* and other request-related messages and can be used to identify this
* request.
- *
+ *
* @param clientToken
* The client token
*/
/**
* Sets the persistence of this request.
- *
+ *
* @param persistence
* The persistence of this request
*/
/**
* Sets the target filename of the inserted file. This value is ignored for
* all inserts that do not have “CHK@” as a target.
- *
+ *
* @param targetFilename
* The filename of the target
*/
/**
* Determines whether to encode the complete file early in the life of the
* request.
- *
+ *
* @param earlyEncode
* <code>true</code> to generate the final key long before the
* file is completely fetchable
/**
* Sets the length of the data that will be transferred after this message
* if <code>uploadFrom</code> is {@link UploadFrom#direct} is used.
- *
+ *
* @param dataLength
* The length of the data
*/
/**
* Sets the name of the file to upload the data from.
- *
+ *
* @param filename
* The filename to upload
*/
/**
* If <code>uploadFrom</code> is {@link UploadFrom#redirect}, use this
* method to determine that target of the redirect.
- *
+ *
* @param targetURI
* The target URI to redirect to
*/