freenet.support.plugins.helpers1

Class WebInterfaceToadlet

java.lang.Object

freenet.clients.http.Toadlet

freenet.support.plugins.helpers1.WebInterfaceToadlet

All Implemented Interfaces:

LinkEnabledCallback

Direct Known Subclasses:

InvisibleWebInterfaceToadlet

public abstract class WebInterfaceToadlet
extends Toadlet
implements LinkEnabledCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected PluginContext	pluginContext

Fields inherited from class freenet.clients.http.Toadlet

HANDLE_METHOD_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebInterfaceToadlet(PluginContext pluginContext2, java.lang.String pluginURL, java.lang.String pageName)

Method Summary

Modifier and Type	Method and Description
HTMLNode	createErrorBox(java.util.List<java.lang.String> errors)
HTMLNode	createErrorBox(java.util.List<java.lang.String> errors, java.lang.String path, FreenetURI retryUri, java.lang.String extraParams)
boolean	isEnabled(ToadletContext ctx) Whether to show the link?
protected boolean	isFormPassword(HTTPRequest req) Validates whether the request contains a formPassword which matches NodeClientCore.formPassword.
protected java.lang.String	normalizePath(java.lang.String path) returns allways at min a "/", but "/path" is allways without trailing '/' so "/path/to/toadlet/blah" and "/path/to/toadlet/blah/" cant be distinguished
java.lang.String	path()

Methods inherited from class freenet.clients.http.Toadlet

addHomepageLink, allowPOSTWithoutPassword, findSupportedMethods, getClientImpl, handleMethodGET, sendErrorPage, sendErrorPage, sendErrorPage, showAsToadlet, showAsToadlet, writeHTMLReply, writeHTMLReply, writeHTMLReply, writeInternalError, writeReply, writeReply, writeReply, writeReply, writeReply, writeReply, writeTemporaryRedirect, writeTextReply, writeTextReply

Methods inherited from class java.lang.Object

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

Field Detail

pluginContext

protected final PluginContext pluginContext

Constructor Detail

WebInterfaceToadlet

protected WebInterfaceToadlet(PluginContext pluginContext2,
                              java.lang.String pluginURL,
                              java.lang.String pageName)

Method Detail

path

public java.lang.String path()

Specified by:

path in class Toadlet

isEnabled

public boolean isEnabled(ToadletContext ctx)

Description copied from interface: LinkEnabledCallback

Whether to show the link?

Specified by:

isEnabled in interface LinkEnabledCallback

Parameters:

ctx - The request which is asking. Can be null.

normalizePath

protected java.lang.String normalizePath(java.lang.String path)

returns allways at min a "/", but "/path" is allways without trailing '/' so "/path/to/toadlet/blah" and "/path/to/toadlet/blah/" cant be distinguished

Parameters:

path -

Returns:

the path without "/path/to/toadlet"

isFormPassword

protected boolean isFormPassword(HTTPRequest req)

Validates whether the request contains a formPassword which matches NodeClientCore.formPassword. See the JavaDoc there for an explanation of the purpose of this mechanism.

ATTENTION: It is critically important to use this function when processing requests which "change the server state". Other words for this would be requests which change your database or "write" requests. Requests which only read values from the server don't have to validate the form password.

To produce a form which already contains the password, use PluginRespirator.addFormChild(freenet.support.HTMLNode, String, String).

Returns:

true if the form password is valid

createErrorBox

public HTMLNode createErrorBox(java.util.List<java.lang.String> errors)

createErrorBox

public HTMLNode createErrorBox(java.util.List<java.lang.String> errors,
                               java.lang.String path,
                               FreenetURI retryUri,
                               java.lang.String extraParams)