NamingServiceBean

i2p.susi.dns.NamingServiceBean

public class NamingServiceBeanextends AddressbookBean

Talk to the NamingService API instead of modifying the hosts.txt files directly, except for the 'published' addressbook.

Field Summary
Fields
Modifier and Type
Field
Description
private String
_cachedLoadMessage
Message from the cached load, null until the first successful load.
private int
_cachedSize
Cached book size, -1 until computed.
private String
_loadKey
Key of the currently cached load (filter, search, category, pagination, book).
private long
_loadTime
When the cached load was performed.
private static final Log
_log
Logger for this class.
private boolean
_serverPaginated
True when the last load applied skip/limit server-side; total is then totalSize().
private String
_sizeKey
Key of the currently cached book size.
private long
_sizeTime
When the cached book size was computed.
private static final long
CACHE_TTL
How long a cached addressbook load or book size is reused before the naming service is re-queried.
private static final String
DEFAULT_NS
Naming service used when none is configured.
private String
detail
Detail line shown for the service on the page.
private boolean
fail
True if the lookup through this service failed.
private int
filteredCount
How many found entries the blacklist removed.
private AddressBean[]
fullFilteredEntries
The entries that survived filtering.
private String
notes
Notes shown for the service on the page.
Fields inherited from class AddressbookBean
beginIndex, book, category, deletionMarks, destination, endIndex, entries, filter, hostname, search, sorter
Modifier and Type
Field
Description
protected int
beginIndex
Beginning index for pagination.
protected String
book
The address book name.
protected String
category
The category filter string.
protected final LinkedList<String>
deletionMarks
List of entries marked for deletion.
protected String
destination
The destination.
protected int
endIndex
Ending index for pagination.
protected AddressBean[]
entries
Array of address entries.
protected String
filter
The filter string.
protected String
hostname
The hostname.
protected String
search
The search string.
protected static final Comparator<AddressBean>
sorter
Comparator for sorting addresses.
Fields inherited from class BaseBean
_context, action, lastSerial, method, PROP_PW_ENABLE, properties, serial
Modifier and Type
Field
Description
protected final I2PAppContext
_context
The I2P application context.
protected String
action
The current action.
protected String
lastSerial
The last serial number for CSRF.
protected String
method
The HTTP method.
static final String
PROP_PW_ENABLE
Property for password enable.
protected final Properties
properties
The configuration properties.
protected String
serial
The serial number.
Constructor Summary
Constructors
Constructor
Description
NamingServiceBean()
A fresh bean: the display range is initialised by AddressbookBean and the cached load and book-size entries below are empty, so the first query repopulates them.
Method Summary
Modifier and Type
Method
Description
private static String
basename(String filename)
Get the basename of a file path.
private void
clearCaches()
Drop cached load results and book size so the next access re-queries the naming service.
void
export(Writer out)
Export address book entries to a writer.
String
getDisplayName()
Returns the display name for the address book.
AddressBean[]
getEntries()
Returns the address entries.
String
getFileName()
Returns the file name for the address book.
String
getLoadBookMessages()
Load addressbook and apply filter, returning messages about this.
AddressBean
getLookup()
Lookup a single destination by hostname.
List<AddressBean>
getLookupAll()
Lookup all destinations for a hostname.
String
getMessages()
Perform actions, returning messages about this.
private NamingService
getNamingService()
Get the NamingService for the current file name, or the root NamingService.
protected int
getTotalFilteredCount()
Gets the total count of filtered results for pagination display.
boolean
haveImagegen()
Check if the imagegen service is available.
String
importFile(RequestWrapper wrequest)
Import entries from a file upload.
private boolean
isDirect()
Check if the published addressbook is in use (direct file access).
boolean
isNotEmpty()
Returns whether the address book is not empty.
protected boolean
isPrefiltered()
Checks if entries are pre-filtered.
private String
loadKey()
Key for the load cache; changes whenever an input that affects the displayed entries changes.
protected int
resultSize()
The number of entries in the current result set.
void
saveNotes()
Save notes for a destination.
private static NamingService
searchNamingService(NamingService ns, String srch)
Perform a depth-first search for a naming service by name.
void
setH(String h)
Sets the hostname for lookup.
void
setNofilter_notes(String n)
Sets the notes for the destination.
private static String
styleMessage(String message, boolean fail)
Style a message for display in the UI.
protected int
totalSize()
The total number of entries in the book.
Methods inherited from class AddressbookBean
generateLoadMessage, getBegin, getBeginInt, getBook, getCategoryFilter, getDestination, getEnd, getEndInt, getFilter, getHostname, getPageBegin, getResultBegin, getResultEnd, getSearch, isHasFilter, isIsEmpty, isValidBook, setBegin, setBook, setDestination, setEnd, setFilter, setHostname, setMarkedForDeletion, setResetDeletionMarks, setSearch
Modifier and Type
Method
Description
protected String
generateLoadMessage()
Format a message about filtered addressbook size, and the number of displayed entries addressbook.jsp catches the case where the whole book is empty.
String
getBegin()
The clamped first displayed entry index, as a string for the JSP.
protected int
getBeginInt()
The first displayed entry index, clamped to the result set.
String
getBook()
This always returns a valid book, non-null.
String
getCategoryFilter()
The category filter, set when the search filter names a category.
String
getDestination()
The destination for the add or edit form, as entered.
String
getEnd()
The clamped last displayed entry index, as a string for the JSP.
protected int
getEndInt()
The last displayed entry index, clamped to the result set.
String
getFilter()
The search filter narrowing the displayed entries.
String
getHostname()
The hostname for the add or edit form, as entered.
int
getPageBegin()
Gets the beginning index into results for display purposes.
String
getResultBegin()
The index of the first entry in the result set, as a string.
String
getResultEnd()
The index of the last entry in the result set, as a string.
String
getSearch()
Returns the search string.
boolean
isHasFilter()
Returns whether a filter is active.
boolean
isIsEmpty()
Returns whether the address book is empty.
boolean
isValidBook()
Because the following from addressbook.jsp fails parsing in the new EL: javax.el.ELException: Failed to parse the expression Can't figure out why, so just replace it with book.validBook:
void
setBegin(String s)
Set the page start index from a form string, ignoring garbage.
void
setBook(String book)
Set the address book to display, normalizing unknown names to "router".
void
setDestination(String destination)
Set the destination for the add or edit form.
void
setEnd(String s)
Set the page end index from a form string, ignoring garbage.
void
setFilter(String filter)
Set the search filter; "none" clears it, and a category name selects that category.
void
setHostname(String hostname)
Set the hostname for the add or edit form.
void
setMarkedForDeletion(String name)
Marks an entry for deletion.
void
setResetDeletionMarks(String dummy)
Resets the deletion marks.
void
setSearch(String s)
Sets the search string.
Methods inherited from class BaseBean
_t, _t, _t, addressbookDir, configFile, debug, getAction, getSerial, getTheme, getThemeName, getThemes, isOverrideCssActive, loadConfig, ngettext, reload, setAction, setSerial, storeMethod, useSoraFont, warn
Modifier and Type
Method
Description
protected static String
_t(String s)
Translate a string.
protected static String
_t(String s, Object o)
Translate a string with one parameter.
protected static String
_t(String s, Object o, Object o2)
Translate a string with two parameters.
protected File
addressbookDir()
Returns the addressbook directory.
protected File
configFile()
The addressbook configuration file.
protected void
debug(String msg)
Log a debug message.
String
getAction()
Get the action.
String
getSerial()
Generate a new random serial for CSRF protection and clear the pending action.
String
getTheme()
Returns the theme path.
String
getThemeName()
The configured console theme name.
String[]
getThemes()
Get all themes.
boolean
isOverrideCssActive()
Determine if a user-provided override.css file is active.
protected void
loadConfig()
Loads the configuration if needed.
protected static String
ngettext(String s, String p, int n)
Translate a string with plural form (ngettext).
protected void
reload()
Reloads the configuration from file.
void
setAction(String action)
Sets the action.
void
setSerial(String serial)
Sets the serial.
void
storeMethod(String method)
Store the HTTP method.
boolean
useSoraFont()
Checks if Sora font should be used.
protected void
warn(Throwable t)
Log a warning message.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _log
  private static final Log _log
  Logger for this class.
