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

Interface ResourceService

All Superinterfaces:

JAXRSService

@Path(value="resources")
public interface ResourceService
extends JAXRSService

REST operations for external resources.

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
BulkActionResult	bulkDeassociation(ResourceDeassociationPatch patch) De-associate any objects from the given resource.
void	check(ResourceTO resourceTO) Checks whether the connection to resource could be established.
javax.ws.rs.core.Response	create(ResourceTO resourceTO) Creates a new resource.
void	delete(String key) Deletes the resource matching the given name.
List<ResourceTO>	list() Returns a list of all resources.
PagedConnObjectTOResult	listConnObjects(String key, String anyTypeKey, ConnObjectTOListQuery listQuery) Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.
ResourceTO	read(String key) Returns the resource with matching name.
ConnObjectTO	readConnObject(String key, String anyTypeKey, String anyKey) Returns connector object from the external resource, for the given type and key.
void	removeSyncToken(String key, String anyTypeKey) Removes the sync token value associated to the given any type from the given resource.
void	setLatestSyncToken(String key, String anyTypeKey) Queries the connector underlying the given resource for the latest sync token value associated to the given any type and stores the value internally, for later usage.
void	update(ResourceTO resourceTO) Updates the resource matching the given name.

Method Detail

readConnObject

@GET
 @Path(value="{key}/{anyTypeKey}/{anyKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
ConnObjectTO readConnObject(@NotNull @PathParam(value="key")
                                                                                                                                                         String key,
                                                                                                                                                         @NotNull @PathParam(value="anyTypeKey")
                                                                                                                                                         String anyTypeKey,
                                                                                                                                                         @NotNull @PathParam(value="anyKey")
                                                                                                                                                         String anyKey)

Returns connector object from the external resource, for the given type and key.

Parameters:

key - name of resource to read connector object from

anyTypeKey - any object type

anyKey - any object key

Returns:

connector object from the external resource, for the given type and key

listConnObjects

@GET
 @Path(value="{key}/{anyTypeKey}")
 @Produces(value={"application/json","application/yaml","application/xml"})
PagedConnObjectTOResult listConnObjects(@NotNull @PathParam(value="key")
                                                                                                                                                            String key,
                                                                                                                                                            @NotNull @PathParam(value="anyTypeKey")
                                                                                                                                                            String anyTypeKey,
                                                                                                                                                            @BeanParam
                                                                                                                                                            ConnObjectTOListQuery listQuery)

Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.

Parameters:

key - name of resource to read connector object from

anyTypeKey - any object type

listQuery - query conditions

Returns:

connector objects from the external resource, for the given type

read

@GET
 @Path(value="{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
ResourceTO read(@NotNull @PathParam(value="key")
                                                                                                                       String key)

Returns the resource with matching name.

Parameters:

key - Name of resource to be read

Returns:

resource with matching name

list

@GET
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ResourceTO> list()

Returns a list of all resources.

Returns:

list of all resources

create

@POST
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                               ResourceTO resourceTO)

Creates a new resource.

Parameters:

resourceTO - Resource to be created

Returns:

Response object featuring Location header of created resource

update

@PUT
 @Path(value="{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
void update(@NotNull
                                                                                                                                                                                               ResourceTO resourceTO)

Updates the resource matching the given name.

Parameters:

resourceTO - resource to be stored

setLatestSyncToken

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

Queries the connector underlying the given resource for the latest sync token value associated to the given any type and stores the value internally, for later usage.

Parameters:

key - resource

anyTypeKey - any type

removeSyncToken

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

Removes the sync token value associated to the given any type from the given resource.

Parameters:

key - resource

anyTypeKey - any type

delete

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

Deletes the resource matching the given name.

Parameters:

key - name of resource to be deleted

check

@POST
 @Path(value="check")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
void check(@NotNull
                                                                                                                                                                                               ResourceTO resourceTO)

Checks whether the connection to resource could be established.

Parameters:

resourceTO - resource to be checked

bulkDeassociation

@POST
 @Path(value="{key}/bulkDeassociation/{anyTypeKey}/{action}")
 @Produces(value={"application/json","application/yaml","application/xml"})
 @Consumes(value={"application/json","application/yaml","application/xml"})
BulkActionResult bulkDeassociation(@NotNull
                                                                                                                                                                                                                                                               ResourceDeassociationPatch patch)

De-associate any objects from the given resource.

Parameters:

patch - any objects to be used for propagation-related operations

Returns:

Bulk action result