org.opencastproject.serviceregistry.api

Interface IncidentService

public interface IncidentService

Manages storing and retrieving of job incidents.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JOB_TYPE Identifier for service registration and location

Method Summary

Modifier and Type	Method and Description
Incident	getIncident(long id) Gets a job incident by a given incident identifier.
List<Incident>	getIncidentsOfJob(List<Long> jobIds) Get the directly related incidents of all given jobs and return them concatenated into a single list.
IncidentTree	getIncidentsOfJob(long jobId, boolean cascade) Get the hierarchy of incidents for a given job identifier.
IncidentL10n	getLocalization(long id, Locale locale) Gets the localized texts for an incident by a given incident identifier and locale.
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.

Field Detail

JOB_TYPE

static final String JOB_TYPE

Identifier for service registration and location

See Also:

Constant Field Values

Method Detail

storeIncident

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

Stores a new job incident.

Throws:

IllegalStateException - if no job related job exists

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

getIncident

Incident getIncident(long id)
              throws IncidentServiceException,
                     NotFoundException

Gets a job incident by a given incident identifier.

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

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

Get the hierarchy of incidents for a given job identifier.

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

getIncidentsOfJob

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

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.

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

getLocalization

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

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.

Parameters:

id - the incident identifier

locale - the locale

Returns:

the incident localization

Throws:

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

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