WizardHelper (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.web.HelperBase
- - net.i2p.router.web.helpers.WizardHelper

```
public class WizardHelper
extends HelperBase
```
The new user wizard. This bean has SESSION scope so the results may be retrieved. All necessary methods are synchronized.

Field Summary
Fields
Modifier and Type Field and Description
static float BW_SCALE
BW_SCALE.
static String PROP_COMPLETE
PROP_COMPLETE.
- Fields inherited from class net.i2p.router.web.HelperBase
  _context, _log, _out, CHECKED, PROP_ADVANCED, SELECTED

Fields
Modifier and Type	Field and Description
`static float`	`BW_SCALE` BW_SCALE.
`static String`	`PROP_COMPLETE` PROP_COMPLETE.

Constructor Summary
Constructors
Constructor and Description
WizardHelper()

Constructors
Constructor and Description
`WizardHelper()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) boolean`	`cancelNDT()` Cancel the test.
`void`	`complete()` complete.
`String`	`getCompletionStatus()` Return the NDT test completion status.
`String`	`getDetailStatus()` Return detailed NDT test status information.
`long`	`getDownBandwidth()` Return the measured download bandwidth.
`String`	`getInboundBurstRate()` To populate form with.
`String`	`getInboundBurstRateBits()` Copied from ConfigNetHelper.
`String`	`getOutboundBurstRate()` To populate form with.
`String`	`getOutboundBurstRateBits()` Copied from ConfigNetHelper.
`String`	`getServerLocation()` Return the NDT test server location.
`int`	`getShareBandwidth()` Adapted from ConfigNetHelper.
`String`	`getShareRateBits()` Copied from ConfigNetHelper.
`String`	`getTestStatus()` Return the current NDT bandwidth test status.
`long`	`getUpBandwidth()` Return the measured upload bandwidth.
`boolean`	`isNDTComplete()`
`boolean`	`isNDTRunning()`
`boolean`	`isNDTSuccessful()`
`void`	`setContextId(String contextId)` Overriden to only do this once.
`(package private) boolean`	`startNDT()` Start the test.

Methods inherited from class net.i2p.router.web.HelperBase
_t, _t, _t, _x, getChecked, isAdvanced, ngettext, storeWriter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BW_SCALE
```
public static final float BW_SCALE
```
    BW_SCALE.
    See Also:
    Constant Field Values
  - PROP_COMPLETE
```
public static final String PROP_COMPLETE
```
    PROP_COMPLETE.
    See Also:
    Constant Field Values
- Constructor Detail
  - WizardHelper
```
public WizardHelper()
```
- Method Detail
  - cancelNDT
```
boolean cancelNDT()
```
    Cancel the test. Called from the Handler.
    Returns:
    success
  - complete
```
public void complete()
```
    complete.
  - getCompletionStatus
```
public String getCompletionStatus()
```
    Return the NDT test completion status.
    Returns:
    HTML-escaped status string or ""
  - getDetailStatus
```
public String getDetailStatus()
```
    Return detailed NDT test status information.
    Returns:
    HTML-escaped status string or ""
  - getDownBandwidth
```
public long getDownBandwidth()
```
    Return the measured download bandwidth.
    Returns:
    bytes per second or 0
  - getInboundBurstRate
```
public String getInboundBurstRate()
```
    To populate form with. Uses the test result if available, else the current setting Adapted from ConfigNetHelper.
    Returns:
    decimal KBytes/sec
  - getInboundBurstRateBits
```
public String getInboundBurstRateBits()
```
    Copied from ConfigNetHelper.
    Returns:
    decimal
  - getOutboundBurstRate
```
public String getOutboundBurstRate()
```
    To populate form with. Uses the test result if available, else the current setting Adapted from ConfigNetHelper.
    Returns:
    decimal KBytes/sec
  - getOutboundBurstRateBits
```
public String getOutboundBurstRateBits()
```
    Copied from ConfigNetHelper.
    Returns:
    decimal
  - getServerLocation
```
public String getServerLocation()
```
    Return the NDT test server location.
    Returns:
    HTML-escaped location or ""
  - getShareBandwidth
```
public int getShareBandwidth()
```
    Adapted from ConfigNetHelper.
    Returns:
    in binary KBytes per second
  - getShareRateBits
```
public String getShareRateBits()
```
    Copied from ConfigNetHelper.
    Returns:
    decimal
  - getTestStatus
```
public String getTestStatus()
```
    Return the current NDT bandwidth test status.
    Returns:
    HTML-escaped status string or ""
  - getUpBandwidth
```
public long getUpBandwidth()
```
    Return the measured upload bandwidth.
    Returns:
    bytes per second or 0
  - isNDTComplete
```
public boolean isNDTComplete()
```
    Returns:
    whether n d t complete
  - isNDTRunning
```
public boolean isNDTRunning()
```
    Returns:
    whether n d t running
  - isNDTSuccessful
```
public boolean isNDTSuccessful()
```
    Returns:
    whether n d t successful
  - setContextId
```
public void setContextId(String contextId)
```
    Overriden to only do this once.
    Overrides:
    setContextId in class HelperBase
    Parameters:
    contextId - beginning few characters of the routerHash, or null to pick the first one we come across.
  - startNDT
```
boolean startNDT()
```
    Start the test. Called from the Handler.
    Returns:
    success

Class WizardHelper

Field Summary

Fields inherited from class net.i2p.router.web.HelperBase

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.web.HelperBase

Methods inherited from class java.lang.Object

Field Detail

BW_SCALE

PROP_COMPLETE

Constructor Detail

WizardHelper

Method Detail

cancelNDT

complete

getCompletionStatus

getDetailStatus

getDownBandwidth

getInboundBurstRate

getInboundBurstRateBits

getOutboundBurstRate

getOutboundBurstRateBits

getServerLocation

getShareBandwidth

getShareRateBits

getTestStatus

getUpBandwidth

isNDTComplete

isNDTRunning

isNDTSuccessful

setContextId

startNDT