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

Interface PasswordManagementService

All Superinterfaces:

JAXRSService

All Known Implementing Classes:

PasswordManagementServiceImpl

@Path("passwordManagement")
public interface PasswordManagementService
extends JAXRSService

REST operations for password management 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
Response	create(@NotNull PasswordManagementTO passwordManagementTO)	Create a new password management module.
void	delete(@NotNull String key)	Delete password management module matching the given key.
List<PasswordManagementTO>	list()	Returns a list of password management modules.
PasswordManagementTO	read(@NotNull String key)	Returns the password management module matching the given key.
void	update(@NotNull PasswordManagementTO passwordManagementTO)	Updates password management module matching the given key.

Method Details

read

@GET
@Path("{key}")
@Produces("application/json")
PasswordManagementTO read(@NotNull @PathParam("key")
 @NotNull String key)

Returns the password management module matching the given key.

Parameters:

key - key of requested password management module

Returns:

password management module with matching id

list

@GET
@Produces("application/json")
List<PasswordManagementTO> list()

Returns a list of password management modules.

Returns:

list of password management modules

create

@POST
@Consumes("application/json")
@Produces("application/json")
Response create(@NotNull
 @NotNull PasswordManagementTO passwordManagementTO)

Create a new password management module.

Parameters:

passwordManagementTO - PasswordManagement to be created.

Returns:

Response object featuring Location header of created password management module

update

@PUT
@Path("{key}")
@Consumes("application/json")
@Produces("application/json")
void update(@NotNull
 @NotNull PasswordManagementTO passwordManagementTO)

Updates password management module matching the given key.

Parameters:

passwordManagementTO - PasswordManagement to replace existing password management module

delete

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

Delete password management module matching the given key.

Parameters:

key - key of password management module to be deleted