Package com.kaltura.client.services

Class MetadataService

java.lang.Object

com.kaltura.client.services.MetadataService

public class MetadataService
extends Object

Metadata service

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataService.AddFromBulkMetadataBuilder
static class	MetadataService.AddFromFileMetadataBuilder
static class	MetadataService.AddFromUrlMetadataBuilder
static class	MetadataService.AddMetadataBuilder
static class	MetadataService.DeleteMetadataBuilder
static class	MetadataService.GetMetadataBuilder
static class	MetadataService.IndexMetadataBuilder
static class	MetadataService.InvalidateMetadataBuilder
static class	MetadataService.ListMetadataBuilder
static class	MetadataService.ServeMetadataBuilder
static class	MetadataService.UpdateFromFileMetadataBuilder
static class	MetadataService.UpdateFromXSLMetadataBuilder
static class	MetadataService.UpdateMetadataBuilder

Constructor Summary

Constructors

Constructor	Description
MetadataService()

Method Summary

Modifier and Type	Method	Description
static MetadataService.AddMetadataBuilder	add(int metadataProfileId, MetadataObjectType objectType, String objectId, String xmlData)	Allows you to add a metadata object and metadata content associated with Kaltura object
static MetadataService.AddFromBulkMetadataBuilder	addFromBulk(int metadataProfileId, MetadataObjectType objectType, String objectId, String url)	Allows you to add a metadata XML data from remote URL.
static MetadataService.AddFromFileMetadataBuilder	addFromFile(int metadataProfileId, MetadataObjectType objectType, String objectId, FileHolder xmlFile)	Allows you to add a metadata object and metadata file associated with Kaltura object
static MetadataService.AddFromFileMetadataBuilder	addFromFile(int metadataProfileId, MetadataObjectType objectType, String objectId, File xmlFile)
static MetadataService.AddFromFileMetadataBuilder	addFromFile(int metadataProfileId, MetadataObjectType objectType, String objectId, FileInputStream xmlFile, String xmlFileMimeType, String xmlFileName)
static MetadataService.AddFromFileMetadataBuilder	addFromFile(int metadataProfileId, MetadataObjectType objectType, String objectId, InputStream xmlFile, String xmlFileMimeType, String xmlFileName, long xmlFileSize)
static MetadataService.AddFromUrlMetadataBuilder	addFromUrl(int metadataProfileId, MetadataObjectType objectType, String objectId, String url)	Allows you to add a metadata XML data from remote URL
static MetadataService.DeleteMetadataBuilder	delete(int id)	Delete an existing metadata
static MetadataService.GetMetadataBuilder	get(int id)	Retrieve a metadata object by id
static MetadataService.IndexMetadataBuilder	index(String id, boolean shouldUpdate)	Index metadata by id, will also index the related object
static MetadataService.InvalidateMetadataBuilder	invalidate(int id)
static MetadataService.InvalidateMetadataBuilder	invalidate(int id, int version)	Mark existing metadata as invalid Used by batch metadata transform
static MetadataService.ListMetadataBuilder	list()
static MetadataService.ListMetadataBuilder	list(MetadataFilter filter)
static MetadataService.ListMetadataBuilder	list(MetadataFilter filter, FilterPager pager)	List metadata objects by filter and pager
static MetadataService.ServeMetadataBuilder	serve(int id)	Serves metadata XML file
static MetadataService.UpdateMetadataBuilder	update(int id)
static MetadataService.UpdateMetadataBuilder	update(int id, String xmlData)
static MetadataService.UpdateMetadataBuilder	update(int id, String xmlData, int version)	Update an existing metadata object with new XML content
static MetadataService.UpdateFromFileMetadataBuilder	updateFromFile(int id)
static MetadataService.UpdateFromFileMetadataBuilder	updateFromFile(int id, FileHolder xmlFile)	Update an existing metadata object with new XML file
static MetadataService.UpdateFromFileMetadataBuilder	updateFromFile(int id, File xmlFile)
static MetadataService.UpdateFromFileMetadataBuilder	updateFromFile(int id, FileInputStream xmlFile, String xmlFileMimeType, String xmlFileName)
static MetadataService.UpdateFromFileMetadataBuilder	updateFromFile(int id, InputStream xmlFile, String xmlFileMimeType, String xmlFileName, long xmlFileSize)
static MetadataService.UpdateFromXSLMetadataBuilder	updateFromXSL(int id, FileHolder xslFile)	Action transforms current metadata object XML using a provided XSL.
static MetadataService.UpdateFromXSLMetadataBuilder	updateFromXSL(int id, File xslFile)
static MetadataService.UpdateFromXSLMetadataBuilder	updateFromXSL(int id, FileInputStream xslFile, String xslFileMimeType, String xslFileName)
static MetadataService.UpdateFromXSLMetadataBuilder	updateFromXSL(int id, InputStream xslFile, String xslFileMimeType, String xslFileName, long xslFileSize)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataService

public MetadataService()

Method Detail

add

public static MetadataService.AddMetadataBuilder add(int metadataProfileId,
                                                     MetadataObjectType objectType,
                                                     String objectId,
                                                     String xmlData)

Allows you to add a metadata object and metadata content associated with Kaltura object

Parameters:

metadataProfileId -

objectType -

objectId -

xmlData - XML metadata

addFromBulk

public static MetadataService.AddFromBulkMetadataBuilder addFromBulk(int metadataProfileId,
                                                                     MetadataObjectType objectType,
                                                                     String objectId,
                                                                     String url)

Allows you to add a metadata XML data from remote URL. Enables different permissions than addFromUrl action.

Parameters:

metadataProfileId -

objectType -

objectId -

url - XML metadata remote URL

addFromFile

public static MetadataService.AddFromFileMetadataBuilder addFromFile(int metadataProfileId,
                                                                     MetadataObjectType objectType,
                                                                     String objectId,
                                                                     File xmlFile)

addFromFile

public static MetadataService.AddFromFileMetadataBuilder addFromFile(int metadataProfileId,
                                                                     MetadataObjectType objectType,
                                                                     String objectId,
                                                                     InputStream xmlFile,
                                                                     String xmlFileMimeType,
                                                                     String xmlFileName,
                                                                     long xmlFileSize)

addFromFile

public static MetadataService.AddFromFileMetadataBuilder addFromFile(int metadataProfileId,
                                                                     MetadataObjectType objectType,
                                                                     String objectId,
                                                                     FileInputStream xmlFile,
                                                                     String xmlFileMimeType,
                                                                     String xmlFileName)

addFromFile

public static MetadataService.AddFromFileMetadataBuilder addFromFile(int metadataProfileId,
                                                                     MetadataObjectType objectType,
                                                                     String objectId,
                                                                     FileHolder xmlFile)

Allows you to add a metadata object and metadata file associated with Kaltura object

Parameters:

metadataProfileId -

objectType -

objectId -

xmlFile - XML metadata

addFromUrl

public static MetadataService.AddFromUrlMetadataBuilder addFromUrl(int metadataProfileId,
                                                                   MetadataObjectType objectType,
                                                                   String objectId,
                                                                   String url)

Allows you to add a metadata XML data from remote URL

Parameters:

metadataProfileId -

objectType -

objectId -

url - XML metadata remote URL

delete

public static MetadataService.DeleteMetadataBuilder delete(int id)

Delete an existing metadata

Parameters:

id -

get

public static MetadataService.GetMetadataBuilder get(int id)

Retrieve a metadata object by id

Parameters:

id -

index

public static MetadataService.IndexMetadataBuilder index(String id,
                                                         boolean shouldUpdate)

Index metadata by id, will also index the related object

Parameters:

id -

shouldUpdate -

invalidate

public static MetadataService.InvalidateMetadataBuilder invalidate(int id)

invalidate

public static MetadataService.InvalidateMetadataBuilder invalidate(int id,
                                                                   int version)

Mark existing metadata as invalid Used by batch metadata transform

Parameters:

id -

version - Enable update only if the metadata object version did not change by other process

list

public static MetadataService.ListMetadataBuilder list()

list

public static MetadataService.ListMetadataBuilder list(MetadataFilter filter)

list

public static MetadataService.ListMetadataBuilder list(MetadataFilter filter,
                                                       FilterPager pager)

List metadata objects by filter and pager

Parameters:

filter -

pager -

serve

public static MetadataService.ServeMetadataBuilder serve(int id)

Serves metadata XML file

Parameters:

id -

update

public static MetadataService.UpdateMetadataBuilder update(int id)

update

public static MetadataService.UpdateMetadataBuilder update(int id,
                                                           String xmlData)

update

public static MetadataService.UpdateMetadataBuilder update(int id,
                                                           String xmlData,
                                                           int version)

Update an existing metadata object with new XML content

Parameters:

id -

xmlData - XML metadata

version - Enable update only if the metadata object version did not change by other process

updateFromFile

public static MetadataService.UpdateFromFileMetadataBuilder updateFromFile(int id)

updateFromFile

public static MetadataService.UpdateFromFileMetadataBuilder updateFromFile(int id,
                                                                           File xmlFile)

updateFromFile

public static MetadataService.UpdateFromFileMetadataBuilder updateFromFile(int id,
                                                                           InputStream xmlFile,
                                                                           String xmlFileMimeType,
                                                                           String xmlFileName,
                                                                           long xmlFileSize)

updateFromFile

public static MetadataService.UpdateFromFileMetadataBuilder updateFromFile(int id,
                                                                           FileInputStream xmlFile,
                                                                           String xmlFileMimeType,
                                                                           String xmlFileName)

updateFromFile

public static MetadataService.UpdateFromFileMetadataBuilder updateFromFile(int id,
                                                                           FileHolder xmlFile)

Update an existing metadata object with new XML file

Parameters:

id -

xmlFile - XML metadata

updateFromXSL

public static MetadataService.UpdateFromXSLMetadataBuilder updateFromXSL(int id,
                                                                         File xslFile)

updateFromXSL

public static MetadataService.UpdateFromXSLMetadataBuilder updateFromXSL(int id,
                                                                         InputStream xslFile,
                                                                         String xslFileMimeType,
                                                                         String xslFileName,
                                                                         long xslFileSize)

updateFromXSL

public static MetadataService.UpdateFromXSLMetadataBuilder updateFromXSL(int id,
                                                                         FileInputStream xslFile,
                                                                         String xslFileMimeType,
                                                                         String xslFileName)

updateFromXSL

public static MetadataService.UpdateFromXSLMetadataBuilder updateFromXSL(int id,
                                                                         FileHolder xslFile)

Action transforms current metadata object XML using a provided XSL.

Parameters:

id -

xslFile -