org.piwik.java.tracking

Class PiwikTracker

java.lang.Object

org.piwik.java.tracking.PiwikTracker

public class PiwikTracker
extends Object

A class that sends PiwikRequests to a specified Piwik server.

Author:

brettcsorba

Constructor Summary

Constructors

Constructor and Description
PiwikTracker(String hostUrl) Creates a tracker that will send PiwikRequests to the specified Tracking HTTP API endpoint.
PiwikTracker(String hostUrl, String proxyHost, int proxyPort) Creates a tracker that will send PiwikRequests to the specified Tracking HTTP API endpoint via the provided proxy

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.HttpClient	getHttpClient() Get a HTTP client.
org.apache.http.HttpResponse	sendBulkRequest(Iterable<PiwikRequest> requests) Send multiple requests in a single HTTP call.
org.apache.http.HttpResponse	sendBulkRequest(Iterable<PiwikRequest> requests, String authToken) Send multiple requests in a single HTTP call.
org.apache.http.HttpResponse	sendRequest(PiwikRequest request) Send a request.

Methods inherited from class java.lang.Object

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

Constructor Detail

PiwikTracker

public PiwikTracker(String hostUrl)

Creates a tracker that will send PiwikRequests to the specified Tracking HTTP API endpoint.

Parameters:

hostUrl - url endpoint to send requests to. Usually in the format http://your-piwik-domain.tld/piwik.php.

PiwikTracker

public PiwikTracker(String hostUrl,
                    String proxyHost,
                    int proxyPort)

Creates a tracker that will send PiwikRequests to the specified Tracking HTTP API endpoint via the provided proxy

Parameters:

hostUrl - url endpoint to send requests to. Usually in the format http://your-piwik-domain.tld/piwik.php.

proxyHost - url endpoint for the proxy

proxyPort - proxy server port number

Method Detail

sendRequest

public org.apache.http.HttpResponse sendRequest(PiwikRequest request)
                                         throws IOException

Send a request.

Parameters:

request - request to send

Returns:

the response from this request

Throws:

IOException - thrown if there was a problem with this connection

sendBulkRequest

public org.apache.http.HttpResponse sendBulkRequest(Iterable<PiwikRequest> requests)
                                             throws IOException

Send multiple requests in a single HTTP call. More efficient than sending several individual requests.

Parameters:

requests - the requests to send

Returns:

the response from these requests

Throws:

IOException - thrown if there was a problem with this connection

sendBulkRequest

public org.apache.http.HttpResponse sendBulkRequest(Iterable<PiwikRequest> requests,
                                                    String authToken)
                                             throws IOException

Send multiple requests in a single HTTP call. More efficient than sending several individual requests. Specify the AuthToken if parameters that require an auth token is used.

Parameters:

requests - the requests to send

authToken - specify if any of the parameters use require AuthToken

Returns:

the response from these requests

Throws:

IOException - thrown if there was a problem with this connection

getHttpClient

protected org.apache.http.client.HttpClient getHttpClient()

Get a HTTP client. With proxy if a proxy is provided in the constructor.

Returns:

a HTTP client