Package org.opencastproject.external.endpoint

Class WorkflowsEndpoint

java.lang.Object

org.opencastproject.external.endpoint.WorkflowsEndpoint

@Path("/api/workflows")
@Produces({"application/json","application/v1.1.0+json","application/v1.2.0+json","application/v1.3.0+json","application/v1.4.0+json","application/v1.5.0+json","application/v1.6.0+json","application/v1.7.0+json","application/v1.8.0+json","application/v1.9.0+json","application/v1.10.0+json","application/v1.11.0+json"})
public class WorkflowsEndpoint
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
WorkflowsEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createWorkflowInstance(String acceptHeader, String eventId, String workflowDefinitionIdentifier, String configuration, boolean withOperations, boolean withConfiguration)
javax.ws.rs.core.Response	deleteWorkflowInstance(String acceptHeader, Long id)
javax.ws.rs.core.Response	getWorkflowInstance(String acceptHeader, Long id, boolean withOperations, boolean withConfiguration)
void	setElasticsearchIndex(org.opencastproject.elasticsearch.index.ElasticsearchIndex elasticsearchIndex)	OSGi DI
void	setIndexService(org.opencastproject.index.service.api.IndexService indexService)	OSGi DI
void	setWorkflowService(org.opencastproject.workflow.api.WorkflowService workflowService)	OSGi DI
javax.ws.rs.core.Response	updateWorkflowInstance(String acceptHeader, Long id, String configuration, String stateStr, boolean withOperations, boolean withConfiguration)

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

Constructor Details

WorkflowsEndpoint

public WorkflowsEndpoint()

Method Details

setWorkflowService

public void setWorkflowService(org.opencastproject.workflow.api.WorkflowService workflowService)

OSGi DI

setElasticsearchIndex

public void setElasticsearchIndex(org.opencastproject.elasticsearch.index.ElasticsearchIndex elasticsearchIndex)

OSGi DI

setIndexService

public void setIndexService(org.opencastproject.index.service.api.IndexService indexService)

OSGi DI

createWorkflowInstance

@POST
@Path("")
public javax.ws.rs.core.Response createWorkflowInstance(@HeaderParam("Accept")
 String acceptHeader,
 @FormParam("event_identifier")
 String eventId,
 @FormParam("workflow_definition_identifier")
 String workflowDefinitionIdentifier,
 @FormParam("configuration")
 String configuration,
 @QueryParam("withoperations")
 boolean withOperations,
 @QueryParam("withconfiguration")
 boolean withConfiguration)

getWorkflowInstance

@GET
@Path("{workflowInstanceId}")
public javax.ws.rs.core.Response getWorkflowInstance(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("workflowInstanceId")
 Long id,
 @QueryParam("withoperations")
 boolean withOperations,
 @QueryParam("withconfiguration")
 boolean withConfiguration)

updateWorkflowInstance

@PUT
@Path("{workflowInstanceId}")
public javax.ws.rs.core.Response updateWorkflowInstance(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("workflowInstanceId")
 Long id,
 @FormParam("configuration")
 String configuration,
 @FormParam("state")
 String stateStr,
 @QueryParam("withoperations")
 boolean withOperations,
 @QueryParam("withconfiguration")
 boolean withConfiguration)

deleteWorkflowInstance

@DELETE
@Path("{workflowInstanceId}")
public javax.ws.rs.core.Response deleteWorkflowInstance(@HeaderParam("Accept")
 String acceptHeader,
 @PathParam("workflowInstanceId")
 Long id)