Package org.keycloak.workflow.admin.resource

Class WorkflowResource

java.lang.Object

org.keycloak.workflow.admin.resource.WorkflowResource

public class WorkflowResource
extends Object

Constructor Summary

Constructors

Constructor	Description
WorkflowResource(WorkflowProvider provider, Workflow workflow)

Method Summary

Modifier and Type	Method	Description
void	activate(ResourceType type, String resourceId, String notBefore)	Activate the workflow for the resource.
void	activateAll(String notBefore)
void	deactivate(ResourceType type, String resourceId)	Deactivate the workflow for the resource.
void	delete()
WorkflowRepresentation	toRepresentation(Boolean includeId)
void	update(WorkflowRepresentation rep)	Update the workflow configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowResource

public WorkflowResource(WorkflowProvider provider,
 Workflow workflow)

Method Details

delete

@DELETE
public void delete()

update

@PUT
@Consumes({"application/yaml","application/json"})
public void update(WorkflowRepresentation rep)

Update the workflow configuration. The method does not update the workflow steps.

toRepresentation

@GET
@Produces({"application/yaml","application/json"})
public WorkflowRepresentation toRepresentation(@QueryParam("includeId")
 Boolean includeId)

activate

@POST
@Path("activate/{type}/{resourceId}")
public void activate(@PathParam("type")
 ResourceType type,
 @PathParam("resourceId")
 String resourceId,
 @QueryParam("notBefore")
 String notBefore)

Activate the workflow for the resource.

Parameters:

type - the resource type

resourceId - the resource id

notBefore - optional value representing the time to schedule the first workflow step, overriding the first step time configuration (after). The value is either an integer representing the seconds from now, an integer followed by 'ms' representing milliseconds from now, or an ISO-8601 date string.

activateAll

@POST
@Path("activate-all")
public void activateAll(@QueryParam("notBefore")
 String notBefore)

deactivate

@POST
@Consumes("application/json")
@Path("deactivate/{type}/{resourceId}")
public void deactivate(@PathParam("type")
 ResourceType type,
 @PathParam("resourceId")
 String resourceId)

Deactivate the workflow for the resource.

Parameters:

type - the resource type

resourceId - the resource id