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

Interface ImplementationService

All Superinterfaces:

JAXRSService

@Path(value="implementations")
public interface ImplementationService
extends JAXRSService

REST operations for implementations.

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
javax.ws.rs.core.Response	create(ImplementationTO implementationTO) Creates a new implementation.
javax.ws.rs.core.Response	delete(ImplementationType type, String key) Deletes the implementation matching the given key and type.
List<ImplementationTO>	list(ImplementationType type) Returns a list of all implementations of the given type.
ImplementationTO	read(ImplementationType type, String key) Returns implementation with matching type and key.
javax.ws.rs.core.Response	update(ImplementationTO implementationTO) Updates an existing implementation.

Method Detail

list

@GET
 @Path(value="{type}")
 @Produces(value={"application/json","application/yaml","application/xml"})
List<ImplementationTO> list(@NotNull @PathParam(value="type")
                                                                                                                                    ImplementationType type)

Returns a list of all implementations of the given type.

Parameters:

type - implementation type

Returns:

list of all implementations.

read

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

Returns implementation with matching type and key.

Parameters:

type - implementation type

key - key of implementation to be read

Returns:

implementation with matching key

create

@POST
 @Path(value="{type}/{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                                                                                                                                                                                                            ImplementationTO implementationTO)

Creates a new implementation.

Parameters:

implementationTO - implementation.

Returns:

Response object featuring Location header of created implementation

update

@PUT
 @Path(value="{type}/{key}")
 @Consumes(value={"application/json","application/yaml","application/xml"})
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response update(@NotNull
                                                                                                                                                                                                                           ImplementationTO implementationTO)

Updates an existing implementation.

Parameters:

implementationTO - implementation.

Returns:

an empty response if operation was successful

delete

@DELETE
 @Path(value="{type}/{key}")
 @Produces(value={"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response delete(@NotNull @PathParam(value="type")
                                                                                                                                                  ImplementationType type,
                                                                                                                                                  @NotNull @PathParam(value="key")
                                                                                                                                                  String key)

Deletes the implementation matching the given key and type.

Parameters:

type - implementation type

key - key for implementation to be deleted

Returns:

an empty response if operation was successful