Package org.opencastproject.usertracking.endpoint

Class UserTrackingRestService

java.lang.Object

org.opencastproject.usertracking.endpoint.UserTrackingRestService

@Path("/usertracking")
public class UserTrackingRestService
extends Object

REST Endpoint for User Tracking Service

Field Summary

Fields

Modifier and Type	Field	Description
protected org.opencastproject.security.api.SecurityService	securityService
protected String	serverUrl
protected String	serviceUrl

Constructor Summary

Constructors

Constructor	Description
UserTrackingRestService()

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	addFootprint(String mediapackageId, String inString, String outString, String type, String isPlaying, javax.servlet.http.HttpServletRequest request)
UserActionImpl	getActionAsJson(String actionId)
UserActionImpl	getActionAsXml(String actionId)
FootprintsListImpl	getFootprintAsJson(String mediapackageId)
FootprintsListImpl	getFootprintAsXml(String mediapackageId)
UserActionListImpl	getUserActionsAsJson(String id, String type, String day, int limit, int offset)
UserActionListImpl	getUserActionsAsXml(String id, String type, String day, int limit, int offset)
javax.ws.rs.core.Response	getUserTrackingEnabled()
ReportImpl	reportAsJson(String from, String to, int offset, int limit)
ReportImpl	reportAsXml(String from, String to, int offset, int limit)
void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)	Sets the security service
void	setService(org.opencastproject.usertracking.api.UserTrackingService service)	Method to set the service this REST endpoint uses
StatsImpl	statsAsJson(String mediapackageId)
StatsImpl	statsAsXml(String mediapackageId)

Methods inherited from class java.lang.Object

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

Field Details

securityService

protected org.opencastproject.security.api.SecurityService securityService

serverUrl

protected String serverUrl

serviceUrl

protected String serviceUrl

Constructor Details

UserTrackingRestService

public UserTrackingRestService()

Method Details

setService

public void setService(org.opencastproject.usertracking.api.UserTrackingService service)

Method to set the service this REST endpoint uses

Parameters:

service -

setSecurityService

public void setSecurityService(org.opencastproject.security.api.SecurityService securityService)

Sets the security service

Parameters:

securityService - the securityService to set

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

getUserActionsAsXml

@GET
@Produces("text/xml")
@Path("/actions.xml")
public UserActionListImpl getUserActionsAsXml(@QueryParam("id")
 String id,
 @QueryParam("type")
 String type,
 @QueryParam("day")
 String day,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset)

Returns:

XML with all footprints

getUserActionsAsJson

@GET
@Produces("application/json")
@Path("/actions.json")
public UserActionListImpl getUserActionsAsJson(@QueryParam("id")
 String id,
 @QueryParam("type")
 String type,
 @QueryParam("day")
 String day,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset)

Returns:

JSON with all footprints

statsAsXml

@GET
@Produces("text/xml")
@Path("/stats.xml")
public StatsImpl statsAsXml(@QueryParam("id")
 String mediapackageId)

statsAsJson

@GET
@Produces("application/json")
@Path("/stats.json")
public StatsImpl statsAsJson(@QueryParam("id")
 String mediapackageId)

reportAsXml

@GET
@Produces("text/xml")
@Path("/report.xml")
public ReportImpl reportAsXml(@QueryParam("from")
 String from,
 @QueryParam("to")
 String to,
 @QueryParam("offset")
 int offset,
 @QueryParam("limit")
 int limit)

reportAsJson

@GET
@Produces("application/json")
@Path("/report.json")
public ReportImpl reportAsJson(@QueryParam("from")
 String from,
 @QueryParam("to")
 String to,
 @QueryParam("offset")
 int offset,
 @QueryParam("limit")
 int limit)

addFootprint

@PUT
@Path("")
@Produces("text/xml")
public javax.ws.rs.core.Response addFootprint(@FormParam("id")
 String mediapackageId,
 @FormParam("in")
 String inString,
 @FormParam("out")
 String outString,
 @FormParam("type")
 String type,
 @FormParam("playing")
 String isPlaying,
 @Context
 javax.servlet.http.HttpServletRequest request)

getActionAsXml

@GET
@Produces("text/xml")
@Path("/action/{id}.xml")
public UserActionImpl getActionAsXml(@PathParam("id")
 String actionId)

getActionAsJson

@GET
@Produces("application/json")
@Path("/action/{id}.json")
public UserActionImpl getActionAsJson(@PathParam("id")
 String actionId)

getFootprintAsXml

@GET
@Produces("text/xml")
@Path("/footprint.xml")
public FootprintsListImpl getFootprintAsXml(@QueryParam("id")
 String mediapackageId)

getFootprintAsJson

@GET
@Produces("application/json")
@Path("/footprint.json")
public FootprintsListImpl getFootprintAsJson(@QueryParam("id")
 String mediapackageId)

getUserTrackingEnabled

@GET
@Produces("text/plain")
@Path("/detailenabled")
public javax.ws.rs.core.Response getUserTrackingEnabled()