Package org.opencastproject.external.endpoint

Class LifeCycleManagementEndpoint

java.lang.Object

org.opencastproject.external.endpoint.LifeCycleManagementEndpoint

@Path("/api/lifecyclemanagement")
@Produces({"application/json","application/v1.12.0+json"})
public class LifeCycleManagementEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String	endpointBaseUrl	Base URL of this endpoint
protected IndexService	indexService

Constructor Summary

Constructors

Constructor	Description
LifeCycleManagementEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createAsJson(String acceptHeader, String title, String targetType, String action, String actionParameters, String actionDate, String cronTrigger, String timing, String targetFilters, String accessControlEntries)
javax.ws.rs.core.Response	getActions(String acceptHeader)
javax.ws.rs.core.Response	getPoliciesAsJson(String acceptHeader, int limit, int offset, String sort)
javax.ws.rs.core.Response	getPoliciesForEvent(String acceptHeader, String eventId, int limit, int offset)
javax.ws.rs.core.Response	getPolicy(String acceptHeader, String id)
javax.ws.rs.core.Response	getTargetTypes(String acceptHeader)
javax.ws.rs.core.Response	getTimings(String acceptHeader)
javax.ws.rs.core.Response	remove(String acceptHeader, String id)
void	setIndexService(IndexService indexService)
void	setLifeCycleService(LifeCycleService lifeCycleService)
javax.ws.rs.core.Response	updateAsJson(String acceptHeader, String id, String title, String targetType, String action, String actionParameters, String actionDate, String cronTrigger, String timing, String targetFilters, String accessControlEntries)

Methods inherited from class java.lang.Object

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

Field Details

endpointBaseUrl

protected String endpointBaseUrl

Base URL of this endpoint

indexService

protected IndexService indexService

Constructor Details

LifeCycleManagementEndpoint

public LifeCycleManagementEndpoint()

Method Details

setLifeCycleService

public void setLifeCycleService(LifeCycleService lifeCycleService)

setIndexService

public void setIndexService(IndexService indexService)

getPolicy

@GET
@Path("policies/{id}")
public javax.ws.rs.core.Response getPolicy(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("id")
 String id)

getPoliciesAsJson

@GET
@Path("policies")
public javax.ws.rs.core.Response getPoliciesAsJson(@HeaderParam("Accept")
 String acceptHeader,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset,
 @QueryParam("sort")
 String sort)
                                            throws LifeCycleServiceException

Throws:

LifeCycleServiceException

getActions

@GET
@Path("policies/actions")
public javax.ws.rs.core.Response getActions(@HeaderParam("Accept")
 String acceptHeader)

getTargetTypes

@GET
@Path("policies/targettypes")
public javax.ws.rs.core.Response getTargetTypes(@HeaderParam("Accept")
 String acceptHeader)

getTimings

@GET
@Path("policies/timings")
public javax.ws.rs.core.Response getTimings(@HeaderParam("Accept")
 String acceptHeader)

getPoliciesForEvent

@GET
@Path("policiesForEvent/{eventId}")
public javax.ws.rs.core.Response getPoliciesForEvent(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("eventId")
 String eventId,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset)
                                              throws SearchIndexException,
NotFoundException,
LifeCycleServiceException

Throws:

SearchIndexException

NotFoundException

LifeCycleServiceException

createAsJson

@POST
@Path("policies")
public javax.ws.rs.core.Response createAsJson(@HeaderParam("Accept")
 String acceptHeader,
 @FormParam("title")
 String title,
 @FormParam("targetType")
 String targetType,
 @FormParam("action")
 String action,
 @FormParam("actionParameters")
 String actionParameters,
 @FormParam("actionDate")
 String actionDate,
 @FormParam("cronTrigger")
 String cronTrigger,
 @FormParam("timing")
 String timing,
 @FormParam("targetFilters")
 String targetFilters,
 @FormParam("accessControlEntries")
 String accessControlEntries)

updateAsJson

@PUT
@Path("policies/{id}")
public javax.ws.rs.core.Response updateAsJson(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("id")
 String id,
 @FormParam("title")
 String title,
 @FormParam("targetType")
 String targetType,
 @FormParam("action")
 String action,
 @FormParam("actionParameters")
 String actionParameters,
 @FormParam("actionDate")
 String actionDate,
 @FormParam("cronTrigger")
 String cronTrigger,
 @FormParam("timing")
 String timing,
 @FormParam("targetFilters")
 String targetFilters,
 @FormParam("accessControlEntries")
 String accessControlEntries)

remove

@DELETE
@Path("policies/{id}")
public javax.ws.rs.core.Response remove(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("id")
 String id)