Package org.opencastproject.workflow.endpoint

Class WorkflowRestService

java.lang.Object

org.opencastproject.rest.AbstractJobProducerEndpoint

org.opencastproject.workflow.endpoint.WorkflowRestService

@Path("/workflow")
public class WorkflowRestService
extends AbstractJobProducerEndpoint

A REST endpoint for the WorkflowService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCENDING_SUFFIX	The constant used to switch the direction of the sorting querystring parameter.
static final String	NEGATE_PREFIX	The constant used to negate a querystring parameter.
protected String	serverUrl	The default server URL
protected ServiceRegistry	serviceRegistry	The service registry
protected String	serviceUrl	The default service URL

Constructor Summary

Constructors

Constructor	Description
WorkflowRestService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI callback for component activation
javax.ws.rs.core.Response	cleanup(int buffer, String stateParam)
javax.ws.rs.core.Response	getConfigurationPanel(String definitionId)	Returns the workflow configuration panel HTML snippet for the workflow definition specified by
javax.ws.rs.core.Response	getCount(WorkflowInstance.WorkflowState state, String operation)
javax.ws.rs.core.Response	getOperationHandlers()
javax.ws.rs.core.Response	getRunningWorkflowOfMediaPackage(String mediaPackageId)
JobProducer	getService()	Returns the job producer that is backing this REST endpoint.
ServiceRegistry	getServiceRegistry()	Return the service registry.
javax.ws.rs.core.Response	getStateMappings()
JaxbWorkflowInstance	getWorkflowAsJson(long id)
JaxbWorkflowInstance	getWorkflowAsXml(long id)
javax.ws.rs.core.Response	getWorkflowDefinitionAsJson(String workflowDefinitionId)
javax.ws.rs.core.Response	getWorkflowDefinitionAsXml(String workflowDefinitionId)
WorkflowDefinitionSet	getWorkflowDefinitionsAsJson()
WorkflowDefinitionSet	getWorkflowDefinitionsAsXml()
javax.ws.rs.core.Response	getWorkflowsOfMediaPackage(String mediaPackageId)
javax.ws.rs.core.Response	mediaPackageHasActiveWorkflows(String mediaPackageId)
javax.ws.rs.core.Response	remove(long workflowInstanceId, boolean force)
javax.ws.rs.core.Response	resume(long workflowInstanceId, String mediaPackage, LocalHashMap properties)
javax.ws.rs.core.Response	resume(long workflowInstanceId, LocalHashMap properties)
void	setService(WorkflowService service)	Sets the workflow service
protected void	setServiceRegistry(ServiceRegistry serviceRegistry)	Callback from the OSGi declarative services to set the service registry.
void	setWorkspace(Workspace workspace)	Callback from the OSGi declarative services to set the workspace.
JaxbWorkflowInstance	start(String workflowDefinitionXmlOrId, MediaPackageImpl mp, String parentWorkflowId, LocalHashMap localMap)
JaxbWorkflowInstance	stop(long workflowInstanceId)
javax.ws.rs.core.Response	suspend(long workflowInstanceId)
javax.ws.rs.core.Response	update(String workflowInstance)
javax.ws.rs.core.Response	userHasActiveWorkflows(String userId)

Methods inherited from class org.opencastproject.rest.AbstractJobProducerEndpoint

checkHeartbeat, dispatchJob

Methods inherited from class java.lang.Object

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

Field Details

NEGATE_PREFIX

public static final String NEGATE_PREFIX

The constant used to negate a querystring parameter. This is only supported on some parameters.

See Also:

• Constant Field Values

DESCENDING_SUFFIX

public static final String DESCENDING_SUFFIX

The constant used to switch the direction of the sorting querystring parameter.

See Also:

• Constant Field Values

serverUrl

protected String serverUrl

The default server URL

serviceUrl

protected String serviceUrl

The default service URL

serviceRegistry

protected ServiceRegistry serviceRegistry

The service registry

Constructor Details

WorkflowRestService

public WorkflowRestService()

Method Details

setServiceRegistry

protected void setServiceRegistry(ServiceRegistry serviceRegistry)

Callback from the OSGi declarative services to set the service registry.

Parameters:

serviceRegistry - the service registry

setService

public void setService(WorkflowService service)

Sets the workflow service

Parameters:

service - the workflow service instance

setWorkspace

public void setWorkspace(Workspace workspace)

Callback from the OSGi declarative services to set the workspace.

Parameters:

workspace - the workspace

activate

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

OSGI callback for component activation

Parameters:

cc - the OSGI declarative services component context

getCount

@GET
@Produces("text/plain")
@Path("/count")
public javax.ws.rs.core.Response getCount(@QueryParam("state")
 WorkflowInstance.WorkflowState state,
 @QueryParam("operation")
 String operation)

getWorkflowDefinitionsAsJson

@GET
@Path("definitions.json")
@Produces("application/json")
public WorkflowDefinitionSet getWorkflowDefinitionsAsJson()
                                                   throws Exception

Throws:

Exception

getWorkflowDefinitionsAsXml

@GET
@Path("definitions.xml")
@Produces("application/xml")
public WorkflowDefinitionSet getWorkflowDefinitionsAsXml()
                                                  throws Exception

Throws:

Exception

getWorkflowDefinitionAsJson

@GET
@Produces("application/json")
@Path("definition/{id}.json")
public javax.ws.rs.core.Response getWorkflowDefinitionAsJson(@PathParam("id")
 String workflowDefinitionId)
                                                      throws NotFoundException

