mobile/android/base/java/org/mozilla/gecko/telemetry/TelemetryPing.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.gecko.telemetry;

import org.mozilla.gecko.sync.ExtendedJSONObject;

/**
 * Container for telemetry data and the data necessary to upload it.
 *
 * The doc ID is used by a Store to manipulate its internal pings and should
 * be the same value found in the urlPath.
 *
 * If you want to create one of these, consider extending
 * {@link org.mozilla.gecko.telemetry.pingbuilders.TelemetryPingBuilder}
 * or one of its descendants.
 */
public class TelemetryPing {
    private final String urlPath;
    private final ExtendedJSONObject payload;
    private final String docID;

    public TelemetryPing(final String urlPath, final ExtendedJSONObject payload, final String docID) {
        this.urlPath = urlPath;
        this.payload = payload;
        this.docID = docID;
    }

    public String getURLPath() { return urlPath; }
    public ExtendedJSONObject getPayload() { return payload; }
    public String getDocID() { return docID; }
}