Package org.opencastproject.capture.admin.endpoint

Class CaptureAgentStateRestService

java.lang.Object

org.opencastproject.capture.admin.endpoint.CaptureAgentStateRestService

@Path("/capture-admin")
public class CaptureAgentStateRestService
extends Object

The REST endpoint for the capture agent service on the capture device

Constructor Summary

Constructors

Constructor	Description
CaptureAgentStateRestService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Callback from OSGi that is called when this service is activated.
javax.ws.rs.core.Response	getAgentState(String agentName, String format)
List<RecordingStateUpdate>	getAllRecordings()
javax.ws.rs.core.Response	getCapabilities(String agentName, String type)
javax.ws.rs.core.Response	getConfiguration(String agentName, String type)
javax.ws.rs.core.Response	getKnownAgents(String type)
javax.ws.rs.core.Response	getRecordingState(String id, String type)
javax.ws.rs.core.Response	removeAgent(String agentName)
javax.ws.rs.core.Response	removeRecording(String id)
javax.ws.rs.core.Response	setAgentState(javax.servlet.http.HttpServletRequest request, String address, String agentName, String state)
javax.ws.rs.core.Response	setConfiguration(String agentName, String configuration)
javax.ws.rs.core.Response	setRecordingState(String id, String state)
void	setSchedulerService(SchedulerService schedulerService)
void	setService(CaptureAgentStateService service)
void	unsetService(CaptureAgentStateService service)

Methods inherited from class java.lang.Object

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

Constructor Details

CaptureAgentStateRestService

public CaptureAgentStateRestService()

Method Details

activate

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

Callback from OSGi that is called when this service is activated.

Parameters:

cc - OSGi component context

setService

public void setService(CaptureAgentStateService service)

unsetService

public void unsetService(CaptureAgentStateService service)

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

getAgentState

@GET
@Produces({"application/xml","application/json"})
@Path("agents/{name}.{format:xml|json}")
public javax.ws.rs.core.Response getAgentState(@PathParam("name")
 String agentName,
 @PathParam("format")
 String format)
                                        throws NotFoundException

Throws:

NotFoundException

setAgentState

@POST
@Produces("text/html")
@Path("agents/{name}")
public javax.ws.rs.core.Response setAgentState(@Context
 javax.servlet.http.HttpServletRequest request,
 @FormParam("address")
 String address,
 @PathParam("name")
 String agentName,
 @FormParam("state")
 String state)
                                        throws NotFoundException

Throws:

NotFoundException

removeAgent

@DELETE
@Path("agents/{name}")
@Produces("text/html")
public javax.ws.rs.core.Response removeAgent(@PathParam("name")
 String agentName)
                                      throws NotFoundException

Throws:

NotFoundException

getKnownAgents

@GET
@Produces({"text/xml","application/json"})
@Path("agents.{type:xml|json}")
public javax.ws.rs.core.Response getKnownAgents(@PathParam("type")
 String type)

getCapabilities

@GET
@Produces({"text/xml","application/json"})
@Path("agents/{name}/capabilities.{type:xml|json}")
public javax.ws.rs.core.Response getCapabilities(@PathParam("name")
 String agentName,
 @PathParam("type")
 String type)
                                          throws NotFoundException

Throws:

NotFoundException

getConfiguration

@GET
@Produces({"text/xml","application/json"})
@Path("agents/{name}/configuration.{type:xml|json}")
public javax.ws.rs.core.Response getConfiguration(@PathParam("name")
 String agentName,
 @PathParam("type")
 String type)
                                           throws NotFoundException

Throws:

NotFoundException

setConfiguration

@POST
@Produces({"text/xml","application/json"})
@Path("agents/{name}/configuration")
public javax.ws.rs.core.Response setConfiguration(@PathParam("name")
 String agentName,
 @FormParam("configuration")
 String configuration)

getRecordingState

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

Throws:

NotFoundException

setRecordingState

@POST
@Path("recordings/{id}")
public javax.ws.rs.core.Response setRecordingState(@PathParam("id")
 String id,
 @FormParam("state")
 String state)
                                            throws NotFoundException

Throws:

NotFoundException

removeRecording

@DELETE
@Path("recordings/{id}")
public javax.ws.rs.core.Response removeRecording(@PathParam("id")
 String id)
                                          throws NotFoundException

Throws:

NotFoundException

getAllRecordings

@GET
@Produces("text/xml")
@Path("recordings")
public List<RecordingStateUpdate> getAllRecordings()