Added some JavaDoc.

pull/105/head
luccioman 8 years ago
parent 52d05d14c6
commit e3892b0957

@ -58,6 +58,13 @@ import net.yacy.server.serverSwitch;
import org.xml.sax.SAXException;
/**
* Handle blacklist import operations. Either :
* <ul>
* <li>load items for selection</li>
* <li>or import selected items</li>
* </ul>
*/
public class sharedBlacklist_p {
public static final int STATUS_NONE = 0;
@ -68,6 +75,19 @@ public class sharedBlacklist_p {
public static final int STATUS_WRONG_INVOCATION = 5;
public static final int STATUS_PARSE_ERROR = 6;
/**
* Try to load blacklist items for selection or to import selected items.
* Handled blacklist source types :
* <ul>
* <li>hash : hash signature of a peer having a shared blacklist</li>
* <li>url : blacklist url</li>
* <li>file : local filesystem blacklist file path</li>
* </ul>
* @param header current servlet request header
* @param post must contain selected blacklist items or a blacklist resource to load
* @param env server environment
* @return the servlet answer
*/
public static serverObjects respond(@SuppressWarnings("unused") final RequestHeader header, final serverObjects post, final serverSwitch env) {
final Switchboard sb = (Switchboard) env;
// return variable that accumulates replacements

@ -78,7 +78,11 @@ public class serverObjects implements Serializable, Cloneable {
private static final long serialVersionUID = 3999165204849858546L;
public static final String ACTION_AUTHENTICATE = "AUTHENTICATE";
/** Key for an URL redirection : should be associated with the redirected location.
* The main servlet handles this to produce an HTTP 302 status. */
public static final String ACTION_LOCATION = "LOCATION";
public final static String ADMIN_AUTHENTICATE_MSG = "admin log-in. If you don't know the password, set it with {yacyhome}/bin/passwd.sh {newpassword}";
private final static Pattern patternNewline = Pattern.compile("\n");

Loading…
Cancel
Save