JAVA-3534: Move spring-rest-http into spring-web-modules

2020-12-29 12:15:04 +01:00
parent 58e1b70793
commit ee174737ab
35 changed files with 2 additions and 3 deletions
@@ -0,0 +1,12 @@
+package com.baeldung;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class CustomerSpringBootRestApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(CustomerSpringBootRestApplication.class, args);
+    }
+}
@@ -0,0 +1,51 @@
+package com.baeldung.config;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.MediaType;
+import org.springframework.http.converter.HttpMessageConverter;
+
+import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
+
+import org.springframework.oxm.xstream.XStreamMarshaller;
+import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer;
+import org.springframework.web.servlet.config.annotation.CorsRegistry;
+import org.springframework.web.servlet.config.annotation.EnableWebMvc;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+import java.text.SimpleDateFormat;
+import java.util.List;
+
+/*
+ * Please note that main web configuration is in src/main/webapp/WEB-INF/api-servlet.xml
+ */
+@Configuration
+@EnableWebMvc
+@ComponentScan({ "com.baeldung.web.controller.status", "com.baeldung.requestmapping" })
+public class MvcConfig implements WebMvcConfigurer {
+
+    public MvcConfig() {
+        super();
+    }
+
+    //
+
+    @Override
+    public void configureMessageConverters(final List<HttpMessageConverter<?>> messageConverters) {
+        final Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
+        builder.indentOutput(true)
+            .dateFormat(new SimpleDateFormat("dd-MM-yyyy hh:mm"));
+
+    }
+
+
+    @Override
+    public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
+        configurer.defaultContentType(MediaType.APPLICATION_JSON);
+    }
+
+    @Override
+    public void addCorsMappings(CorsRegistry registry) {
+        registry.addMapping("/**");
+    }
+}
@@ -0,0 +1,76 @@
+package com.baeldung.controllers;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.context.request.async.DeferredResult;
+
+import java.util.concurrent.ForkJoinPool;
+
+@RestController
+public class DeferredResultController {
+
+	private final static Logger LOG = LoggerFactory.getLogger(DeferredResultController.class);
+
+	@GetMapping("/async-deferredresult")
+	public DeferredResult<ResponseEntity<?>> handleReqDefResult(Model model) {
+	    LOG.info("Received async-deferredresult request");
+	    DeferredResult<ResponseEntity<?>> output = new DeferredResult<>();
+	    ForkJoinPool.commonPool().submit(() -> {
+	        LOG.info("Processing in separate thread");
+	        try {
+			    Thread.sleep(6000);
+	        } catch (InterruptedException e) {
+	        }
+	        output.setResult(ResponseEntity.ok("ok"));
+	    });
+	    LOG.info("servlet thread freed");
+	    return output;
+	}
+
+	public DeferredResult<ResponseEntity<?>> handleReqWithTimeouts(Model model) {
+		LOG.info("Received async request with a configured timeout");
+		DeferredResult<ResponseEntity<?>> deferredResult = new DeferredResult<>(500l);
+		deferredResult.onTimeout(new Runnable() {
+			@Override
+			public void run() {
+				deferredResult.setErrorResult(
+						ResponseEntity.status(HttpStatus.REQUEST_TIMEOUT).body("Request timeout occurred."));
+			}
+		});
+		ForkJoinPool.commonPool().submit(() -> {
+			LOG.info("Processing in separate thread");
+			try {
+				Thread.sleep(600l);
+				deferredResult.setResult(ResponseEntity.ok("ok"));
+			} catch (InterruptedException e) {
+				LOG.info("Request processing interrupted");
+				deferredResult.setErrorResult(ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
+						.body("INTERNAL_SERVER_ERROR occurred."));
+			}
+
+		});
+		LOG.info("servlet thread freed");
+		return deferredResult;
+	}
+
+	public DeferredResult<ResponseEntity<?>> handleAsyncFailedRequest(Model model) {
+		DeferredResult<ResponseEntity<?>> deferredResult = new DeferredResult<>();
+		ForkJoinPool.commonPool().submit(() -> {
+			try {
+				// Exception occurred in processing
+				throw new Exception();
+			} catch (Exception e) {
+				LOG.info("Request processing failed");
+				deferredResult.setErrorResult(ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
+						.body("INTERNAL_SERVER_ERROR occurred."));
+			}
+		});
+		return deferredResult;
+	}
+
+}
@@ -0,0 +1,79 @@
+package com.baeldung.model;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+
+public class Customer {
+    private String id;
+    private String telephone;
+    private List<String> favorites;
+    private Map<String, Boolean> communicationPreferences;
+
+    public Customer() {
+    }
+
+    public Customer(String id, String telephone, List<String> favorites, Map<String, Boolean> communicationPreferences) {
+        this(telephone, favorites, communicationPreferences);
+        this.id = id;
+    }
+
+    public Customer(String telephone, List<String> favorites, Map<String, Boolean> communicationPreferences) {
+        this.telephone = telephone;
+        this.favorites = favorites;
+        this.communicationPreferences = communicationPreferences;
+    }
+
+    public static Customer fromCustomer(Customer customer) {
+        return new Customer(customer.getId(), customer.getTelephone(), customer.getFavorites(), customer.getCommunicationPreferences());
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getTelephone() {
+        return telephone;
+    }
+
+    public void setTelephone(String telephone) {
+        this.telephone = telephone;
+    }
+
+    public Map<String, Boolean> getCommunicationPreferences() {
+        return communicationPreferences;
+    }
+
+    public void setCommunicationPreferences(Map<String, Boolean> communicationPreferences) {
+        this.communicationPreferences = communicationPreferences;
+    }
+
+    public List<String> getFavorites() {
+        return favorites;
+    }
+
+    public void setFavorites(List<String> favorites) {
+        this.favorites = favorites;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (!(o instanceof Customer)) {
+            return false;
+        }
+        Customer customer = (Customer) o;
+        return Objects.equals(id, customer.id);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id);
+    }
+}
@@ -0,0 +1,47 @@
+package com.baeldung.requestmapping;
+
+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.RequestParam;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@Controller
+@RequestMapping(value = "/ex")
+public class BarMappingExamplesController {
+
+    public BarMappingExamplesController() {
+        super();
+    }
+
+    // API
+
+    // with @RequestParam
+
+    @RequestMapping(value = "/bars")
+    @ResponseBody
+    public String getBarBySimplePathWithRequestParam(@RequestParam("id") final long id) {
+        return "Get a specific Bar with id=" + id;
+    }
+
+    @RequestMapping(value = "/bars", params = "id")
+    @ResponseBody
+    public String getBarBySimplePathWithExplicitRequestParam(@RequestParam("id") final long id) {
+        return "Get a specific Bar with id=" + id;
+    }
+
+    @RequestMapping(value = "/bars", params = { "id", "second" })
+    @ResponseBody
+    public String getBarBySimplePathWithExplicitRequestParams(@RequestParam("id") final long id) {
+        return "Get a specific Bar with id=" + id;
+    }
+
+    // with @PathVariable
+
+    @RequestMapping(value = "/bars/{numericId:[\\d]+}")
+    @ResponseBody
+    public String getBarsBySimplePathWithPathVariable(@PathVariable final long numericId) {
+        return "Get a specific Bar with id=" + numericId;
+    }
+
+}
@@ -0,0 +1,55 @@
+package com.baeldung.requestmapping;
+
+import java.util.Arrays;
+import java.util.List;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import com.baeldung.web.dto.Bazz;
+import com.fasterxml.jackson.core.JsonProcessingException;
+
+@RestController
+@RequestMapping("/bazz")
+public class BazzNewMappingsExampleController {
+
+    @GetMapping
+    public ResponseEntity<?> getBazzs() throws JsonProcessingException{
+        List<Bazz> data = Arrays.asList(
+            new Bazz("1", "Bazz1"),
+            new Bazz("2", "Bazz2"),
+            new Bazz("3", "Bazz3"),
+            new Bazz("4", "Bazz4"));
+        return new ResponseEntity<>(data, HttpStatus.OK);
+    }
+    
+    @GetMapping("/{id}")
+    public ResponseEntity<?> getBazz(@PathVariable String id){
+        return new ResponseEntity<>(new Bazz(id, "Bazz"+id), HttpStatus.OK);
+    }
+    
+    @PostMapping
+    public ResponseEntity<?> newBazz(@RequestParam("name") String name){
+        return new ResponseEntity<>(new Bazz("5", name), HttpStatus.OK);
+    }
+    
+    @PutMapping("/{id}")
+    public ResponseEntity<?> updateBazz(@PathVariable String id,
+        @RequestParam("name") String name){
+        return new ResponseEntity<>(new Bazz(id, name), HttpStatus.OK);
+    }
+    
+    @DeleteMapping("/{id}")
+    public ResponseEntity<?> deleteBazz(@PathVariable String id){
+        return new ResponseEntity<>(new Bazz(id), HttpStatus.OK);
+    }
+    
+}
@@ -0,0 +1,129 @@
+package com.baeldung.requestmapping;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+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.ResponseBody;
+
+@Controller
+@RequestMapping(value = "/ex")
+public class FooMappingExamplesController {
+
+    public FooMappingExamplesController() {
+        super();
+    }
+
+    // API
+
+    // mapping examples
+
+    @RequestMapping(value = "/foos")
+    @ResponseBody
+    public String getFoosBySimplePath() {
+        return "Simple Get some Foos";
+    }
+
+    // with @PathVariable
+
+    @RequestMapping(value = "/foos/{id}")
+    @ResponseBody
+    public String getFoosBySimplePathWithPathVariable(@PathVariable final long id) {
+        return "Get a specific Foo with id=" + id;
+    }
+
+    @RequestMapping(value = "/foos/{fooid}/bar/{barid}")
+    @ResponseBody
+    public String getFoosBySimplePathWithPathVariables(@PathVariable final long fooid, @PathVariable final long barid) {
+        return "Get a specific Bar with id=" + barid + " from a Foo with id=" + fooid;
+    }
+
+    // other HTTP verbs
+
+    @RequestMapping(value = "/foos", method = RequestMethod.POST)
+    @ResponseBody
+    public String postFoos() {
+        return "Post some Foos";
+    }
+
+    // with headers
+
+    @RequestMapping(value = "/foos", headers = "key=val")
+    @ResponseBody
+    public String getFoosWithHeader() {
+        return "Get some Foos with Header";
+    }
+
+    @RequestMapping(value = "/foos", headers = { "key1=val1", "key2=val2" })
+    @ResponseBody
+    public String getFoosWithHeaders() {
+        return "Get some Foos with Header";
+    }
+
+    // @RequestMapping(value = "/foos", method = RequestMethod.GET, headers = "Accept=application/json")
+    // @ResponseBody
+    // public String getFoosAsJsonFromBrowser() {
+    // return "Get some Foos with Header Old";
+    // }
+
+    @RequestMapping(value = "/foos", produces = { "application/json", "application/xml" })
+    @ResponseBody
+    public String getFoosAsJsonFromREST() {
+        return "Get some Foos with Header New";
+    }
+
+    // advanced - multiple mappings
+
+    @RequestMapping(value = { "/advanced/bars", "/advanced/foos" })
+    @ResponseBody
+    public String getFoosOrBarsByPath() {
+        return "Advanced - Get some Foos or Bars";
+    }
+
+    @RequestMapping(value = "*")
+    @ResponseBody
+    public String getFallback() {
+        return "Fallback for GET Requests";
+    }
+
+    @RequestMapping(value = "*", method = { RequestMethod.GET, RequestMethod.POST })
+    @ResponseBody
+    public String allFallback() {
+        return "Fallback for All Requests";
+    }
+
+    @RequestMapping(value = "/foos/multiple", method = { RequestMethod.PUT, RequestMethod.POST })
+    @ResponseBody
+    public String putAndPostFoos() {
+        return "Advanced - PUT and POST within single method";
+    }
+ 
+    // --- Ambiguous Mapping
+ 
+    @GetMapping(value = "foos/duplicate" )
+    public ResponseEntity<String> duplicate() {
+        return new ResponseEntity<>("Duplicate", HttpStatus.OK);
+    }
+    
+    // uncomment for exception of type java.lang.IllegalStateException: Ambiguous mapping
+
+    // @GetMapping(value = "foos/duplicate" )
+    // public String duplicateEx() {
+    // return "Duplicate";
+    // }
+    
+    @GetMapping(value = "foos/duplicate", produces = MediaType.APPLICATION_XML_VALUE)
+    public ResponseEntity<String> duplicateXml() {
+        return new ResponseEntity<>("<message>Duplicate</message>", HttpStatus.OK);
+    }
+     
+    @GetMapping(value = "foos/duplicate", produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<String> duplicateJson() {
+        return new ResponseEntity<>("{\"message\":\"Duplicate\"}", HttpStatus.OK);
+    }
+
+}
@@ -0,0 +1,6 @@
+package com.baeldung.service;
+
+public interface CustomerIdGenerator {
+    int generateNextId();
+}
+
@@ -0,0 +1,14 @@
+package com.baeldung.service;
+
+import com.baeldung.model.Customer;
+
+import java.util.Optional;
+
+public interface CustomerService {
+
+    Customer createCustomer(Customer customer);
+
+    Optional<Customer> findCustomer(String id);
+
+    void updateCustomer(Customer customer);
+}
@@ -0,0 +1,17 @@
+package com.baeldung.service.impl;
+
+import com.baeldung.service.CustomerIdGenerator;
+
+import org.springframework.stereotype.Component;
+
+import java.util.concurrent.atomic.AtomicInteger;
+
+@Component
+public class CustomerIdGeneratorImpl implements CustomerIdGenerator {
+    private static final AtomicInteger SEQUENCE = new AtomicInteger();
+
+    @Override
+    public int generateNextId() {
+        return SEQUENCE.incrementAndGet();
+    }
+}
@@ -0,0 +1,42 @@
+package com.baeldung.service.impl;
+
+import com.baeldung.model.Customer;
+import com.baeldung.service.CustomerIdGenerator;
+import com.baeldung.service.CustomerService;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+
+@Service
+public class CustomerServiceImpl implements CustomerService {
+    private CustomerIdGenerator customerIdGenerator;
+    private List<Customer> customers = new ArrayList<>();
+
+    @Autowired
+    public CustomerServiceImpl(CustomerIdGenerator customerIdGenerator) {
+        this.customerIdGenerator = customerIdGenerator;
+    }
+
+    @Override
+    public Customer createCustomer(Customer customer) {
+        customer.setId(Integer.toString(customerIdGenerator.generateNextId()));
+        customers.add(customer);
+        return customer;
+    }
+
+    @Override
+    public Optional<Customer> findCustomer(String id) {
+        return customers.stream()
+                        .filter(customer -> customer.getId().equals(id))
+                        .findFirst();
+    }
+
+    @Override
+    public void updateCustomer(Customer customer) {
+        customers.set(customers.indexOf(customer), customer);
+    }
+}
@@ -0,0 +1,69 @@
+package com.baeldung.web.controller.customer;
+
+import com.baeldung.model.Customer;
+import com.baeldung.service.CustomerService;
+import com.baeldung.web.exception.CustomerNotFoundException;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.github.fge.jsonpatch.JsonPatch;
+import com.github.fge.jsonpatch.JsonPatchException;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
+
+import java.net.URI;
+
+import javax.validation.Valid;
+
+@RestController
+@RequestMapping(value = "/customers")
+public class CustomerRestController {
+    private CustomerService customerService;
+    private ObjectMapper objectMapper = new ObjectMapper();
+
+    @Autowired
+    public CustomerRestController(CustomerService customerService) {
+        this.customerService = customerService;
+    }
+
+    @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<Customer> createCustomer(@RequestBody Customer customer) {
+        Customer customerCreated = customerService.createCustomer(customer);
+        URI location = ServletUriComponentsBuilder.fromCurrentRequest()
+                                                  .path("/{id}")
+                                                  .buildAndExpand(customerCreated.getId())
+                                                  .toUri();
+        return ResponseEntity.created(location).build();
+    }
+
+    @PatchMapping(path = "/{id}", consumes = "application/json-patch+json")
+    public ResponseEntity<Customer> updateCustomer(@PathVariable String id,
+                                                   @RequestBody JsonPatch patch) {
+        try {
+            Customer customer = customerService.findCustomer(id).orElseThrow(CustomerNotFoundException::new);
+            Customer customerPatched = applyPatchToCustomer(patch, customer);
+            customerService.updateCustomer(customerPatched);
+
+            return ResponseEntity.ok(customerPatched);
+        } catch (CustomerNotFoundException e) {
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
+        } catch (JsonPatchException | JsonProcessingException e) {
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
+        }
+    }
+
+    private Customer applyPatchToCustomer(JsonPatch patch, Customer targetCustomer) throws JsonPatchException, JsonProcessingException {
+        JsonNode patched = patch.apply(objectMapper.convertValue(targetCustomer, JsonNode.class));
+        return objectMapper.treeToValue(patched, Customer.class);
+    }
+}
@@ -0,0 +1,24 @@
+package com.baeldung.web.controller.status;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@Controller
+public class ExampleController {
+
+    @RequestMapping(value = "/controller", method = RequestMethod.GET)
+    @ResponseBody
+    public ResponseEntity sendViaResponseEntity() {
+        return new ResponseEntity(HttpStatus.NOT_ACCEPTABLE);
+    }
+
+    @RequestMapping(value = "/exception", method = RequestMethod.GET)
+    @ResponseBody
+    public ResponseEntity sendViaException() {
+        throw new ForbiddenException();
+    }
+}
@@ -0,0 +1,10 @@
+package com.baeldung.web.controller.status;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(value = HttpStatus.FORBIDDEN, reason = "To show an example of a custom message")
+public class ForbiddenException extends RuntimeException {
+    private static final long serialVersionUID = 6826605655586311552L;
+
+}
@@ -0,0 +1,22 @@
+package com.baeldung.web.dto;
+
+public class Bazz {
+
+    
+    public String id;
+    public String name;
+
+    public Bazz(String id){
+        this.id = id;
+    }
+    public Bazz(String id, String name) {
+        this.id = id;
+        this.name = name;
+    }
+
+    @Override
+    public String toString() {
+        return "Bazz [id=" + id + ", name=" + name + "]";
+    }
+    
+}
@@ -0,0 +1,45 @@
+package com.baeldung.web.dto;
+
+import com.thoughtworks.xstream.annotations.XStreamAlias;
+
+@XStreamAlias("Foo")
+public class Foo {
+    private long id;
+    private String name;
+
+    public Foo() {
+        super();
+    }
+
+    public Foo(final String name) {
+        super();
+
+        this.name = name;
+    }
+
+    public Foo(final long id, final String name) {
+        super();
+
+        this.id = id;
+        this.name = name;
+    }
+
+    // API
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(final long id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+}
@@ -0,0 +1,5 @@
+package com.baeldung.web.exception;
+
+public class CustomerNotFoundException extends RuntimeException {
+
+}