Package org.opencastproject.lti.endpoint

Class LtiServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.lti.endpoint.LtiServiceRemoteImpl

All Implemented Interfaces:

LtiService

public class LtiServiceRemoteImpl
extends RemoteBase
implements LtiService

The service calling the LTI REST endpoint (for multi-node setups with LTI)

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.lti.service.api.LtiService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
LtiServiceRemoteImpl()

Method Summary

Modifier and Type	Method	Description
void	copyEventToSeries(String eventId, String seriesId)	Copy an event to a different series
void	delete(String eventId)	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	setEventMetadataJson(String eventId, String metadataJson)	Set the event metadata
void	setRemoteServiceManager(ServiceRegistry serviceRegistry)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient trustedHttpClient)	Sets the trusted http client
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 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

LtiServiceRemoteImpl

public LtiServiceRemoteImpl()

Method Details

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)

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

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 eventId)

Description copied from interface: LtiService

Deletes the specified event

Specified by:

delete in interface LtiService

Parameters:

eventId - ID of the event

setTrustedHttpClient

public void setTrustedHttpClient(TrustedHttpClient trustedHttpClient)

Description copied from class: RemoteBase

Sets the trusted http client

Overrides:

setTrustedHttpClient in class RemoteBase

Parameters:

trustedHttpClient -

setRemoteServiceManager

public void setRemoteServiceManager(ServiceRegistry serviceRegistry)

Description copied from class: RemoteBase

Sets the remote service manager.

Overrides:

setRemoteServiceManager in class RemoteBase

Parameters:

serviceRegistry -