com.maxmind.geoip2

Class WebServiceClient.Builder

java.lang.Object

com.maxmind.geoip2.WebServiceClient.Builder

Enclosing class:

WebServiceClient

public static final class WebServiceClient.Builder
extends Object

Builder creates instances of WebServiceClient from values set by the methods.

This example shows how to create a WebServiceClient object with the Builder:

WebServiceClient client = new WebServiceClient.Builder(12,"licensekey").host ("geoip.maxmind.com").build();

Only the values set in the Builder constructor are required.

Constructor Summary

Constructors

Constructor and Description
Builder(int userId, String licenseKey)

Method Summary

Modifier and Type	Method and Description
WebServiceClient	build()
WebServiceClient.Builder	connectTimeout(int val)
WebServiceClient.Builder	disableHttps() Disables HTTPS to connect to a test server or proxy.
WebServiceClient.Builder	host(String val)
WebServiceClient.Builder	locales(List<String> val)
WebServiceClient.Builder	port(int val)
WebServiceClient.Builder	proxy(Proxy val)
WebServiceClient.Builder	readTimeout(int val)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(int userId,
               String licenseKey)

Parameters:

userId - Your MaxMind user ID.

licenseKey - Your MaxMind license key.

Method Detail

connectTimeout

public WebServiceClient.Builder connectTimeout(int val)

Parameters:

val - Timeout in milliseconds to establish a connection to the web service. The default is 3000 (3 seconds).

Returns:

Builder object

disableHttps

public WebServiceClient.Builder disableHttps()

Disables HTTPS to connect to a test server or proxy. The minFraud ScoreResponse and InsightsResponse web services require HTTPS.

Returns:

Builder object

host

public WebServiceClient.Builder host(String val)

Parameters:

val - The host to use.

Returns:

Builder object

port

public WebServiceClient.Builder port(int val)

Parameters:

val - The port to use.

Returns:

Builder object

locales

public WebServiceClient.Builder locales(List<String> val)

Parameters:

val - List of locale codes to use in name property from most preferred to least preferred.

Returns:

Builder object

readTimeout

public WebServiceClient.Builder readTimeout(int val)

Parameters:

val - readTimeout in milliseconds to read data from an established connection to the web service. The default is 20000 (20 seconds).

Returns:

Builder object

proxy

public WebServiceClient.Builder proxy(Proxy val)

Parameters:

val - the proxy to use when making this request.

Returns:

Builder object

build

public WebServiceClient build()

Returns:

an instance of WebServiceClient created from the fields set on this builder.