Throws:

NotFoundException

getWorkflowDefinitionAsXml

@GET
@Produces("text/xml")
@Path("definition/{id}.xml")
public javax.ws.rs.core.Response getWorkflowDefinitionAsXml(@PathParam("id")
 String workflowDefinitionId)
                                                     throws NotFoundException

Throws:

NotFoundException

getConfigurationPanel

@GET
@Produces("text/html")
@Path("configurationPanel")
public javax.ws.rs.core.Response getConfigurationPanel(@QueryParam("definitionId")
 String definitionId)
                                                throws NotFoundException

Returns the workflow configuration panel HTML snippet for the workflow definition specified by

Parameters:

definitionId -

Returns:

config panel HTML snippet

Throws:

NotFoundException

mediaPackageHasActiveWorkflows

@GET
@Produces("application/json")
@Path("mediaPackage/{id}/hasActiveWorkflows")
public javax.ws.rs.core.Response mediaPackageHasActiveWorkflows(@PathParam("id")
 String mediaPackageId)

getWorkflowsOfMediaPackage

@GET
@Produces("application/json")
@Path("mediaPackage/{id}/instances.json")
public javax.ws.rs.core.Response getWorkflowsOfMediaPackage(@PathParam("id")
 String mediaPackageId)

getRunningWorkflowOfMediaPackage

@GET
@Produces("application/json")
@Path("mediaPackage/{id}/currentInstance.json")
public javax.ws.rs.core.Response getRunningWorkflowOfMediaPackage(@PathParam("id")
 String mediaPackageId)

userHasActiveWorkflows

@GET
@Produces("application/json")
@Path("user/{id}/hasActiveWorkflows")
public javax.ws.rs.core.Response userHasActiveWorkflows(@PathParam("id")
 String userId)

getWorkflowAsXml

@GET
@Produces("text/xml")
@Path("instance/{id}.xml")
public JaxbWorkflowInstance getWorkflowAsXml(@PathParam("id")
 long id)
                                      throws WorkflowDatabaseException,
NotFoundException,
UnauthorizedException

Throws:

WorkflowDatabaseException

NotFoundException

UnauthorizedException

getWorkflowAsJson

@GET
@Produces("application/json")
@Path("instance/{id}.json")
public JaxbWorkflowInstance getWorkflowAsJson(@PathParam("id")
 long id)
                                       throws WorkflowDatabaseException,
NotFoundException,
UnauthorizedException

Throws:

WorkflowDatabaseException

NotFoundException

UnauthorizedException

start

@POST
@Path("start")
@Produces("text/xml")
public JaxbWorkflowInstance start(@FormParam("definition")
 String workflowDefinitionXmlOrId,
 @FormParam("mediapackage")
 MediaPackageImpl mp,
 @FormParam("parent")
 String parentWorkflowId,
 @FormParam("properties")
 LocalHashMap localMap)

stop

@POST
@Path("stop")
@Produces("text/xml")
public JaxbWorkflowInstance stop(@FormParam("id")
 long workflowInstanceId)
                          throws WorkflowException,
NotFoundException,
UnauthorizedException

Throws:

WorkflowException

NotFoundException

UnauthorizedException

remove

@DELETE
@Path("remove/{id}")
@Produces("text/plain")
public javax.ws.rs.core.Response remove(@PathParam("id")
 long workflowInstanceId,
 @QueryParam("force")
 boolean force)
                                 throws WorkflowException,
NotFoundException,
UnauthorizedException

Throws:

WorkflowException

NotFoundException

UnauthorizedException

suspend

@POST
@Path("suspend")
@Produces("text/xml")
public javax.ws.rs.core.Response suspend(@FormParam("id")
 long workflowInstanceId)
                                  throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

resume

@POST
@Path("resume")
@Produces("text/xml")
public javax.ws.rs.core.Response resume(@FormParam("id")
 long workflowInstanceId,
 @FormParam("properties")
 LocalHashMap properties)
                                 throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

resume

@POST
@Path("replaceAndresume")
@Produces("text/xml")
public javax.ws.rs.core.Response resume(@FormParam("id")
 long workflowInstanceId,
 @FormParam("mediapackage")
 String mediaPackage,
 @FormParam("properties")
 LocalHashMap properties)
                                 throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

update

@POST
@Path("update")
public javax.ws.rs.core.Response update(@FormParam("workflow")
 String workflowInstance)
                                 throws NotFoundException,
UnauthorizedException

Throws:

NotFoundException

UnauthorizedException

getOperationHandlers

@GET
@Path("handlers.json")
public javax.ws.rs.core.Response getOperationHandlers()

getStateMappings

@GET
@Path("statemappings.json")
public javax.ws.rs.core.Response getStateMappings()

cleanup

@Path("/cleanup")
public javax.ws.rs.core.Response cleanup(@FormParam("buffer")
 int buffer,
 @FormParam("state")
 String stateParam)
                                  throws UnauthorizedException

Throws:

UnauthorizedException

getService

public JobProducer getService()

Returns the job producer that is backing this REST endpoint.

Specified by:

getService in class AbstractJobProducerEndpoint

Returns:

the job producer

See Also:

• AbstractJobProducerEndpoint.getService()

getServiceRegistry

public ServiceRegistry getServiceRegistry()

Return the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducerEndpoint

See Also:

• AbstractJobProducerEndpoint.getServiceRegistry()