com.formkiq.server.api.FolderFilesController Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of formkiq-server Show documentation
Show all versions of formkiq-server Show documentation
Server-side integration for the FormKiQ ios application
/*
* Copyright (C) 2016 FormKiQ Inc.
*
* Licensed 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 com.formkiq.server.api;
import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR;
import static javax.servlet.http.HttpServletResponse.SC_NOT_FOUND;
import static javax.servlet.http.HttpServletResponse.SC_OK;
import static javax.servlet.http.HttpServletResponse.SC_UNAUTHORIZED;
import static org.springframework.web.bind.annotation.RequestMethod.GET;
import static org.springframework.web.bind.annotation.RequestMethod.POST;
import java.io.IOException;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.transaction.Transactional;
import org.apache.commons.io.IOUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpEntity;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import com.formkiq.server.domain.type.FolderFormStatus;
import com.formkiq.server.domain.type.FolderFormsListDTO;
import com.formkiq.server.domain.type.FormDTO;
import com.formkiq.server.domain.type.FormOrderByField;
import com.formkiq.server.domain.type.SortDirection;
import com.formkiq.server.service.FolderService;
import com.formkiq.server.service.PreconditionFailedException;
import com.formkiq.server.service.SpringSecurityService;
import com.formkiq.server.util.Strings;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
/**
* FoldersController rest services.
*
*/
@RestController
public class FolderFilesController extends AbstractRestController {
/** Root URI. */
private static final String ROOT = "/api/folders/files";
/** GET Folder File url. */
public static final String API_FOLDER_FILE_GET = ROOT + "/get";
/** SYNC url. */
public static final String API_FOLDER_FILE_SAVE = ROOT + "/save";
/** LIST url. */
public static final String API_FOLDER_FILE_LIST = ROOT + "/list";
/** DELETE Folder File url. */
public static final String API_FOLDER_FILE_DELETE = ROOT + "/delete";
/** FolderService. */
@Autowired
private FolderService folderservice;
/** SpringSecurityService. */
@Autowired
private SpringSecurityService securityService;
/**
* Deletes a Folder File.
* @param request {@link HttpServletRequest}
* @param folder {@link String}
* @param parentuuid {@link String}
* @param uuid {@link String}
* @return {@link ApiMessageResponse}
*/
@ApiOperation(value = "delete", nickname = "Folder File Delete")
@ApiResponses(value = {
@ApiResponse(code = SC_OK, message = "Success",
response = ApiMessageResponse.class),
@ApiResponse(code = SC_UNAUTHORIZED, message = "Unauthorized"),
@ApiResponse(code = SC_FORBIDDEN, message = "Forbidden"),
@ApiResponse(code = SC_NOT_FOUND, message = "Not Found"),
@ApiResponse(code = SC_INTERNAL_SERVER_ERROR,
message = "Failure") })
@Transactional
@RequestMapping(value = API_FOLDER_FILE_DELETE, method = POST)
public ApiMessageResponse delete(
final HttpServletRequest request,
@RequestParam(value = "folder", required = true)
final String folder,
@RequestParam(value = "parent_uuid", required = false)
final String parentuuid,
@RequestParam(value = "uuid", required = false)
final String uuid) {
getApiVersion(request);
UserDetails user = this.securityService.getUserDetails();
if (!Strings.isEmpty(parentuuid)) {
this.folderservice.deleteFolderFile(user, folder, parentuuid, true);
} else if (!Strings.isEmpty(uuid)) {
this.folderservice.deleteFolderFile(user, folder, uuid, false);
} else {
throw new PreconditionFailedException(
"'parent_uuid' or 'uuid' is required");
}
return new ApiMessageResponse("Deleted successful");
}
/**
* Folder File List.
* @param request {@link HttpServletRequest}
* @return {@link FolderFormsListDTO}
* @throws MissingServletRequestParameterException Exception
*/
@ApiOperation(value = "list", nickname = "Folder File List")
@ApiImplicitParams({
@ApiImplicitParam(name = "folder", value = "Folder",
required = true, dataType = "string", paramType = "query"),
@ApiImplicitParam(name = "text", value = "Text to search for",
required = false, dataType = "string", paramType = "query"),
@ApiImplicitParam(name = "uuid",
value = "UUID to look for records under",
required = true, dataType = "string", paramType = "query"),
@ApiImplicitParam(name = "token", value = "Paging token",
required = false, dataType = "string", paramType = "query"),
})
@ApiResponses(value = {
@ApiResponse(code = SC_OK, message = "Success",
response = FolderFormsListDTO.class),
@ApiResponse(code = SC_UNAUTHORIZED, message = "Unauthorized"),
@ApiResponse(code = SC_FORBIDDEN, message = "Forbidden"),
@ApiResponse(code = SC_NOT_FOUND, message = "Not Found"),
@ApiResponse(code = SC_INTERNAL_SERVER_ERROR,
message = "Failure") })
@Transactional
@RequestMapping(value = API_FOLDER_FILE_LIST, method = GET)
public FolderFormsListDTO filelist(final HttpServletRequest request)
throws MissingServletRequestParameterException {
Map map = request.getParameterMap();
String folder = getParameter(map, "folder", true);
String text = getParameter(map, "text", false);
String uuid = getParameter(map, "uuid", false);
String token = getParameter(map, "token", false);
List status = getParameters(map, "status",
Arrays.asList(FolderFormStatus.ACTIVE, FolderFormStatus.DRAFT),
FolderFormStatus.class);
SortDirection dir = getParameter(map, "orderdir", SortDirection.ASC,
SortDirection.class);
FormOrderByField orderby = getParameter(map, "order",
FormOrderByField.NAME, FormOrderByField.class);
return this.folderservice.findForms(folder, uuid, text, orderby,
dir, status, token);
}
/**
* Gets a File.
* @param request {@link HttpServletRequest}
* @param response {@link HttpServletResponse}
* @param folder {@link String}
* @param uuid {@link String}
* @throws IOException IOException
*/
@ApiOperation(value = "get", nickname = "Folder File Get")
@ApiResponses(value = {
@ApiResponse(code = SC_OK, message = "Success"),
@ApiResponse(code = SC_UNAUTHORIZED, message = "Unauthorized"),
@ApiResponse(code = SC_FORBIDDEN, message = "Forbidden"),
@ApiResponse(code = SC_NOT_FOUND, message = "Not Found"),
@ApiResponse(code = SC_INTERNAL_SERVER_ERROR,
message = "Failure") })
@Transactional
@RequestMapping(value = API_FOLDER_FILE_GET, method = GET)
public void get(
final HttpServletRequest request,
final HttpServletResponse response,
@RequestParam(value = "folder", required = true)
final String folder,
@RequestParam(value = "uuid", required = true) final String uuid)
throws IOException {
getApiVersion(request);
UserDetails user = this.securityService.getUserDetails();
FormDTO dto = this.folderservice.findForm(user, folder, uuid);
response.addHeader("sha1hash", dto.getSha1hash());
response.setContentType("application/zip");
response.setContentLengthLong(dto.getData().length);
IOUtils.write(dto.getData(), response.getOutputStream());
}
/**
* Save File to Folder.
* @param request {@link HttpServletRequest}
* @param response {@link HttpServletResponse}
* @param folder {@link String}
* @param entity HttpEntity<byte[]>
* @param lastSha1hash {@link String}
* @return {@link ApiMessageResponse}
* @throws IOException IOException
*/
@ApiOperation(value = "save", nickname = "Folder File Save")
@ApiResponses(value = {
@ApiResponse(code = SC_OK, message = "Success",
response = ApiMessageResponse.class),
@ApiResponse(code = SC_UNAUTHORIZED, message = "Unauthorized"),
@ApiResponse(code = SC_FORBIDDEN, message = "Forbidden"),
@ApiResponse(code = SC_NOT_FOUND, message = "Not Found"),
@ApiResponse(code = SC_INTERNAL_SERVER_ERROR,
message = "Failure") })
@Transactional
@RequestMapping(value = API_FOLDER_FILE_SAVE, method = POST)
public ApiMessageResponse saveFolderFile(
final HttpServletRequest request,
final HttpServletResponse response,
@RequestParam(value = "folder", required = true)
final String folder,
@RequestParam(value = "sha1hash", required = false)
final String lastSha1hash,
final HttpEntity entity)
throws IOException {
getApiVersion(request);
ApiMessageResponse msg = new ApiMessageResponse("Save successful");
if (request instanceof MultipartHttpServletRequest) {
MultipartHttpServletRequest rr =
(MultipartHttpServletRequest) request;
Iterator itr = rr.getFileNames();
MultipartFile mpf = rr.getFile(itr.next());
String sha1hash = this.folderservice.saveForm(folder,
mpf.getBytes(), lastSha1hash);
response.addHeader("sha1hash", sha1hash);
} else {
String sha1hash = this.folderservice.saveForm(folder,
entity.getBody(), lastSha1hash);
response.addHeader("sha1hash", sha1hash);
}
return msg;
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy