Package org.opencastproject.metadata.api

Interface MetadataService<A>

Type Parameters:
A - the type of metadata provided
All Known Subinterfaces:
MediaPackageMetadataService, StaticMetadataService
public interface MetadataService<A>
Generic interface for metadata providing services.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PRIORITY_KEY
    The static constant used when configuring the priority

  • Method Summary

    Modifier and Type
    Method
    Description
    A
    getMetadata(org.opencastproject.mediapackage.MediaPackage mediaPackage)
    Gets the metadata for a MediaPackage if possible.
    int
    getPriority()
    The priority of this MetadataService compared to others when more than one is registered in the system.

  • Field Details

    • PRIORITY_KEY

      static final String PRIORITY_KEY
      The static constant used when configuring the priority
      See Also:

  • Method Details

    • getPriority

      int getPriority()
      The priority of this MetadataService compared to others when more than one is registered in the system. When more than one MetadataService is registered, the getMetadata(MediaPackage) method may be called on each service in order of priority. Metadata objects returned by higher priority MetadataServices should override those returned by lower priority services. The lowest number is the highest priority (i.e. 1 is a higher priority than 2).
      Returns:
      The priority

    • getMetadata

      A getMetadata(org.opencastproject.mediapackage.MediaPackage mediaPackage)
      Gets the metadata for a MediaPackage if possible. If no metadata can be extracted from the catalogs in the MediaPackage, this returns null;
      Parameters:
      mediaPackage - The mediapackage to inspect for catalogs
      Returns:
      The metadata extracted from the media package