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

Interface AuthModuleService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

AuthModuleServiceImpl

@Path("authModules")
public interface AuthModuleService
extends JAXRSService

REST operations for authentication modules.

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

Modifier and Type	Method	Description
javax.ws.rs.core.Response	create(@NotNull AuthModuleTO authModuleTO)	Create a new authentication module.
void	delete(@NotNull String key)	Delete authentication module matching the given key.
List<AuthModuleTO>	list()	Returns a list of authentication modules.
AuthModuleTO	read(@NotNull String key)	Returns the authentication module matching the given key.
void	update(@NotNull AuthModuleTO authModuleTO)	Updates authentication module matching the given key.

Method Detail

read

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

Returns the authentication module matching the given key.

Parameters:

key - key of requested authentication module

Returns:

authentication module with matching id

list

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

Returns a list of authentication modules.

Returns:

list of authentication modules

create

@POST
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
javax.ws.rs.core.Response create(@NotNull
                                 @NotNull AuthModuleTO authModuleTO)

Create a new authentication module.

Parameters:

authModuleTO - AuthModule to be created.

Returns:

Response object featuring Location header of created authentication module

update

@PUT
@Path("{key}")
@Consumes({"application/json","application/yaml","application/xml"})
@Produces({"application/json","application/yaml","application/xml"})
void update(@NotNull
            @NotNull AuthModuleTO authModuleTO)

Updates authentication module matching the given key.

Parameters:

authModuleTO - AuthModule to replace existing authentication module

delete

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

Delete authentication module matching the given key.

Parameters:

key - key of authentication module to be deleted