/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.syncope.common.rest.api.service;
import java.util.List;
import javax.validation.constraints.NotNull;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.apache.syncope.common.lib.to.SecurityQuestionTO;
/**
* REST operations for configuration.
*/
@Path("securityQuestions")
public interface SecurityQuestionService extends JAXRSService {
/**
* Returns a list of all security questions.
*
* @return list of all security questions
*/
@GET
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
List<SecurityQuestionTO> list();
/**
* Returns security question with matching key.
*
* @param key security question key to be read
* @return security question with matching key
*/
@GET
@Path("{key}")
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
SecurityQuestionTO read(@NotNull @PathParam("key") String key);
/**
* Creates a new security question.
*
* @param securityQuestionTO security question to be created
* @return Response object featuring Location header of created security question
*/
@POST
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
Response create(@NotNull SecurityQuestionTO securityQuestionTO);
/**
* Updates the security question matching the provided key.
*
* @param securityQuestionTO security question to be stored
*/
@PUT
@Path("{key}")
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
void update(@NotNull SecurityQuestionTO securityQuestionTO);
/**
* Deletes the security question matching the provided key.
*
* @param key security question key to be deleted
*/
@DELETE
@Path("{key}")
void delete(@NotNull @PathParam("key") String key);
/**
* Ask for security question configured for the user matching the given username, if any.
*
* @param username username for which the security question is requested
* @return security question, if configured for the user matching the given username
*/
@GET
@Path("byUser/{username}")
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
SecurityQuestionTO readByUser(@NotNull @PathParam("username") String username);
}