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

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
void	check(@NotNull ResourceTO resourceTO) Checks whether the connection to resource could be established.
javax.ws.rs.core.Response	create(@NotNull ResourceTO resourceTO) Creates a new resource.
void	delete(@NotNull String key) Deletes the resource matching the given name.
javax.ws.rs.core.Response	getConnObjectKeyValue(@NotNull String key, @NotNull String anyTypeKey, @NotNull String anyKey) Returns the calculated connObjectKey value for the given type and key.
List<ResourceTO>	list() Returns a list of all resources.
ResourceTO	read(@NotNull String key) Returns the resource with matching name.
ConnObjectTO	readConnObject(@NotNull String key, @NotNull String anyTypeKey, @NotNull String value) Returns connector object from the external resource, for the given type and key.
void	removeSyncToken(@NotNull String key, @NotNull String anyTypeKey) Removes the sync token value associated to the given any type from the given resource.
PagedConnObjectTOResult	searchConnObjects(@NotNull String key, @NotNull String anyTypeKey, ConnObjectTOQuery connObjectTOQuery) Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.
void	setLatestSyncToken(@NotNull String key, @NotNull 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(@NotNull ResourceTO resourceTO) Updates the resource matching the given name.

Method Detail

getConnObjectKeyValue

@OPTIONS
 @Path(value="{key}/{anyTypeKey}/{anyKey}")
javax.ws.rs.core.Response getConnObjectKeyValue(@NotNull @PathParam(value="key")
                                                                                                     @NotNull String key,
                                                                                                     @NotNull @PathParam(value="anyTypeKey")
                                                                                                     @NotNull String anyTypeKey,
                                                                                                     @NotNull @PathParam(value="anyKey")
                                                                                                     @NotNull String anyKey)

Returns the calculated connObjectKey value for the given type and key.

Parameters:

key - name of resource to read connector object from

anyTypeKey - any object type

anyKey - user, group or any object key

Returns:

connObjectKey value for the external resource, for the given type and key

readConnObject

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

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

value - if value looks like a UUID then it is interpreted as user, group or any object key, otherwise as key value on the resource

Returns:

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

searchConnObjects

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

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

connObjectTOQuery - 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")
                                                                                                                       @NotNull 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
                                                                                                                                                                                               @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
                                                                                                                                                                                               @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")
                                                                                                                                             @NotNull String key,
                                                                                                                                             @NotNull @PathParam(value="anyTypeKey")
                                                                                                                                             @NotNull 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")
                                                                                                                                            @NotNull String key,
                                                                                                                                            @NotNull @PathParam(value="anyTypeKey")
                                                                                                                                            @NotNull 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")
                                                                                                                                                                                                  @NotNull 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
                                                                                                                                                                                               @NotNull ResourceTO resourceTO)

Checks whether the connection to resource could be established.

Parameters:

resourceTO - resource to be checked