com.kaltura.client.services.KalturaAppTokenService 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;
import com.kaltura.client.enums.*;

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

/**  Manage application authentication tokens    */
@SuppressWarnings("serial")
public class KalturaAppTokenService extends KalturaServiceBase {
    public KalturaAppTokenService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Add new application authentication token     */
    public KalturaAppToken add(KalturaAppToken appToken) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("appToken", appToken);
        this.kalturaClient.queueServiceCall("apptoken", "add", kparams, KalturaAppToken.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaAppToken.class, resultXmlElement);
    }

	/**  Get application authentication token by id     */
    public KalturaAppToken get(String id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("apptoken", "get", kparams, KalturaAppToken.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaAppToken.class, resultXmlElement);
    }

	/**  Update application authentication token by id     */
    public KalturaAppToken update(String id, KalturaAppToken appToken) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("appToken", appToken);
        this.kalturaClient.queueServiceCall("apptoken", "update", kparams, KalturaAppToken.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaAppToken.class, resultXmlElement);
    }

	/**  Delete application authentication token by id     */
    public void delete(String id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("apptoken", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

    public KalturaAppTokenListResponse list() throws KalturaApiException {
        return this.list(null);
    }

    public KalturaAppTokenListResponse list(KalturaAppTokenFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List application authentication tokens by filter and pager     */
    public KalturaAppTokenListResponse list(KalturaAppTokenFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("apptoken", "list", kparams, KalturaAppTokenListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaAppTokenListResponse.class, resultXmlElement);
    }

    public KalturaSessionInfo startSession(String id, String tokenHash) throws KalturaApiException {
        return this.startSession(id, tokenHash, null);
    }

    public KalturaSessionInfo startSession(String id, String tokenHash, String userId) throws KalturaApiException {
        return this.startSession(id, tokenHash, userId, KalturaSessionType.get(Integer.MIN_VALUE));
    }

    public KalturaSessionInfo startSession(String id, String tokenHash, String userId, KalturaSessionType type) throws KalturaApiException {
        return this.startSession(id, tokenHash, userId, type, Integer.MIN_VALUE);
    }

	/**  Starts a new KS (kaltura Session) based on application authentication token id  
	    */
    public KalturaSessionInfo startSession(String id, String tokenHash, String userId, KalturaSessionType type, int expiry) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("tokenHash", tokenHash);
        kparams.add("userId", userId);
        kparams.add("type", type);
        kparams.add("expiry", expiry);
        this.kalturaClient.queueServiceCall("apptoken", "startSession", kparams, KalturaSessionInfo.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaSessionInfo.class, resultXmlElement);
    }
}