SidebarHelper (Javadocs [I2P+ 2.13.0+]

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

```
public class SidebarHelper
extends HelperBase
```
Simple helper to query the appropriate router for data necessary to render the summary sections on the router console. For the full summary bar use renderSummaryBar()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SidebarHelper.NetworkState` Enumeration of network reachability state values.
`static class`	`SidebarHelper.NetworkStateMessage` State message to be displayed to the user in the summary bar.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) I2PAppContext`	`ctx` Global application context
`(package private) static String`	`DEFAULT_FULL` Default full summary bar sections
`(package private) static String`	`DEFAULT_FULL_ADVANCED` Default full summary bar sections for advanced mode
`(package private) static String`	`DEFAULT_FULL_NEWUSER` Default full summary bar sections for new users
`(package private) static String`	`DEFAULT_MINIMAL` Default minimal summary bar sections
`(package private) static String`	`DEFAULT_MINIMAL_ADVANCED` Default minimal summary bar sections for advanced mode @since 0.9.32
`(package private) String`	`firstVersion` First version the router was started with, used to detect new installs
`(package private) static String`	`PROP_SUMMARYBAR` Property prefix for summary bar section configuration per page
`(package private) static String`	`THINSP` Thin space separator
`(package private) String`	`version` Current I2P core version

Fields inherited from class net.i2p.router.web.HelperBase
_context, _log, _out, CHECKED, SELECTED

Constructor Summary
Constructors
Constructor and Description
SidebarHelper()

Constructors
Constructor and Description
`SidebarHelper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allowReseed()` Whether manual reseed should be allowed, based on uptime and known router count or the always-allow property.
`String`	`getAction()` Form action or null.
`int`	`getActivePeers()` How many peers we are talking to now
`int`	`getActiveProfiles()` How many active identities have we spoken with recently
`int`	`getAllPeers()` How many routers we know about, minus ourselves
`int`	`getAvgPeerTestTime()` Average peer test round-trip time (good + too-slow combined)
`int`	`getAvgPeerTestTimeGood()` Average successful peer test round-trip time
`int`	`getBanlistedPeers()` How many peers are banned.
`String`	`getConcurrency()` Concurrent build count and average build request time
`String`	`getConfigTable()` Build the HTML table for configuring which sidebar sections are shown and their display order.
`String`	`getConsoleNonce()` Console nonce or null.
`String`	`getCPUBar()` Render JVM CPU Load Bar
`int`	`getCPULoad()` Retrieve CPU Load as a percentage.
`int`	`getCPULoadAvg()` Retrieve CPU Load Average as a percentage.
`String`	`getDestinations()` Client destinations connected locally.
`int`	`getFastPeers()` How many active peers the router ranks as fast.
`String`	`getFirewallAndReseedStatus()` The firewall status and reseed status/buttons
`String`	`getFiveMinuteKBps()` Format the 5-minute average bandwidth rates for display.
`int`	`getHighCapacityPeers()` How many active peers the router ranks as having a high capacity.
`String`	`getIdent()` Retrieve the shortened 4 character ident for the router located within the current JVM at the given context.
`String`	`getInboundBacklog()` Inbound tunnel build queue size
`int`	`getInboundClientTunnels()` How many inbound client tunnels we have.
`String`	`getInboundTransferred()` How much data have we received since the router started (pretty printed string with 2 decimal places and the appropriate units - GB/MB/KB/bytes)
`int`	`getInboundTunnels()` How many free inbound tunnels we have.
`String`	`getJobLag()` How lagged our job queue is over the last minute (pretty printed with the units attached)
`String`	`getLifetimeKBps()` Format the lifetime average bandwidth rates for display.
`String`	`getMaxParticipatingTunnels()` Maximum number of tunnels we are willing to participate in, either from config or a reasonable default based on system resources.
`String`	`getMemory()` Retrieve amount of used memory.
`String`	`getMemoryBar()` Render the memory usage bar with blended real-time and one-minute average
`String`	`getMessageDelay()` How long it takes us to pump out a message, averaged over the last minute (pretty printed with the units attached)
`NewsHelper`	`getNewsHelper()` Stored NewsHelper.
`int`	`getOutboundClientTunnels()` How many active outbound client tunnels we have.
`String`	`getOutboundTransferred()` How much data have we sent since the router started (pretty printed string with 2 decimal places and the appropriate units - GB/MB/KB/bytes)
`int`	`getOutboundTunnels()` How many active outbound tunnels we have.
`int`	`getParticipatingTunnels()` How many tunnels we are participating in.
`SidebarHelper.NetworkStateMessage`	`getReachability()` Network reachability state and message.
`String`	`getRequestURI()` Return the request URI, or /home as default.
`String`	`getRestartStatus()` The restart status and buttons
`String`	`getSecondKBps()` Format the current bandwidth rates for display.
`String`	`getShareRatio()` Participant-to-client tunnel share ratio
`int`	`getStoredRouterInfos()` Number of router infos stored in the Kademlia netDb
`List<String>`	`getSummaryBarSections(String page)` Get the list of active summary bar sections for a given page
`int`	`getSystemLoad()` Retrieve System Load Average as a percentage.
`int`	`getTunnelBuildSuccess()` Retrieve Tunnel build success as a percentage.
`String`	`getTunnelLag()` How long it takes us to test our tunnels, averaged over the last 10 minutes (pretty printed with the units attached)
`String`	`getTunnelStatus()` Localized tunnel status string (e.g.
`int`	`getUnreachablePeers()` How many peers are unreachable.
`String`	`getUpdateNonce()` Update nonce or null.
`String`	`getUpdateStatus()` The update status and buttons
`String`	`getUptime()` Retrieve a pretty printed uptime count (ala 4d or 7h or 39m)
`String`	`getVersion()` Retrieve the version number of the router.
`int`	`getWellIntegratedPeers()` How many active peers the router ranks as well integrated (floodfill).
`boolean`	`isAdvanced()` True if advanced mode is enabled in config.
`boolean`	`isI2PTunnelRunning()` Are both the webapp and TCG running?
`void`	`renderSummaryBar()` Render the full summary bar HTML to the output writer
`(package private) static void`	`saveSummaryBarSections(RouterContext ctx, String page, Map<Integer,String> sections)` Save the summary bar section order to router config
`void`	`setAction(String s)` Form action, HTML-stripped before storing.
`void`	`setConsoleNonce(String s)` Console nonce, HTML-stripped before storing.
`void`	`setRequest(HttpServletRequest s)` Servlet request.
`void`	`setRequestURI(String s)` Request URI, HTML-stripped before storing.
`void`	`setUpdateNonce(String s)` Update nonce, HTML-stripped before storing.
`boolean`	`showFirewallWarning()` Should we warn about a possible firewall problem?
`void`	`storeNewsHelper(NewsHelper n)` NewsHelper to store for sidebar rendering.
`void`	`storeSession(HttpSession session)` For form validation and session-bound nonce generation
`boolean`	`unifiedSidebar()` True if unified sidebar is enabled.

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

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

- Field Detail
  - ctx
```
I2PAppContext ctx
```
    Global application context
  - DEFAULT_FULL
```
static final String DEFAULT_FULL
```
    Default full summary bar sections
    See Also:
    Constant Field Values
  - DEFAULT_FULL_ADVANCED
```
static final String DEFAULT_FULL_ADVANCED
```
    Default full summary bar sections for advanced mode
    See Also:
    Constant Field Values
  - DEFAULT_FULL_NEWUSER
```
static final String DEFAULT_FULL_NEWUSER
```
    Default full summary bar sections for new users
    See Also:
    Constant Field Values
  - DEFAULT_MINIMAL
```
static final String DEFAULT_MINIMAL
```
    Default minimal summary bar sections
    See Also:
    Constant Field Values
  - DEFAULT_MINIMAL_ADVANCED
```
static final String DEFAULT_MINIMAL_ADVANCED
```
    Default minimal summary bar sections for advanced mode @since 0.9.32
    See Also:
    Constant Field Values
  - firstVersion
```
String firstVersion
```
    First version the router was started with, used to detect new installs
  - PROP_SUMMARYBAR
```
static final String PROP_SUMMARYBAR
```
    Property prefix for summary bar section configuration per page
    See Also:
    Constant Field Values
  - THINSP
```
static final String THINSP
```
    Thin space separator
    See Also:
    Constant Field Values
  - version
```
String version
```
    Current I2P core version
- Constructor Detail
  - SidebarHelper
```
public SidebarHelper()
```
- Method Detail
  - allowReseed
```
public boolean allowReseed()
```
    Whether manual reseed should be allowed, based on uptime and known router count or the always-allow property.
  - getAction
```
public String getAction()
```
    Form action or null.
    Returns:
    the form action or null
  - getActivePeers
```
public int getActivePeers()
```
    How many peers we are talking to now
    Returns:
    the active peers
  - getActiveProfiles
```
public int getActiveProfiles()
```
    How many active identities have we spoken with recently
    Returns:
    the active profiles
  - getAllPeers
```
public int getAllPeers()
```
    How many routers we know about, minus ourselves
    Returns:
    peer count, minimum 0
  - getAvgPeerTestTime
```
public int getAvgPeerTestTime()
```
    Average peer test round-trip time (good + too-slow combined)
    Returns:
    average test time in milliseconds
  - getAvgPeerTestTimeGood
```
public int getAvgPeerTestTimeGood()
```
    Average successful peer test round-trip time
    Returns:
    average good-test time in milliseconds
  - getBanlistedPeers
```
public int getBanlistedPeers()
```
    How many peers are banned.
    Returns:
    banned peer count
  - getConcurrency
```
public String getConcurrency()
```
    Concurrent build count and average build request time
    Returns:
    formatted string "concurrent / requestTime"
  - getConfigTable
```
public String getConfigTable()
```
    Build the HTML table for configuring which sidebar sections are shown and their display order.
    Returns:
    HTML table with move/delete/add controls
  - getConsoleNonce
```
public String getConsoleNonce()
```
    Console nonce or null.
    Returns:
    the console nonce or null
  - getCPUBar
```
public String getCPUBar()
```
    Render JVM CPU Load Bar
    Returns:
    the c p u bar
  - getCPULoad
```
public int getCPULoad()
```
    Retrieve CPU Load as a percentage.
    Returns:
    the c p u load
  - getCPULoadAvg
```
public int getCPULoadAvg()
```
    Retrieve CPU Load Average as a percentage.
    Returns:
    the c p u load avg
  - getDestinations
```
public String getDestinations()
```
    Client destinations connected locally.
    Returns:
    html section summary
  - getFastPeers
```
public int getFastPeers()
```
    How many active peers the router ranks as fast.
    Returns:
    fast peer count
  - getFirewallAndReseedStatus
```
public String getFirewallAndReseedStatus()
```
    The firewall status and reseed status/buttons
    Returns:
    the firewall and reseed status
  - getFiveMinuteKBps
```
public String getFiveMinuteKBps()
```
    Format the 5-minute average bandwidth rates for display.
    Returns:
    "x.xx / y.yy {K|M}"
  - getHighCapacityPeers
```
public int getHighCapacityPeers()
```
    How many active peers the router ranks as having a high capacity.
    Returns:
    high capacity peer count
  - getIdent
```
public String getIdent()
```
    Retrieve the shortened 4 character ident for the router located within the current JVM at the given context.
    Returns:
    the ident
  - getInboundBacklog
```
public String getInboundBacklog()
```
    Inbound tunnel build queue size
    Returns:
    backlog count as string
  - getInboundClientTunnels
```
public int getInboundClientTunnels()
```
    How many inbound client tunnels we have.
    Returns:
    the inbound client tunnels
  - getInboundTransferred
```
public String getInboundTransferred()
```
    How much data have we received since the router started (pretty printed string with 2 decimal places and the appropriate units - GB/MB/KB/bytes)
    Returns:
    the inbound transferred
  - getInboundTunnels
```
public int getInboundTunnels()
```
    How many free inbound tunnels we have.
    Returns:
    the inbound tunnels
  - getJobLag
```
public String getJobLag()
```
    How lagged our job queue is over the last minute (pretty printed with the units attached)
    Returns:
    the job lag
  - getLifetimeKBps
```
public String getLifetimeKBps()
```
    Format the lifetime average bandwidth rates for display.
    Returns:
    "x.xx / y.yy {K|M}"
  - getMaxParticipatingTunnels
```
public String getMaxParticipatingTunnels()
```
    Maximum number of tunnels we are willing to participate in, either from config or a reasonable default based on system resources.
    Returns:
    max participating tunnel count as string
  - getMemory
```
public String getMemory()
```
    Retrieve amount of used memory.
    Returns:
    the memory
  - getMemoryBar
```
public String getMemoryBar()
```
    Render the memory usage bar with blended real-time and one-minute average
    Returns:
    HTML for the memory bar display
  - getMessageDelay
```
public String getMessageDelay()
```
    How long it takes us to pump out a message, averaged over the last minute (pretty printed with the units attached)
    Returns:
    the message delay
  - getNewsHelper
```
public NewsHelper getNewsHelper()
```
    Stored NewsHelper.
    Returns:
    the stored NewsHelper
  - getOutboundClientTunnels
```
public int getOutboundClientTunnels()
```
    How many active outbound client tunnels we have.
    Returns:
    the outbound client tunnels
  - getOutboundTransferred
```
public String getOutboundTransferred()
```
    How much data have we sent since the router started (pretty printed string with 2 decimal places and the appropriate units - GB/MB/KB/bytes)
    Returns:
    the outbound transferred
  - getOutboundTunnels
```
public int getOutboundTunnels()
```
    How many active outbound tunnels we have.
    Returns:
    the outbound tunnels
  - getParticipatingTunnels
```
public int getParticipatingTunnels()
```
    How many tunnels we are participating in.
    Returns:
    the participating tunnels
  - getReachability
```
public SidebarHelper.NetworkStateMessage getReachability()
```
    Network reachability state and message.
    Returns:
    network reachability state and message
  - getRequestURI
```
public String getRequestURI()
```
    Return the request URI, or /home as default.
    Returns:
    non-null; "/home" if (strangely) not set by jsp
  - getRestartStatus
```
public String getRestartStatus()
```
    The restart status and buttons
    Returns:
    the restart status
  - getSecondKBps
```
public String getSecondKBps()
```
    Format the current bandwidth rates for display.
    Returns:
    "x.xx / y.yy {K|M}"
  - getShareRatio
```
public String getShareRatio()
```
    Participant-to-client tunnel share ratio
    Returns:
    ratio string formatted to appropriate precision
  - getStoredRouterInfos
```
public int getStoredRouterInfos()
```
    Number of router infos stored in the Kademlia netDb
    Returns:
    stored router info count
  - getSummaryBarSections
```
public List<String> getSummaryBarSections(String page)
```
    Get the list of active summary bar sections for a given page
    Parameters:
    page - the page name (e.g. "home" or "default")
    Returns:
    list of section identifiers, or empty list if none configured
  - getSystemLoad
```
public int getSystemLoad()
```
    Retrieve System Load Average as a percentage.
    Returns:
    the system load
  - getTunnelBuildSuccess
```
public int getTunnelBuildSuccess()
```
    Retrieve Tunnel build success as a percentage. Returns the higher of the 1-minute or 10-minute average.
    Returns:
    the tunnel build success
  - getTunnelLag
```
public String getTunnelLag()
```
    How long it takes us to test our tunnels, averaged over the last 10 minutes (pretty printed with the units attached)
    Returns:
    the tunnel lag
  - getTunnelStatus
```
public String getTunnelStatus()
```
    Localized tunnel status string (e.g. overload/congested/normal)
    Returns:
    tunnel status or empty string if no context
  - getUnreachablePeers
```
public int getUnreachablePeers()
```
    How many peers are unreachable.
    Returns:
    unreachable peer count
  - getUpdateNonce
```
public String getUpdateNonce()
```
    Update nonce or null.
    Returns:
    the update nonce or null
  - getUpdateStatus
```
public String getUpdateStatus()
```
    The update status and buttons
    Returns:
    the update status
  - getUptime
```
public String getUptime()
```
    Retrieve a pretty printed uptime count (ala 4d or 7h or 39m)
    Returns:
    the uptime
  - getVersion
```
public String getVersion()
```
    Retrieve the version number of the router.
    Returns:
    the version
  - getWellIntegratedPeers
```
public int getWellIntegratedPeers()
```
    How many active peers the router ranks as well integrated (floodfill).
    Returns:
    floodfill peer count
  - isAdvanced
```
public boolean isAdvanced()
```
    True if advanced mode is enabled in config.
    Overrides:
    isAdvanced in class HelperBase
    Returns:
    true if advanced mode is enabled in config
  - isI2PTunnelRunning
```
public boolean isI2PTunnelRunning()
```
    Are both the webapp and TCG running?
    Returns:
    whether i2 p tunnel running
  - renderSummaryBar
```
public void renderSummaryBar()
                      throws IOException
```
    Render the full summary bar HTML to the output writer
    Throws:
    IOException
  - saveSummaryBarSections
```
static void saveSummaryBarSections(RouterContext ctx,
                                   String page,
                                   Map<Integer,String> sections)
```
    Save the summary bar section order to router config
    Parameters:
    ctx - router context
    page - page identifier
    sections - ordered map of section index to section id
  - setAction
```
public void setAction(String s)
```
    Form action, HTML-stripped before storing.
    Parameters:
    s - form action, HTML-stripped before storing
  - setConsoleNonce
```
public void setConsoleNonce(String s)
```
    Console nonce, HTML-stripped before storing.
    Parameters:
    s - console nonce, HTML-stripped before storing
  - setRequest
```
public void setRequest(HttpServletRequest s)
```
    Servlet request.
    Parameters:
    s - the servlet request
  - setRequestURI
```
public void setRequestURI(String s)
```
    Request URI, HTML-stripped before storing.
    Parameters:
    s - the request URI, HTML-stripped before storing
  - setUpdateNonce
```
public void setUpdateNonce(String s)
```
    Update nonce, HTML-stripped before storing.
    Parameters:
    s - update nonce, HTML-stripped before storing
  - showFirewallWarning
```
public boolean showFirewallWarning()
```
    Should we warn about a possible firewall problem?
  - storeNewsHelper
```
public void storeNewsHelper(NewsHelper n)
```
    NewsHelper to store for sidebar rendering.
    Parameters:
    n - NewsHelper to store for sidebar rendering
  - storeSession
```
public void storeSession(HttpSession session)
```
    For form validation and session-bound nonce generation
  - unifiedSidebar
```
public boolean unifiedSidebar()
```
    True if unified sidebar is enabled.
    Returns:
    true if unified sidebar is enabled

Class SidebarHelper

Nested Class Summary

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

ctx

DEFAULT_FULL

DEFAULT_FULL_ADVANCED

DEFAULT_FULL_NEWUSER

DEFAULT_MINIMAL

DEFAULT_MINIMAL_ADVANCED

firstVersion

PROP_SUMMARYBAR

THINSP

version

Constructor Detail

SidebarHelper

Method Detail

allowReseed

getAction

getActivePeers

getActiveProfiles

getAllPeers

getAvgPeerTestTime

getAvgPeerTestTimeGood

getBanlistedPeers

getConcurrency

getConfigTable

getConsoleNonce

getCPUBar

getCPULoad

getCPULoadAvg

getDestinations

getFastPeers

getFirewallAndReseedStatus

getFiveMinuteKBps

getHighCapacityPeers

getIdent

getInboundBacklog

getInboundClientTunnels

getInboundTransferred

getInboundTunnels

getJobLag

getLifetimeKBps

getMaxParticipatingTunnels

getMemory

getMemoryBar

getMessageDelay

getNewsHelper

getOutboundClientTunnels

getOutboundTransferred

getOutboundTunnels

getParticipatingTunnels

getReachability

getRequestURI

getRestartStatus

getSecondKBps

getShareRatio

getStoredRouterInfos

getSummaryBarSections

getSystemLoad

getTunnelBuildSuccess

getTunnelLag

getTunnelStatus

getUnreachablePeers

getUpdateNonce

getUpdateStatus

getUptime

getVersion

getWellIntegratedPeers

isAdvanced

isI2PTunnelRunning

renderSummaryBar

saveSummaryBarSections

setAction

setConsoleNonce