Java tutorial
/* * Copyright (C) 2007-2014 Crafter Software Corporation. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ package org.craftercms.studio.controller.services.rest; import com.wordnik.swagger.annotations.Api; import com.wordnik.swagger.annotations.ApiOperation; import com.wordnik.swagger.annotations.ApiParam; import com.wordnik.swagger.annotations.ApiResponse; import com.wordnik.swagger.annotations.ApiResponses; import java.io.IOException; import java.io.InputStream; import java.util.List; import java.util.Map; import org.apache.commons.lang.StringUtils; import org.craftercms.studio.api.content.DescriptorService; import org.craftercms.studio.commons.dto.Context; import org.craftercms.studio.commons.dto.Item; import org.craftercms.studio.commons.dto.ItemId; import org.craftercms.studio.commons.exception.ErrorManager; import org.craftercms.studio.commons.exception.StudioException; import org.craftercms.studio.exceptions.StudioServerErrorCode; import org.craftercms.studio.utils.RestControllerUtils; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.http.HttpStatus; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.multipart.MultipartFile; /** * Descriptor Service RESTful Controller. * Defines RESTful services for descriptors. * * @author Dejan Brkic */ @Controller @RequestMapping("/api/1/descriptor") @Api(value = "Descriptor Services", description = "Descriptor Services", position = 2) public class DescriptorServiceController { /** * Descriptor Service instance. */ @Autowired private DescriptorService descriptorService; /** * Create a new descriptor. * * @param site site identifier * @param contentTypeId content type identifier * @param parentId parent identifier * @param fileName file name * @param file content stream * @param properties additional properties * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad Request") }) @RequestMapping(value = "/create/{site}", method = RequestMethod.POST, params = { "content_type_id", "parent_id", "file_name" }) @ResponseBody public Item create( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "content_type_id", required = true, value = "String") @RequestParam(value = "content_type_id", required = true) final String contentTypeId, @ApiParam(name = "parent_id", required = true, value = "String") @RequestParam(value = "parent_id", required = true) final String parentId, @ApiParam(name = "file_name", required = true, value = "String") @RequestParam(value = "file_name", required = true) final String fileName, @ApiParam(name = "file", required = true, value = "MultipartFile") @RequestParam(value = "file") final MultipartFile file, @ApiParam(name = "properties", required = false, value = "Map<String, String>") @RequestParam(value = "properties", required = false) final Map<String, String> properties) throws StudioException { Context context = RestControllerUtils.createMockContext(); InputStream content = null; try { content = file.getInputStream(); } catch (IOException e) { throw ErrorManager.createError(StudioServerErrorCode.FILE_UPLOAD_IO_ERROR); } Item item = descriptorService.create(context, site, contentTypeId, parentId, fileName, content, properties); return item; } /** * Create a new descriptor. * * @param site site identifier * @param contentTypeId content type identifier * @param parentId parent identifier * @param fileName file name * @param content content * @param properties additional properties * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/create/{site}", method = RequestMethod.POST, params = { "content_type_id", "parent_id", "file_name", "content" }) @ResponseBody public Item create( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "content_type_id", required = true, value = "String") @RequestParam(value = "content_type_id", required = true) final String contentTypeId, @ApiParam(name = "parent_id", required = true, value = "String") @RequestParam(value = "parent_id", required = true) final String parentId, @ApiParam(name = "file_name", required = true, value = "String") @RequestParam(value = "file_name", required = true) final String fileName, @ApiParam(name = "content", required = true, value = "String") @RequestParam(value = "content", required = true) final String content, @ApiParam(name = "properties", required = false, value = "Map<String, String>") @RequestParam(value = "properties", required = false) final Map<String, String> properties) throws StudioException { Context context = RestControllerUtils.createMockContext(); Item item = descriptorService.create(context, site, contentTypeId, parentId, fileName, content, properties); return item; } /** * Create a new descriptor as copy of existing. * * @param site site identifier * @param itemId item identifier of descriptor to be duplicated * @param parentId parent identifier * @param fileName file name * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/duplicate/{site}", method = RequestMethod.POST) @ResponseBody public Item duplicate( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id", required = true) final String itemId, @ApiParam(name = "parent_id", required = true, value = "String") @RequestParam(value = "parent_id", required = true) final String parentId, @ApiParam(name = "file_name", required = true, value = "String") @RequestParam(value = "file_name") final String fileName) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = new ItemId(itemId); Item item = descriptorService.duplicate(context, site, descriptorItemId, parentId, fileName); return item; } /** * Move/rename descriptor. * * @param site site identifier * @param itemId item identifier * @param parentId destination parent identifier * @param fileName file name * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/move/{site}", method = RequestMethod.POST) @ResponseBody public Item move( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id", required = true) final String itemId, @ApiParam(name = "parent_id", required = true, value = "String") @RequestParam(value = "parent_id", required = true) final String parentId, @ApiParam(name = "file_name", required = true, value = "String") @RequestParam(value = "file_name", required = true) final String fileName) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = new ItemId(itemId); Item item = descriptorService.move(context, site, descriptorItemId, parentId, fileName); return item; } /** * Get descriptor item. * * @param site site identifier * @param itemId item identifier * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/read/{site}", params = { "item_id" }, method = RequestMethod.GET) @ResponseBody public Item read( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id", required = true) final String itemId) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = new ItemId(itemId); Item item = descriptorService.read(context, site, descriptorItemId); return item; } /** * Read textual content for given descriptor id. * * @param site site identifier * @param itemId descriptor item identifier * @return textual content of descriptor * @throws StudioException */ @ApiOperation(value = "read textual content of descriptor", position = 3) @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = String.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/read_text/{site}", params = { "item_id" }, method = RequestMethod.GET) @ResponseBody public String getTextContent( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id") final String itemId) throws StudioException { Context context = RestControllerUtils.createMockContext(); return descriptorService.getTextContent(context, site, itemId); } /** * Update given descriptor. * * @param site site identifier * @param itemId descriptor item identifier * @param file content stream * @param properties additional properties * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/update/{site}", method = RequestMethod.POST, params = "item_id") @ResponseBody public Item update( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id", required = true) final String itemId, @ApiParam(name = "file", required = true, value = "MultipartFile") @RequestParam(value = "file", required = true) final MultipartFile file, @ApiParam(name = "properties", required = false, value = "Map<String, String>") @RequestParam(value = "properties", required = false) final Map<String, String> properties) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = new ItemId(itemId); InputStream contentStream = null; try { contentStream = file.getInputStream(); } catch (IOException e) { throw ErrorManager.createError(StudioServerErrorCode.FILE_UPLOAD_IO_ERROR); } Item item = descriptorService.update(context, site, descriptorItemId, contentStream, properties); return item; } /** * Update given descriptor. * * @param site site identifier * @param itemId descriptor item identifier * @param content descriptor content * @param properties additional properties * @return item * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/update/{site}", method = RequestMethod.POST, params = { "item_id", "content" }) @ResponseBody public Item update( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id", required = true) final String itemId, @ApiParam(name = "content", required = true, value = "String") @RequestParam(value = "content", required = true) final String content, @ApiParam(name = "content", required = false, value = "Map<String, String>") @RequestParam(value = "properties", required = false) final Map<String, String> properties) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = new ItemId(itemId); Item item = descriptorService.update(context, site, descriptorItemId, content, properties); return item; } /** * Delete descriptor. * * @param site site identifier * @param itemId descriptor item identifier * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success"), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/delete/{site}", method = RequestMethod.POST) @ResponseStatus(HttpStatus.NO_CONTENT) public void delete( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = true, value = "String") @RequestParam(value = "item_id", required = true) final String itemId) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = new ItemId(itemId); descriptorService.delete(context, site, descriptorItemId); } /** * Find descriptor by given query. * * @param site site identifier * @param query search query * @return list of descriptor items * @throws StudioException */ @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/find/{site}", method = RequestMethod.POST) @ResponseBody public List<Item> findBy( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "site", required = true, value = "String") @RequestParam(value = "query", required = true) final String query) throws StudioException { throw ErrorManager.createError(StudioServerErrorCode.NOT_IMPLEMENTED); } /** * List children for given descriptor item. * * @param site site identifier * @param itemId parent descriptor item id * @return list of children items * @throws StudioException */ @ApiOperation(value = "list children descriptors") @ApiResponses({ @ApiResponse(code = 200, message = "Success", response = Item.class), @ApiResponse(code = 400, message = "Bad request") }) @RequestMapping(value = "/list/{site}", method = RequestMethod.GET) @ResponseBody public List<Item> list( @ApiParam(name = "site", required = true, value = "String") @PathVariable final String site, @ApiParam(name = "item_id", required = false, value = "String") @RequestParam(value = "item_id", required = false) final String itemId) throws StudioException { Context context = RestControllerUtils.createMockContext(); ItemId descriptorItemId = null; if (StringUtils.isNotEmpty(itemId)) { descriptorItemId = new ItemId(itemId); } return descriptorService.list(context, site, descriptorItemId); } public void setDescriptorService(final DescriptorService descriptorService) { this.descriptorService = descriptorService; } }