org.apache.syncope.common.services

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.services.JAXRSService

DEFAULT_PARAM_PAGE, DEFAULT_PARAM_PAGE_VALUE, DEFAULT_PARAM_SIZE, DEFAULT_PARAM_SIZE_VALUE, PARAM_DETAILS, PARAM_FIQL, PARAM_ORDERBY, PARAM_PAGE, PARAM_SIZE

Method Summary

Methods

Modifier and Type	Method and Description
BulkActionResult	bulk(BulkAction bulkAction) Executes the provided bulk action.
BulkActionResult	bulkDeassociation(String resourceName, SubjectType subjectType, ResourceDeassociationActionType type, List<SubjectId> subjectIds) De-associate users or roles (depending on the provided subject type) from the given resource.
boolean	check(ResourceTO resourceTO) Checks wether the connection to resource could be established.
javax.ws.rs.core.Response	create(ResourceTO resourceTO) Creates a new resource.
void	delete(String resourceName) Deletes the resource matching the given name.
ConnObjectTO	getConnectorObject(String resourceName, SubjectType type, Long id) Returns connector object from the external resource, for the given type and id.
List<PropagationActionClass>	getPropagationActionsClasses() Returns a list of classes that can be used to customize the propagation process.
List<ResourceTO>	list() Returns a list of all resources.
ResourceTO	read(String resourceName) Returns the resource with matching name.
void	update(String resourceName, ResourceTO resourceTO) Updates the resource matching the given name.

Method Detail

getConnectorObject

@GET
@Path(value="{resourceName}/{type}/{id}")
@Produces(value={"application/xml","application/json"})
ConnObjectTO getConnectorObject(@NotNull@PathParam(value="resourceName")
                                                String resourceName,
                                                @NotNull@PathParam(value="type")
                                                SubjectType type,
                                                @NotNull@PathParam(value="id")
                                                Long id)

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

Parameters:

resourceName - Name of resource to read connector object from

type - user / role

id - user id / role id

Returns:

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

getPropagationActionsClasses

@GET
@Path(value="propagationActionsClasses")
@Produces(value={"application/xml","application/json"})
List<PropagationActionClass> getPropagationActionsClasses()

Returns a list of classes that can be used to customize the propagation process.

Returns:

list of classes that can be used to customize the propagation process

read

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

Returns the resource with matching name.

Parameters:

resourceName - Name of resource to be read

Returns:

resource with matching name

list

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

Returns a list of all resources.

Returns:

list of all resources

create

@POST
@Consumes(value={"application/xml","application/json"})
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="{resourceName}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="resourceName")
                            String resourceName,
                            @NotNull
                            ResourceTO resourceTO)

Updates the resource matching the given name.

Parameters:

resourceName - name of resource to be updated

resourceTO - resource to be stored

delete

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

Deletes the resource matching the given name.

Parameters:

resourceName - name of resource to be deleted

check

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

Checks wether the connection to resource could be established.

Parameters:

resourceTO - resource to be checked

Returns:

true if connection to resource could be established

bulkDeassociation

@POST
@Path(value="{resourceName}/bulkDeassociation/{subjType}/{type}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulkDeassociation(@NotNull@PathParam(value="resourceName")
                                                             String resourceName,
                                                             @NotNull@PathParam(value="subjType")
                                                             SubjectType subjectType,
                                                             @NotNull@PathParam(value="type")
                                                             ResourceDeassociationActionType type,
                                                             @NotNull
                                                             List<SubjectId> subjectIds)

De-associate users or roles (depending on the provided subject type) from the given resource.

Parameters:

resourceName - name of resource

subjectType - subject type (user or role)

type - resource de-association action type

subjectIds - users or roles against which the bulk action will be performed

Returns:

Response object featuring BulkActionResult as Entity

bulk

@POST
@Path(value="bulk")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
BulkActionResult bulk(@NotNull
                                                BulkAction bulkAction)

Executes the provided bulk action.

Parameters:

bulkAction - list of resource names against which the bulk action will be performed

Returns:

Bulk action result