All Superinterfaces:: JAXRSService

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

REST operations for implementations.

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_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`javax.ws.rs.core.Response`	`create(@NotNull org.apache.syncope.common.lib.to.ImplementationTO implementationTO)`	Creates a new implementation.
`javax.ws.rs.core.Response`	`delete(@NotNull String type, @NotNull String key)`	Deletes the implementation matching the given key and type.
`List<org.apache.syncope.common.lib.to.ImplementationTO>`	`list(@NotNull String type)`	Returns a list of all implementations of the given type.
`org.apache.syncope.common.lib.to.ImplementationTO`	`read(@NotNull String type, @NotNull String key)`	Returns implementation with matching type and key.
`javax.ws.rs.core.Response`	`update(@NotNull org.apache.syncope.common.lib.to.ImplementationTO implementationTO)`	Updates an existing implementation.

Method Detail

list

@GET
@Path("{type}")
@Produces({"application/json","application/yaml","application/xml"})
List<org.apache.syncope.common.lib.to.ImplementationTO> list(@NotNull @PathParam("type")
                                                             @NotNull String type)

Returns a list of all implementations of the given type.

Parameters:: type - implementation type
Returns:: list of all implementations.

read

@GET
@Path("{type}/{key}")
@Produces({"application/json","application/yaml","application/xml"})
org.apache.syncope.common.lib.to.ImplementationTO read(@NotNull @PathParam("type")
                                                       @NotNull String type,
                                                       @NotNull @PathParam("key")
                                                       @NotNull 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("{type}/{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                 @NotNull org.apache.syncope.common.lib.to.ImplementationTO implementationTO)

Creates a new implementation.

Parameters:: implementationTO - implementation.
Returns:: Response object featuring Location header of created implementation

update

@PUT
@Path("{type}/{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response update(@NotNull
                                 @NotNull org.apache.syncope.common.lib.to.ImplementationTO implementationTO)

Updates an existing implementation.

Parameters:: implementationTO - implementation.
Returns:: an empty response if operation was successful

delete

@DELETE
@Path("{type}/{key}")
@Produces({"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response delete(@NotNull @PathParam("type")
                                 @NotNull String type,
                                 @NotNull @PathParam("key")
                                 @NotNull 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

Interface ImplementationService

Field Summary