Package org.opencastproject.inspection.remote

Class MediaInspectionServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.inspection.remote.MediaInspectionServiceRemoteImpl

All Implemented Interfaces:

MediaInspectionService

public class MediaInspectionServiceRemoteImpl
extends RemoteBase
implements MediaInspectionService

Proxies a remote media inspection service for use as a JVM-local service.

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.serviceregistry.api.RemoteBase

RemoteBase.HttpClientClosingInputStream

Field Summary

Fields inherited from class org.opencastproject.serviceregistry.api.RemoteBase

client, elementsFromHttpResponse, remoteServiceManager, serviceType

Fields inherited from interface org.opencastproject.inspection.api.MediaInspectionService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
MediaInspectionServiceRemoteImpl()	Constructs a new remote media inspection service proxy

Method Summary

Modifier and Type	Method	Description
Job	enrich(MediaPackageElement original, boolean override)	Equip an existing media package element with automatically generated metadata
Job	enrich(MediaPackageElement original, boolean override, Map<String,String> options)	Equip an existing media package element with automatically generated metadata
Job	inspect(URI uri)	Inspect a track based on a given uri to the track and put the gathered data into the track
Job	inspect(URI uri, Map<String,String> options)	Inspect a track based on a given uri to the track and put the gathered data into the track
void	setRemoteServiceManager(ServiceRegistry remoteServiceManager)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient client)	Sets the trusted http client

Methods inherited from class org.opencastproject.serviceregistry.api.RemoteBase

closeConnection, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

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

Constructor Details

MediaInspectionServiceRemoteImpl

public MediaInspectionServiceRemoteImpl()

Constructs a new remote media inspection service proxy

Method Details

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient client)

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

client -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry remoteServiceManager)

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

remoteServiceManager -

inspect

public Job inspect(URI uri)
            throws MediaInspectionException

Inspect a track based on a given uri to the track and put the gathered data into the track

Specified by:

inspect in interface MediaInspectionService

Parameters:

uri - the uri to a track in a media package

Returns:

the receipt of this job, that can be used to check the current status of inspect method and retrieve track with added metadata when done

Throws:

MediaInspectionException - if there is a failure during media package update

See Also:

• MediaInspectionService.inspect(java.net.URI)

inspect

public Job inspect(URI uri,
 Map<String,String> options)
            throws MediaInspectionException

Inspect a track based on a given uri to the track and put the gathered data into the track

Specified by:

inspect in interface MediaInspectionService

Parameters:

uri - the uri to a track in a media package

options - Options in form of key/value pairs that are passed to the Media Inspection Service implementation. Those options may be implementation specific. The implementation is supposed to raise an exception in case unsupported options are encountered. Value may not be null.

Returns:

the receipt of this job, that can be used to check the current status of inspect method and retrieve track with added metadata when done

Throws:

MediaInspectionException - if there is a failure during media package update

See Also:

• MediaInspectionService.inspect(java.net.URI)

enrich

public Job enrich(MediaPackageElement original,
 boolean override)
           throws MediaInspectionException

Equip an existing media package element with automatically generated metadata

Specified by:

enrich in interface MediaInspectionService

Parameters:

original - The original media package element that will be inspected

override - In case of conflict between existing and automatically obtained metadata this switch selects preference. False..The original metadata will be kept, True..The new metadata will be used.

Returns:

the receipt of this job, that can be used to check the current status of enrich method and retrieve enriched element when done

Throws:

MediaInspectionException - if there is a failure during media package update

enrich

public Job enrich(MediaPackageElement original,
 boolean override,
 Map<String,String> options)
           throws MediaInspectionException

Equip an existing media package element with automatically generated metadata

Specified by:

enrich in interface MediaInspectionService

Parameters:

original - The original media package element that will be inspected

override - In case of conflict between existing and automatically obtained metadata this switch selects preference. False..The original metadata will be kept, True..The new metadata will be used.

options - Options in form of key/value pairs that are passed to the MediaInspectionService implementation. Those options may be implementation specific. The implementation is supposed to raise an exception in case unsupported options are encountered. Value may not be null.

Returns:

the receipt of this job, that can be used to check the current status of enrich method and retrieve enriched element when done

Throws:

MediaInspectionException - if there is a failure during media package update