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

Interface ReconciliationService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

ReconciliationServiceImpl

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

REST operations for reconciliation.

Field Summary

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

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method and Description
List<ProvisioningReport>	pull(CSVPullSpec spec, InputStream csv) Pulls the CSV input into Syncope according to the provided specification.
List<ProvisioningReport>	pull(ReconQuery query, @NotNull PullTaskTO pullTask) Pulls the matching user, group, any object or linked account from the External Resource into Syncope.
javax.ws.rs.core.Response	push(AnyQuery anyQuery, CSVPushSpec spec) Export a list of any objects matching the given query as CSV according to the provided specification.
List<ProvisioningReport>	push(ReconQuery query, @NotNull PushTaskTO pushTask) Pushes the matching user, group, any object or linked account in Syncope onto the External Resource.
ReconStatus	status(ReconQuery query) Gets compared status between attributes in Syncope and on the given External Resource.

Method Detail

status

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
ReconStatus status(@BeanParam
                                                                                                    ReconQuery query)

Gets compared status between attributes in Syncope and on the given External Resource.

Parameters:

query - query conditions

Returns:

reconciliation status

push

@POST
 @Path(value="push")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ProvisioningReport> push(@BeanParam
                                                                                                                                                                                                                 ReconQuery query,
                                                                                                                                                                                                                 @NotNull
                                                                                                                                                                                                                 @NotNull PushTaskTO pushTask)

Pushes the matching user, group, any object or linked account in Syncope onto the External Resource.

Parameters:

query - query conditions

pushTask - push specification

Returns:

push report

pull

@POST
 @Path(value="pull")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ProvisioningReport> pull(@BeanParam
                                                                                                                                                                                                                 ReconQuery query,
                                                                                                                                                                                                                 @NotNull
                                                                                                                                                                                                                 @NotNull PullTaskTO pullTask)

Pulls the matching user, group, any object or linked account from the External Resource into Syncope.

Parameters:

query - query conditions

pullTask - pull specification

Returns:

pull report

push

@GET
 @Path(value="csv/push")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value="text/csv")
javax.ws.rs.core.Response push(@BeanParam
                                                                                                                                                                      AnyQuery anyQuery,
                                                                                                                                                                      @BeanParam
                                                                                                                                                                      CSVPushSpec spec)

Export a list of any objects matching the given query as CSV according to the provided specification.

Parameters:

anyQuery - query conditions

spec - CSV push specification

Returns:

CSV content matching the provided specification

pull

@POST
 @Path(value="csv/pull")
 @Consumes(value="text/csv")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ProvisioningReport> pull(@BeanParam
                                                                                                                                                                      CSVPullSpec spec,
                                                                                                                                                                      InputStream csv)

Pulls the CSV input into Syncope according to the provided specification.

Parameters:

spec - CSV pull specification

csv - CSV input

Returns:

pull report