Package org.opencastproject.ingest.scanner

Class InboxScannerService

java.lang.Object

org.opencastproject.ingest.scanner.InboxScannerService

All Implemented Interfaces:

org.apache.felix.fileinstall.ArtifactInstaller, org.apache.felix.fileinstall.ArtifactListener, org.osgi.service.cm.ManagedService

public class InboxScannerService
extends Object
implements org.apache.felix.fileinstall.ArtifactInstaller, org.osgi.service.cm.ManagedService

The inbox scanner monitors a directory for incoming media packages.

There is one InboxScanner instance per inbox. Each instance is configured by a config file in .../etc/load named <inbox-scanned-pid>-<name>.cfg where name can be arbitrarily chosen and has no further meaning. inbox-scanned-pid must confirm to the PID given to the InboxScanner in the declarative service (DS) configuration OSGI-INF/inbox-scanner-service.xml.

Implementation notes

Monitoring leverages Apache FileInstall by implementing ArtifactInstaller.

See Also:

• Ingestor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FFPROBE_BINARY_CONFIG
static final String	FFPROBE_BINARY_DEFAULT
static final String	INBOX_DATETIME_FORMAT
static final String	INBOX_METADATA_FFPROBE
static final String	INBOX_METADATA_REGEX
static final String	INBOX_PATH	The configuration key to use for determining the inbox path
static final String	INBOX_POLL	The configuration key to use for determining the polling interval in ms.
static final String	INBOX_SCHEDULE_MATCH
static final String	INBOX_SCHEDULE_MATCH_THRESHOLD
static final String	INBOX_THREADS
static final String	INBOX_TRIES
static final String	INBOX_TRIES_BETWEEN_SEC
static final String	MEDIA_FLAVOR	The configuration key to use for determining the default media flavor
static final String	USER_NAME	The configuration key to use for determining the user to run as for ingest
static final String	USER_ORG	The configuration key to use for determining the user's organization
static final String	WORKFLOW_CONFIG	The configuration key to use for determining the workflow configuration to use for ingest
static final String	WORKFLOW_DEFINITION	The configuration key to use for determining the workflow definition to use for ingest
protected Workspace	workspace

Constructor Summary

Constructors

Constructor	Description
InboxScannerService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGi callback.
boolean	canHandle(File artifact)
void	deactivate()	OSGi callback.
void	install(File artifact)
void	setIngestService(IngestService ingestService)	OSGi callback to set the ingest service.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)	OSGi callback to set the organization directory server.
void	setSchedulerService(SchedulerService schedulerService)
void	setSecurityService(SecurityService securityService)	OSGi callback to set the security service.
void	setSeriesService(SeriesService seriesService)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	OSGi callback to set the user directory.
void	setWorkspace(Workspace workspace)
void	uninstall(File artifact)
void	update(File artifact)
void	updated(Dictionary properties)

Methods inherited from class java.lang.Object

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

Field Details

USER_NAME

public static final String USER_NAME

The configuration key to use for determining the user to run as for ingest

See Also:

• Constant Field Values

USER_ORG

public static final String USER_ORG

The configuration key to use for determining the user's organization

See Also:

• Constant Field Values

WORKFLOW_DEFINITION

public static final String WORKFLOW_DEFINITION

The configuration key to use for determining the workflow definition to use for ingest

See Also:

• Constant Field Values

MEDIA_FLAVOR

public static final String MEDIA_FLAVOR

The configuration key to use for determining the default media flavor

See Also:

• Constant Field Values

WORKFLOW_CONFIG

public static final String WORKFLOW_CONFIG

The configuration key to use for determining the workflow configuration to use for ingest

See Also:

• Constant Field Values

INBOX_PATH

public static final String INBOX_PATH

The configuration key to use for determining the inbox path

See Also:

• Constant Field Values

INBOX_POLL

public static final String INBOX_POLL

The configuration key to use for determining the polling interval in ms.

See Also:

• Constant Field Values

INBOX_THREADS

public static final String INBOX_THREADS

See Also:

• Constant Field Values

INBOX_TRIES

public static final String INBOX_TRIES

See Also:

• Constant Field Values

INBOX_TRIES_BETWEEN_SEC

public static final String INBOX_TRIES_BETWEEN_SEC

See Also:

• Constant Field Values

INBOX_METADATA_REGEX

public static final String INBOX_METADATA_REGEX

See Also:

• Constant Field Values

INBOX_DATETIME_FORMAT

public static final String INBOX_DATETIME_FORMAT

See Also:

• Constant Field Values

INBOX_METADATA_FFPROBE

public static final String INBOX_METADATA_FFPROBE

See Also:

• Constant Field Values

INBOX_SCHEDULE_MATCH

public static final String INBOX_SCHEDULE_MATCH

See Also:

• Constant Field Values

INBOX_SCHEDULE_MATCH_THRESHOLD

public static final String INBOX_SCHEDULE_MATCH_THRESHOLD

See Also:

• Constant Field Values

FFPROBE_BINARY_CONFIG

public static final String FFPROBE_BINARY_CONFIG

See Also:

• Constant Field Values

FFPROBE_BINARY_DEFAULT

public static final String FFPROBE_BINARY_DEFAULT

See Also:

• Constant Field Values

workspace

protected Workspace workspace

Constructor Details

InboxScannerService

public InboxScannerService()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

OSGi callback.

deactivate

public void deactivate()

OSGi callback.

updated

public void updated(Dictionary properties)
             throws org.osgi.service.cm.ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

org.osgi.service.cm.ConfigurationException

canHandle

public boolean canHandle(File artifact)

Specified by:

canHandle in interface org.apache.felix.fileinstall.ArtifactListener

install

public void install(File artifact)
             throws Exception

Specified by:

install in interface org.apache.felix.fileinstall.ArtifactInstaller

Throws:

Exception

update

public void update(File artifact)

Specified by:

update in interface org.apache.felix.fileinstall.ArtifactInstaller

uninstall

public void uninstall(File artifact)

Specified by:

uninstall in interface org.apache.felix.fileinstall.ArtifactInstaller

setIngestService

public void setIngestService(IngestService ingestService)

OSGi callback to set the ingest service.

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback to set the security service.

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

OSGi callback to set the user directory.

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

OSGi callback to set the organization directory server.

setSeriesService

public void setSeriesService(SeriesService seriesService)

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

setWorkspace

public void setWorkspace(Workspace workspace)