- DEFAULT_NS
  private static final String DEFAULT_NS
  Naming service used when none is configured.
  See Also:
  Constant Field Values
- detail
  private String detail
  Detail line shown for the service on the page.
- notes
  private String notes
  Notes shown for the service on the page.
- fail
  private boolean fail
  True if the lookup through this service failed.
- filteredCount
  private int filteredCount
  How many found entries the blacklist removed.
- fullFilteredEntries
  private AddressBean[] fullFilteredEntries
  The entries that survived filtering.
- _serverPaginated
  private boolean _serverPaginated
  True when the last load applied skip/limit server-side; total is then totalSize().
- CACHE_TTL
  private static final long CACHE_TTL
  How long a cached addressbook load or book size is reused before the naming service is re-queried.
  See Also:
  Constant Field Values
- _loadKey
  private String _loadKey
  Key of the currently cached load (filter, search, category, pagination, book).
- _loadTime
  private long _loadTime
  When the cached load was performed.
- _cachedLoadMessage
  private String _cachedLoadMessage
  Message from the cached load, null until the first successful load.
- _sizeKey
  private String _sizeKey
  Key of the currently cached book size.
- _sizeTime
  private long _sizeTime
  When the cached book size was computed.
- _cachedSize
  private int _cachedSize
  Cached book size, -1 until computed.
