Package org.opencastproject.scheduler.impl.persistence

Class SchedulerServiceDatabaseImpl

java.lang.Object

org.opencastproject.scheduler.impl.persistence.SchedulerServiceDatabaseImpl

All Implemented Interfaces:

SchedulerServiceDatabase

public class SchedulerServiceDatabaseImpl
extends Object
implements SchedulerServiceDatabase

Implements SchedulerServiceDatabase.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PERSISTENCE_UNIT	JPA persistence unit name

Constructor Summary

Constructors

Constructor	Description
SchedulerServiceDatabaseImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Creates EntityManagerFactory using persistence provider and properties passed via OSGi.
int	countEvents()	Retrieve the number of events.
void	deleteEvent(String mediapackageId)	Removes the extended event from persistent storage.
Optional<ExtendedEventDto>	getEvent(String mediapackageId)	Get the event with the given mediapackage id for the current organization.
Optional<ExtendedEventDto>	getEvent(String mediapackageId, String orgId)	Get the event with the given mediapackage id and organization.
List<ExtendedEventDto>	getEvents()	Get all events from the scheduler for the current organizations.
List<String>	getEvents(String captureAgentId, Date start, Date end, int separationMillis)	Get the mediapackage IDs of all events scheduled on the given capture agent between the given start/end time.
List<ExtendedEventDto>	getKnownRecordings()	Retrieve all events which have a recording state and a recording last heard.
Date	getLastModified(String agentId)	Get the last modification date by an agent identifier
Map<String,Date>	getLastModifiedDates()	Get a Map of last modification dates of all existing capture agents.
void	resetRecordingState(String mediapackageId)	Nulls recording state and recording last heard of of the given media package.
List<ExtendedEventDto>	search(Optional<String> captureAgentId, Optional<Date> optStartsFrom, Optional<Date> optStartsTo, Optional<Date> optEndFrom, Optional<Date> optEndTo, Optional<Integer> limit)	Retrieve all events matching given filter ordered by start time ascending.
void	setDBSessionFactory(org.opencastproject.db.DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)	OSGi DI
void	storeEvent(String mediapackageId, String organizationId, Optional<String> captureAgentId, Optional<Date> start, Optional<Date> end, Optional<String> source, Optional<String> recordingState, Optional<Long> recordingLastHeard, Optional<String> presenters, Optional<Date> lastModifiedDate, Optional<String> checksum, Optional<Map<String,String>> workflowProperties, Optional<Map<String,String>> caProperties)	Create or update an event identified by mediapackageId and organizationId
void	touchLastEntry(String agentId)	Touches the most recent entry by updating its last modification date.

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

JPA persistence unit name

See Also:

• Constant Field Values

Constructor Details

SchedulerServiceDatabaseImpl

public SchedulerServiceDatabaseImpl()

Method Details

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

OSGi DI

setSecurityService

public void setSecurityService(org.opencastproject.security.api.SecurityService securityService)

OSGi DI

setDBSessionFactory

public void setDBSessionFactory(org.opencastproject.db.DBSessionFactory dbSessionFactory)

activate

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

Creates EntityManagerFactory using persistence provider and properties passed via OSGi.

Parameters:

cc -

touchLastEntry

public void touchLastEntry(String agentId)
                    throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Touches the most recent entry by updating its last modification date.

Specified by:

touchLastEntry in interface SchedulerServiceDatabase

Parameters:

agentId - the capture agent identifier

Throws:

SchedulerServiceDatabaseException - if updating of the last modified value fails

getLastModified

public Date getLastModified(String agentId)
                     throws org.opencastproject.util.NotFoundException,
SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Get the last modification date by an agent identifier

Specified by:

getLastModified in interface SchedulerServiceDatabase

Parameters:

agentId - the capture agent identifier

Returns:

the last modification date

Throws:

org.opencastproject.util.NotFoundException - if the agent could not be found

SchedulerServiceDatabaseException - if exception occurred

getLastModifiedDates

public Map<String,Date> getLastModifiedDates()
                                      throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Get a Map of last modification dates of all existing capture agents.

Specified by:

getLastModifiedDates in interface SchedulerServiceDatabase

Returns:

the last modified map

Throws:

SchedulerServiceDatabaseException - if exception occurred

storeEvent

public void storeEvent(String mediapackageId,
 String organizationId,
 Optional<String> captureAgentId,
 Optional<Date> start,
 Optional<Date> end,
 Optional<String> source,
 Optional<String> recordingState,
 Optional<Long> recordingLastHeard,
 Optional<String> presenters,
 Optional<Date> lastModifiedDate,
 Optional<String> checksum,
 Optional<Map<String,String>> workflowProperties,
 Optional<Map<String,String>> caProperties)
                throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Create or update an event identified by mediapackageId and organizationId

