net.lightbody.bmp.client

Class ClientUtil

java.lang.Object

net.lightbody.bmp.client.ClientUtil

public class ClientUtil
extends Object

A utility class with convenience methods for clients using BrowserMob Proxy in embedded mode.

Constructor Summary

Constructors

Constructor and Description
ClientUtil()

Method Summary

Modifier and Type	Method and Description
static AdvancedHostResolver	createDnsJavaResolver() Creates a DnsJavaResolver instance that can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).
static AdvancedHostResolver	createDnsJavaWithNativeFallbackResolver() Creates a ChainedHostResolver instance that first attempts to resolve a hostname using a DnsJavaResolver, then uses NativeCacheManipulatingResolver.
static AdvancedHostResolver	createNativeCacheManipulatingResolver() Creates a NativeCacheManipulatingResolver instance that can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).
static AdvancedHostResolver	createNativeResolver() Creates a NativeResolver instance that does not support cache manipulation that can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).
static org.openqa.selenium.Proxy	createSeleniumProxy(BrowserMobProxy browserMobProxy) Creates a Selenium Proxy object from the BrowserMobProxy instance.
static org.openqa.selenium.Proxy	createSeleniumProxy(BrowserMobProxy browserMobProxy, InetAddress connectableAddress) Creates a Selenium Proxy object from the BrowserMobProxy instance, using the specified connectableAddress as the Selenium Proxy object's proxy address.
static org.openqa.selenium.Proxy	createSeleniumProxy(InetSocketAddress connectableAddressAndPort) Creates a Selenium Proxy object using the specified connectableAddressAndPort as the HTTP proxy server.
static InetAddress	getConnectableAddress() Attempts to retrieve a "connectable" address for this device that other devices on the network can use to connect to a local proxy.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientUtil

public ClientUtil()

Method Detail

createNativeCacheManipulatingResolver

public static AdvancedHostResolver createNativeCacheManipulatingResolver()

Creates a NativeCacheManipulatingResolver instance that can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).

Returns:

a new NativeCacheManipulatingResolver

createNativeResolver

public static AdvancedHostResolver createNativeResolver()

Creates a NativeResolver instance that does not support cache manipulation that can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).

Returns:

a new NativeResolver

createDnsJavaResolver

public static AdvancedHostResolver createDnsJavaResolver()

Creates a DnsJavaResolver instance that can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).

Returns:

a new DnsJavaResolver

createDnsJavaWithNativeFallbackResolver

public static AdvancedHostResolver createDnsJavaWithNativeFallbackResolver()

Creates a ChainedHostResolver instance that first attempts to resolve a hostname using a DnsJavaResolver, then uses NativeCacheManipulatingResolver. Can be used when calling BrowserMobProxy.setHostNameResolver(net.lightbody.bmp.proxy.dns.AdvancedHostResolver).

Returns:

a new ChainedHostResolver that resolves addresses first using a DnsJavaResolver, then using a NativeCacheManipulatingResolver

createSeleniumProxy

public static org.openqa.selenium.Proxy createSeleniumProxy(BrowserMobProxy browserMobProxy)

Creates a Selenium Proxy object from the BrowserMobProxy instance. The BrowserMobProxy must be started. Retrieves the address of the Proxy using getConnectableAddress().

Parameters:

browserMobProxy - started BrowserMobProxy instance to read connection information from

Returns:

a Selenium Proxy instance, configured to use the BrowserMobProxy instance as its proxy server

Throws:

IllegalStateException - if the proxy has not been started.

createSeleniumProxy

public static org.openqa.selenium.Proxy createSeleniumProxy(BrowserMobProxy browserMobProxy,
                                                            InetAddress connectableAddress)

Creates a Selenium Proxy object from the BrowserMobProxy instance, using the specified connectableAddress as the Selenium Proxy object's proxy address. Determines the port using BrowserMobProxy.getPort(). The BrowserMobProxy must be started.

Parameters:

browserMobProxy - started BrowserMobProxy instance to read the port from

connectableAddress - the network address the Selenium Proxy will use to reach this BrowserMobProxy instance

Returns:

a Selenium Proxy instance, configured to use the BrowserMobProxy instance as its proxy server

Throws:

IllegalStateException - if the proxy has not been started.

createSeleniumProxy

public static org.openqa.selenium.Proxy createSeleniumProxy(InetSocketAddress connectableAddressAndPort)

Creates a Selenium Proxy object using the specified connectableAddressAndPort as the HTTP proxy server.

Parameters:

connectableAddressAndPort - the network address (or hostname) and port the Selenium Proxy will use to reach its proxy server (the InetSocketAddress may be unresolved).

Returns:

a Selenium Proxy instance, configured to use the specified address and port as its proxy server

getConnectableAddress

public static InetAddress getConnectableAddress()

Attempts to retrieve a "connectable" address for this device that other devices on the network can use to connect to a local proxy. This is a "reasonable guess" that is suitable in many (but not all) common scenarios. TODO: define the algorithm used to discover a "connectable" local host

Returns:

a "reasonable guess" at an address that can be used by other machines on the network to reach this host