Package org.opencastproject.scheduler.remote

Class SchedulerServiceRemoteImpl

java.lang.Object

org.opencastproject.serviceregistry.api.RemoteBase

org.opencastproject.scheduler.remote.SchedulerServiceRemoteImpl

All Implemented Interfaces:

SchedulerService

public class SchedulerServiceRemoteImpl
extends RemoteBase
implements SchedulerService

A proxy to a remote series 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, remoteServiceManager, serviceType

Fields inherited from interface org.opencastproject.scheduler.api.SchedulerService

JOB_TYPE, WORKFLOW_CONFIG_PREFIX

Constructor Summary

Constructors

Constructor	Description
SchedulerServiceRemoteImpl()

Method Summary

Modifier and Type	Method	Description
void	addEvent(Date startDateTime, Date endDateTime, String captureAgentId, Set<String> userIds, MediaPackage mediaPackage, Map<String,String> wfProperties, Map<String,String> caMetadata, Optional<String> schedulingSource)	Creates new event using specified mediapackage, workflow configuration and capture agent configuration.
Map<String,net.fortuna.ical4j.model.Period>	addMultipleEvents(net.fortuna.ical4j.model.property.RRule rRule, Date start, Date end, Long duration, TimeZone tz, String captureAgentId, Set<String> userIds, MediaPackage templateMp, Map<String,String> wfProperties, Map<String,String> caMetadata, Optional<String> schedulingSource)	Creates a group of new event using specified mediapackage, workflow configuration and capture agent configuration.
List<MediaPackage>	findConflictingEvents(String captureDeviceID, Date startDate, Date endDate)	Returns list of all conflicting events, i.e. all events that ends after start date and begins before end date.
List<MediaPackage>	findConflictingEvents(String captureAgentId, net.fortuna.ical4j.model.property.RRule rrule, Date startDate, Date endDate, long duration, TimeZone timezone)	Returns list of all conflicting events.
String	getCalendar(Optional<String> captureAgentId, Optional<String> seriesId, Optional<Date> cutoff)	Generates calendar for specified capture agent.
Map<String,String>	getCaptureAgentConfiguration(String eventId)	Retrieves capture agent configuration for specified event.
Optional<MediaPackage>	getCurrentRecording(String captureAgentId)	Retrieves the currently active recording for the given capture agent (if any).
DublinCoreCatalog	getDublinCore(String eventId)	Retrieves dublin core catalog associated with specified event ID.
int	getEventCount()	Returns the number of scheduled events.
Map<String,Recording>	getKnownRecordings()	Gets the state of all recordings in the system.
MediaPackage	getMediaPackage(String eventId)	Retrieves mediapackage associated with specified event ID.
Recording	getRecordingState(String id)	Gets the state of a recording, if it exists.
String	getScheduleLastModified(String agentId)	Returns hash of last modification of event belonging to specified capture agent.
TechnicalMetadata	getTechnicalMetadata(String eventId)	Retrieves the technical metadata associated with specified event ID.
Optional<MediaPackage>	getUpcomingRecording(String captureAgentId)	Retrieves the upcoming recording for the given capture agent (if any).
Map<String,String>	getWorkflowConfig(String eventId)	Retrieves workflow configuration associated with specified event ID.
void	removeEvent(String eventId)	Removes event with specified ID.
void	removeRecording(String eventId)	Removes a recording from the system, if the recording exists.
void	removeScheduledRecordingsBeforeBuffer(long buffer)	Remove all of the scheduled events before a buffer.
List<MediaPackage>	search(Optional<String> captureAgentId, Optional<Date> startsFrom, Optional<Date> startsTo, Optional<Date> endFrom, Optional<Date> endTo)	Retrieves all events matching given filter.
void	setRemoteServiceManager(ServiceRegistry serviceRegistry)	Sets the remote service manager.
void	setTrustedHttpClient(TrustedHttpClient trustedHttpClient)	Sets the trusted http client
void	updateEvent(String eventId, Optional<Date> startDateTime, Optional<Date> endDateTime, Optional<String> captureAgentId, Optional<Set<String>> userIds, Optional<MediaPackage> mediaPackage, Optional<Map<String,String>> wfProperties, Optional<Map<String,String>> caMetadata)	Updates event with specified ID and check for conflicts.
void	updateEvent(String eventId, Optional<Date> startDateTime, Optional<Date> endDateTime, Optional<String> captureAgentId, Optional<Set<String>> userIds, Optional<MediaPackage> mediaPackage, Optional<Map<String,String>> wfProperties, Optional<Map<String,String>> caMetadata, boolean allowConflict)	Updates event with specified ID and possibly checking for conflicts.
boolean	updateRecordingState(String mediapackageId, String state)	Updates the state of a recording with the given state, if it exists.

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

