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
static void	actionJob(String refKey, JobAction jobAction)
Map<String,String>	batch(BatchRequest batchRequest)
static int	count(String resource, TaskType kind)
static int	count(AnyTypeKind anyTypeKind, String entityKey, String notification)
static int	count(AnyTypeKind anyTypeKind, String entityKey, TaskType kind)
static int	count(TaskType kind)
int	countExecutions(String taskKey)
static void	create(TaskType type, SchedTaskTO taskTO)
static void	delete(TaskType type, String taskKey)
void	deleteExecution(String taskExecKey)
static JobTO	getJob(String key)
static <T extends TaskTO> List<T>	list(String resource, TaskType taskType, int page, int size, SortParam<String> sort)
static <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)
static List<JobTO>	listJobs()
static List<NotificationTaskTO>	listNotificationTasks(String notification, AnyTypeKind anyTypeKind, String entityKey, int page, int size, SortParam<String> sort)
static List<PropagationTaskTO>	listPropagationTasks(String resource, int page, int size, SortParam<String> sort)
static List<PropagationTaskTO>	listPropagationTasks(AnyTypeKind anyTypeKind, String entityKey, int page, int size, SortParam<String> sort)
List<ExecTO>	listRecentExecutions(int max)
static NotificationTaskTO	readNotificationTask(String taskKey)
static PropagationTaskTO	readPropagationTask(String taskKey)
static <T extends TaskTO> T	readTask(TaskType type, String taskKey)
void	startExecution(String taskKey, Date startAt)
static void	startExecution(String taskKey, Date startAt, boolean dryRun)
static 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 Detail

TaskRestClient

public TaskRestClient()

Method Detail

getJob

public static JobTO getJob(String key)

listJobs

public static List<JobTO> listJobs()

actionJob

public static void actionJob(String refKey,
                             JobAction jobAction)

count

public static int count(TaskType kind)

count

public static int count(String resource,
                        TaskType kind)

count

public static int count(AnyTypeKind anyTypeKind,
                        String entityKey,
                        TaskType kind)

count

public static int count(AnyTypeKind anyTypeKind,
                        String entityKey,
                        String notification)

countExecutions

public int countExecutions(String taskKey)

Specified by:

countExecutions in interface ExecutionRestClient

listPropagationTasks

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

listPropagationTasks

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

listNotificationTasks

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

list

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

list

public static <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 static PropagationTaskTO readPropagationTask(String taskKey)

readNotificationTask

public static NotificationTaskTO readNotificationTask(String taskKey)

readTask

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

delete

public static void delete(TaskType type,
                          String taskKey)

startExecution

public void startExecution(String taskKey,
                           Date startAt)

Specified by:

startExecution in interface ExecutionRestClient

startExecution

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

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 static void create(TaskType type,
                          SchedTaskTO taskTO)

update

public static void update(TaskType type,
                          SchedTaskTO taskTO)

batch

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

Specified by:

batch in interface ExecutionRestClient