freenet.clients.http.wizardsteps

Class BandwidthManipulator

java.lang.Object

freenet.clients.http.wizardsteps.BandwidthManipulator

Direct Known Subclasses:

BANDWIDTH_MONTHLY, BANDWIDTH_RATE

public abstract class BandwidthManipulator
extends java.lang.Object

Utility class used by bandwidth steps to detect and set bandwidth, and set the wizard completion flag.

Field Summary

Fields

Modifier and Type	Field and Description
protected Config	config
protected NodeClientCore	core

Constructor Summary

Constructors

Constructor and Description
BandwidthManipulator(NodeClientCore core, Config config)

Method Summary

Modifier and Type	Method and Description
protected BandwidthLimit	detectBandwidthLimits() Attempts to detect upstream and downstream bandwidth limits.
protected BandwidthLimit	getCurrentBandwidthLimitsOrNull()
protected HTMLNode	parseErrorBox(HTMLNode parent, PageHelper helper, java.lang.String message) Creates a titled infobox for a bandwidth setting error.
protected void	setBandwidthLimit(java.lang.String limit, boolean setOutputLimit) Sets the selected limit type to the given limit.
protected void	setWizardComplete()

Methods inherited from class java.lang.Object

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

Field Detail

core

protected final NodeClientCore core

config

protected final Config config

Constructor Detail

BandwidthManipulator

public BandwidthManipulator(NodeClientCore core,
                            Config config)

Method Detail

setBandwidthLimit

protected void setBandwidthLimit(java.lang.String limit,
                                 boolean setOutputLimit)
                          throws InvalidConfigValueException

Sets the selected limit type to the given limit.

Parameters:

limit - To parse limit from. Can include SI or IEC units, but not /s.

setOutputLimit - If true, output limit is set. If false, input limit is set.

Throws:

InvalidConfigValueException - If the value is negative, a number cannot be parsed from it, or the value is too low to be usable.

See Also:

Node.minimumBandwidth

parseErrorBox

protected HTMLNode parseErrorBox(HTMLNode parent,
                                 PageHelper helper,
                                 java.lang.String message)

Creates a titled infobox for a bandwidth setting error.

Parameters:

parent - Node to attach warning to.

helper - Helper to create infobox.

message - Message to display in the infobox body.

Returns:

infobox node with the message added.

getCurrentBandwidthLimitsOrNull

protected BandwidthLimit getCurrentBandwidthLimitsOrNull()

detectBandwidthLimits

protected BandwidthLimit detectBandwidthLimits()

Attempts to detect upstream and downstream bandwidth limits.

Returns:

Upstream and downstream bandwidth in bytes per second. If a limit is set to -1, it is unavailable or nonsensically low. In case of error, both values are set to: -2 if the upstream bandwidth setting has already been configured. -3 if the UPnP plugin is not loaded or done starting up.

setWizardComplete

protected void setWizardComplete()