com.kaltura.client.services.KalturaSearchService 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.
 */

/**  Search service allows you to search for media in various media providers  This
  service is being used mostly by the CW component    */
@SuppressWarnings("serial")
public class KalturaSearchService extends KalturaServiceBase {
    public KalturaSearchService(KalturaClient client) {
        this.kalturaClient = client;
    }

    public KalturaSearchResultResponse search(KalturaSearch search) throws KalturaApiException {
        return this.search(search, null);
    }

	/**  Search for media in one of the supported media providers     */
    public KalturaSearchResultResponse search(KalturaSearch search, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("search", search);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("search", "search", kparams, KalturaSearchResultResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaSearchResultResponse.class, resultXmlElement);
    }

	/**  Retrieve extra information about media found in search action   Some providers
	  return only part of the fields needed to create entry from, use this action to
	  get the rest of the fields.     */
    public KalturaSearchResult getMediaInfo(KalturaSearchResult searchResult) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("searchResult", searchResult);
        this.kalturaClient.queueServiceCall("search", "getMediaInfo", kparams, KalturaSearchResult.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaSearchResult.class, resultXmlElement);
    }

	/**  Search for media given a specific URL   Kaltura supports a searchURL action on
	  some of the media providers.   This action will return a KalturaSearchResult
	  object based on a given URL (assuming the media provider is supported)     */
    public KalturaSearchResult searchUrl(KalturaMediaType mediaType, String url) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("mediaType", mediaType);
        kparams.add("url", url);
        this.kalturaClient.queueServiceCall("search", "searchUrl", kparams, KalturaSearchResult.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaSearchResult.class, resultXmlElement);
    }

    public KalturaSearchAuthData externalLogin(KalturaSearchProviderType searchSource, String userName, String password) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("searchSource", searchSource);
        kparams.add("userName", userName);
        kparams.add("password", password);
        this.kalturaClient.queueServiceCall("search", "externalLogin", kparams, KalturaSearchAuthData.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaSearchAuthData.class, resultXmlElement);
    }
}