HostsTxtNamingService

net.i2p.client.naming.HostsTxtNamingService

public class HostsTxtNamingServiceextends MetaNamingService

A naming service based on multiple "hosts.txt" files. Supports .b32.i2p and {b64} lookups. Supports caching. All host names are converted to lower case.

Field Summary
Fields
Modifier and Type
Field
Description
static final String
DEFAULT_HOSTS_FILE
Default hosts.txt filenames.
static final String
PROP_HOSTS_FILE
If this system property is specified, the tunnel will read the given file for hostname=destKey values when resolving names.
Fields inherited from class MetaNamingService
_services
Modifier and Type
Field
Description
protected final List<NamingService>
_services
Chained naming services, in order.
Fields inherited from class DummyNamingService
BASE32_HASH_LENGTH, CACHE_MAX_SIZE, DEST_SIZE, PROP_B32
Modifier and Type
Field
Description
protected static final int
BASE32_HASH_LENGTH
Length of a base32 hash string.
protected static final int
CACHE_MAX_SIZE
Maximum cache size.
static final int
DEST_SIZE
Standard base64 destination length (no certificate).
static final String
PROP_B32
Property to enable b32 lookup.
Fields inherited from class NamingService
_context, _listeners, _log, _updaters, PROP_IMPL
Modifier and Type
Field
Description
protected final I2PAppContext
_context
The app context.
protected final Set<NamingServiceListener>
_listeners
The listeners.
protected final Log
_log
The logger.
protected final Set<NamingServiceUpdater>
_updaters
The updaters.
static final String
PROP_IMPL
What classname should be used as the naming service impl?
Constructor Summary
Constructors
Constructor
Description
HostsTxtNamingService(I2PAppContext context)
The naming service should only be constructed and accessed through the application context.
Method Summary
Modifier and Type
Method
Description
private List<String>
getFilenames()
The hosts files configured for this service.
Set<String>
getNames(Properties options)
All services aggregated, unless options contains the property "file", in which case only for that file.
Destination
lookup(String hostname, Properties lookupOptions, Properties storedOptions)
Throws, this service knows no destinations.
boolean
put(String hostname, Destination d, Properties options)
Stores in the last service.
boolean
putIfAbsent(String hostname, Destination d, Properties options)
Stores in the last service.
boolean
remove(String hostname, Properties options)
Removes from all services.
Methods inherited from class MetaNamingService
addNamingService, export, getBase64Entries, getEntries, getNamingServices, registerListener, removeNamingService, reverseLookup, shutdown, size, unregisterListener
Modifier and Type
Method
Description
final boolean
addNamingService(NamingService ns, boolean head)
Only for chaining-capable NamingServices.
void
export(Writer out, Properties options)
All services aggregated.
Map<String,String>
getBase64Entries(Properties options)
All services aggregated.
Map<String, Destination>
getEntries(Properties options)
All services aggregated.
List<NamingService>
getNamingServices()
For daisy chaining (MetaNamingService).
void
registerListener(NamingServiceListener nsl)
Register a listener for naming service changes.
boolean
removeNamingService(NamingService ns)
Only for chaining-capable NamingServices.
String
reverseLookup(Destination dest, Properties options)
Same as reverseLookup(dest) but with options This implementation returns null.
void
shutdown()
Parent will call when removed.
int
size(Properties options)
All services aggregated.
void
unregisterListener(NamingServiceListener nsl)
Unregister a listener for naming service changes.
Methods inherited from class DummyNamingService
clearCache, getCache, putCache, removeCache
Modifier and Type
Method
Description
protected static void
clearCache()
Clear all cached destinations.
protected static Destination
getCache(String s)
Look up a cached destination.
protected static void
putCache(String s, Destination d)
Provide basic static caching for all services.
protected static void
removeCache(String s)
Remove a cached destination.
Methods inherited from class NamingService
addDestination, addDestination, addNamingService, createInstance, export, getConfiguration, getEntries, getName, getNames, getParent, isB32Host, isBlindedHost, isI2PHost, lookup, lookup, lookupAll, lookupAll, lookupBase32, lookupBase64, put, putAll, putIfAbsent, registerUpdater, remove, remove, remove, requestUpdate, reverseLookup, reverseLookup, reverseLookupAll, reverseLookupAll, reverseLookupAll, setConfiguration, size, start, toString, unregisterUpdater, update
Modifier and Type
Method
Description
boolean
addDestination(String hostname, Destination d)
Add a Destination to an existing hostname's entry in the addressbook.
boolean
addDestination(String hostname, Destination d, Properties options)
Add a Destination to an existing hostname's entry in the addressbook.
boolean
addNamingService(NamingService ns)
Only for chaining-capable NamingServices.
static final NamingService
createInstance(I2PAppContext context)
WARNING - for use by I2PAppContext only - others must use I2PAppContext.namingService().
void
export(Writer out)
Export in a hosts.txt format.
Properties
getConfiguration()
Warning - unimplemented in any subclass.
Map<String, Destination>
getEntries()
Warning - This obviously brings the whole database into memory, so use is discouraged.
String
getName()
The name of this naming service.
Set<String>
getNames()
All known hostnames.
NamingService
getParent()
This implementation returns null.
static boolean
isB32Host(String hostname)
Is this a b32 hostname? Does NOT validate the base32 part except for length.
static boolean
isBlindedHost(String hostname)
Is this a blinded ("b33") hostname? Does NOT validate the base32 part except for length.
static boolean
isI2PHost(String hostname)
Is this an i2p hostname?
Destination
lookup(String hostname)
Look up a hostname.
Destination
lookup(Hash hash, int timeout)
Same as NamingService.lookupBase32(String, int) but with the SHA256 Hash precalculated This implementation returns null.
List<Destination>
lookupAll(String hostname)
For NamingServices that support multiple Destinations for a single hostname, return all of them.
List<Destination>
lookupAll(String hostname, Properties lookupOptions, List<Properties> storedOptions)
For NamingServices that support multiple Destinations and Properties for a single hostname, return all of them.
Destination
lookupBase32(String hostname, int timeout)
Lookup a Base 32 address.
protected Destination
lookupBase64(String hostname)
If the hostname is a valid Base64 encoded destination, return the decoded Destination.
boolean
put(String hostname, Destination d)
Add a hostname and Destination to the addressbook.
boolean
putAll(Map<String, Destination> entries, Properties options)
Put all the entries, each with the given options.
boolean
putIfAbsent(String hostname, Destination d)
Add a hostname and Destination to the addressbook.
void
registerUpdater(NamingServiceUpdater nsu)
Register an updater for the naming service.
boolean
remove(String hostname)
Delete the entry.
boolean
remove(String hostname, Destination d)
Remove a hostname's entry only if it contains the Destination d.
boolean
remove(String hostname, Destination d, Properties options)
Remove a hostname's entry only if it contains the Destination d.
void
requestUpdate(Properties options)
Ask any registered updaters to update now.
String
reverseLookup(Destination dest)
Reverse lookup a destination.
String
reverseLookup(Hash h)
Reverse lookup a hash.
List<String>
reverseLookupAll(Destination dest)
Reverse lookup a destination This implementation returns reverseLookupAll(dest, null).
List<String>
reverseLookupAll(Destination d, Properties options)
Same as reverseLookupAll(dest) but with options This implementation returns the result from reverseLookup, or null.
List<String>
reverseLookupAll(Hash h)
Reverse lookup a hash.
boolean
setConfiguration(Properties p)
Warning - unimplemented in any subclass.
int
size()
The number of entries in this naming service.
void
start()
Parent will call when added.
String
toString()
Returns a string representation of this naming service.
void
unregisterUpdater(NamingServiceUpdater nsu)
Unregister an updater for the naming service.
boolean
update(String hostname, Destination d, Properties options)
Fails if entry did not previously exist.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- PROP_HOSTS_FILE
  public static final String PROP_HOSTS_FILE
  If this system property is specified, the tunnel will read the given file for hostname=destKey values when resolving names.
  See Also:
  Constant Field Values
