com.brsanthu.googleanalytics.internal

Class GoogleAnalyticsImpl

java.lang.Object

com.brsanthu.googleanalytics.internal.GoogleAnalyticsImpl

All Implemented Interfaces:

GoogleAnalytics, GoogleAnalyticsExecutor, AutoCloseable

public class GoogleAnalyticsImpl
extends Object
implements GoogleAnalytics, GoogleAnalyticsExecutor

This is the main class of this library that accepts the requests from clients and sends the events to Google Analytics (GA). Clients needs to instantiate this object with GoogleAnalyticsConfig and DefaultRequest. Configuration contains sensible defaults so one could just initialize using one of the convenience constructors. This object is ThreadSafe and it is intended that clients create one instance of this for each GA Tracker Id and reuse each time an event needs to be posted. This object contains resources which needs to be shutdown/disposed. So close() method is called to release all resources. Once close method is called, this instance cannot be reused so create new instance if required.

Field Summary

Fields

Modifier and Type	Field and Description
protected GoogleAnalyticsConfig	config
protected List<HttpRequest>	currentBatch
protected DefaultRequest	defaultRequest
protected HttpClient	httpClient
protected boolean	inSample
protected static org.slf4j.Logger	logger
protected GoogleAnalyticsStatsImpl	stats

Constructor Summary

Constructors

Constructor and Description
GoogleAnalyticsImpl(GoogleAnalyticsConfig config, DefaultRequest defaultRequest, HttpClient httpClient)

Method Summary

Modifier and Type	Method and Description
void	close()
EventHit	event()
ExceptionHit	exception()
void	flush()
protected void	gatherStats(GoogleAnalyticsRequest<?> request)
GoogleAnalyticsConfig	getConfig()
DefaultRequest	getDefaultRequest()
GoogleAnalyticsStats	getStats()
void	ifEnabled(Runnable runnable)
boolean	inSample()
ItemHit	item()
PageViewHit	pageView()
PageViewHit	pageView(String url, String title)
PageViewHit	pageView(String url, String title, String description)
boolean	performSamplingElection()
GoogleAnalyticsResponse	post(GoogleAnalyticsRequest<?> request)
java8.util.concurrent.CompletableFuture<GoogleAnalyticsResponse>	postAsync(GoogleAnalyticsRequest<?> gaReq)
protected GoogleAnalyticsResponse	postBatch(GoogleAnalyticsRequest<?> gaReq)
protected java8.util.concurrent.CompletableFuture<GoogleAnalyticsResponse>	postSingle(GoogleAnalyticsRequest<?> gaReq)
protected void	processCustomDimensionParameters(GoogleAnalyticsRequest<?> request, HttpRequest req) Processes the custom dimensions and adds the values to list of parameters, which would be posted to GA.
protected void	processCustomMetricParameters(GoogleAnalyticsRequest<?> request, HttpRequest req) Processes the custom metrics and adds the values to list of parameters, which would be posted to GA.
protected void	processParameters(GoogleAnalyticsRequest<?> request, HttpRequest req)
void	resetStats()
ScreenViewHit	screenView()
ScreenViewHit	screenView(String appName, String screenName)
SocialHit	social()
SocialHit	social(String socialNetwork, String socialAction, String socialTarget)
TimingHit	timing()
TransactionHit	transaction()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.brsanthu.googleanalytics.GoogleAnalytics

builder

Field Detail

logger

protected static final org.slf4j.Logger logger

config

protected final GoogleAnalyticsConfig config

defaultRequest

protected final DefaultRequest defaultRequest

httpClient

protected final HttpClient httpClient

inSample

protected boolean inSample

stats

protected GoogleAnalyticsStatsImpl stats

currentBatch

protected List<HttpRequest> currentBatch

Constructor Detail

GoogleAnalyticsImpl

public GoogleAnalyticsImpl(GoogleAnalyticsConfig config,
                           DefaultRequest defaultRequest,
                           HttpClient httpClient)

Method Detail

performSamplingElection

public boolean performSamplingElection()

Specified by:

performSamplingElection in interface GoogleAnalytics

inSample

public boolean inSample()

Specified by:

inSample in interface GoogleAnalytics

getConfig

public GoogleAnalyticsConfig getConfig()

Specified by:

getConfig in interface GoogleAnalytics

getDefaultRequest

public DefaultRequest getDefaultRequest()

post

public GoogleAnalyticsResponse post(GoogleAnalyticsRequest<?> request)

Specified by:

post in interface GoogleAnalyticsExecutor

postAsync

public java8.util.concurrent.CompletableFuture<GoogleAnalyticsResponse> postAsync(GoogleAnalyticsRequest<?> gaReq)

Specified by:

postAsync in interface GoogleAnalyticsExecutor

postBatch

protected GoogleAnalyticsResponse postBatch(GoogleAnalyticsRequest<?> gaReq)

postSingle

protected java8.util.concurrent.CompletableFuture<GoogleAnalyticsResponse> postSingle(GoogleAnalyticsRequest<?> gaReq)

processParameters

protected void processParameters(GoogleAnalyticsRequest<?> request,
                                 HttpRequest req)

processCustomDimensionParameters

protected void processCustomDimensionParameters(GoogleAnalyticsRequest<?> request,
                                                HttpRequest req)

Processes the custom dimensions and adds the values to list of parameters, which would be posted to GA.

Parameters:

request -

req -

processCustomMetricParameters

protected void processCustomMetricParameters(GoogleAnalyticsRequest<?> request,
                                             HttpRequest req)

Processes the custom metrics and adds the values to list of parameters, which would be posted to GA.

Parameters:

request -

req -

gatherStats

protected void gatherStats(GoogleAnalyticsRequest<?> request)

close

public void close()

Specified by:

close in interface AutoCloseable

getStats

public GoogleAnalyticsStats getStats()

Specified by:

getStats in interface GoogleAnalytics

resetStats

public void resetStats()

Specified by:

resetStats in interface GoogleAnalytics

event

public EventHit event()

Specified by:

event in interface GoogleAnalytics

exception

public ExceptionHit exception()

Specified by:

exception in interface GoogleAnalytics

item

public ItemHit item()

Specified by:

item in interface GoogleAnalytics

pageView

public PageViewHit pageView()

Specified by:

pageView in interface GoogleAnalytics

pageView

public PageViewHit pageView(String url,
                            String title)

Specified by:

pageView in interface GoogleAnalytics

pageView

public PageViewHit pageView(String url,
                            String title,
                            String description)

Specified by:

pageView in interface GoogleAnalytics

screenView

public ScreenViewHit screenView()

Specified by:

screenView in interface GoogleAnalytics

screenView

public ScreenViewHit screenView(String appName,
                                String screenName)

Specified by:

screenView in interface GoogleAnalytics

social

public SocialHit social()

Specified by:

social in interface GoogleAnalytics

social

public SocialHit social(String socialNetwork,
                        String socialAction,
                        String socialTarget)

Specified by:

social in interface GoogleAnalytics

timing

public TimingHit timing()

Specified by:

timing in interface GoogleAnalytics

transaction

public TransactionHit transaction()

Specified by:

transaction in interface GoogleAnalytics

ifEnabled

public void ifEnabled(Runnable runnable)

Specified by:

ifEnabled in interface GoogleAnalytics

flush

public void flush()

Specified by:

flush in interface GoogleAnalytics