com.google.maps

Class GeoApiContext

java.lang.Object

com.google.maps.GeoApiContext

public class GeoApiContext
extends java.lang.Object

The entry point for making requests against the Google Geo APIs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GeoApiContext.RequestHandler RequestHandler is the service provider interface that enables requests to be handled via switchable back ends.

Constructor Summary

Constructors

Constructor and Description
GeoApiContext() Construct a GeoApiContext with OkHttp.
GeoApiContext(GeoApiContext.RequestHandler requestHandler) Construct a GeoApiContext with the specified strategy for handling requests.

Method Summary

Modifier and Type	Method and Description
GeoApiContext	disableRetries() Disable retries completely.
GeoApiContext	setApiKey(java.lang.String apiKey)
GeoApiContext	setChannel(java.lang.String channel) Sets the default channel for requests (can be overridden by requests).
GeoApiContext	setConnectTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the default connect timeout for new connections.
GeoApiContext	setEnterpriseCredentials(java.lang.String clientId, java.lang.String cryptographicSecret)
GeoApiContext	setMaxRetries(java.lang.Integer maxRetries) Sets the maximum number of times each retry-able errors will be retried.
GeoApiContext	setProxy(java.net.Proxy proxy) Sets the proxy for new connections.
GeoApiContext	setQueryRateLimit(int maxQps) Sets the maximum number of queries that will be executed during a 1 second interval.
GeoApiContext	setQueryRateLimit(int maxQps, int minimumInterval) Sets the rate at which queries are executed.
GeoApiContext	setReadTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the default read timeout for new connections.
GeoApiContext	setRetryTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the cumulative time limit for which retry-able errors will be retried.
GeoApiContext	setWriteTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the default write timeout for new connections.
GeoApiContext	toggleifExceptionIsAllowedToRetry(java.lang.Class<? extends ApiException> exception, boolean allowedToRetry) Allows specific API exceptions to be retried or not retried.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoApiContext

public GeoApiContext()

Construct a GeoApiContext with OkHttp.

GeoApiContext

public GeoApiContext(GeoApiContext.RequestHandler requestHandler)

Construct a GeoApiContext with the specified strategy for handling requests.

Parameters:

requestHandler - How to handle URL requests to the Google Maps APIs.

See Also:

OkHttpRequestHandler, GaeRequestHandler

Method Detail

setApiKey

public GeoApiContext setApiKey(java.lang.String apiKey)

setEnterpriseCredentials

public GeoApiContext setEnterpriseCredentials(java.lang.String clientId,
                                              java.lang.String cryptographicSecret)

setChannel

public GeoApiContext setChannel(java.lang.String channel)

Sets the default channel for requests (can be overridden by requests). Only useful for Google Maps for Work clients.

Parameters:

channel - The channel to use for analytics

setConnectTimeout

public GeoApiContext setConnectTimeout(long timeout,
                                       java.util.concurrent.TimeUnit unit)

Sets the default connect timeout for new connections. A value of 0 means no timeout.

See Also:

URLConnection.setConnectTimeout(int)

setReadTimeout

public GeoApiContext setReadTimeout(long timeout,
                                    java.util.concurrent.TimeUnit unit)

Sets the default read timeout for new connections. A value of 0 means no timeout.

See Also:

URLConnection.setReadTimeout(int)

setWriteTimeout

public GeoApiContext setWriteTimeout(long timeout,
                                     java.util.concurrent.TimeUnit unit)

Sets the default write timeout for new connections. A value of 0 means no timeout.

setRetryTimeout

public GeoApiContext setRetryTimeout(long timeout,
                                     java.util.concurrent.TimeUnit unit)

Sets the cumulative time limit for which retry-able errors will be retried. Defaults to 60 seconds. Set to zero to retry requests forever.

This operates separately from the count-based setMaxRetries(Integer).

setMaxRetries

public GeoApiContext setMaxRetries(java.lang.Integer maxRetries)

Sets the maximum number of times each retry-able errors will be retried. Set this to null to not have a max number. Set this to zero to disable retries.

This operates separately from the time-based setRetryTimeout(long, TimeUnit).

disableRetries

public GeoApiContext disableRetries()

Disable retries completely.

setQueryRateLimit

public GeoApiContext setQueryRateLimit(int maxQps)

Sets the maximum number of queries that will be executed during a 1 second interval. The default is 10. A minimum interval between requests will also be enforced, set to 1/(2 * maxQps).

setQueryRateLimit

public GeoApiContext setQueryRateLimit(int maxQps,
                                       int minimumInterval)

Sets the rate at which queries are executed.

Parameters:

maxQps - The maximum number of queries to execute per second.

minimumInterval - The minimum amount of time, in milliseconds, to pause between requests. Note that this pause only occurs if the amount of time between requests has not elapsed naturally.

toggleifExceptionIsAllowedToRetry

public GeoApiContext toggleifExceptionIsAllowedToRetry(java.lang.Class<? extends ApiException> exception,
                                                       boolean allowedToRetry)

Allows specific API exceptions to be retried or not retried.

setProxy

public GeoApiContext setProxy(java.net.Proxy proxy)

Sets the proxy for new connections.

Parameters:

proxy - The proxy to be used by the underlying HTTP client.