org.apache.syncope.common.services

Interface WorkflowService

All Superinterfaces:

JAXRSService

@Path(value="workflows/{kind}")
public interface WorkflowService
extends JAXRSService

REST operations for workflow definition management.

Field Summary

Fields inherited from interface org.apache.syncope.common.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exportDefinition(SubjectType kind) Exports workflow definition for matching kind.
javax.ws.rs.core.Response	exportDiagram(SubjectType kind) Exports workflow diagram representation.
javax.ws.rs.core.Response	getOptions(SubjectType kind) Checks whether Activiti is enabled (for users or roles).
void	importDefinition(SubjectType kind, String definition) Imports workflow definition for matching kind.

Method Detail

getOptions

@OPTIONS
javax.ws.rs.core.Response getOptions(@NotNull@PathParam(value="kind")
                                           SubjectType kind)

Checks whether Activiti is enabled (for users or roles).

Parameters:

kind - user or role

Returns:

Response contains special syncope HTTP header indicating if Activiti is enabled for users / roles

See Also:

RESTHeaders.ACTIVITI_USER_ENABLED, RESTHeaders.ACTIVITI_ROLE_ENABLED

exportDefinition

@GET
@Produces(value={"application/xml","application/json"})
javax.ws.rs.core.Response exportDefinition(@NotNull@PathParam(value="kind")
                                                      SubjectType kind)

Exports workflow definition for matching kind.

Parameters:

kind - user or role

Returns:

workflow definition for matching kind

exportDiagram

@GET
@Path(value="diagram.png")
@Produces(value="image/png")
javax.ws.rs.core.Response exportDiagram(@NotNull@PathParam(value="kind")
                                                        SubjectType kind)

Exports workflow diagram representation.

Parameters:

kind - user or role

Returns:

workflow diagram representation

importDefinition

@PUT
@Consumes(value={"application/xml","application/json"})
void importDefinition(@NotNull@PathParam(value="kind")
                                 SubjectType kind,
                                 @NotNull
                                 String definition)

Imports workflow definition for matching kind.

Parameters:

kind - user or role

definition - workflow definition for matching kind