org.apache.syncope.common.services

Interface SecurityQuestionService

All Superinterfaces:

JAXRSService

@Path(value="securityQuestions")
public interface SecurityQuestionService
extends JAXRSService

REST operations for configuration.

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
javax.ws.rs.core.Response	create(SecurityQuestionTO securityQuestionTO) Creates a new security question.
void	delete(Long securityQuestionId) Deletes the security question matching the provided id.
List<SecurityQuestionTO>	list() Returns a list of all security questions.
SecurityQuestionTO	read(Long securityQuestionId) Returns security question with matching id.
SecurityQuestionTO	readByUser(String username) Ask for security question configured for the user matching the given username, if any.
void	update(Long securityQuestionId, SecurityQuestionTO securityQuestionTO) Updates the security question matching the provided id.

Method Detail

list

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

Returns a list of all security questions.

Returns:

list of all security questions

read

@GET
@Path(value="{securityQuestionId}")
@Produces(value={"application/xml","application/json"})
SecurityQuestionTO read(@NotNull@PathParam(value="securityQuestionId")
                                        Long securityQuestionId)

Returns security question with matching id.

Parameters:

securityQuestionId - security question id to be read

Returns:

security question with matching id

create

@POST
@Consumes(value={"application/xml","application/json"})
javax.ws.rs.core.Response create(@NotNull
                                             SecurityQuestionTO securityQuestionTO)

Creates a new security question.

Parameters:

securityQuestionTO - security question to be created

Returns:

Response object featuring Location header of created security question

update

@PUT
@Path(value="{securityQuestionId}")
@Consumes(value={"application/xml","application/json"})
void update(@NotNull@PathParam(value="securityQuestionId")
                            Long securityQuestionId,
                            @NotNull
                            SecurityQuestionTO securityQuestionTO)

Updates the security question matching the provided id.

Parameters:

securityQuestionId - security question id to be updated

securityQuestionTO - security question to be stored

delete

@DELETE
@Path(value="{securityQuestionId}")
void delete(@NotNull@PathParam(value="securityQuestionId")
                      Long securityQuestionId)

Deletes the security question matching the provided id.

Parameters:

securityQuestionId - security question id to be deleted

readByUser

@GET
@Path(value="byUser/{username}")
@Produces(value={"application/xml","application/json"})
@Consumes(value={"application/xml","application/json"})
SecurityQuestionTO readByUser(@NotNull@PathParam(value="username")
                                                       String username)

Ask for security question configured for the user matching the given username, if any.

Parameters:

username - username for which the security question is requested

Returns:

security question, if configured for the user matching the given username