Java tutorial
/* * Copyright 2013 University of Southern California * * 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 edu.isi.misd.scanner.network.registry.web.controller; import edu.isi.misd.scanner.network.registry.data.domain.ScannerUser; import edu.isi.misd.scanner.network.registry.data.domain.Site; import edu.isi.misd.scanner.network.registry.data.repository.ScannerUserRepository; import edu.isi.misd.scanner.network.registry.data.repository.SiteRepository; import edu.isi.misd.scanner.network.registry.data.service.RegistryService; import edu.isi.misd.scanner.network.registry.data.service.RegistryServiceConstants; import edu.isi.misd.scanner.network.registry.web.errors.BadRequestException; import edu.isi.misd.scanner.network.registry.web.errors.ConflictException; import edu.isi.misd.scanner.network.registry.web.errors.ForbiddenException; import edu.isi.misd.scanner.network.registry.web.errors.ResourceNotFoundException; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import java.util.Map; import org.apache.commons.collections.CollectionUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.dao.DataIntegrityViolationException; import org.springframework.http.HttpStatus; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestHeader; 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; /** * @author Mike D'Arcy */ @Controller public class SiteController extends BaseController { private static final Log log = LogFactory.getLog(SiteController.class.getName()); public static final String BASE_PATH = "/sites"; public static final String ENTITY_PATH = BASE_PATH + ID_URL_PATH; public static final String REQUEST_PARAM_SITE_NAME = "siteName"; public static final String REQUEST_PARAM_USER_NAME = "userName"; @Autowired private SiteRepository siteRepository; @Autowired private ScannerUserRepository scannerUserRepository; @Autowired private RegistryService registryService; @RequestMapping(value = BASE_PATH, method = { RequestMethod.GET, RequestMethod.HEAD }, produces = HEADER_JSON_MEDIA_TYPE) public @ResponseBody List<Site> getSites(@RequestParam Map<String, String> paramMap) { Map<String, String> params = validateParameterMap(paramMap, REQUEST_PARAM_SITE_NAME); String siteName = params.get(REQUEST_PARAM_SITE_NAME); List<Site> sites = new ArrayList<Site>(); if (siteName != null) { Site site = siteRepository.findBySiteName(siteName); if (site == null) { throw new ResourceNotFoundException(siteName); } sites.add(site); } else { Iterator iter = siteRepository.findAll().iterator(); CollectionUtils.addAll(sites, iter); } return sites; } @RequestMapping(value = ENTITY_PATH, method = { RequestMethod.GET, RequestMethod.HEAD }, produces = HEADER_JSON_MEDIA_TYPE) public @ResponseBody Site getSite(@PathVariable(ID_URL_PATH_VAR) Integer id) { Site foundSite = siteRepository.findOne(id); if (foundSite == null) { throw new ResourceNotFoundException(id); } return foundSite; } @RequestMapping(value = BASE_PATH, method = RequestMethod.POST, consumes = HEADER_JSON_MEDIA_TYPE, produces = HEADER_JSON_MEDIA_TYPE) @ResponseStatus(value = HttpStatus.CREATED) public @ResponseBody Site createSite(@RequestHeader(HEADER_LOGIN_NAME) String loginName, @RequestParam Map<String, String> paramMap, @RequestBody Site site) { if (!registryService.userIsSuperuser(loginName)) { throw new ForbiddenException(loginName, RegistryServiceConstants.MSG_SUPERUSER_ROLE_REQUIRED); } Map<String, String> params = validateParameterMap(paramMap, REQUEST_PARAM_USER_NAME); String userName = params.get(REQUEST_PARAM_USER_NAME); ScannerUser user = null; if (userName != null) { user = scannerUserRepository.findByUserName(userName); if (user == null) { throw new BadRequestException( String.format(RegistryServiceConstants.MSG_INVALID_PARAMETER_VALUE, userName) + " " + RegistryServiceConstants.MSG_UNKNOWN_USER_NAME); } } try { registryService.createSite(site, user); } catch (DataIntegrityViolationException e) { log.warn(e); throw new ConflictException(e.getMostSpecificCause()); } // force the re-query to ensure a complete result view if updated return siteRepository.findOne(site.getSiteId()); } @RequestMapping(value = ENTITY_PATH, method = RequestMethod.PUT, consumes = HEADER_JSON_MEDIA_TYPE, produces = HEADER_JSON_MEDIA_TYPE) public @ResponseBody Site updateSite(@RequestHeader(HEADER_LOGIN_NAME) String loginName, @PathVariable(ID_URL_PATH_VAR) Integer id, @RequestBody Site site) { // find the requested resource Site foundSite = siteRepository.findOne(id); // if the ID is not found then throw a ResourceNotFoundException (404) if (foundSite == null) { throw new ResourceNotFoundException(id); } // if the ID in the request body is null, use the ID parsed from the URL // if the ID is found in the request body but does not match the ID in // the current data, then throw a ConflictException (409) Integer updateID = site.getSiteId(); if (updateID == null) { site.setSiteId(id); } else if (!site.getSiteId().equals(foundSite.getSiteId())) { throw new ConflictException(site.getSiteId(), foundSite.getSiteId()); } // check that the user can perform the update if (!registryService.userCanManageSite(loginName, site.getSiteId())) { throw new ForbiddenException(loginName, RegistryServiceConstants.MSG_SITE_MANAGEMENT_ROLE_REQUIRED); } try { siteRepository.save(site); } catch (DataIntegrityViolationException e) { log.warn(e); throw new ConflictException(e.getMostSpecificCause()); } // force the re-query to ensure a complete result view if updated return siteRepository.findOne(site.getSiteId()); } @RequestMapping(value = ENTITY_PATH, method = RequestMethod.DELETE) @ResponseStatus(value = HttpStatus.NO_CONTENT) public void removeSite(@RequestHeader(HEADER_LOGIN_NAME) String loginName, @PathVariable(ID_URL_PATH_VAR) Integer id) { if (!registryService.userIsSuperuser(loginName)) { throw new ForbiddenException(loginName, RegistryServiceConstants.MSG_SUPERUSER_ROLE_REQUIRED); } Site site = siteRepository.findOne(id); if (site == null) { throw new ResourceNotFoundException(id); } registryService.deleteSite(site); } }