Package org.opencastproject.serviceregistry.impl.endpoint

Class IncidentServiceEndpoint

java.lang.Object

org.opencastproject.serviceregistry.impl.endpoint.IncidentServiceEndpoint

@Path("/incidents")
public class IncidentServiceEndpoint
extends Object

REST endpoint for Incident Service.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FMT_DIGEST
static final String	FMT_FULL
static final String	FMT_SYS
protected String	serverUrl	This server's base URL
protected ServiceRegistry	serviceRegistry	The remote service manager
protected String	serviceUrl	The REST endpoint's base URL
protected IncidentService	svc	The incident service

Constructor Summary

Constructors

Constructor	Description
IncidentServiceEndpoint()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	The method that is called, when the service is activated
javax.ws.rs.core.Response	getIncident(long incidentId, String type)
javax.ws.rs.core.Response	getIncidentsOfJobAsList(javax.servlet.http.HttpServletRequest request, List<Long> jobIds, String format, String type)
javax.ws.rs.core.Response	getIncidentsOfJobAsTree(javax.servlet.http.HttpServletRequest request, long jobId, boolean cascade, String format, String type)
javax.ws.rs.core.Response	getLocalization(long incidentId, String locale)
javax.ws.rs.core.Response	postIncident(String jobXml, String date, String code, String severityString, String details, LocalHashMap params)
void	setIncidentService(IncidentService incidentService)	OSGi callback for setting the incident service.

Methods inherited from class java.lang.Object

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

Field Details

FMT_FULL

public static final String FMT_FULL

See Also:

• Constant Field Values

FMT_DIGEST

public static final String FMT_DIGEST

See Also:

• Constant Field Values

FMT_SYS

public static final String FMT_SYS

See Also:

• Constant Field Values

svc

protected IncidentService svc

The incident service

serviceRegistry

protected ServiceRegistry serviceRegistry

The remote service manager

serverUrl

protected String serverUrl

This server's base URL

serviceUrl

protected String serviceUrl

The REST endpoint's base URL

Constructor Details

IncidentServiceEndpoint

public IncidentServiceEndpoint()

Method Details

setIncidentService

public void setIncidentService(IncidentService incidentService)

OSGi callback for setting the incident service.

activate

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

The method that is called, when the service is activated

Parameters:

cc - The ComponentContext of this service

getIncidentsOfJobAsList

@GET
@Produces({"application/xml","application/json"})
@Path("job/incidents.{type:xml|json}")
public javax.ws.rs.core.Response getIncidentsOfJobAsList(@Context
 javax.servlet.http.HttpServletRequest request,
 @QueryParam("id")
 List<Long> jobIds,
 @QueryParam("format") @DefaultValue("sys")
 String format,
 @PathParam("type")
 String type)

getIncidentsOfJobAsTree

@GET
@Produces({"application/xml","application/json"})
@Path("job/{id}.{type:xml|json}")
public javax.ws.rs.core.Response getIncidentsOfJobAsTree(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("id")
 long jobId,
 @QueryParam("cascade") @DefaultValue("false")
 boolean cascade,
 @QueryParam("format") @DefaultValue("sys")
 String format,
 @PathParam("type")
 String type)
                                                  throws NotFoundException

Throws:

NotFoundException

getIncident

@GET
@Produces({"application/xml","application/json"})
@Path("{id}.{type:xml|json}")
public javax.ws.rs.core.Response getIncident(@PathParam("id")
 long incidentId,
 @PathParam("type")
 String type)
                                      throws NotFoundException

Throws:

NotFoundException

getLocalization

@GET
@Produces("application/json")
@Path("localization/{id}")
public javax.ws.rs.core.Response getLocalization(@PathParam("id")
 long incidentId,
 @QueryParam("locale")
 String locale)
                                          throws NotFoundException

Throws:

NotFoundException

postIncident

@POST
@Produces("application/xml")
@Path("/")
public javax.ws.rs.core.Response postIncident(@FormParam("job")
 String jobXml,
 @FormParam("date")
 String date,
 @FormParam("code")
 String code,
 @FormParam("severity")
 String severityString,
 @FormParam("details")
 String details,
 @FormParam("params")
 LocalHashMap params)