org.opencastproject.serviceregistry.api

Class Incidents

java.lang.Object

org.opencastproject.serviceregistry.api.Incidents

public final class Incidents
extends Object

Create and record job incidents. Facade for IncidentService.

Field Summary

Fields

Modifier and Type	Field and Description
static List<Tuple<String,String>>	NO_DETAILS
static Map<String,String>	NO_PARAMS

Constructor Summary

Constructors

Constructor and Description
Incidents(ServiceRegistry sr, IncidentService is)

Method Summary

Modifier and Type	Method and Description
boolean	alreadyRecordedFailureIncident(long jobId)
void	record(Job job, Incident.Severity severity, int code) Record an incident for a given job.
void	record(Job job, Incident.Severity severity, int code, Map<String,String> params, List<Tuple<String,String>> details) Record an incident for a given job.
void	recordFailure(Job job, int code) Record a failure incident for a given job.
void	recordFailure(Job job, int code, List<Tuple<String,String>> details) Record a failure incident for a given job.
void	recordFailure(Job job, int code, Map<String,String> params) Record a failure incident for a given job.
void	recordFailure(Job job, int code, Map<String,String> params, List<Tuple<String,String>> details) Record a failure incident for a given job.
void	recordFailure(Job job, int code, Throwable t, List<Tuple<String,String>> details) Record a failure incident for a given job.
void	recordFailure(Job job, int code, Throwable t, Map<String,String> params, List<Tuple<String,String>> details) Record a failure incident for a given job.
void	recordJobCreationIncident(Job job, Throwable t)
void	recordMigrationIncident(Job job, String error)
void	unhandledException(Job job, Incident.Severity severity, Throwable t) Record an incident for a given job caused by an uncatched exception.
void	unhandledException(long jobId, Incident.Severity severity, Throwable t) Record an incident for a given job caused by an uncatched exception.

Methods inherited from class java.lang.Object

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

Field Detail

NO_PARAMS

public static final Map<String,String> NO_PARAMS

NO_DETAILS

public static final List<Tuple<String,String>> NO_DETAILS

Constructor Detail

Incidents

public Incidents(ServiceRegistry sr,
                 IncidentService is)

Method Detail

record

public void record(Job job,
                   Incident.Severity severity,
                   int code,
                   Map<String,String> params,
                   List<Tuple<String,String>> details)

Record an incident for a given job. This method is intended to record client incidents, i.e. incidents crafted by the programmer.

Parameters:

code - A code number. This incident factory method enforces an incident code schema of job_type.code , e.g. org.opencastproject.service.1511 . So instead of aligning job.getJobType() and the incident's code prefix manually this is done automatically for you by this method. See Incident.getCode().

See Also:

Incident

record

public void record(Job job,
                   Incident.Severity severity,
                   int code)

Record an incident for a given job. This method is intended to record client incidents, i.e. incidents crafted by the programmer.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordFailure

public void recordFailure(Job job,
                          int code)

Record a failure incident for a given job.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordFailure

public void recordFailure(Job job,
                          int code,
                          Map<String,String> params)

Record a failure incident for a given job.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordFailure

public void recordFailure(Job job,
                          int code,
                          List<Tuple<String,String>> details)

Record a failure incident for a given job.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordFailure

public void recordFailure(Job job,
                          int code,
                          Map<String,String> params,
                          List<Tuple<String,String>> details)

Record a failure incident for a given job.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordFailure

public void recordFailure(Job job,
                          int code,
                          Throwable t,
                          List<Tuple<String,String>> details)

Record a failure incident for a given job.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordFailure

public void recordFailure(Job job,
                          int code,
                          Throwable t,
                          Map<String,String> params,
                          List<Tuple<String,String>> details)

Record a failure incident for a given job.

See Also:

record(org.opencastproject.job.api.Job, org.opencastproject.job.api.Incident.Severity, int, java.util.Map, java.util.List), Incident

recordMigrationIncident

public void recordMigrationIncident(Job job,
                                    String error)

recordJobCreationIncident

public void recordJobCreationIncident(Job job,
                                      Throwable t)

unhandledException

public void unhandledException(Job job,
                               Incident.Severity severity,
                               Throwable t)

Record an incident for a given job caused by an uncatched exception. This method is intended to record incidents by the job system itself, e.g. the job dispatcher.

unhandledException

public void unhandledException(long jobId,
                               Incident.Severity severity,
                               Throwable t)

Record an incident for a given job caused by an uncatched exception. This method is intended to record incidents by the job system itself, e.g. the job dispatcher. Please note that an incident will only be recorded if none of severity Incident.Severity.FAILURE has already been recorded by the job or one of its child jobs. If no job with the given job id exists nothing happens.

alreadyRecordedFailureIncident

public boolean alreadyRecordedFailureIncident(long jobId)