closeConnection, elementsFromHttpResponse, getResponse, getResponse, runRequest

Methods inherited from class java.lang.Object

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

Constructor Details

SchedulerServiceRemoteImpl

public SchedulerServiceRemoteImpl()

Method Details

addEvent

public void addEvent(Date startDateTime,
 Date endDateTime,
 String captureAgentId,
 Set<String> userIds,
 MediaPackage mediaPackage,
 Map<String,String> wfProperties,
 Map<String,String> caMetadata,
 Optional<String> schedulingSource)
              throws UnauthorizedException,
SchedulerConflictException,
SchedulerException

Description copied from interface: SchedulerService

Creates new event using specified mediapackage, workflow configuration and capture agent configuration. The mediapackage id is used as the event's identifier. Default capture agent properties are created from agentId and DublinCore. Following values are generated:

• event.title (mapped from dc:title)
• event.series (mapped from mediaPackage#getSeries())
• event.location (mapped from captureAgentId)

Specified by:

addEvent in interface SchedulerService

Parameters:

startDateTime - the event start time (the start date must be before the end date)

endDateTime - the event end time (the end date must be after the start date)

captureAgentId - the capture agent id

userIds - the list of user identifiers of speakers/lecturers

mediaPackage - the mediapackage

wfProperties - the workflow configuration

caMetadata - the capture agent configuration

schedulingSource - the optional scheduling source from which the event comes from

Throws:

UnauthorizedException - if the caller is not authorized to take this action

SchedulerConflictException - if there are conflicting events

SchedulerException - if creating new events failed

addMultipleEvents

public Map<String,net.fortuna.ical4j.model.Period> addMultipleEvents(net.fortuna.ical4j.model.property.RRule rRule,
 Date start,
 Date end,
 Long duration,
 TimeZone tz,
 String captureAgentId,
 Set<String> userIds,
 MediaPackage templateMp,
 Map<String,String> wfProperties,
 Map<String,String> caMetadata,
 Optional<String> schedulingSource)
                                                              throws UnauthorizedException,
SchedulerConflictException,
SchedulerException

Description copied from interface: SchedulerService

Creates a group of new event using specified mediapackage, workflow configuration and capture agent configuration. The mediapackage id is used as the event's identifier. Default capture agent properties are created from agentId and DublinCore. Following values are generated:

• event.title (mapped from dc:title)
• event.series (mapped from mediaPackage#getSeries())
• event.location (mapped from captureAgentId)

Specified by:

addMultipleEvents in interface SchedulerService

Parameters:

rRule - the RRule for the events to schedule

start - the start date for the recurrence

end - the end date for the recurrence

duration - the duration of the events

tz - the TimeZone for the events

captureAgentId - the capture agent id

userIds - the list of user identifiers of speakers/lecturers

templateMp - the mediapackage to base the events on

wfProperties - the workflow configuration

caMetadata - the capture agent configuration

schedulingSource - the optional scheduling source from which the event comes from

Returns:

A Map of mediapackage ID and Period where the event occurs

Throws:

UnauthorizedException - if the caller is not authorized to take this action

SchedulerConflictException - if there are conflicting events

SchedulerException - if creating new events failed

updateEvent

public void updateEvent(String eventId,
 Optional<Date> startDateTime,
 Optional<Date> endDateTime,
 Optional<String> captureAgentId,
 Optional<Set<String>> userIds,
 Optional<MediaPackage> mediaPackage,
 Optional<Map<String,String>> wfProperties,
 Optional<Map<String,String>> caMetadata)
                 throws NotFoundException,
UnauthorizedException,
SchedulerConflictException,
SchedulerException

Description copied from interface: SchedulerService

Updates event with specified ID and check for conflicts. Default capture agent properties are created from DublinCore. Following values are generated:

• event.title (mapped from dc:title)
• event.series (mapped from mediaPackage#getSeries())
• event.location (mapped from captureAgentId)

Specified by:

updateEvent in interface SchedulerService

Parameters:

eventId - the optional event identifier

startDateTime - the optional event start time

endDateTime - the optional event end time

captureAgentId - the optional capture agent id

userIds - the optional list of user identifiers of speakers/lecturers

mediaPackage - the optional mediapackage to update

wfProperties - the optional workflow configuration to update

caMetadata - the optional capture configuration to update

Throws:

NotFoundException - if event with specified ID cannot be found

UnauthorizedException - if the current user is not authorized to perform this action

SchedulerConflictException - if there are conflicting events

SchedulerException - if exception occurred

updateEvent

public void updateEvent(String eventId,
 Optional<Date> startDateTime,
 Optional<Date> endDateTime,
 Optional<String> captureAgentId,
 Optional<Set<String>> userIds,
 Optional<MediaPackage> mediaPackage,
 Optional<Map<String,String>> wfProperties,
 Optional<Map<String,String>> caMetadata,
 boolean allowConflict)
                 throws NotFoundException,
UnauthorizedException,
SchedulerConflictException,
SchedulerException

Description copied from interface: SchedulerService

Updates event with specified ID and possibly checking for conflicts. Default capture agent properties are created from DublinCore. Following values are generated:

• event.title (mapped from dc:title)
• event.series (mapped from mediaPackage#getSeries())
• event.location (mapped from captureAgentId)

Specified by:

updateEvent in interface SchedulerService

Parameters:

eventId - the event identifier

startDateTime - the optional event start time

endDateTime - the optional event end time

captureAgentId - the optional capture agent id

userIds - the optional list of user identifiers of speakers/lecturers

mediaPackage - the optional mediapackage to update

wfProperties - the optional workflow configuration to update

caMetadata - the optional capture configuration to update

allowConflict - the flag to ignore conflict checks

Throws:

NotFoundException - if event with specified ID cannot be found

UnauthorizedException - if the current user is not authorized to perform this action

SchedulerConflictException - if there are conflicting events

SchedulerException - if exception occurred

removeEvent

public void removeEvent(String eventId)
                 throws NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Removes event with specified ID.

Specified by:

removeEvent in interface SchedulerService

Parameters:

eventId - the event identifier

Throws:

NotFoundException - if event with specified ID cannot be found

UnauthorizedException - if the current user is not authorized to perform this action

SchedulerException - if exception occurred

getMediaPackage

public MediaPackage getMediaPackage(String eventId)
                             throws NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Retrieves mediapackage associated with specified event ID.

Specified by:

getMediaPackage in interface SchedulerService

Parameters:

eventId - ID of event for which mediapackage will be retrieved

Returns:

MediaPackage for specified event

Throws:

NotFoundException - if event with specified ID cannot be found

SchedulerException - if exception occurred

UnauthorizedException

getDublinCore

public DublinCoreCatalog getDublinCore(String eventId)
                                throws NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Retrieves dublin core catalog associated with specified event ID.

Specified by:

getDublinCore in interface SchedulerService

Parameters:

eventId - ID of event for which DublinCore will be retrieved

Returns:

DublinCoreCatalog for specified event

Throws:

NotFoundException - if event with specified ID cannot be found

SchedulerException - if exception occurred

UnauthorizedException

getTechnicalMetadata

public TechnicalMetadata getTechnicalMetadata(String eventId)
                                       throws NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Retrieves the technical metadata associated with specified event ID.

Specified by:

getTechnicalMetadata in interface SchedulerService

Parameters:

eventId - ID of event for which technical metadata will be retrieved

Returns:

TechnicalMetadata for specified event

Throws:

NotFoundException - if event with specified ID cannot be found

SchedulerException - if exception occurred

UnauthorizedException

getWorkflowConfig

public Map<String,String> getWorkflowConfig(String eventId)
                                     throws NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Retrieves workflow configuration associated with specified event ID.

Specified by:

getWorkflowConfig in interface SchedulerService

Parameters:

eventId - ID of event for which workflow configuration will be retrieved

Returns:

configuration of the workflow

Throws:

NotFoundException - if event with specified ID cannot be found

SchedulerException - if exception occurred

UnauthorizedException

getCaptureAgentConfiguration

public Map<String,String> getCaptureAgentConfiguration(String eventId)
                                                throws NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Retrieves capture agent configuration for specified event.

Specified by:

getCaptureAgentConfiguration in interface SchedulerService

Parameters:

eventId - ID of event for which capture agent configuration will be retrieved

Returns:

configurations of capture agent

Throws:

NotFoundException - if event with specified ID cannot be found

SchedulerException - if exception occurred

UnauthorizedException

getEventCount

public int getEventCount()
                  throws SchedulerException,
UnauthorizedException

Description copied from interface: SchedulerService

Returns the number of scheduled events.

Specified by:

getEventCount in interface SchedulerService

Returns:

the number of scheduled events

Throws:

SchedulerException - if exception occurred

UnauthorizedException

getScheduleLastModified

public String getScheduleLastModified(String agentId)
                               throws SchedulerException

Description copied from interface: SchedulerService

Returns hash of last modification of event belonging to specified capture agent.

Specified by:

getScheduleLastModified in interface SchedulerService

Parameters:

agentId - the capture agent identifier

Returns:

the last modification hash

Throws:

SchedulerException - if exception occurred

search

public List<MediaPackage> search(Optional<String> captureAgentId,
 Optional<Date> startsFrom,
 Optional<Date> startsTo,
 Optional<Date> endFrom,
 Optional<Date> endTo)
                          throws UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Retrieves all events matching given filter.

Specified by:

search in interface SchedulerService

Parameters:

captureAgentId - the capture agent id filter

startsFrom - the start from date filter

startsTo - the start to date filter

endFrom - the end from date filter

endTo - the end to date filter

Returns:

a MediaPackage list of matching events

Throws:

SchedulerException - if exception occurred

UnauthorizedException

getCurrentRecording

public Optional<MediaPackage> getCurrentRecording(String captureAgentId)
                                           throws SchedulerException,
UnauthorizedException

Description copied from interface: SchedulerService

Retrieves the currently active recording for the given capture agent (if any).

Specified by:

getCurrentRecording in interface SchedulerService

Parameters:

captureAgentId - The id of the agent to get the current recording of.

Returns:

The currently active recording or none, if agent is currently idle

Throws:

SchedulerException - In case the current recording cannot be retrieved.

UnauthorizedException

getUpcomingRecording

public Optional<MediaPackage> getUpcomingRecording(String captureAgentId)
                                            throws SchedulerException,
UnauthorizedException

Description copied from interface: SchedulerService

Retrieves the upcoming recording for the given capture agent (if any).

Specified by:

getUpcomingRecording in interface SchedulerService

Parameters:

captureAgentId - The id of the agent to get the upcoming recording of.

Returns:

The cupcoming recording or none, if there is none.

Throws:

SchedulerException - In case the upcoming recording cannot be retrieved.

UnauthorizedException

findConflictingEvents

public List<MediaPackage> findConflictingEvents(String captureDeviceID,
 Date startDate,
 Date endDate)
                                         throws UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Returns list of all conflicting events, i.e. all events that ends after start date and begins before end date.

Specified by:

findConflictingEvents in interface SchedulerService

Parameters:

captureDeviceID - capture device ID for which conflicting events are searched for

startDate - start date of conflicting period

endDate - end date of conflicting period

Returns:

a MediaPackage list of all conflicting events

Throws:

SchedulerException - if exception occurred

UnauthorizedException

findConflictingEvents

public List<MediaPackage> findConflictingEvents(String captureAgentId,
 net.fortuna.ical4j.model.property.RRule rrule,
 Date startDate,
 Date endDate,
 long duration,
 TimeZone timezone)
                                         throws UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Returns list of all conflicting events. Conflicting periods are calculated based on recurrence rule, start date, end date and duration of each conflicting period.

Specified by:

findConflictingEvents in interface SchedulerService

Parameters:

captureAgentId - capture agent ID for which conflicting events are searched for

rrule - recurrence rule

startDate - beginning of period

endDate - ending of period

duration - duration of each period

timezone - the time zone of the capture agent

Returns:

a MediaPackage list of all conflicting events

Throws:

SchedulerException - if exception occurred

UnauthorizedException

getCalendar

public String getCalendar(Optional<String> captureAgentId,
 Optional<String> seriesId,
 Optional<Date> cutoff)
                   throws SchedulerException

Description copied from interface: SchedulerService

Generates calendar for specified capture agent.

Specified by:

getCalendar in interface SchedulerService

Parameters:

captureAgentId - capture agent id filter

seriesId - series id filter

cutoff - cutoff date filter

Returns:

generated calendar

Throws:

SchedulerException - if exception occurred

removeScheduledRecordingsBeforeBuffer

public void removeScheduledRecordingsBeforeBuffer(long buffer)
                                           throws UnauthorizedException,
SchedulerException

Description copied from interface: SchedulerService

Remove all of the scheduled events before a buffer.

Specified by:

removeScheduledRecordingsBeforeBuffer in interface SchedulerService

Parameters:

buffer - The number of seconds before now that defines a cutoff for events, if they have their end time before this cutoff they will be removed

Throws:

SchedulerException

UnauthorizedException

updateRecordingState

public boolean updateRecordingState(String mediapackageId,
 String state)
                             throws NotFoundException,
SchedulerException

Description copied from interface: SchedulerService

Updates the state of a recording with the given state, if it exists.

Specified by:

updateRecordingState in interface SchedulerService

Parameters:

mediapackageId - The id of the recording in the system.

state - The state to set for that recording. This should be defined from Recording.

Throws:

NotFoundException - if the recording with the given id has not been found

SchedulerException

getRecordingState

public Recording getRecordingState(String id)
                            throws NotFoundException,
SchedulerException

Description copied from interface: SchedulerService

Gets the state of a recording, if it exists.

Specified by:

getRecordingState in interface SchedulerService

Parameters:

id - The id of the recording.

Returns:

The state of the recording, or null if it does not exist. This should be defined from Recording.

Throws:

NotFoundException - if the recording with the given id has not been found

SchedulerException

removeRecording

public void removeRecording(String eventId)
                     throws NotFoundException,
SchedulerException

Description copied from interface: SchedulerService

Removes a recording from the system, if the recording exists.

Specified by:

removeRecording in interface SchedulerService

Parameters:

eventId - The id of the recording to remove.

Throws:

NotFoundException - if the recording with the given id has not been found

SchedulerException

getKnownRecordings

public Map<String,Recording> getKnownRecordings()
                                         throws SchedulerException

Description copied from interface: SchedulerService

Gets the state of all recordings in the system.

Specified by:

getKnownRecordings in interface SchedulerService

Returns:

A map of recording-state pairs.

Throws:

SchedulerException

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 -