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

Interface ConnectorHistoryService

All Superinterfaces:

JAXRSService

@Path(value="connectorsHistory")
public interface ConnectorHistoryService
extends JAXRSService

REST operations for connector configuration versioning.

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	delete(String key) Deletes the connector configuration history instance matching the provided key.
List<ConnInstanceHistoryConfTO>	list(String connectorKey) Returns a list of all connector configuration history instances for the given connector instance key.
void	restore(String key) Restores the connector configuration history instance matching the provided key.

Method Detail

list

@GET
 @Path(value="{connectorKey}")
 @Produces(value={"application/json","application/xml"})
List<ConnInstanceHistoryConfTO> list(@NotNull @PathParam(value="connectorKey")
                                                                                                                                  String connectorKey)

Returns a list of all connector configuration history instances for the given connector instance key.

Parameters:

connectorKey - connector instance key

Returns:

list of all connector configuration history instances for the given connector instance key

restore

@POST
 @Path(value="{key}")
 @Produces(value={"application/json","application/xml"})
void restore(@NotNull @PathParam(value="key")
                                                                                                  String key)

Restores the connector configuration history instance matching the provided key.

Parameters:

key - connector configuration history instance key to be restored

delete

@DELETE
 @Path(value="{key}")
 @Produces(value={"application/json","application/xml"})
void delete(@NotNull @PathParam(value="key")
                                                                                                   String key)

Deletes the connector configuration history instance matching the provided key.

Parameters:

key - connector configuration history instance key to be deleted