GoogleAnalyticsConfig (Google Analytics Java7 API 2.0.6 API)

java.lang.Object
- com.brsanthu.googleanalytics.GoogleAnalyticsConfig

```
public class GoogleAnalyticsConfig
extends Object
```
Properties that can be configured in this library. These would include any properties that are required to process the tracking request or enhance the tracking request (but not specified in measurement protocol like User agent).
Most of the properties are initialization level and request level. If a property is a initialization level property, it should be set at the time of GoogleAnalytics object initialization. If a property is a request level property, it can be set any time and it will be effective.
All properties of this config object supports method chaining. So for example, you could do, new GoogleAnalyticsConfig().setMaxThreads(2).setThreadNameFormat("name");

Author:

Santhosh Kumar

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_MAX_HTTP_CONNECTIONS_PER_ROUTE

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_HTTP_CONNECTIONS_PER_ROUTE`

Constructor Summary

Constructors
Constructor and Description

GoogleAnalyticsConfig()

Constructors
Constructor and Description
`GoogleAnalyticsConfig()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getBatchSize()`
`String`	`getBatchUrl()`
`String`	`getHttpsUrl()`
`String`	`getHttpUrl()`
`int`	`getMaxHttpConnectionsPerRoute()`
`int`	`getMaxThreads()` Maximum threads to use to process the asynchronous event posting and Http client connection pooling.
`int`	`getMinThreads()`
`String`	`getProxyHost()`
`String`	`getProxyPassword()`
`int`	`getProxyPort()`
`String`	`getProxyUserName()`
`RequestParameterDiscoverer`	`getRequestParameterDiscoverer()`
`int`	`getSamplePercentage()` The sample percentage to apply to all analytics.
`String`	`getThreadNameFormat()`
`int`	`getThreadQueueSize()`
`int`	`getThreadTimeoutSecs()`
`String`	`getUrl()`
`String`	`getUserAgent()`
`boolean`	`isBatchingEnabled()`
`boolean`	`isDiscoverRequestParameters()`
`boolean`	`isEnabled()`
`boolean`	`isGatherStats()`
`boolean`	`isUseHttps()`
`boolean`	`isValidate()`
`static String`	`mask(String value)`
`GoogleAnalyticsConfig`	`setBatchingEnabled(boolean batchingEnabled)`
`GoogleAnalyticsConfig`	`setBatchSize(int batchSize)`
`GoogleAnalyticsConfig`	`setBatchUrl(String batchUrl)`
`GoogleAnalyticsConfig`	`setDeriveSystemParameters(boolean deriveSystemProperties)` Deprecated. Use `setDiscoverRequestParameters(boolean)` instead
`GoogleAnalyticsConfig`	`setDiscoverRequestParameters(boolean discoverSystemParameters)` If true, derives the system properties (User Language, Region, Country, Screen Size, Color Depth, and File encoding) and adds to the default request.
`GoogleAnalyticsConfig`	`setEnabled(boolean enabled)` Enables or disables the GoogleAnalytics posting.
`GoogleAnalyticsConfig`	`setGatherStats(boolean gatherStats)` If set to true, `GoogleAnalyticsImpl` will collect the basic stats about successful event postings for various hit types and keeps a copy of `GoogleAnalyticsStatsImpl`, which can be retrieved using `GoogleAnalyticsImpl.getStats()`
`GoogleAnalyticsConfig`	`setHttpsUrl(String httpsUrl)` URL to use when posting the event in https mode.
`GoogleAnalyticsConfig`	`setHttpUrl(String httpUrl)` URL to use when posting the event in http mode.
`GoogleAnalyticsConfig`	`setMaxHttpConnectionsPerRoute(int maxHttpConnectionsPerRoute)`
`GoogleAnalyticsConfig`	`setMaxThreads(int maxThreads)`
`GoogleAnalyticsConfig`	`setMinThreads(int minThreads)`
`GoogleAnalyticsConfig`	`setProxyHost(String proxyHost)` Sets the host name of the proxy server, to connect to Google analytics.
`GoogleAnalyticsConfig`	`setProxyPassword(String proxyPassword)` Sets the password which should be used to authenticate to the proxy server.
`GoogleAnalyticsConfig`	`setProxyPort(int proxyPort)` Sets the host name of the proxy server, to connect to Google analytics.
`GoogleAnalyticsConfig`	`setProxyUserName(String proxyUserName)` Sets the user name which should be used to authenticate to the proxy server.
`GoogleAnalyticsConfig`	`setRequestParameterDiscoverer(RequestParameterDiscoverer requestParameterDiscoverer)` Sets the appropriate request parameter discoverer.
`GoogleAnalyticsConfig`	`setSamplePercentage(int samplePercentage)`
`GoogleAnalyticsConfig`	`setThreadNameFormat(String threadNameFormat)` Sets the thread name format that should be while creating the threads.
`GoogleAnalyticsConfig`	`setThreadQueueSize(int threadQueueSize)`
`GoogleAnalyticsConfig`	`setThreadTimeoutSecs(int threadTimeoutSecs)`
`GoogleAnalyticsConfig`	`setUseHttps(boolean useHttps)` Instructs to use https url to send the events.
`GoogleAnalyticsConfig`	`setUserAgent(String userAgent)` Sets the user agent string that should be sent while making the http request.
`GoogleAnalyticsConfig`	`setValidate(boolean validate)` If set, validates the request before sending to Google Analytics.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_HTTP_CONNECTIONS_PER_ROUTE
```
public static final int DEFAULT_MAX_HTTP_CONNECTIONS_PER_ROUTE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GoogleAnalyticsConfig
```
public GoogleAnalyticsConfig()
```
- Method Detail
  - getRequestParameterDiscoverer
