/*
- * todesbaum-lib -
- * Copyright (C) 2006 David Roden
+ * jSite - ClientPutDir.java - Copyright © 2006–2012 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
/**
* Abstract base class for all put requests that insert a directory.
- *
+ *
+ * @param <C>
+ * The type of the “ClientPutDir” command
* @author David Roden <droden@gmail.com>
- * @version $Id: ClientPutDir.java 356 2006-03-24 15:13:38Z bombe $
*/
-public class ClientPutDir extends ClientPut {
+public class ClientPutDir<C extends ClientPutDir<?>> extends ClientPut {
+
+ /**
+ * All possible manifest putters. Manifest putters are used to distribute
+ * files of a directory insert to different containers, depending on size,
+ * type, and other factors.
+ *
+ * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
+ */
+ public enum ManifestPutter {
+
+ /**
+ * Use the “simple” manifest putter. Despite its name this is currently
+ * the default manifest putter.
+ */
+ SIMPLE("simple"),
+
+ /** Use the “default” manifest putter. */
+ DEFAULT("default");
+
+ /** The name of the manifest putter. */
+ private final String name;
+
+ /**
+ * Creates a new manifest putter.
+ *
+ * @param name
+ * The name of the manifest putter
+ */
+ private ManifestPutter(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Returns the name of the manifest putter.
+ *
+ * @return The name of the manifest putter
+ */
+ public String getName() {
+ return name;
+ }
+
+ //
+ // OBJECT METHODS
+ //
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public String toString() {
+ return name.substring(0, 1).toUpperCase() + name.substring(1);
+ }
+
+ }
/** The default file of the directory. */
protected String defaultName;
+ /** The manifest putter to use. */
+ private ManifestPutter manifestPutter;
+
/**
* Creates a new request with the specified name, identifier, and URI.
- *
+ *
* @param name
* The name of the request
* @param identifier
/**
* Returns the default name of the directory.
- *
+ *
* @return The default name of the directory
*/
public String getDefaultName() {
* requested without a filename. It's about the same as the
* <code>index.html</code> file that gets delivered if you only request a
* directory from a webserver.
- *
+ *
* @param defaultName
* The default name of the directory
*/
}
/**
+ * Returns the current manifest putter.
+ *
+ * @return The current manifest putter (may be {@code null})
+ */
+ public ManifestPutter getManifestPutter() {
+ return manifestPutter;
+ }
+
+ /**
+ * Sets the manifest putter for the “ClientPutDir” command. If {@code null}
+ * is given the node will choose a manifest putter.
+ *
+ * @param manifestPutter
+ * The manifest putter to use for the command (may be
+ * {@code null})
+ * @return This ClientPutDir command
+ */
+ @SuppressWarnings("unchecked")
+ public C setManifestPutter(ManifestPutter manifestPutter) {
+ this.manifestPutter = manifestPutter;
+ return (C) this;
+ }
+
+ /**
* {@inheritDoc}
*/
@Override
super.write(writer);
if (defaultName != null)
writer.write("DefaultName=" + defaultName + LINEFEED);
+ if (manifestPutter != null) {
+ writer.write("ManifestPutter=" + manifestPutter.getName() + LINEFEED);
+ }
}
}