EventLogHelper

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.EventLogHelper

public class EventLogHelperextends FormHandler

Helper for router event log display and filtering. Renders system events including startup, crashes, network changes, and configuration updates. Provides filtering by event type and time range. Supports /events.jsp page in router console.

Nested Class Summary
Nested classes/interfaces inherited from class FormHandler
FormHandler.Message
Modifier and Type
Class
Description
static class
FormHandler.Message
Message class to encapsulate the message text and the canClose flag.
Field Summary
Fields
Modifier and Type
Field
Description
private long
_age
Age of the events shown.
private String
_event
The event type filtered for.
private static final String[]
_events
The event names offered in the form.
private long
_from
Start time of the events shown.
private static final long[]
_times
The age options offered in the form, in seconds.
private final Map<String,String>
_xevents
The EventLog names mapped to translated display strings.
private static final String
ALL
Filter value selecting every event.
private static final long
DAY
One day, in seconds.
private static final Pattern
EVENT_DIGIT
Matches a single digit.
private static final Pattern
EVENT_SPACE
Matches the text after an event name.
Fields inherited from class FormHandler
_action, _context, _log, _method, _out, _requestWrapper, _session, _settings
Modifier and Type
Field
Description
protected String
_action
Form action.
protected RouterContext
_context
Router context.
protected Log
_log
Class logger.
protected String
_method
Request method.
protected Writer
_out
Output writer.
protected RequestWrapper
_requestWrapper
Only for multipart/form-data.
protected HttpSession
_session
HTTP session for nonce validation.
protected Map
_settings
Not for multipart/form-data, will be null.
Constructor Summary
Constructors
Constructor
Description
EventLogHelper()
Prepares the helper with an empty, pre-sized event translation map.
Method Summary
Modifier and Type
Method
Description
String
getEvents()
Get the events.
String
getForm()
Get the form.
protected void
processForm()
Does nothing; the event log page submits no form.
void
setContextId(String contextId)
Configure this bean to query a particular router context.
void
setFrom(String s)
Set the from.
void
setType(String s)
Set the type.
private void
writeOption(long age)
Write one age filter option.
private void
writeOption(String key, String val)
Writes one option of the filter form.
Methods inherited from class FormHandler
_t, _t, _t, _x, addFormError, addFormError, addFormErrorNoEscape, addFormErrorNoEscape, addFormNotice, addFormNotice, addFormNoticeNoEscape, addFormNoticeNoEscape, getAllMessages, getErrors, getJettyString, getNotices, isAdvanced, resolveEffectiveAction, setAction, setNonce, setRequestWrapper, setSettings, storeMethod, storeSession, storeWriter
Modifier and Type
Method
Description
String
_t(String s)
Translate a string.
String
_t(String s, Object o)
Translate a string with a parameter This is a lot more expensive than _t(s), so use sparingly.
String
_t(String s, Object o, Object o2)
Translate a string with two parameters.
static String
_x(String s)
Mark a string for extraction by xgettext and translation.
protected void
addFormError(String errorMsg)
Add an error message to display Use if it does not include a link.
protected void
addFormError(String errorMsg, boolean canClose)
Add an error message to display Use if it does not include a link.
protected void
addFormErrorNoEscape(String msg)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormErrorNoEscape(String msg, boolean canClose)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormNotice(String msg)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNotice(String msg, boolean canClose)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNoticeNoEscape(String msg)
Add a non-error message to display Use if it includes a link or other formatting.
protected void
addFormNoticeNoEscape(String msg, boolean canClose)
Add a non-error message to display Use if it includes a link or other formatting.
String
getAllMessages()
Display everything, wrap it in a div for consistent presentation.
String
getErrors()
Display any error messages (processing the form if it hasn't been yet).
protected String
getJettyString(String key)
FormHandler.setSettings(Map) must have been called previously Curses Jetty for returning arrays.
String
getNotices()
Display any non-error messages (processing the form if it hasn't been yet).
boolean
isAdvanced()
Same as HelperBase.
static String
resolveEffectiveAction(String action, Map<?,?> settings)
Resolve which operation the user actually requested.
void
setAction(String val)
Action value.
void
setNonce(String val)
Nonce value.
void
setRequestWrapper(RequestWrapper rw)
Only set by formhandler.jsi for multipart/form-data.
void
setSettings(Map settings)
For many forms, it's easiest just to put all the parameters here.
void
storeMethod(String val)
Call this to prevent changes using GET.
void
storeSession(HttpSession session)
For nonce validation.
void
storeWriter(Writer out)
Store the output writer for inline form processing.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- EVENT_SPACE
  private static final Pattern EVENT_SPACE
  Matches the text after an event name.
- EVENT_DIGIT
  private static final Pattern EVENT_DIGIT
  Matches a single digit.
- _from
  private long _from
  Start time of the events shown.
- _age
  private long _age
  Age of the events shown.
- _event
  private String _event
  The event type filtered for.
- _xevents
  private final Map<String,String> _xevents
  The EventLog names mapped to translated display strings.
- ALL
  private static final String ALL
  Filter value selecting every event.
  See Also:
  Constant Field Values
- _events
  private static final String[] _events
  The event names offered in the form.
- DAY
  private static final long DAY
  One day, in seconds.
  See Also:
  Constant Field Values
- _times
  private static final long[] _times
  The age options offered in the form, in seconds.
Constructor Details
- EventLogHelper
  public EventLogHelper()
  Prepares the helper with an empty, pre-sized event translation map.
Method Details
- processForm
  protected void processForm()
  Does nothing; the event log page submits no form.
  Specified by:
  processForm in class FormHandler
- setContextId
  public void setContextId(String contextId)
  Description copied from class: FormHandler
  Configure this bean to query a particular router context.
  Overrides:
  setContextId in class FormHandler
  Parameters:
  contextId - beginning few characters of the routerHash, or null to pick the first one we come across.
- setFrom
  public void setFrom(String s)
  Set the from.
  Parameters:
  s - the age of the events to list, in seconds; anything unparsable or zero shows all
- setType
  public void setType(String s)
  Set the type.
  Parameters:
  s - the event category to list, or the all-categories value to show every type
- getForm
  public String getForm()
  Get the form.
  Returns:
  always the empty string, as required by the JSP getter convention; the markup is written to the response writer
- writeOption
  private void writeOption(String key, String val) throws IOException
  Writes one option of the filter form.
  Parameters:
  key - the option value
  val - the option label
  Throws:
  IOException - if the writing fails
- writeOption
  private void writeOption(long age) throws IOException
  Write one age filter option.
  Parameters:
  age - lookback window in seconds; 0 renders as "All events"
  Throws:
  IOException - if the output writer fails
- getEvents
  public String getEvents()
  Get the events.
  Returns:
  the filtered events rendered as HTML

Nested Class Summary

Nested classes/interfaces inherited from class FormHandler

Field Summary

Fields inherited from class FormHandler

Constructor Summary

Method Summary

Methods inherited from class FormHandler

Methods inherited from class Object

Field Details

EVENT_SPACE

EVENT_DIGIT

_from

_age

_event

_xevents

ALL

_events

DAY

_times

Constructor Details

Method Details

processForm

setContextId

setFrom

setType

getForm

writeOption

writeOption

getEvents