com.kaltura.client.services.KalturaStatsService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kalturaClient Show documentation

KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php

The newest version!

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.KalturaClient;
import com.kaltura.client.KalturaServiceBase;
import com.kaltura.client.types.*;
import org.w3c.dom.Element;
import com.kaltura.client.utils.ParseUtils;
import com.kaltura.client.KalturaParams;
import com.kaltura.client.KalturaApiException;

/**
 * This class was generated using generate.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

/**  Stats Service    */
@SuppressWarnings("serial")
public class KalturaStatsService extends KalturaServiceBase {
    public KalturaStatsService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Will write to the event log a single line representing the event   client
	  version - will help interprete the line structure. different client versions
	  might have slightly different data/data formats in the line event_id - number is
	  the row number in yuval's excel datetime - same format as MySql's datetime - can
	  change and should reflect the time zone session id - can be some big random
	  number or guid partner id entry id unique viewer widget id ui_conf id uid - the
	  puser id as set by the ppartner current point - in milliseconds duration -
	  milliseconds user ip process duration - in milliseconds control id seek new
	  point referrer       KalturaStatsEvent $event     */
    public boolean collect(KalturaStatsEvent event) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("event", event);
        this.kalturaClient.queueServiceCall("stats", "collect", kparams);
        if (this.kalturaClient.isMultiRequest())
            return false;
        Element resultXmlElement = this.kalturaClient.doQueue();
        String resultText = resultXmlElement.getTextContent();
        return ParseUtils.parseBool(resultText);
    }

	/**  Will collect the kmcEvent sent form the KMC client   // this will actually be an
	  empty function because all events will be sent using GET and will anyway be
	  logged in the apache log     */
    public void kmcCollect(KalturaStatsKmcEvent kmcEvent) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("kmcEvent", kmcEvent);
        this.kalturaClient.queueServiceCall("stats", "kmcCollect", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

    public KalturaCEError reportKceError(KalturaCEError kalturaCEError) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("kalturaCEError", kalturaCEError);
        this.kalturaClient.queueServiceCall("stats", "reportKceError", kparams, KalturaCEError.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaCEError.class, resultXmlElement);
    }

	/**  Use this action to report errors to the kaltura server.     */
    public void reportError(String errorCode, String errorMessage) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("errorCode", errorCode);
        kparams.add("errorMessage", errorMessage);
        this.kalturaClient.queueServiceCall("stats", "reportError", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }
}