Package org.opencastproject.serviceregistry.impl

Class AbstractIncidentService

java.lang.Object

org.opencastproject.serviceregistry.impl.AbstractIncidentService

All Implemented Interfaces:

IncidentService

Direct Known Subclasses:

OsgiIncidentService

public abstract class AbstractIncidentService
extends Object
implements IncidentService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_DESCRIPTION
static final String	FIELD_TITLE
static final String	NO_DESCRIPTION
static final String	NO_TITLE
static final String	PERSISTENCE_UNIT_NAME

Fields inherited from interface org.opencastproject.serviceregistry.api.IncidentService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractIncidentService()

Method Summary

Modifier and Type	Method	Description
static List<String>	genDbKeys(List<String> locale, String base)	Create a list of localization database keys from a base key and a locale split into its part, e.g.
protected abstract DBSession	getDBSession()
Incident	getIncident(long id)	Gets a job incident by a given incident identifier.
IncidentTree	getIncidentsOfJob(long jobId, boolean cascade)	Get the hierarchy of incidents for a given job identifier.
List<Incident>	getIncidentsOfJob(List<Long> jobIds)	Get the directly related incidents of all given jobs and return them concatenated into a single list.
IncidentL10n	getLocalization(long id, Locale locale)	Gets the localized texts for an incident by a given incident identifier and locale.
protected abstract ServiceRegistry	getServiceRegistry()
protected abstract WorkflowService	getWorkflowService()
static List<String>	localeToList(Locale locale)	Convert a locale into a list of strings, [language, country, variant]
static String	replaceVars(String template, Map<String,String> params)	Replace variables of the form #{xxx} in a string template.
Incident	storeIncident(Job job, Date timestamp, String code, Incident.Severity severity, Map<String,String> descriptionParameters, List<Tuple<String,String>> details)	Stores a new job incident.

Methods inherited from class java.lang.Object

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

Field Details

PERSISTENCE_UNIT_NAME

public static final String PERSISTENCE_UNIT_NAME

See Also:

• Constant Field Values

NO_TITLE

public static final String NO_TITLE

See Also:

• Constant Field Values

NO_DESCRIPTION

public static final String NO_DESCRIPTION

See Also:

• Constant Field Values

FIELD_TITLE

public static final String FIELD_TITLE

See Also:

• Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

AbstractIncidentService

public AbstractIncidentService()

Method Details

getServiceRegistry

protected abstract ServiceRegistry getServiceRegistry()

getWorkflowService

protected abstract WorkflowService getWorkflowService()

getDBSession

protected abstract DBSession getDBSession()

storeIncident

public Incident storeIncident(Job job,
 Date timestamp,
 String code,
 Incident.Severity severity,
 Map<String,String> descriptionParameters,
 List<Tuple<String,String>> details)
                       throws IncidentServiceException,
IllegalStateException

Description copied from interface: IncidentService

Stores a new job incident.

Specified by:

storeIncident in interface IncidentService

Throws:

IncidentServiceException - if there is a problem communicating with the underlying data store

IllegalStateException - if no job related job exists

getIncident

public Incident getIncident(long id)
                     throws IncidentServiceException,
NotFoundException

Description copied from interface: IncidentService

Gets a job incident by a given incident identifier.

Specified by:

getIncident in interface IncidentService

Parameters:

id - the incident indentifier

Returns:

the job incident

Throws:

IncidentServiceException - if there is a problem communicating with the underlying data store

NotFoundException - if there is no job incident with this incident identifier

getIncidentsOfJob

public List<Incident> getIncidentsOfJob(List<Long> jobIds)
                                 throws IncidentServiceException

Description copied from interface: IncidentService

Get the directly related incidents of all given jobs and return them concatenated into a single list. No incidents of any descendants will be returned.

Specified by:

getIncidentsOfJob in interface IncidentService

Parameters:

jobIds - the job identifiers

Returns:

the concatenated list of directly related incidents

Throws:

IncidentServiceException - if there is a problem communicating with the underlying data store

getIncidentsOfJob

public IncidentTree getIncidentsOfJob(long jobId,
 boolean cascade)
                               throws NotFoundException,
IncidentServiceException

Description copied from interface: IncidentService

Get the hierarchy of incidents for a given job identifier.

Specified by:

getIncidentsOfJob in interface IncidentService

Parameters:

jobId - the job identifier

cascade - if true, return the incidents of the given job and those of of its descendants; if false, just return the incidents of the given job, which means that the list returned by IncidentTree.getDescendants() will always be empty

Returns:

the list of incidents

Throws:

NotFoundException - if there is no incident with this job identifier

IncidentServiceException - if there is a problem communicating with the underlying data store

getLocalization

public IncidentL10n getLocalization(long id,
 Locale locale)
                             throws IncidentServiceException,
NotFoundException

Description copied from interface: IncidentService

Gets the localized texts for an incident by a given incident identifier and locale. If there are no localized texts of the given locale, the default localized texts are returned.

Specified by:

getLocalization in interface IncidentService

Parameters:

id - the incident identifier

locale - the locale

Returns:

the incident localization

Throws:

IncidentServiceException - if there is a problem communicating with the underlying data store

NotFoundException - if there is no job incident with this incident identifier

genDbKeys

public static List<String> genDbKeys(List<String> locale,
 String base)

Create a list of localization database keys from a base key and a locale split into its part, e.g. ["de", "DE"] or ["en"]. The returned list starts with the most specific key getting more common, e.g. ["org.opencastproject.composer.1.title.de.DE", "org.opencastproject.composer.1.title.de", "org.opencastproject.composer.1.title"]

localeToList

public static List<String> localeToList(Locale locale)

Convert a locale into a list of strings, [language, country, variant]

replaceVars

public static String replaceVars(String template,
 Map<String,String> params)

Replace variables of the form #{xxx} in a string template.