```
public RequestParameterDiscoverer getRequestParameterDiscoverer()
```
  - setRequestParameterDiscoverer
```
public GoogleAnalyticsConfig setRequestParameterDiscoverer(RequestParameterDiscoverer requestParameterDiscoverer)
```
    Sets the appropriate request parameter discoverer. Default is DefaultRequestParameterDiscoverer but can be changed to AwtRequestParameterDiscoverer if you want to use Toolkit to derive the screen resolution etc. Please make sure you also enable the discovery using setDiscoverRequestParameters(boolean)
    
    Parameters:
    
    requestParameterDiscoverer - can be null and is so, parameters will not be discovered.
    
    Returns:
    
    GoogleAnalyticsConfig with requestParameterDiscoverer set
  - isGatherStats
```
public boolean isGatherStats()
```
  - setGatherStats
```
public GoogleAnalyticsConfig setGatherStats(boolean gatherStats)
```
    If set to true, GoogleAnalyticsImpl will collect the basic stats about successful event postings for various hit types and keeps a copy of GoogleAnalyticsStatsImpl, which can be retrieved using GoogleAnalyticsImpl.getStats()
    
    Parameters:
    
    gatherStats -
    
    Returns:
    
    GoogleAnalyticsConfig with gatherStats set
  - setThreadNameFormat
```
public GoogleAnalyticsConfig setThreadNameFormat(String threadNameFormat)
```
    Sets the thread name format that should be while creating the threads.
    Default is "googleanalytics-thread-{0}" where {0} is the thread counter. If you specify a custom format, make sure {0} is there somewhere otherwise all threads will be nameed same and can be an issue for troubleshooting.
    
    Parameters:
    
    threadNameFormat - non-null string for thread name.
  - getThreadNameFormat
```
public String getThreadNameFormat()
```
  - setDeriveSystemParameters
```
@Deprecated
public GoogleAnalyticsConfig setDeriveSystemParameters(boolean deriveSystemProperties)
```
    Deprecated. Use setDiscoverRequestParameters(boolean) instead
    
    Deprecated since 1.0.6
  - setDiscoverRequestParameters
```
public GoogleAnalyticsConfig setDiscoverRequestParameters(boolean discoverSystemParameters)
```
    If true, derives the system properties (User Language, Region, Country, Screen Size, Color Depth, and File encoding) and adds to the default request.
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - isDiscoverRequestParameters
```
public boolean isDiscoverRequestParameters()
```
  - setProxyUserName
```
public GoogleAnalyticsConfig setProxyUserName(String proxyUserName)
```
    Sets the user name which should be used to authenticate to the proxy server. This is applicable only if setProxyHost(String) is not empty.
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - getProxyUserName
```
public String getProxyUserName()
```
  - getProxyPassword
```
public String getProxyPassword()
```
  - setProxyPassword
```
public GoogleAnalyticsConfig setProxyPassword(String proxyPassword)
```
    Sets the password which should be used to authenticate to the proxy server. This is applicable only if setProxyHost(String) and setProxyUserName(String) is not empty.
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - getProxyHost
```
public String getProxyHost()
```
  - setProxyHost
```
public GoogleAnalyticsConfig setProxyHost(String proxyHost)
```
    Sets the host name of the proxy server, to connect to Google analytics.
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - getProxyPort
```
public int getProxyPort()
```
  - setProxyPort
```
public GoogleAnalyticsConfig setProxyPort(int proxyPort)
```
    Sets the host name of the proxy server, to connect to Google analytics.
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - getUserAgent
```
public String getUserAgent()
```
  - setUserAgent
```
public GoogleAnalyticsConfig setUserAgent(String userAgent)
```
    Sets the user agent string that should be sent while making the http request. Default is Apache Http Client's user agent, which looks something similar to this. Apache-HttpClient/release (java 1.5)
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - isEnabled
```
public boolean isEnabled()
```
  - setEnabled
```
public GoogleAnalyticsConfig setEnabled(boolean enabled)
```
    Enables or disables the GoogleAnalytics posting. If disabled, library will continue to accept the send/post requests but silently skips sending the event and returns successful response. Default is false.
    This is request level configuration (can be changed any time).
  - getMaxThreads
