com.browserup.bup.proxy.dns

Class AbstractHostNameRemapper

java.lang.Object

com.browserup.bup.proxy.dns.AbstractHostNameRemapper

All Implemented Interfaces:

AdvancedHostResolver, HostResolver

Direct Known Subclasses:

DnsJavaResolver, NativeResolver

public abstract class AbstractHostNameRemapper
extends java.lang.Object
implements AdvancedHostResolver

Base class that provides host name remapping capabilities for AdvancedHostResolvers. Subclasses must implement resolveRemapped(String) instead of HostResolver.resolve(String), which takes the remapped host as the input parameter.

Constructor Summary

Constructors

Constructor and Description
AbstractHostNameRemapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	applyRemapping(java.lang.String originalHost) Applies this class's host name remappings to the specified original host, returning the remapped host name (if any), or the originalHost if there is no remapped host name.
void	clearHostRemappings() Removes all hostname remappings.
java.util.Map<java.lang.String,java.lang.String>	getHostRemappings() Returns all host remappings in effect.
java.util.Collection<java.lang.String>	getOriginalHostnames(java.lang.String remappedHost) Returns the original address or addresses that are remapped to the specified remappedHost.
void	remapHost(java.lang.String originalHost, java.lang.String remappedHost) Remaps an individual host.
void	remapHosts(java.util.Map<java.lang.String,java.lang.String> hostRemappings) Replaces the host remappings in the existing list of remappings (if any) with the specified remappings.
void	removeHostRemapping(java.lang.String originalHost) Removes the specified host remapping.
java.util.Collection<java.net.InetAddress>	resolve(java.lang.String originalHost) Retrieves the remapped hostname and resolves it using resolveRemapped(String).
abstract java.util.Collection<java.net.InetAddress>	resolveRemapped(java.lang.String remappedHost) Resolves the specified remapped host.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.browserup.bup.proxy.dns.AdvancedHostResolver

clearDNSCache, setNegativeDNSCacheTimeout, setPositiveDNSCacheTimeout

Constructor Detail

AbstractHostNameRemapper

public AbstractHostNameRemapper()

Method Detail

remapHosts

public void remapHosts(java.util.Map<java.lang.String,java.lang.String> hostRemappings)

Description copied from interface: AdvancedHostResolver

Replaces the host remappings in the existing list of remappings (if any) with the specified remappings. The remappings will be applied in the order specified by the Map's iterator. Note: The original hostnames must exactly match the requested hostname. It is not a domain or regular expression match.

Specified by:

remapHosts in interface AdvancedHostResolver

Parameters:

hostRemappings - Map of <original hostname, remapped hostname>

remapHost

public void remapHost(java.lang.String originalHost,
                      java.lang.String remappedHost)

Description copied from interface: AdvancedHostResolver

Remaps an individual host. If there are any existing remappings, the new remapping will be applied last, after all existing remappings are applied. If there is already a remapping for the specified originalHost, it will be removed before the new remapping is added to the end of the host remapping list (and will therefore be the last remapping applied).

Specified by:

remapHost in interface AdvancedHostResolver

Parameters:

originalHost - Original host to remap. Must exactly match the requested hostname (not a domain or regular expression match).

remappedHost - hostname that will replace originalHost

removeHostRemapping

public void removeHostRemapping(java.lang.String originalHost)

Description copied from interface: AdvancedHostResolver

Removes the specified host remapping. If the remapping does not exist, this method has no effect.

Specified by:

removeHostRemapping in interface AdvancedHostResolver

Parameters:

originalHost - currently-remapped hostname

clearHostRemappings

public void clearHostRemappings()

Description copied from interface: AdvancedHostResolver

Removes all hostname remappings.

Specified by:

clearHostRemappings in interface AdvancedHostResolver

getHostRemappings

public java.util.Map<java.lang.String,java.lang.String> getHostRemappings()

Description copied from interface: AdvancedHostResolver

Returns all host remappings in effect. Iterating over the returned Map is guaranteed to return remappings in the order in which the remappings are actually applied.

Specified by:

getHostRemappings in interface AdvancedHostResolver

Returns:

Map of <original hostname, remapped hostname>

getOriginalHostnames

public java.util.Collection<java.lang.String> getOriginalHostnames(java.lang.String remappedHost)

Description copied from interface: AdvancedHostResolver

Returns the original address or addresses that are remapped to the specified remappedHost. Iterating over the returned Collection is guaranteed to return original mappings in the order in which the remappings are applied.

Specified by:

getOriginalHostnames in interface AdvancedHostResolver

Parameters:

remappedHost - remapped hostname

Returns:

original hostnames that are remapped to the specified remappedHost, or an empty Collection if no remapping is defined to the remappedHost

applyRemapping

public java.lang.String applyRemapping(java.lang.String originalHost)

Applies this class's host name remappings to the specified original host, returning the remapped host name (if any), or the originalHost if there is no remapped host name.

Parameters:

originalHost - original host name to resolve

Returns:

a remapped host, or the original host if no mapping exists

resolveRemapped

public abstract java.util.Collection<java.net.InetAddress> resolveRemapped(java.lang.String remappedHost)

Resolves the specified remapped host. Subclasses should provide resolution by implementing this method, rather than overriding HostResolver.resolve(String).

Parameters:

remappedHost - remapped hostname to resolve

Returns:

resolved InetAddresses, or an empty list if no addresses were found

resolve

public java.util.Collection<java.net.InetAddress> resolve(java.lang.String originalHost)

Retrieves the remapped hostname and resolves it using resolveRemapped(String).

Specified by:

resolve in interface HostResolver

Parameters:

originalHost - original hostname to resolve

Returns:

InetAddresses resolved from the remapped hostname, or an empty list if no addresses were found