ConfigKeyringHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigKeyringHandler

public class ConfigKeyringHandlerextends FormHandler

Handles adding and revoking keys from the router keyring. Accepts destinations in base64, base32 .b32.i2p, or .i2p hostname form.

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 String
_key
The session key being added.
private int
_mode
What the form asked to do.
private String
_peer
Base64 of the peer being keyed.
private String[]
_revokes
Tags the form asks to revoke.
private String
_secret
The tag secret being added.
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
ConfigKeyringHandler()
Constructor.
Method Summary
Public Methods
Modifier and Type
Method
Description
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
void
setEncryptMode(String m)
Set the encryption type mode from form.
void
setKey(String key)
Set the encryption key from form.
void
setNofilter_blindedPassword(String pw)
Set the blinded lookup password from form.
void
setPeer(String peer)
Set the peer destination from form.
void
setRevokeClient(String[] revokes)
Set the list of destinations to revoke from keyring.
Methods inherited from class FormHandler
_t, _t, _t, _x, addFormError, addFormError, addFormErrorNoEscape, addFormErrorNoEscape, addFormNotice, addFormNotice, addFormNoticeNoEscape, addFormNoticeNoEscape, getAllMessages, getErrors, getJettyString, getNotices, isAdvanced, resolveEffectiveAction, setAction, setContextId, 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
setContextId(String contextId)
Configure this bean to query a particular router context.
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
- _peer
  private String _peer
  Base64 of the peer being keyed.
- _key
  private String _key
  The session key being added.
- _secret
  private String _secret
  The tag secret being added.
- _revokes
  private String[] _revokes
  Tags the form asks to revoke.
- _mode
  private int _mode
  What the form asked to do.
Constructor Details
- ConfigKeyringHandler
  public ConfigKeyringHandler()
  Constructor. The console builds this bean reflectively and fills it through the property setters, so every field starts null or zero.
Method Details
- processForm
  protected void processForm()
  Description copied from class: FormHandler
  Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
  Will only be called if _action is non-null and the nonce is valid.
  Specified by:
  processForm in class FormHandler
- setPeer
  public void setPeer(String peer)
  Set the peer destination from form.
  Parameters:
  peer - the destination the keyring change applies to; trimmed of surrounding whitespace
- setKey
  public void setKey(String key)
  Set the encryption key from form.
  Parameters:
  key - the encryption key
- setNofilter_blindedPassword
  public void setNofilter_blindedPassword(String pw)
  Set the blinded lookup password from form.
  Parameters:
  pw - the blinded lookup password
- setEncryptMode
  public void setEncryptMode(String m)
  Set the encryption type mode from form.
  Parameters:
  m - the encryption mode string
- setRevokeClient
  public void setRevokeClient(String[] revokes)
  Set the list of destinations to revoke from keyring.
  Parameters:
  revokes - the list of destinations to revoke

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

_peer

_key

_secret

_revokes

_mode

Constructor Details

Method Details

processForm

setPeer

setKey

setNofilter_blindedPassword

setEncryptMode

setRevokeClient