```
public int getMaxThreads()
```
    Maximum threads to use to process the asynchronous event posting and Http client connection pooling. Default is
    This is initialization level configuration (must be set while creating GoogleAnalytics object).
  - setMaxThreads
```
public GoogleAnalyticsConfig setMaxThreads(int maxThreads)
```
  - getMinThreads
```
public int getMinThreads()
```
  - setMinThreads
```
public GoogleAnalyticsConfig setMinThreads(int minThreads)
```
  - isUseHttps
```
public boolean isUseHttps()
```
  - setUseHttps
```
public GoogleAnalyticsConfig setUseHttps(boolean useHttps)
```
    Instructs to use https url to send the events. Default is true.
    This is request level configuration (can be changed any time).
  - isValidate
```
public boolean isValidate()
```
  - setValidate
```
public GoogleAnalyticsConfig setValidate(boolean validate)
```
    If set, validates the request before sending to Google Analytics. If any errors found, GoogleAnalyticsException will be thrown with details. Default is false. Note that, if you are sending the event in async mode, then request is always validated and logged to log file as warnings irrespective of this flag.
    This is request level configuration (can be changed any time).
  - getHttpUrl
```
public String getHttpUrl()
```
  - setHttpUrl
```
public GoogleAnalyticsConfig setHttpUrl(String httpUrl)
```
    URL to use when posting the event in http mode. This url is Google Analytics service url and usually not updated by the clients.
    Default value is http://www.google-analytics.com/collect
    
    This is request level configuration (can be changed any time).
  - getHttpsUrl
```
public String getHttpsUrl()
```
  - setHttpsUrl
```
public GoogleAnalyticsConfig setHttpsUrl(String httpsUrl)
```
    URL to use when posting the event in https mode. This url is Google Analytics service url and usually not updated by the clients.
    Default value is https://www.google-analytics.com/collect
    This is request level configuration (can be changed any time).
  - getUrl
```
public String getUrl()
```
  - getMaxHttpConnectionsPerRoute
```
public int getMaxHttpConnectionsPerRoute()
```
  - setMaxHttpConnectionsPerRoute
```
public GoogleAnalyticsConfig setMaxHttpConnectionsPerRoute(int maxHttpConnectionsPerRoute)
```
  - getSamplePercentage
```
public int getSamplePercentage()
```
    The sample percentage to apply to all analytics. Integer between 0 and 100, every time an analytics implementation is initialized, a random number will be compared to the sample percentage, allowing or disallowing analytics from the initialized instance
    
    Returns:
    
    int between 1 and 100
  - setSamplePercentage
```
public GoogleAnalyticsConfig setSamplePercentage(int samplePercentage)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - mask
```
public static String mask(String value)
```
  - getThreadQueueSize
```
public int getThreadQueueSize()
```
  - setThreadQueueSize
```
public GoogleAnalyticsConfig setThreadQueueSize(int threadQueueSize)
```
  - getThreadTimeoutSecs
```
public int getThreadTimeoutSecs()
```
  - setThreadTimeoutSecs
```
public GoogleAnalyticsConfig setThreadTimeoutSecs(int threadTimeoutSecs)
```
  - getBatchUrl
```
public String getBatchUrl()
```
  - setBatchUrl
```
public GoogleAnalyticsConfig setBatchUrl(String batchUrl)
```
  - isBatchingEnabled
```
public boolean isBatchingEnabled()
```
  - setBatchingEnabled
```
public GoogleAnalyticsConfig setBatchingEnabled(boolean batchingEnabled)
```
  - getBatchSize
```
public int getBatchSize()
```
  - setBatchSize
```
public GoogleAnalyticsConfig setBatchSize(int batchSize)
```

Class GoogleAnalyticsConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_HTTP_CONNECTIONS_PER_ROUTE

Constructor Detail

GoogleAnalyticsConfig

Method Detail

getRequestParameterDiscoverer

setRequestParameterDiscoverer

isGatherStats

setGatherStats

setThreadNameFormat

getThreadNameFormat

setDeriveSystemParameters

setDiscoverRequestParameters

isDiscoverRequestParameters

setProxyUserName

getProxyUserName

getProxyPassword

setProxyPassword

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getUserAgent

setUserAgent

isEnabled

setEnabled

getMaxThreads

setMaxThreads

getMinThreads

setMinThreads

isUseHttps

setUseHttps

isValidate

setValidate

getHttpUrl

setHttpUrl

getHttpsUrl

setHttpsUrl

getUrl

getMaxHttpConnectionsPerRoute

setMaxHttpConnectionsPerRoute

getSamplePercentage

setSamplePercentage

toString

mask

getThreadQueueSize

setThreadQueueSize

getThreadTimeoutSecs

setThreadTimeoutSecs

getBatchUrl

setBatchUrl

isBatchingEnabled

setBatchingEnabled

getBatchSize

setBatchSize