Specified by:

storeEvent in interface SchedulerServiceDatabase

Parameters:

mediapackageId - the mediapackage ID

organizationId - the organization ID of the organization owning the event

captureAgentId - the capture agent ID of the capture agent this event is scheduled on

start - the recording start time

end - the recording end time

source - the source

recordingState - the recording state

recordingLastHeard - the recording last heard

presenters - the presenters

lastModifiedDate - the last modified date

checksum - the checksum

workflowProperties - the workflow properties

caProperties - the capture agent properties

Throws:

SchedulerServiceDatabaseException - in case the event cannot be stored.

getEvents

public List<String> getEvents(String captureAgentId,
 Date start,
 Date end,
 int separationMillis)
                       throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Get the mediapackage IDs of all events scheduled on the given capture agent between the given start/end time. Events which are only partially contained within the given interval are also included in the result set. The results are ordered by start date ascending.

Specified by:

getEvents in interface SchedulerServiceDatabase

Parameters:

captureAgentId - the capture agent ID of the capture agent to check

start - the start date of the interval to check

end - the end date of the interval to check

separationMillis - number of milliseconds to prepend and append to given interval

Returns:

The mediapackage IDs of the events between start (inclusive) and end (inclusive) scheduled on the given capture agent.

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.

search

public List<ExtendedEventDto> search(Optional<String> captureAgentId,
 Optional<Date> optStartsFrom,
 Optional<Date> optStartsTo,
 Optional<Date> optEndFrom,
 Optional<Date> optEndTo,
 Optional<Integer> limit)
                              throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Retrieve all events matching given filter ordered by start time ascending.

Specified by:

search in interface SchedulerServiceDatabase

Parameters:

captureAgentId - the capture agent id filter

optStartsFrom - the start from date filter

optStartsTo - the start to date filter

optEndFrom - the end from date filter

optEndTo - the end to date filter

limit - the maximum number of results to retrieve

Returns:

The events matching the given filter

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.

getKnownRecordings

public List<ExtendedEventDto> getKnownRecordings()
                                          throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Retrieve all events which have a recording state and a recording last heard.

Specified by:

getKnownRecordings in interface SchedulerServiceDatabase

Returns:

all events which have a recording state and a recording last heard

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.

deleteEvent

public void deleteEvent(String mediapackageId)
                 throws org.opencastproject.util.NotFoundException,
SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Removes the extended event from persistent storage.

Specified by:

deleteEvent in interface SchedulerServiceDatabase

Parameters:

mediapackageId - ID of event to be removed

Throws:

org.opencastproject.util.NotFoundException - if there is no element with specified ID

SchedulerServiceDatabaseException - if exception occurred

getEvents

public List<ExtendedEventDto> getEvents()
                                 throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Get all events from the scheduler for the current organizations.

Specified by:

getEvents in interface SchedulerServiceDatabase

Returns:

The list of events.

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.

getEvent

public Optional<ExtendedEventDto> getEvent(String mediapackageId,
 String orgId)
                                    throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Get the event with the given mediapackage id and organization.

Specified by:

getEvent in interface SchedulerServiceDatabase

Parameters:

mediapackageId - The mediapackage id to look for

orgId - The organization id to look for

Returns:

The event or nothing, if the event couldn't be found.

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.

getEvent

public Optional<ExtendedEventDto> getEvent(String mediapackageId)
                                    throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Get the event with the given mediapackage id for the current organization.

Specified by:

getEvent in interface SchedulerServiceDatabase

Parameters:

mediapackageId - The mediapackage id to look for

Returns:

The event or nothing, if the event couldn't be found.

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.

resetRecordingState

public void resetRecordingState(String mediapackageId)
                         throws org.opencastproject.util.NotFoundException,
SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Nulls recording state and recording last heard of of the given media package.

Specified by:

resetRecordingState in interface SchedulerServiceDatabase

Parameters:

mediapackageId - The mediapackage id to look for

Throws:

org.opencastproject.util.NotFoundException - if there is no element with specified ID

SchedulerServiceDatabaseException - If the database cannot be queried.

countEvents

public int countEvents()
                throws SchedulerServiceDatabaseException

Description copied from interface: SchedulerServiceDatabase

Retrieve the number of events.

Specified by:

countEvents in interface SchedulerServiceDatabase

Returns:

The number of events.

Throws:

SchedulerServiceDatabaseException - If the database cannot be queried.