Merge branch 'master' of https://github.com/JonCook/tutorials

spring-dispatcher-servlet/README.md

@@ -0,0 +1,7 @@
+## Spring DispatcherServlet
+
+This module contains articles about Spring DispatcherServlet
+
+## Relevant articles:
+
+- [An Intro to the Spring DispatcherServlet](https://www.baeldung.com/spring-dispatcherservlet)

spring-dispatcher-servlet/pom.xml

@@ -0,0 +1,101 @@
+<?xml version="1.0"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.baeldung</groupId>
+    <artifactId>spring-dispatcher-servlet</artifactId>
+    <version>1.0.0</version>
+    <name>spring-dispatcher-servlet</name>
+    <packaging>war</packaging>
+
+    <parent>
+        <groupId>com.baeldung</groupId>
+        <artifactId>parent-spring-5</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
+        <relativePath>../parent-spring-5</relativePath>
+    </parent>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+            <version>${spring.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-webmvc</artifactId>
+            <version>${spring.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <version>${javax.servlet-api.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet.jsp.jstl</groupId>
+            <artifactId>jstl-api</artifactId>
+            <version>${jstl-api.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet.jsp</groupId>
+            <artifactId>javax.servlet.jsp-api</artifactId>
+            <version>${javax.servlet.jsp-api.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.codehaus.jackson</groupId>
+            <artifactId>jackson-mapper-asl</artifactId>
+            <version>${jackson-mapper-asl.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>jstl</artifactId>
+            <version>${jstl.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-fileupload</groupId>
+            <artifactId>commons-fileupload</artifactId>
+            <version>${commons-fileupload.version}</version>
+        </dependency>
+        <dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<version>1.5.10.RELEASE</version>
+			<scope>test</scope>
+		</dependency>
+    </dependencies>
+
+    <build>
+        <finalName>spring-dispatcher-servlet</finalName>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.tomcat.maven</groupId>
+                    <artifactId>tomcat8-maven-plugin</artifactId>
+                    <version>${tomcat8-maven-plugin.version}</version>
+                    <configuration>
+                        <path>/springdispatcherservlet</path>
+                    </configuration>
+                </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-war-plugin</artifactId>
+                    <version>${maven-war-plugin.version}</version>
+                    <configuration>
+                        <warSourceDirectory>src/main/webapp</warSourceDirectory>
+                        <failOnMissingWebXml>false</failOnMissingWebXml>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+    </build>
+
+    <properties>
+        <tomcat8-maven-plugin.version>3.0-r1655215</tomcat8-maven-plugin.version>
+    </properties>
+
+</project>

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/configuration/AppConfig.java

@@ -0,0 +1,83 @@
+package com.baeldung.springdispatcherservlet.configuration;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.ui.context.support.ResourceBundleThemeSource;
+import org.springframework.web.multipart.commons.CommonsMultipartResolver;
+import org.springframework.web.servlet.config.annotation.*;
+import org.springframework.web.servlet.resource.PathResourceResolver;
+import org.springframework.web.servlet.theme.CookieThemeResolver;
+import org.springframework.web.servlet.theme.ThemeChangeInterceptor;
+import org.springframework.web.servlet.view.JstlView;
+import org.springframework.web.servlet.view.UrlBasedViewResolver;
+
+import java.io.IOException;
+
+@Configuration
+@EnableWebMvc
+@ComponentScan("com.baeldung.springdispatcherservlet")
+public class AppConfig implements WebMvcConfigurer {
+
+    public void addViewControllers(ViewControllerRegistry registry) {
+        registry.addViewController("/").setViewName("index");
+    }
+
+    /** Multipart file uploading configuratioin */
+    @Bean
+    public CommonsMultipartResolver multipartResolver() throws IOException {
+        CommonsMultipartResolver resolver = new CommonsMultipartResolver();
+        resolver.setMaxUploadSize(10000000);
+        return resolver;
+    }
+
+    /** View resolver for JSP */
+    @Bean
+    public UrlBasedViewResolver viewResolver() {
+        UrlBasedViewResolver resolver = new UrlBasedViewResolver();
+        resolver.setPrefix("/WEB-INF/jsp/");
+        resolver.setSuffix(".jsp");
+        resolver.setViewClass(JstlView.class);
+        return resolver;
+    }
+
+    /** Static resource locations including themes*/
+    @Override
+    public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry.addResourceHandler("/resources/**/*")
+                .addResourceLocations("/", "/resources/")
+                .setCachePeriod(3600)
+                .resourceChain(true)
+                .addResolver(new PathResourceResolver());
+    }
+
+    /** BEGIN theme configuration */
+    @Bean
+    public ResourceBundleThemeSource themeSource(){
+        ResourceBundleThemeSource themeSource = new ResourceBundleThemeSource();
+        themeSource.setDefaultEncoding("UTF-8");
+        themeSource.setBasenamePrefix("themes.");
+        return themeSource;
+    }
+
+    @Bean
+    public CookieThemeResolver themeResolver(){
+        CookieThemeResolver resolver = new CookieThemeResolver();
+        resolver.setDefaultThemeName("default");
+        resolver.setCookieName("example-theme-cookie");
+        return resolver;
+    }
+
+    @Bean
+    public ThemeChangeInterceptor themeChangeInterceptor(){
+        ThemeChangeInterceptor interceptor = new ThemeChangeInterceptor();
+        interceptor.setParamName("theme");
+        return interceptor;
+    }
+
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        registry.addInterceptor(themeChangeInterceptor());
+    }
+    /** END theme configuration */
+}

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/configuration/WebAppInitializer.java

@@ -0,0 +1,23 @@
+package com.baeldung.springdispatcherservlet.configuration;
+
+import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRegistration;
+
+import org.springframework.web.WebApplicationInitializer;
+import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
+import org.springframework.web.servlet.DispatcherServlet;
+
+public class WebAppInitializer implements WebApplicationInitializer {
+
+	@Override
+	public void onStartup(ServletContext container) throws ServletException {
+		AnnotationConfigWebApplicationContext context = new AnnotationConfigWebApplicationContext();
+		context.register(AppConfig.class);
+		context.setServletContext(container);
+
+		ServletRegistration.Dynamic servlet = container.addServlet("dispatcher", new DispatcherServlet(context));
+		servlet.setLoadOnStartup(1);
+		servlet.addMapping("/");
+	}
+}

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/controller/MultipartController.java

@@ -0,0 +1,47 @@
+package com.baeldung.springdispatcherservlet.controller;
+
+import org.springframework.beans.factory.annotation.Autowired;
+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.RequestParam;
+import org.springframework.web.multipart.MultipartFile;
+import org.springframework.web.servlet.ModelAndView;
+
+import javax.servlet.ServletContext;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.InputStream;
+
+@Controller
+public class MultipartController {
+
+    @Autowired
+    ServletContext context;
+
+    @RequestMapping(value = "/upload", method = RequestMethod.POST)
+    public ModelAndView FileuploadController(@RequestParam("file") MultipartFile file) {
+        ModelAndView modelAndView = new ModelAndView("index");
+        try {
+            InputStream in = file.getInputStream();
+            String path = new File(".").getAbsolutePath();
+            FileOutputStream f = new FileOutputStream(path.substring(0, path.length() - 1) + "/uploads/" + file.getOriginalFilename());
+            try {
+                int ch;
+                while ((ch = in.read()) != -1) {
+                    f.write(ch);
+                }
+                modelAndView.getModel().put("message", "File uploaded successfully!");
+            } catch (Exception e) {
+                System.out.println("Exception uploading multipart: " + e);
+            } finally {
+                f.flush();
+                f.close();
+                in.close();
+            }
+        } catch (Exception e) {
+            System.out.println("Exception uploading multipart: " + e);
+        }
+        return modelAndView;
+    }
+}

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/controller/UserController.java

@@ -0,0 +1,30 @@
+package com.baeldung.springdispatcherservlet.controller;
+
+import com.baeldung.springdispatcherservlet.domain.User;
+import com.baeldung.springdispatcherservlet.services.UserService;
+import org.springframework.beans.factory.annotation.Autowired;
+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.RequestParam;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@Controller
+@RequestMapping("/user")
+public class UserController {
+
+    @Autowired
+    private UserService userService;
+
+    @RequestMapping(value = "/example", method = RequestMethod.GET)
+    @ResponseBody
+    public User fetchUserExample() {
+        return userService.exampleUser();
+    }
+
+    @RequestMapping(value = "/name", method = RequestMethod.GET)
+    @ResponseBody
+    public User fetchUserByFirstName(@RequestParam(value = "firstName") String firstName) {
+        return userService.fetchUserByFirstName(firstName);
+    }
+}

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/controller/UserRestController.java

@@ -0,0 +1,27 @@
+package com.baeldung.springdispatcherservlet.controller;
+
+import com.baeldung.springdispatcherservlet.domain.User;
+import com.baeldung.springdispatcherservlet.services.UserService;
+import org.springframework.beans.factory.annotation.Autowired;
+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.RestController;
+
+@RestController
+@RequestMapping("/rest/user")
+public class UserRestController {
+
+    @Autowired
+    private UserService userService;
+
+    @RequestMapping(value = "/example", method = RequestMethod.GET)
+    public User fetchUserExample() {
+        return userService.exampleUser();
+    }
+
+    @RequestMapping(value = "/name", method = RequestMethod.GET)
+    public User fetchUserByFirstName(@RequestParam(value = "firstName") String firstName) {
+        return userService.fetchUserByFirstName(firstName);
+    }
+}

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/domain/User.java

@@ -0,0 +1,41 @@
+package com.baeldung.springdispatcherservlet.domain;
+
+
+public class User {
+    private long id;
+    private String firstName;
+    private String lastName;
+
+    public User(long id, String firstName, String lastName) {
+        this.id = id;
+        this.firstName = firstName;
+        this.lastName = lastName;
+    }
+
+    public User() {
+    }
+
+    public long getId() {
+        return id;
+    }
+
+    public void setId(long id) {
+        this.id = id;
+    }
+
+    public String getFirstName() {
+        return firstName;
+    }
+
+    public void setFirstName(String firstName) {
+        this.firstName = firstName;
+    }
+
+    public String getLastName() {
+        return lastName;
+    }
+
+    public void setLastName(String lastName) {
+        this.lastName = lastName;
+    }
+}

spring-dispatcher-servlet/src/main/java/com/baeldung/springdispatcherservlet/services/UserService.java

@@ -0,0 +1,17 @@
+package com.baeldung.springdispatcherservlet.services;
+
+import org.springframework.stereotype.Service;
+
+import com.baeldung.springdispatcherservlet.domain.User;
+
+@Service
+public class UserService {
+
+    public User fetchUserByFirstName(String firstName) {
+        return new User(1, firstName, "Everyperson");
+    }
+
+    public User exampleUser() {
+        return new User(1, "Example", "Everyperson");
+    }
+}

spring-dispatcher-servlet/src/main/resources/logback.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
+            </pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT" />
+    </root>
+</configuration>

spring-dispatcher-servlet/src/main/resources/themes/default.properties

@@ -0,0 +1 @@
+styleSheet=/resources/css/default.css

spring-dispatcher-servlet/src/main/resources/themes/example.properties

@@ -0,0 +1 @@
+styleSheet=/resources/css/example.css

spring-dispatcher-servlet/src/main/webapp/WEB-INF/jsp/index.jsp

@@ -0,0 +1,30 @@
+<%@taglib uri="http://www.springframework.org/tags" prefix="spring"%>
+<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>
+<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>
+<%@ page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1" %>
+
+<c:set var="ctx" value="${pageContext.request.contextPath}" />
+
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Spring Dispatcher</title>
+    <link rel="stylesheet" href="${ctx}/<spring:theme code='styleSheet'/>" type="text/css"/>
+</head>
+<body>
+    <h2>Hello World!</h2>
+    <br/>
+    <a href="${ctx}/?theme=example">Switch Theme!</a>
+    <a href="${ctx}/?theme=default">Switch Theme!</a>
+    <br/>
+    <br/>
+    <br/>
+    <form action="${ctx}/upload" method="post" enctype="multipart/form-data">
+        <label>Upload a file! </label><input type="file" name="file"/>
+        <input type="submit" value="Upload File"/>
+    </form>
+    <br/>
+    <br/>
+    ${message}
+</body>
+</html>

spring-dispatcher-servlet/src/main/webapp/resources/css/default.css

@@ -0,0 +1,4 @@
+h2 {
+    color: green;
+    font-weight: 400;
+}

spring-dispatcher-servlet/src/main/webapp/resources/css/example.css

@@ -0,0 +1,4 @@
+h2 {
+    color: red;
+    font-weight: 700;
+}

spring-dispatcher-servlet/src/test/java/org/baeldung/SpringContextIntegrationTest.java

@@ -0,0 +1,19 @@
+package org.baeldung;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+
+import com.baeldung.springdispatcherservlet.configuration.AppConfig;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = AppConfig.class)
+@WebAppConfiguration
+public class SpringContextIntegrationTest {
+
+    @Test
+    public void whenSpringContextIsBootstrapped_thenNoExceptions() {
+    }
+}

spring-dispatcher-servlet/src/test/java/org/baeldung/SpringContextTest.java

@@ -0,0 +1,19 @@
+package org.baeldung;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+
+import com.baeldung.springdispatcherservlet.configuration.AppConfig;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = AppConfig.class)
+@WebAppConfiguration
+public class SpringContextTest {
+
+    @Test
+    public void whenSpringContextIsBootstrapped_thenNoExceptions() {
+    }
+}