Package org.opencastproject.lti.service.impl

Class LtiServiceImpl

java.lang.Object

org.opencastproject.lti.service.impl.LtiServiceImpl

All Implemented Interfaces:

LtiService

public class LtiServiceImpl
extends Object
implements LtiService

The LTI service implementation

Field Summary

Fields inherited from interface org.opencastproject.lti.service.api.LtiService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
LtiServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
void	addCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)	OSGi DI.
void	copyEventToSeries(String eventId, String seriesId)	Copy an event to a different series
void	delete(String id)	Deletes the specified event
String	getEventMetadata(String eventId)	Returns the event metadata for a specific event
String	getNewEventMetadata()	Returns the event metadata for a new event
List<LtiJob>	listJobs(String seriesId)	List currently running jobs for the series
void	modified(org.osgi.service.component.ComponentContext cc)
void	removeCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)	OSGi DI.
void	setAssetManager(AssetManager assetManager)	OSGi DI
void	setAuthorizationService(AuthorizationService authorizationService)	OSGi DI
void	setEventMetadataJson(String eventId, String metadataJson)	Set the event metadata
void	setIndexService(IndexService indexService)	OSGi DI
void	setIngestService(IngestService ingestService)	OSGi DI
void	setSearchIndex(ElasticsearchIndex searchIndex)	OSGi DI
void	setSeriesService(SeriesService seriesService)	OSGI DI
void	setWorkflowService(WorkflowService workflowService)	OSGi DI
void	setWorkspace(Workspace workspace)	OSGi DI
void	upsertEvent(LtiFileUpload file, String captions, String captionFormat, String captionLanguage, String eventId, String seriesId, String metadataJson)	Upload a new event or update existing event's metadata

Methods inherited from class java.lang.Object

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

Constructor Details

LtiServiceImpl

public LtiServiceImpl()

Method Details

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

OSGi DI

setSeriesService

public void setSeriesService(SeriesService seriesService)

OSGI DI

setAssetManager

public void setAssetManager(AssetManager assetManager)

OSGi DI

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

OSGi DI

setWorkspace

public void setWorkspace(Workspace workspace)

OSGi DI

setSearchIndex

public void setSearchIndex(ElasticsearchIndex searchIndex)

OSGi DI

setIndexService

public void setIndexService(IndexService indexService)

OSGi DI

setIngestService

public void setIngestService(IngestService ingestService)

OSGi DI

addCatalogUIAdapter

public void addCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)

OSGi DI.

removeCatalogUIAdapter

public void removeCatalogUIAdapter(EventCatalogUIAdapter catalogUIAdapter)

OSGi DI.

activate

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

modified

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

listJobs

public List<LtiJob> listJobs(String seriesId)

Description copied from interface: LtiService

List currently running jobs for the series

Specified by:

listJobs in interface LtiService

Parameters:

seriesId - ID of the series

Returns:

A list of jobs

upsertEvent

public void upsertEvent(LtiFileUpload file,
 String captions,
 String captionFormat,
 String captionLanguage,
 String eventId,
 String seriesId,
 String metadataJson)
                 throws UnauthorizedException,
NotFoundException

Description copied from interface: LtiService

Upload a new event or update existing event's metadata

Specified by:

upsertEvent in interface LtiService

Parameters:

file - File to upload

captions - Subtitles file

eventId - ID of the event (can be null for new events)

seriesId - ID of the series

metadataJson - Metadata for the event as JSON string

Throws:

UnauthorizedException

NotFoundException

copyEventToSeries

public void copyEventToSeries(String eventId,
 String seriesId)

Description copied from interface: LtiService

Copy an event to a different series

Specified by:

copyEventToSeries in interface LtiService

Parameters:

eventId - Event ID to copy

seriesId - Series ID to copy into

getEventMetadata

public String getEventMetadata(String eventId)
                        throws NotFoundException,
UnauthorizedException

Description copied from interface: LtiService

Returns the event metadata for a specific event

Specified by:

getEventMetadata in interface LtiService

Parameters:

eventId - ID of the event

Returns:

The event metadata list

Throws:

NotFoundException - If the event doesn't exist

UnauthorizedException - If the user cannot access the event

getNewEventMetadata

public String getNewEventMetadata()

Description copied from interface: LtiService

Returns the event metadata for a new event

Specified by:

getNewEventMetadata in interface LtiService

Returns:

The event metadata list

setEventMetadataJson

public void setEventMetadataJson(String eventId,
 String metadataJson)
                          throws NotFoundException,
UnauthorizedException

Description copied from interface: LtiService

Set the event metadata

Specified by:

setEventMetadataJson in interface LtiService

Parameters:

eventId - ID of the event

metadataJson - New metadata of the event as JSON

Throws:

NotFoundException - If the event doesn't exist

UnauthorizedException - If the user cannot access the event

delete

public void delete(String id)

Description copied from interface: LtiService

Deletes the specified event

Specified by:

delete in interface LtiService

Parameters:

id - ID of the event