Constructor Details
- NamingServiceBean
  public NamingServiceBean()
  A fresh bean: the display range is initialised by AddressbookBean and the cached load and book-size entries below are empty, so the first query repopulates them.
Method Details
- isDirect
  private boolean isDirect()
  Check if the published addressbook is in use (direct file access).
  Returns:
  true if the book is "published"
- isPrefiltered
  protected boolean isPrefiltered()
  Checks if entries are pre-filtered.
  Overrides:
  isPrefiltered in class AddressbookBean
  Returns:
  true when the entries came back already filtered by the naming service, so callers must not filter or paginate them again
- resultSize
  protected int resultSize()
  The number of entries in the current result set.
  Overrides:
  resultSize in class AddressbookBean
  Returns:
  the size of the lookup result
- getTotalFilteredCount
  protected int getTotalFilteredCount()
  Gets the total count of filtered results for pagination display. Returns the count BEFORE manual pagination is applied.
  Overrides:
  getTotalFilteredCount in class AddressbookBean
  Returns:
  the total count of filtered results
- totalSize
  protected int totalSize()
  The total number of entries in the book.
  Overrides:
  totalSize in class AddressbookBean
  Returns:
  the total size of the address book
- isNotEmpty
  public boolean isNotEmpty()
  Returns whether the address book is not empty.
  Overrides:
  isNotEmpty in class AddressbookBean
  Returns:
  whether not empty
- getFileName
  public String getFileName()
  Returns the file name for the address book.
  Overrides:
  getFileName in class AddressbookBean
  Returns:
  the file name
- getDisplayName
  public String getDisplayName()
  Returns the display name for the address book.
  Overrides:
  getDisplayName in class AddressbookBean
  Returns:
  the display name
- searchNamingService
  private static NamingService searchNamingService(NamingService ns, String srch)
  Perform a depth-first search for a naming service by name.
  Parameters:
  ns - the root naming service to search from
  srch - the name to search for
  Returns:
  the matching NamingService, or null if not found
