org.opencastproject.serviceregistry.api.IncidentService Maven / Gradle / Ivy
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License
* at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*
*/
package org.opencastproject.serviceregistry.api;
import org.opencastproject.job.api.Incident;
import org.opencastproject.job.api.IncidentTree;
import org.opencastproject.job.api.Job;
import org.opencastproject.util.NotFoundException;
import org.opencastproject.util.data.Tuple;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;
/** Manages storing and retrieving of job incidents. */
public interface IncidentService {
/**
* Identifier for service registration and location
*/
String JOB_TYPE = "org.opencastproject.incident";
/**
* Stores a new job incident.
*
* @throws IllegalStateException
* if no job related job exists
* @throws IncidentServiceException
* if there is a problem communicating with the underlying data store
*/
Incident storeIncident(Job job, Date timestamp, String code, Incident.Severity severity,
Map descriptionParameters, List> details)
throws IncidentServiceException, IllegalStateException;
/**
* Gets a job incident by a given incident identifier.
*
* @param id
* the incident indentifier
* @return the job incident
* @throws IncidentServiceException
* if there is a problem communicating with the underlying data store
* @throws NotFoundException
* if there is no job incident with this incident identifier
*/
Incident getIncident(long id) throws IncidentServiceException, NotFoundException;
/**
* Get the hierarchy of incidents for a given job identifier.
*
* @param jobId
* the job identifier
* @param 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
* {@link org.opencastproject.job.api.IncidentTree#getDescendants()} will always be empty
* @return the list of incidents
* @throws NotFoundException
* if there is no incident with this job identifier
* @throws IncidentServiceException
* if there is a problem communicating with the underlying data store
*/
IncidentTree getIncidentsOfJob(long jobId, boolean cascade) throws NotFoundException, 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.
*
* @param jobIds
* the job identifiers
* @return the concatenated list of directly related incidents
* @throws IncidentServiceException
* if there is a problem communicating with the underlying data store
*/
List getIncidentsOfJob(List jobIds) throws IncidentServiceException;
/**
* 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.
*
* @param id
* the incident identifier
* @param locale
* the locale
* @return the incident localization
* @throws NotFoundException
* if there is no job incident with this incident identifier
* @throws IncidentServiceException
* if there is a problem communicating with the underlying data store
*/
IncidentL10n getLocalization(long id, Locale locale) throws IncidentServiceException, NotFoundException;
}