Package org.apache.syncope.client.console.rest

Class TaskRestClient

java.lang.Object

org.apache.syncope.client.console.rest.BaseRestClient

org.apache.syncope.client.console.rest.TaskRestClient

All Implemented Interfaces:

Serializable, ExecutionRestClient, RestClient

public class TaskRestClient
extends BaseRestClient
implements ExecutionRestClient

Console client for invoking Rest Tasks services.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.syncope.client.console.rest.BaseRestClient

LOG

Constructor Summary

Constructors

Constructor	Description
TaskRestClient()

Method Summary

Modifier and Type	Method	Description
void	actionJob(String refKey, JobAction jobAction)
Map<String,String>	batch(BatchRequest batchRequest)
long	count(String resource, TaskType kind)
long	count(AnyTypeKind anyTypeKind, String entityKey, String notification)
long	count(AnyTypeKind anyTypeKind, String entityKey, TaskType kind)
long	count(TaskType kind)
long	countExecutions(String taskKey)
void	create(TaskType type, SchedTaskTO taskTO)
void	delete(TaskType type, String taskKey)
void	deleteExecution(String taskExecKey)
JobTO	getJob(String key)
SyncopeForm	getMacroTaskForm(String taskKey)
<T extends TaskTO> List<T>	list(String resource, TaskType taskType, int page, int size, SortParam<String> sort)
<T extends TaskTO> List<T>	list(TaskType taskType, int page, int size, SortParam<String> sort)
List<ExecTO>	listExecutions(String taskKey, int page, int size, SortParam<String> sort)
List<JobTO>	listJobs()
List<NotificationTaskTO>	listNotificationTasks(String notification, AnyTypeKind anyTypeKind, String entityKey, int page, int size, SortParam<String> sort)
List<PropagationTaskTO>	listPropagationTasks(String resource, int page, int size, SortParam<String> sort)
List<PropagationTaskTO>	listPropagationTasks(AnyTypeKind anyTypeKind, String entityKey, int page, int size, SortParam<String> sort)
List<ExecTO>	listRecentExecutions(int max)
NotificationTaskTO	readNotificationTask(String taskKey)
PropagationTaskTO	readPropagationTask(String taskKey)
<T extends TaskTO> T	readTask(TaskType type, String taskKey)
void	startExecution(String taskKey, Date startAt)
void	startExecution(String taskKey, Date startAt, boolean dryRun)
void	startExecution(String taskKey, Date startAt, boolean dryRun, SyncopeForm macroTaskForm)
void	update(TaskType type, SchedTaskTO taskTO)

Methods inherited from class org.apache.syncope.client.console.rest.BaseRestClient

getObject, getService, getService, getStatus, getSyncopeService, resetClient, toOrderBy

Methods inherited from class java.lang.Object

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

Constructor Details

TaskRestClient

public TaskRestClient()

Method Details

getJob

public JobTO getJob(String key)

listJobs

public List<JobTO> listJobs()

actionJob

public void actionJob(String refKey,
 JobAction jobAction)

count

public long count(TaskType kind)

count

public long count(String resource,
 TaskType kind)

count

public long count(AnyTypeKind anyTypeKind,
 String entityKey,
 TaskType kind)

count

public long count(AnyTypeKind anyTypeKind,
 String entityKey,
 String notification)

countExecutions

public long countExecutions(String taskKey)

Specified by:

countExecutions in interface ExecutionRestClient

listPropagationTasks

public List<PropagationTaskTO> listPropagationTasks(String resource,
 int page,
 int size,
 SortParam<String> sort)

listPropagationTasks

public List<PropagationTaskTO> listPropagationTasks(AnyTypeKind anyTypeKind,
 String entityKey,
 int page,
 int size,
 SortParam<String> sort)

listNotificationTasks

public List<NotificationTaskTO> listNotificationTasks(String notification,
 AnyTypeKind anyTypeKind,
 String entityKey,
 int page,
 int size,
 SortParam<String> sort)

list

public <T extends TaskTO> List<T> list(TaskType taskType,
 int page,
 int size,
 SortParam<String> sort)

list

public <T extends TaskTO> List<T> list(String resource,
 TaskType taskType,
 int page,
 int size,
 SortParam<String> sort)

listExecutions

public List<ExecTO> listExecutions(String taskKey,
 int page,
 int size,
 SortParam<String> sort)

Specified by:

listExecutions in interface ExecutionRestClient

readPropagationTask

public PropagationTaskTO readPropagationTask(String taskKey)

readNotificationTask

public NotificationTaskTO readNotificationTask(String taskKey)

readTask

public <T extends TaskTO> T readTask(TaskType type,
 String taskKey)

getMacroTaskForm

public SyncopeForm getMacroTaskForm(String taskKey)

delete

public void delete(TaskType type,
 String taskKey)

startExecution

public void startExecution(String taskKey,
 Date startAt)

Specified by:

startExecution in interface ExecutionRestClient

startExecution

public void startExecution(String taskKey,
 Date startAt,
 boolean dryRun)

startExecution

public void startExecution(String taskKey,
 Date startAt,
 boolean dryRun,
 SyncopeForm macroTaskForm)

deleteExecution

public void deleteExecution(String taskExecKey)

Specified by:

deleteExecution in interface ExecutionRestClient

listRecentExecutions

public List<ExecTO> listRecentExecutions(int max)

Specified by:

listRecentExecutions in interface ExecutionRestClient

create

public void create(TaskType type,
 SchedTaskTO taskTO)

update

public void update(TaskType type,
 SchedTaskTO taskTO)

batch

public Map<String,String> batch(BatchRequest batchRequest)

Specified by:

batch in interface ExecutionRestClient