freenet.clients.http

Interface ToadletContainer

All Known Implementing Classes:

SimpleToadletServer

public interface ToadletContainer

Interface for toadlet containers. Toadlets should register here.

Method Summary

Modifier and Type	Method and Description
HTMLNode	addFormChild(HTMLNode parentNode, java.lang.String target, java.lang.String name)
boolean	allowPosts() Can we deal with POSTs yet?
boolean	disableProgressPage()
boolean	doRobots() Whether to tell spiders to go away
boolean	enableActivelinks()
boolean	enableCachingForChkAndSskKeys()
boolean	enableExtendedMethodHandling()
boolean	enableInlinePrefetch()
boolean	enablePersistentConnections()
Toadlet	findToadlet(java.net.URI uri) Find a Toadlet by URI.
boolean	fproxyHasCompletedWizard()
long	generateUniqueID() Create a unique ID for a ToadletContext
BucketFactory	getBucketFactory() Get the BucketFactory
java.lang.String	getFormPassword() Get the form password
java.io.File	getOverrideFile()
PageMaker	getPageMaker()
FProxyFetchInProgress.REFILTER_POLICY	getReFilterPolicy() What to do when we find cached data on the global queue but it's already been filtered, and we want a filtered copy.
PageMaker.THEME	getTheme() Get the name of the theme to be used by all the Toadlets
java.lang.String	getURL()
java.lang.String	getURL(java.lang.String host)
boolean	isAdvancedModeEnabled()
boolean	isAllowedFullAccess(java.net.InetAddress remoteAddr) Is the given IP address allowed full access to the node?
boolean	isFProxyJavascriptEnabled()
boolean	isFProxyWebPushingEnabled()
boolean	isSSL()
boolean	publicGatewayMode() Was public-gateway mode enabled on startup? (Changing it won't take effect until restart because of bookmark-related issues).
void	register(Toadlet t, java.lang.String menu, java.lang.String urlPrefix, boolean atFront, boolean fullAccessOnly) Register a Toadlet.
void	register(Toadlet t, java.lang.String menu, java.lang.String urlPrefix, boolean atFront, java.lang.String name, java.lang.String title, boolean fullOnly, LinkEnabledCallback cb) Registers a Toadlet and optionally adds a navigation link to the menu.
void	register(Toadlet t, java.lang.String menu, java.lang.String urlPrefix, boolean atFront, java.lang.String name, java.lang.String title, boolean fullOnly, LinkEnabledCallback cb, FredPluginL10n l10n) Registers a Toadlet and optionally adds a navigation link to the menu.
boolean	sendAllThemes()
void	setAdvancedMode(boolean enabled)
void	unregister(Toadlet t)

Method Detail

register

void register(Toadlet t,
              java.lang.String menu,
              java.lang.String urlPrefix,
              boolean atFront,
              boolean fullAccessOnly)

Register a Toadlet. All requests whose URL starts with the given prefix will be passed to this toadlet.

Parameters:

t - the toadlet to register

menu - the menu category to register a navigation link with with. It is most likely also a l10n key, though that is irrelevant to this method.

urlPrefix - the prefix that the Toadlet will serve; should be a path like /foo/bar/baz, most likely the string returned by the toadlet's path() method

atFront - If true, this Toadlet will take precedence over any other previously-registered Toadlet whose urlPrefix also matches. Otherwise, the other matching Toadlet is used instead.

fullOnly - Whether or not the navigation link is shown when the http client does not have full security access. Note that passing false does not prevent the Toadlet from receiving requests under urlPrefix, so Toadlet authors are advised to check for full access themselves, possibly returning a 403 error code.

register

void register(Toadlet t,
              java.lang.String menu,
              java.lang.String urlPrefix,
              boolean atFront,
              java.lang.String name,
              java.lang.String title,
              boolean fullOnly,
              LinkEnabledCallback cb)

Registers a Toadlet and optionally adds a navigation link to the menu. All requests whose URL starts with the given prefix will be given to this Toadlet. If either the menu or the name parameter is null, then no navigation link is be registered for the Toadlet and the title, fullOnly, cb, and l10n parameters are ignored.

Parameters:

t - the toadlet to register

menu - the menu category to register a navigation link with with. It is most likely also a l10n key, though that is irrelevant to this method.

urlPrefix - the prefix that the Toadlet will serve; should be a path like /foo/bar/baz, most likely the string returned by the toadlet's path() method

atFront - If true, this Toadlet will take precedence over any other previously-registered Toadlet whose urlPrefix also matches. Otherwise, the other matching Toadlet is used instead.

name - A l10n key used for the navigation link label.

title - A l10n key used for the navigation link tooltip.

fullOnly - Whether or not the navigation link is shown when the http client does not have full security access. Note that passing false does not prevent the Toadlet from receiving requests under urlPrefix, so Toadlet authors are advised to check for full access themselves, possibly returning a 403 error code.

cb - A LinkEnabledCalback, allowing fine control of when the navigation link is visible and when it isn't. Passing null means it is always visible.

register

void register(Toadlet t,
              java.lang.String menu,
              java.lang.String urlPrefix,
              boolean atFront,
              java.lang.String name,
              java.lang.String title,
              boolean fullOnly,
              LinkEnabledCallback cb,
              FredPluginL10n l10n)

Registers a Toadlet and optionally adds a navigation link to the menu. All requests whose URL starts with the given prefix will be given to this Toadlet. If either the menu or the name parameter is null, then no navigation link is be registered for the Toadlet and the title, fullOnly, cb, and l10n parameters are ignored.

Parameters:

t - the toadlet to register

menu - the menu category to register a navigation link with with. It is most likely also a l10n key, though that is irrelevant to this method.

urlPrefix - the prefix that the Toadlet will serve; should be a path like /foo/bar/baz, most likely the string returned by the toadlet's path() method

atFront - If true, this Toadlet will take precedence over any other previously-registered Toadlet whose urlPrefix also matches. Otherwise, the other matching Toadlet is used instead.

name - A l10n key used for the navigation link label.

title - A l10n key used for the navigation link tooltip.

fullOnly - Whether or not the navigation link is shown when the http client does not have full security access. Note that passing false does not prevent the Toadlet from receiving requests under urlPrefix, so Toadlet authors are advised to check for full access themselves, possibly returning a 403 error code.

cb - A LinkEnabledCalback, allowing fine control of when the navigation link is visible and when it isn't. Passing null means it is always visible.

l10n - A FredPluginL10n instance for translating the name and title parameters. May be null.

unregister

void unregister(Toadlet t)

findToadlet

Toadlet findToadlet(java.net.URI uri)
             throws PermanentRedirectException

Find a Toadlet by URI.

Throws:

java.net.URISyntaxException

RedirectException

PermanentRedirectException

getTheme

PageMaker.THEME getTheme()

Get the name of the theme to be used by all the Toadlets

getFormPassword

java.lang.String getFormPassword()

Get the form password

isAllowedFullAccess

boolean isAllowedFullAccess(java.net.InetAddress remoteAddr)

Is the given IP address allowed full access to the node?

doRobots

boolean doRobots()

Whether to tell spiders to go away

addFormChild

HTMLNode addFormChild(HTMLNode parentNode,
                      java.lang.String target,
                      java.lang.String name)

enablePersistentConnections

boolean enablePersistentConnections()

enableInlinePrefetch

boolean enableInlinePrefetch()

enableExtendedMethodHandling

boolean enableExtendedMethodHandling()

enableCachingForChkAndSskKeys

boolean enableCachingForChkAndSskKeys()

getBucketFactory

BucketFactory getBucketFactory()

Get the BucketFactory

allowPosts

boolean allowPosts()

Can we deal with POSTs yet?

publicGatewayMode

boolean publicGatewayMode()

Was public-gateway mode enabled on startup? (Changing it won't take effect until restart because of bookmark-related issues). If so, users with full access will still be able to configure the node etc, but everyone else will not have access to the download queue or anything else that might conceivably result in a DoS.

enableActivelinks

boolean enableActivelinks()

sendAllThemes

boolean sendAllThemes()

isFProxyJavascriptEnabled

boolean isFProxyJavascriptEnabled()

isFProxyWebPushingEnabled

boolean isFProxyWebPushingEnabled()

disableProgressPage

boolean disableProgressPage()

getPageMaker

PageMaker getPageMaker()

isAdvancedModeEnabled

boolean isAdvancedModeEnabled()

setAdvancedMode

void setAdvancedMode(boolean enabled)

fproxyHasCompletedWizard

boolean fproxyHasCompletedWizard()

getReFilterPolicy

FProxyFetchInProgress.REFILTER_POLICY getReFilterPolicy()

What to do when we find cached data on the global queue but it's already been filtered, and we want a filtered copy.

getOverrideFile

java.io.File getOverrideFile()

getURL

java.lang.String getURL()

getURL

java.lang.String getURL(java.lang.String host)

isSSL

boolean isSSL()

generateUniqueID

long generateUniqueID()

Create a unique ID for a ToadletContext