com.kaltura.client.services.KalturaDocumentsService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaClient Show documentation
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 java.util.ArrayList;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import com.kaltura.client.KalturaFiles;
import com.kaltura.client.KalturaFile;
/**
* This class was generated using generate.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
/** Document service lets you upload and manage document files */
@SuppressWarnings("serial")
public class KalturaDocumentsService extends KalturaServiceBase {
public KalturaDocumentsService(KalturaClient client) {
this.kalturaClient = client;
}
/** Add new document entry after the specific document file was uploaded and the
upload token id exists */
public KalturaDocumentEntry addFromUploadedFile(KalturaDocumentEntry documentEntry, String uploadTokenId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("documentEntry", documentEntry);
kparams.add("uploadTokenId", uploadTokenId);
this.kalturaClient.queueServiceCall("document_documents", "addFromUploadedFile", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
public KalturaDocumentEntry addFromEntry(String sourceEntryId) throws KalturaApiException {
return this.addFromEntry(sourceEntryId, null);
}
public KalturaDocumentEntry addFromEntry(String sourceEntryId, KalturaDocumentEntry documentEntry) throws KalturaApiException {
return this.addFromEntry(sourceEntryId, documentEntry, Integer.MIN_VALUE);
}
/** Copy entry into new entry */
public KalturaDocumentEntry addFromEntry(String sourceEntryId, KalturaDocumentEntry documentEntry, int sourceFlavorParamsId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("sourceEntryId", sourceEntryId);
kparams.add("documentEntry", documentEntry);
kparams.add("sourceFlavorParamsId", sourceFlavorParamsId);
this.kalturaClient.queueServiceCall("document_documents", "addFromEntry", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
public KalturaDocumentEntry addFromFlavorAsset(String sourceFlavorAssetId) throws KalturaApiException {
return this.addFromFlavorAsset(sourceFlavorAssetId, null);
}
/** Copy flavor asset into new entry */
public KalturaDocumentEntry addFromFlavorAsset(String sourceFlavorAssetId, KalturaDocumentEntry documentEntry) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("sourceFlavorAssetId", sourceFlavorAssetId);
kparams.add("documentEntry", documentEntry);
this.kalturaClient.queueServiceCall("document_documents", "addFromFlavorAsset", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
public long convert(String entryId) throws KalturaApiException {
return this.convert(entryId, Integer.MIN_VALUE);
}
public long convert(String entryId, int conversionProfileId) throws KalturaApiException {
return this.convert(entryId, conversionProfileId, null);
}
/** Convert entry */
public long convert(String entryId, int conversionProfileId, ArrayList dynamicConversionAttributes) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("conversionProfileId", conversionProfileId);
kparams.add("dynamicConversionAttributes", dynamicConversionAttributes);
this.kalturaClient.queueServiceCall("document_documents", "convert", kparams);
if (this.kalturaClient.isMultiRequest())
return 0;
Element resultXmlElement = this.kalturaClient.doQueue();
String resultText = resultXmlElement.getTextContent();
return ParseUtils.parseBigint(resultText);
}
public KalturaDocumentEntry get(String entryId) throws KalturaApiException {
return this.get(entryId, -1);
}
/** Get document entry by ID. */
public KalturaDocumentEntry get(String entryId, int version) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("version", version);
this.kalturaClient.queueServiceCall("document_documents", "get", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
/** Update document entry. Only the properties that were set will be updated. */
public KalturaDocumentEntry update(String entryId, KalturaDocumentEntry documentEntry) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("documentEntry", documentEntry);
this.kalturaClient.queueServiceCall("document_documents", "update", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
/** Delete a document entry. */
public void delete(String entryId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
this.kalturaClient.queueServiceCall("document_documents", "delete", kparams);
if (this.kalturaClient.isMultiRequest())
return ;
this.kalturaClient.doQueue();
}
public KalturaDocumentListResponse list() throws KalturaApiException {
return this.list(null);
}
public KalturaDocumentListResponse list(KalturaDocumentEntryFilter filter) throws KalturaApiException {
return this.list(filter, null);
}
/** List document entries by filter with paging support. */
public KalturaDocumentListResponse list(KalturaDocumentEntryFilter filter, KalturaFilterPager pager) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("filter", filter);
kparams.add("pager", pager);
this.kalturaClient.queueServiceCall("document_documents", "list", kparams, KalturaDocumentListResponse.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentListResponse.class, resultXmlElement);
}
public String upload(File fileData) throws KalturaApiException {
return this.upload(new KalturaFile(fileData));
}
public String upload(InputStream fileData, String fileDataName, long fileDataSize) throws KalturaApiException {
return this.upload(new KalturaFile(fileData, fileDataName, fileDataSize));
}
public String upload(FileInputStream fileData, String fileDataName) throws KalturaApiException {
return this.upload(new KalturaFile(fileData, fileDataName));
}
/** Upload a document file to Kaltura, then the file can be used to create a
document entry. */
public String upload(KalturaFile fileData) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
KalturaFiles kfiles = new KalturaFiles();
kfiles.add("fileData", fileData);
this.kalturaClient.queueServiceCall("document_documents", "upload", kparams, kfiles);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
String resultText = resultXmlElement.getTextContent();
return ParseUtils.parseString(resultText);
}
/** This will queue a batch job for converting the document file to swf Returns
the URL where the new swf will be available */
public String convertPptToSwf(String entryId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
this.kalturaClient.queueServiceCall("document_documents", "convertPptToSwf", kparams);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
String resultText = resultXmlElement.getTextContent();
return ParseUtils.parseString(resultText);
}
public String serve(String entryId) throws KalturaApiException {
return this.serve(entryId, null);
}
public String serve(String entryId, String flavorAssetId) throws KalturaApiException {
return this.serve(entryId, flavorAssetId, false);
}
/** Serves the file content */
public String serve(String entryId, String flavorAssetId, boolean forceProxy) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("flavorAssetId", flavorAssetId);
kparams.add("forceProxy", forceProxy);
this.kalturaClient.queueServiceCall("document_documents", "serve", kparams);
return this.kalturaClient.serve();
}
public String serveByFlavorParamsId(String entryId) throws KalturaApiException {
return this.serveByFlavorParamsId(entryId, null);
}
public String serveByFlavorParamsId(String entryId, String flavorParamsId) throws KalturaApiException {
return this.serveByFlavorParamsId(entryId, flavorParamsId, false);
}
/** Serves the file content */
public String serveByFlavorParamsId(String entryId, String flavorParamsId, boolean forceProxy) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("flavorParamsId", flavorParamsId);
kparams.add("forceProxy", forceProxy);
this.kalturaClient.queueServiceCall("document_documents", "serveByFlavorParamsId", kparams);
return this.kalturaClient.serve();
}
public KalturaDocumentEntry updateContent(String entryId, KalturaResource resource) throws KalturaApiException {
return this.updateContent(entryId, resource, Integer.MIN_VALUE);
}
/** Replace content associated with the given document entry. */
public KalturaDocumentEntry updateContent(String entryId, KalturaResource resource, int conversionProfileId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
kparams.add("resource", resource);
kparams.add("conversionProfileId", conversionProfileId);
this.kalturaClient.queueServiceCall("document_documents", "updateContent", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
/** Approves document replacement */
public KalturaDocumentEntry approveReplace(String entryId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
this.kalturaClient.queueServiceCall("document_documents", "approveReplace", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
/** Cancels document replacement */
public KalturaDocumentEntry cancelReplace(String entryId) throws KalturaApiException {
KalturaParams kparams = new KalturaParams();
kparams.add("entryId", entryId);
this.kalturaClient.queueServiceCall("document_documents", "cancelReplace", kparams, KalturaDocumentEntry.class);
if (this.kalturaClient.isMultiRequest())
return null;
Element resultXmlElement = this.kalturaClient.doQueue();
return ParseUtils.parseObject(KalturaDocumentEntry.class, resultXmlElement);
}
}