- basename
  private static String basename(String filename)
  Get the basename of a file path.
  Parameters:
  filename - the full file path
  Returns:
  the basename (part after the last '/')
- getNamingService
  private NamingService getNamingService()
  Get the NamingService for the current file name, or the root NamingService.
  Returns:
  the book matching the current file name, falling back to the root naming service when no book in the tree matches
- loadKey
  private String loadKey()
  Key for the load cache; changes whenever an input that affects the displayed entries changes.
  Returns:
  the cache key
- clearCaches
  private void clearCaches()
  Drop cached load results and book size so the next access re-queries the naming service. Called after actions that mutate the addressbook.
- getLoadBookMessages
  public String getLoadBookMessages()
  Load addressbook and apply filter, returning messages about this. To control memory, don't load the whole addressbook if we can help it... only load what is searched for. Results are cached for CACHE_TTL and reused while the inputs (filter, search, category, pagination, book) are unchanged.
  Overrides:
  getLoadBookMessages in class AddressbookBean
  Returns:
  messages about loading the address book
- getEntries
  public AddressBean[] getEntries()
  Returns the address entries. Returns the entries with blacklist filtering and the current filter, search, and pagination applied, loading or reusing the cached load.
  Overrides:
  getEntries in class AddressbookBean
  Returns:
  the filtered, searched, and paginated entries, or null if no load has succeeded yet
- getMessages
  public String getMessages()
  Perform actions, returning messages about this.
  Overrides:
  getMessages in class AddressbookBean
  Returns:
  messages about the performed actions
- saveNotes
  public void saveNotes()
  Save notes for a destination.
- setH
  public void setH(String h)
  Sets the hostname for lookup.
  Parameters:
  h - the hostname to set
- setNofilter_notes
  public void setNofilter_notes(String n)
  Sets the notes for the destination.
  Parameters:
  n - the notes to set
- getLookup
  public AddressBean getLookup()
  Lookup a single destination by hostname.
  Returns:
  the AddressBean for the destination, or null if not found
- getLookupAll
  public List<AddressBean> getLookupAll()
  Lookup all destinations for a hostname.
  Returns:
  list of AddressBeans for all destinations, or null if not found
- export
  public void export(Writer out) throws IOException
  Export address book entries to a writer.
  Parameters:
  out - the writer to export to
  Throws:
  IOException - if an I/O error occurs
- importFile
  public String importFile(RequestWrapper wrequest) throws IOException
  Import entries from a file upload.
  Parameters:
  wrequest - the request wrapper containing the file
  Returns:
  messages about the import operation
  Throws:
  IOException - if an I/O error occurs
- styleMessage
  private static String styleMessage(String message, boolean fail)
  Style a message for display in the UI.
  Parameters:
  message - the text for the messages paragraph, inserted verbatim and not escaped
  fail - true if the message indicates a failure
  Returns:
  the styled HTML message
- haveImagegen
  public boolean haveImagegen()
  Check if the imagegen service is available.
  Returns:
  true if imagegen is registered

Field Summary

Fields inherited from class AddressbookBean

Fields inherited from class BaseBean

Constructor Summary

Method Summary

Methods inherited from class AddressbookBean

Methods inherited from class BaseBean

Methods inherited from class Object

Field Details

_log

DEFAULT_NS

detail

notes

fail

filteredCount

fullFilteredEntries

_serverPaginated

CACHE_TTL

_loadKey

_loadTime

_cachedLoadMessage

_sizeKey

_sizeTime

_cachedSize

Constructor Details

Method Details

isDirect

isPrefiltered

resultSize

getTotalFilteredCount

totalSize

isNotEmpty

getFileName

getDisplayName

searchNamingService

basename

getNamingService

loadKey

clearCaches

getLoadBookMessages

getEntries

getMessages

saveNotes

setH

setNofilter_notes

getLookup

getLookupAll

export

importFile

styleMessage

haveImagegen