Java tutorial
/* * Copyright: (c) 2004-2011 Mayo Foundation for Medical Education and * Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the * triple-shield Mayo logo are trademarks and service marks of MFMER. * * Except as contained in the copyright notice above, or as used to identify * MFMER as the author of this software, the trade names, trademarks, service * marks, or product names of the copyright holder shall not be used in * advertising, promotion or otherwise in connection with this software without * prior written authorization of the copyright holder. * * 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.mayo.cts2.framework.webapp.rest.controller; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.stereotype.Controller; import org.springframework.web.bind.WebDataBinder; import org.springframework.web.bind.annotation.InitBinder; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; 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 edu.mayo.cts2.framework.model.command.Page; import edu.mayo.cts2.framework.model.core.Message; import edu.mayo.cts2.framework.model.mapversion.MapEntry; import edu.mayo.cts2.framework.model.mapversion.MapEntryDirectory; import edu.mayo.cts2.framework.model.mapversion.MapEntryList; import edu.mayo.cts2.framework.model.mapversion.MapEntryMsg; import edu.mayo.cts2.framework.model.service.core.EntityNameOrURI; import edu.mayo.cts2.framework.model.service.core.Query; import edu.mayo.cts2.framework.model.service.exception.UnknownResourceReference; import edu.mayo.cts2.framework.model.util.ModelUtils; import edu.mayo.cts2.framework.service.command.restriction.MapEntryQueryServiceRestrictions; import edu.mayo.cts2.framework.service.profile.mapentry.MapEntryMaintenanceService; import edu.mayo.cts2.framework.service.profile.mapentry.MapEntryQuery; import edu.mayo.cts2.framework.service.profile.mapentry.MapEntryQueryService; import edu.mayo.cts2.framework.service.profile.mapentry.MapEntryReadService; import edu.mayo.cts2.framework.service.profile.mapentry.name.MapEntryReadId; import edu.mayo.cts2.framework.webapp.rest.command.QueryControl; import edu.mayo.cts2.framework.webapp.rest.command.RestFilter; import edu.mayo.cts2.framework.webapp.rest.command.RestReadContext; import edu.mayo.cts2.framework.webapp.rest.query.MapEntryQueryBuilder; import edu.mayo.cts2.framework.webapp.rest.util.ControllerUtils; /** * The Class MapEntryController. * * @author <a href="mailto:kevin.peterson@mayo.edu">Kevin Peterson</a> */ @Controller public class MapEntryController extends AbstractMessageWrappingController { @Cts2Service private MapEntryReadService mapEntryReadService; @Cts2Service private MapEntryQueryService mapEntryQueryService; @Cts2Service private MapEntryMaintenanceService mapEntryMaintenanceService; private UrlTemplateBinder<MapEntry> URL_BINDER = new UrlTemplateBinder<MapEntry>() { @Override public Map<String, String> getPathValues(MapEntry resource) { Map<String, String> returnMap = new HashMap<String, String>(); returnMap.put(VAR_MAPID, resource.getAssertedBy().getMap().getContent()); returnMap.put(VAR_MAPVERSIONID, resource.getAssertedBy().getMapVersion().getContent()); returnMap.put(VAR_MAPENTRYID, getScopedEntityName(resource.getMapFrom())); return returnMap; } }; private final static MessageFactory<MapEntry> MESSAGE_FACTORY = new MessageFactory<MapEntry>() { @Override public Message createMessage(MapEntry resource) { MapEntryMsg msg = new MapEntryMsg(); msg.setEntry(resource); return msg; } }; /** * Creates the map entry. * * @param httpServletRequest the http servlet request * @param mapEntry the map entry * @param changeseturi the changeseturi * @param mapName the map name * @param mapVersionName the map version name * @param mapsFromName the maps from name */ @RequestMapping(value = PATH_MAPENTRY_OF_MAPVERSION_BYID, method = RequestMethod.PUT) public Object updateMapEntry(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, @RequestBody MapEntry mapEntry, @RequestParam(value = PARAM_CHANGESETCONTEXT, required = false) String changeseturi, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName, @PathVariable(VAR_MAPENTRYID) String mapsFromName) { MapEntryReadId id = new MapEntryReadId(this.getScopedEntityName(mapsFromName), ModelUtils.nameOrUriFromName(mapVersionName)); return this.doUpdate(httpServletResponse, mapEntry, changeseturi, id, this.mapEntryMaintenanceService); } @RequestMapping(value = PATH_MAPENTRY, method = RequestMethod.POST) public Object createMapEntry(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, @RequestBody MapEntry mapEntry, @RequestParam(value = PARAM_CHANGESETCONTEXT, required = false) String changeseturi) { return this.doCreate(httpServletResponse, mapEntry, changeseturi, PATH_MAPENTRY_OF_MAPVERSION_BYID, URL_BINDER, this.mapEntryMaintenanceService); } @RequestMapping(value = PATH_MAPENTRY_OF_MAPVERSION_BYID, method = RequestMethod.DELETE) public Object deleteMapEntry(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, RestReadContext restReadContext, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName, @PathVariable(VAR_MAPENTRYID) String mapsFromName, @RequestParam(PARAM_CHANGESETCONTEXT) String changeseturi) { MapEntryReadId id = new MapEntryReadId(this.getScopedEntityName(mapsFromName), ModelUtils.nameOrUriFromName(mapVersionName)); return this.doDelete(httpServletResponse, id, changeseturi, this.mapEntryMaintenanceService); } @RequestMapping(value = PATH_MAPENTRY_OF_MAPVERSION_BYID, method = RequestMethod.GET) public Object getMapEntryOfMapVersionByName(HttpServletRequest httpServletRequest, RestReadContext restReadContext, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName, @PathVariable(VAR_MAPENTRYID) String mapsFromName) { return this.getMapEntryOfMapVersionByName(httpServletRequest, restReadContext, null, mapName, mapVersionName, mapsFromName); } /** * Gets the map entry by maps from name. * * @param httpServletRequest the http servlet request * @param mapName the map name * @param mapVersionName the map version name * @param mapsFromName the maps from name * @return the map entry by maps from name */ @RequestMapping(value = PATH_MAPENTRY_OF_MAPVERSION_BYID, method = RequestMethod.POST) public Object getMapEntryOfMapVersionByName(HttpServletRequest httpServletRequest, RestReadContext restReadContext, @RequestBody Query query, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName, @PathVariable(VAR_MAPENTRYID) String mapsFromName) { MapEntryReadId id = new MapEntryReadId(this.getScopedEntityName(mapsFromName), ModelUtils.nameOrUriFromName(mapVersionName)); return this.doRead(httpServletRequest, MESSAGE_FACTORY, this.mapEntryReadService, restReadContext, //TODO: This needs to be fixed UnknownResourceReference.class, id); } /** * Gets the map entries. * * @param httpServletRequest the http servlet request * @param restrictions the restrictions * @param resolvedFilter the filter * @param page the page * @param mapName the map name * @param mapVersionName the map version name * @return the map entries */ @RequestMapping(value = { PATH_MAPENTRIES }, method = RequestMethod.GET) public Object getMapEntries(HttpServletRequest httpServletRequest, RestReadContext restReadContext, QueryControl queryControl, MapEntryQueryServiceRestrictions restrictions, RestFilter restFilter, Page page, boolean list, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName) { return this.getMapEntries(httpServletRequest, restReadContext, queryControl, null, restrictions, restFilter, page, list, mapName, mapVersionName); } /** * Gets the map entries. * * @param httpServletRequest the http servlet request * @param query the query * @param restrictions the restrictions * @param resolvedFilter the filter * @param page the page * @param mapName the map name * @param mapVersionName the map version name * @return the map entries */ @RequestMapping(value = { PATH_MAPENTRIES }, method = RequestMethod.POST) public Object getMapEntries(HttpServletRequest httpServletRequest, RestReadContext restReadContext, QueryControl queryControl, @RequestBody Query query, MapEntryQueryServiceRestrictions restrictions, RestFilter restFilter, Page page, boolean list, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName) { restrictions.setMapVersion(ModelUtils.nameOrUriFromName(mapVersionName)); MapEntryQueryBuilder builder = this.getNewResourceQueryBuilder(); MapEntryQuery resourceQuery = builder.addQuery(query).addRestFilter(restFilter) .addRestrictions(restrictions).addRestReadContext(restReadContext).build(); return this.doQuery(httpServletRequest, list, this.mapEntryQueryService, resourceQuery, page, queryControl, MapEntryDirectory.class, MapEntryList.class); } @RequestMapping(value = { PATH_MAPENTRIES }, method = RequestMethod.HEAD) @ResponseBody public void getMapEntriesCount(HttpServletResponse httpServletResponse, RestReadContext restReadContext, @RequestBody Query query, MapEntryQueryServiceRestrictions restrictions, RestFilter restFilter, Page page, boolean list, @PathVariable(VAR_MAPID) String mapName, @PathVariable(VAR_MAPVERSIONID) String mapVersionName) { MapEntryQueryBuilder builder = this.getNewResourceQueryBuilder(); MapEntryQuery resourceQuery = builder.addQuery(query).addRestFilter(restFilter) .addRestrictions(restrictions).addRestReadContext(restReadContext).build(); int count = this.mapEntryQueryService.count(resourceQuery); this.setCount(count, httpServletResponse); } @InitBinder public void initMapEntryQueryServiceRestrictionsBinder(WebDataBinder binder, @RequestParam(value = PARAM_TARGETENTITYID, required = false) List<String> targetEntities) { if (binder.getTarget() instanceof MapEntryQueryServiceRestrictions) { MapEntryQueryServiceRestrictions restrictions = (MapEntryQueryServiceRestrictions) binder.getTarget(); Set<EntityNameOrURI> targetEntitiesSet = ControllerUtils.idsToEntityNameOrUriSet(targetEntities); restrictions.setTargetEntities(targetEntitiesSet); } } private MapEntryQueryBuilder getNewResourceQueryBuilder() { return new MapEntryQueryBuilder(this.mapEntryQueryService, this.getFilterResolver(), this.getReadContextResolver()); } }