- DEFAULT_HOSTS_FILE
  public static final String DEFAULT_HOSTS_FILE
  Default hosts.txt filenames.
  See Also:
  Constant Field Values
Constructor Details
- HostsTxtNamingService
  public HostsTxtNamingService(I2PAppContext context)
  The naming service should only be constructed and accessed through the application context. This constructor should only be used by the appropriate application context itself.
  Parameters:
  context - the application context
Method Details
- getFilenames
  private List<String> getFilenames()
  The hosts files configured for this service.
  Returns:
  the file names, empty if none are configured
- lookup
  public Destination lookup(String hostname, Properties lookupOptions, Properties storedOptions)
  Description copied from class: DummyNamingService
  Throws, this service knows no destinations.
  Overrides:
  lookup in class MetaNamingService
  Parameters:
  hostname - mixed case as it could be a key
  lookupOptions - input parameter, NamingService-specific, can be null
  storedOptions - output parameter, NamingService-specific, any stored properties will be added if non-null
  Returns:
  dest or null
- put
  public boolean put(String hostname, Destination d, Properties options)
  Description copied from class: MetaNamingService
  Stores in the last service.
  Overrides:
  put in class MetaNamingService
  Parameters:
  hostname - the host name to map to the destination, overwriting any existing entry
  d - the destination for the hostname
  options - NamingService-specific, can be null
  Returns:
  true if the entry was stored; this base implementation always returns false
- putIfAbsent
  public boolean putIfAbsent(String hostname, Destination d, Properties options)
  Description copied from class: MetaNamingService
  Stores in the last service.
  Overrides:
  putIfAbsent in class MetaNamingService
  Parameters:
  hostname - the host name to map to the destination, which must not already be present
  d - the destination for the hostname
  options - NamingService-specific, can be null
  Returns:
  true if no entry existed and the new one was stored; this base implementation always returns false
- remove
  public boolean remove(String hostname, Properties options)
  Description copied from class: MetaNamingService
  Removes from all services.
  Overrides:
  remove in class MetaNamingService
  Parameters:
  hostname - the host name whose entry is to be deleted
  options - NamingService-specific, can be null
  Returns:
  true if removed successfully, false on error or if it did not exist
- getNames
  public Set<String> getNames(Properties options)
  All services aggregated, unless options contains the property "file", in which case only for that file.
  Overrides:
  getNames in class MetaNamingService
  Parameters:
  options - NamingService-specific, can be null
  Returns:
  the hostnames from the selected file, or from every service if no file is named

Field Summary

Fields inherited from class MetaNamingService

Fields inherited from class DummyNamingService

Fields inherited from class NamingService

Constructor Summary

Method Summary

Methods inherited from class MetaNamingService

Methods inherited from class DummyNamingService

Methods inherited from class NamingService

Methods inherited from class Object

Field Details

PROP_HOSTS_FILE

DEFAULT_HOSTS_FILE

Constructor Details

Method Details

getFilenames

lookup

put

putIfAbsent

remove

getNames