org.apache.syncope.common.rest.api.service

Interface ReconciliationService

All Superinterfaces:

JAXRSService

@Path(value="reconciliation")
public interface ReconciliationService
extends JAXRSService

REST operations for tasks.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

PARAM_ANYTYPE_KIND, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_RESOURCE, PARAM_SIZE

Method Summary

Modifier and Type	Method and Description
void	pull(AnyTypeKind anyTypeKind, String anyKey, String resourceKey, PullTaskTO pullTask) Pulls the given user, group or any object from the External Resource into Syncope.
void	push(AnyTypeKind anyTypeKind, String anyKey, String resourceKey, PushTaskTO pushTask) Pushes the given user, group or any object in Syncope onto the External Resource.
ReconStatus	status(AnyTypeKind anyTypeKind, String anyKey, String resourceKey) Gets current attributes on Syncope and on the given External Resource, related to given user, group or any object.

Method Detail

status

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
ReconStatus status(@NotNull @QueryParam(value="anyTypeKind")
                                                                                                    AnyTypeKind anyTypeKind,
                                                                                                    @NotNull @QueryParam(value="anyKey")
                                                                                                    String anyKey,
                                                                                                    @NotNull @QueryParam(value="resourceKey")
                                                                                                    String resourceKey)

Gets current attributes on Syncope and on the given External Resource, related to given user, group or any object.

Parameters:

anyTypeKind - anyTypeKind

anyKey - user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)name

resourceKey - resource key

Returns:

reconciliation status

push

@POST
 @Path(value="push")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void push(@NotNull @QueryParam(value="anyTypeKind")
                                                                                                                                                                                             AnyTypeKind anyTypeKind,
                                                                                                                                                                                             @NotNull @QueryParam(value="anyKey")
                                                                                                                                                                                             String anyKey,
                                                                                                                                                                                             @NotNull @QueryParam(value="resourceKey")
                                                                                                                                                                                             String resourceKey,
                                                                                                                                                                                             @NotNull
                                                                                                                                                                                             PushTaskTO pushTask)

Pushes the given user, group or any object in Syncope onto the External Resource.

Parameters:

anyTypeKind - anyTypeKind

anyKey - user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)name

resourceKey - resource key

pushTask - push specification

pull

@POST
 @Path(value="pull")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void pull(@NotNull @QueryParam(value="anyTypeKind")
                                                                                                                                                                                             AnyTypeKind anyTypeKind,
                                                                                                                                                                                             @NotNull @QueryParam(value="anyKey")
                                                                                                                                                                                             String anyKey,
                                                                                                                                                                                             @NotNull @QueryParam(value="resourceKey")
                                                                                                                                                                                             String resourceKey,
                                                                                                                                                                                             @NotNull
                                                                                                                                                                                             PullTaskTO pullTask)

Pulls the given user, group or any object from the External Resource into Syncope.

Parameters:

anyTypeKind - anyTypeKind

anyKey - user, group or any object: if value looks like a UUID then it is interpreted as key, otherwise as a (user)name

resourceKey - resource key

pullTask - pull specification