Package org.opencastproject.workflow.handler.workflow

Class SeriesWorkflowOperationHandler

  • All Implemented Interfaces:
    org.opencastproject.workflow.api.WorkflowOperationHandler
    public class SeriesWorkflowOperationHandler
extends org.opencastproject.workflow.api.AbstractWorkflowOperationHandler
    The workflow definition for handling "series" operations

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

        org.opencastproject.workflow.api.AbstractWorkflowOperationHandler.Configuration

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String APPLY_ACL_PROPERTY
      Name of the configuration option that provides whether the ACL should be applied or not
      static String ATTACH_PROPERTY
      Name of the configuration option that provides the flavors of the series catalogs to attach
      static String COPY_METADATA_PROPERTY
      Name of the configuration key that specifies the list of series metadata to be copied to the episode
      static String DEFAULT_NS_PROPERTY
      Name of the configuration key that specifies the default namespace for the metadata to be copied to the episode
      static String SERIES_PROPERTY
      Name of the configuration option that provides the optional series identifier

      • Fields inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

        asList, description, id, serviceRegistry

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addCatalogUIAdapter​(org.opencastproject.metadata.dublincore.SeriesCatalogUIAdapter catalogUIAdapter)
      OSGi callback to add SeriesCatalogUIAdapter instance.
      void removeCatalogUIAdapter​(org.opencastproject.metadata.dublincore.SeriesCatalogUIAdapter catalogUIAdapter)
      OSGi callback to remove SeriesCatalogUIAdapter instance.
      protected void setAuthorizationService​(org.opencastproject.security.api.AuthorizationService authorizationService)
      Callback for the OSGi declarative services configuration.
      void setSecurityService​(org.opencastproject.security.api.SecurityService securityService)
      Callback for the OSGi declarative services configuration.
      void setSeriesService​(org.opencastproject.series.api.SeriesService seriesService)
      Callback for the OSGi declarative services configuration.
      void setWorkspace​(org.opencastproject.workspace.api.Workspace workspace)
      Callback for the OSGi declarative services configuration.
      org.opencastproject.workflow.api.WorkflowOperationResult start​(org.opencastproject.workflow.api.WorkflowInstance workflowInstance, org.opencastproject.job.api.JobContext context)

      • Methods inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

        activate, asList, cfgKeyMissing, createResult, createResult, createResult, createResult, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, setServiceRegistry, skip, toString, waitForStatus, waitForStatus

    • Field Detail

      • SERIES_PROPERTY

        public static final String SERIES_PROPERTY
        Name of the configuration option that provides the optional series identifier
        See Also:
        Constant Field Values

      • ATTACH_PROPERTY

        public static final String ATTACH_PROPERTY
        Name of the configuration option that provides the flavors of the series catalogs to attach
        See Also:
        Constant Field Values

      • APPLY_ACL_PROPERTY

        public static final String APPLY_ACL_PROPERTY
        Name of the configuration option that provides whether the ACL should be applied or not
        See Also:
        Constant Field Values

      • COPY_METADATA_PROPERTY

        public static final String COPY_METADATA_PROPERTY
        Name of the configuration key that specifies the list of series metadata to be copied to the episode
        See Also:
        Constant Field Values

      • DEFAULT_NS_PROPERTY

        public static final String DEFAULT_NS_PROPERTY
        Name of the configuration key that specifies the default namespace for the metadata to be copied to the episode
        See Also:
        Constant Field Values

    • Constructor Detail

      • SeriesWorkflowOperationHandler

        public SeriesWorkflowOperationHandler()

    • Method Detail

      • setAuthorizationService

        protected void setAuthorizationService​(org.opencastproject.security.api.AuthorizationService authorizationService)
        Callback for the OSGi declarative services configuration.
        Parameters:
        authorizationService - the authorization service

      • setSeriesService

        public void setSeriesService​(org.opencastproject.series.api.SeriesService seriesService)
        Callback for the OSGi declarative services configuration.
        Parameters:
        seriesService - the series service

      • setWorkspace

        public void setWorkspace​(org.opencastproject.workspace.api.Workspace workspace)
        Callback for the OSGi declarative services configuration.
        Parameters:
        workspace - the workspace

      • setSecurityService

        public void setSecurityService​(org.opencastproject.security.api.SecurityService securityService)
        Callback for the OSGi declarative services configuration.
        Parameters:
        securityService - the securityService

      • addCatalogUIAdapter

        public void addCatalogUIAdapter​(org.opencastproject.metadata.dublincore.SeriesCatalogUIAdapter catalogUIAdapter)
        OSGi callback to add SeriesCatalogUIAdapter instance.

      • removeCatalogUIAdapter

        public void removeCatalogUIAdapter​(org.opencastproject.metadata.dublincore.SeriesCatalogUIAdapter catalogUIAdapter)
        OSGi callback to remove SeriesCatalogUIAdapter instance.

      • start

        public org.opencastproject.workflow.api.WorkflowOperationResult start​(org.opencastproject.workflow.api.WorkflowInstance workflowInstance,
                                                                      org.opencastproject.job.api.JobContext context)
                                                               throws org.opencastproject.workflow.api.WorkflowOperationException
        Specified by:
        start in interface org.opencastproject.workflow.api.WorkflowOperationHandler
        Specified by:
        start in class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler
        Throws:
        org.opencastproject.workflow.api.WorkflowOperationException
        See Also:
        WorkflowOperationHandler.start(org.opencastproject.workflow.api.WorkflowInstance, JobContext)