Spring Web MVC dispatcher-servlet xml vs applicationContext xml plus shared security

Question

What is the correct way to use the two contexts  dispatcher-servlet xml and applicationContext xml  What goes where   I want to write a fairly typical app deployed in a servlet container  It has some controllers with JSP views  It also has some nontrivial logic on the back-end  Do I really need both contexts  How are they related to each other  How can I decide what to put in which   Also  I want to use Spring-security for my application  I may want to use its features  like declarative security with annotations  in web controllers as well as in deeper layers  How should I configure security to work in this case  Should it be in one of those files  which    or both

User · Answer

lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance       xmlns p  http   www springframework org schema p      xmlns context  http   www springframework org schema context      xmlns mvc  http   www springframework org schema mvc      xsi schemaLocation           http   www springframework org schema beans         http   www springframework org schema beans spring-beans-3 0 xsd         http   www springframework org schema context         http   www springframework org schema context spring-context-3 0 xsd         http   www springframework org schema mvc         http   www springframework org schema mvc spring-mvc-3 0 xsd   gt        lt mvc annotation-driven   gt       lt mvc default-servlet-handler   gt       lt mvc resources mapping   resources     location   resources     gt        lt context component-scan base-package  com sapta hr    gt        lt bean id  multipartResolver          class  org springframework web multipart commons CommonsMultipartResolver    gt        lt bean id  messageSource           class  org springframework context support ReloadableResourceBundleMessageSource  gt           lt property name  basename  value   WEB-INF messages    gt       lt  bean gt        lt bean id  viewResolver          class  org springframework web servlet view InternalResourceViewResolver  gt            lt property name  prefix  gt               lt value gt  WEB-INF pages  lt  value gt           lt  property gt           lt property name  suffix  gt               lt value gt  jsp lt  value gt           lt  property gt       lt  bean gt    lt  beans gt

User · Answer

lt  xml version  1 0  encoding  UTF-8   gt   lt web-app xmlns xsi  http   www w3 org 2001 XMLSchema-instance  xmlns  http   java sun com xml ns javaee  xsi schemaLocation  http   java sun com xml ns javaee http   java sun com xml ns javaee web-app 3 0 xsd  id  WebApp ID  version  3 0  gt     lt display-name gt TestPOC lt  display-name gt      lt servlet gt           lt servlet-name gt mvc-dispatcher lt  servlet-name gt           lt servlet-class gt org springframework web servlet DispatcherServlet lt  servlet-class gt           lt load-on-startup gt 1 lt  load-on-startup gt       lt  servlet gt       lt servlet-mapping gt           lt servlet-name gt mvc-dispatcher lt  servlet-name gt           lt url-pattern gt   lt  url-pattern gt       lt  servlet-mapping gt       lt context-param gt           lt param-name gt contextConfigLocation lt  param-name gt           lt param-value gt  WEB-INF mvc-dispatcher-servlet xml lt  param-value gt       lt  context-param gt      lt welcome-file-list gt       lt welcome-file gt index jsp lt  welcome-file gt     lt  welcome-file-list gt   lt  web-app gt

User · Answer

To add to Kevin s answer  I find that in practice nearly all of your non-trivial Spring MVC applications will require an application context  as opposed to only the spring MVC dispatcher servlet context    It is in the application context that you should configure all non-web related concerns such as   Security Persistence Scheduled Tasks Others   To make this a bit more concrete  here s an example of the Spring configuration I ve used when setting up a modern  Spring version 4 1 2  Spring MVC application   Personally  I prefer to still use a WEB-INF web xml file but that s really the only xml configuration in sight  WEB-INF web xml  lt  xml version  quot 1 0 quot  encoding  quot UTF-8 quot   gt   lt web-app xmlns  quot http   xmlns jcp org xml ns javaee quot  xmlns xsi  quot http   www w3 org 2001 XMLSchema-instance quot  xsi schemaLocation  quot http   xmlns jcp org xml ns javaee http   xmlns jcp org xml ns javaee web-app 3 1 xsd quot  version  quot 3 1 quot  gt        lt filter gt       lt filter-name gt openEntityManagerInViewFilter lt  filter-name gt       lt filter-class gt org springframework orm jpa support OpenEntityManagerInViewFilter lt  filter-class gt     lt  filter gt        lt filter gt       lt filter-name gt springSecurityFilterChain lt  filter-name gt       lt filter-class gt org springframework web filter DelegatingFilterProxy      lt  filter-class gt     lt  filter gt       lt filter-mapping gt       lt filter-name gt springSecurityFilterChain lt  filter-name gt       lt url-pattern gt    lt  url-pattern gt     lt  filter-mapping gt      lt filter-mapping gt       lt filter-name gt openEntityManagerInViewFilter lt  filter-name gt       lt url-pattern gt    lt  url-pattern gt     lt  filter-mapping gt        lt servlet gt       lt servlet-name gt springMvc lt  servlet-name gt       lt servlet-class gt org springframework web servlet DispatcherServlet lt  servlet-class gt       lt load-on-startup gt 1 lt  load-on-startup gt       lt init-param gt         lt param-name gt contextClass lt  param-name gt         lt param-value gt org springframework web context support AnnotationConfigWebApplicationContext lt  param-value gt       lt  init-param gt       lt init-param gt         lt param-name gt contextConfigLocation lt  param-name gt         lt param-value gt com company config WebConfig lt  param-value gt       lt  init-param gt     lt  servlet gt        lt context-param gt       lt param-name gt contextClass lt  param-name gt       lt param-value gt org springframework web context support AnnotationConfigWebApplicationContext lt  param-value gt     lt  context-param gt      lt context-param gt       lt param-name gt contextConfigLocation lt  param-name gt       lt param-value gt com company config AppConfig lt  param-value gt     lt  context-param gt      lt listener gt       lt listener-class gt org springframework web context ContextLoaderListener lt  listener-class gt     lt  listener gt      lt servlet-mapping gt       lt servlet-name gt springMvc lt  servlet-name gt       lt url-pattern gt   lt  url-pattern gt     lt  servlet-mapping gt        lt session-config gt       lt session-timeout gt 30 lt  session-timeout gt     lt  session-config gt      lt jsp-config gt       lt jsp-property-group gt         lt url-pattern gt   jsp lt  url-pattern gt         lt scripting-invalid gt true lt  scripting-invalid gt       lt  jsp-property-group gt     lt  jsp-config gt      lt  web-app gt    WebConfig java  Configuration  EnableWebMvc  ComponentScan basePackages    quot com company controller quot   public class WebConfig       Bean   public InternalResourceViewResolver getInternalResourceViewResolver         InternalResourceViewResolver resolver   new InternalResourceViewResolver        resolver setPrefix  quot  WEB-INF views  quot        resolver setSuffix  quot  jsp quot        return resolver          AppConfig java  Configuration  ComponentScan basePackages    quot com company quot    Import value    SecurityConfig class  PersistenceConfig class  ScheduleConfig class   public class AppConfig        application domain  Beans here        Security java  Configuration  EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter      Autowired   private LdapUserDetailsMapper ldapUserDetailsMapper      Override     protected void configure HttpSecurity http  throws Exception       http authorizeRequests          antMatchers  quot   quot   permitAll          antMatchers  quot     js    quot   permitAll          antMatchers  quot     images    quot   permitAll          antMatchers  quot     quot   access  quot hasRole  ROLE ADMIN   quot          and   formLogin         http logout   logoutRequestMatcher new AntPathRequestMatcher  quot  logout quot               Autowired     public void configureGlobal AuthenticationManagerBuilder auth  throws Exception         auth ldapAuthentication          userSearchBase  quot OU App Users quot          userSearchFilter  quot sAMAccountName  0  quot          groupSearchBase  quot OU Development quot          groupSearchFilter  quot member  0  quot          userDetailsContextMapper ldapUserDetailsMapper         contextSource getLdapContextSource              private LdapContextSource getLdapContextSource         LdapContextSource cs   new LdapContextSource        cs setUrl  quot ldaps   ldapServer 636 quot        cs setBase  quot DC COMPANY DC COM quot        cs setUserDn  quot CN administrator CN Users DC COMPANY DC COM quot        cs setPassword  quot password quot        cs afterPropertiesSet        return cs          PersistenceConfig java  Configuration  EnableTransactionManagement  EnableJpaRepositories transactionManagerRef    quot getTransactionManager quot   entityManagerFactoryRef    quot getEntityManagerFactory quot   basePackages    quot com company quot   public class PersistenceConfig       Bean   public LocalContainerEntityManagerFactoryBean getEntityManagerFactory DataSource dataSource        LocalContainerEntityManagerFactoryBean lef   new LocalContainerEntityManagerFactoryBean        lef setDataSource dataSource       lef setJpaVendorAdapter getHibernateJpaVendorAdapter         lef setPackagesToScan  quot com company quot        return lef         private HibernateJpaVendorAdapter getHibernateJpaVendorAdapter         HibernateJpaVendorAdapter hibernateJpaVendorAdapter   new HibernateJpaVendorAdapter        hibernateJpaVendorAdapter setDatabase Database ORACLE       hibernateJpaVendorAdapter setDatabasePlatform  quot org hibernate dialect Oracle10gDialect quot        hibernateJpaVendorAdapter setShowSql false       hibernateJpaVendorAdapter setGenerateDdl false       return hibernateJpaVendorAdapter          Bean   public JndiObjectFactoryBean getDataSource         JndiObjectFactoryBean jndiFactoryBean   new JndiObjectFactoryBean        jndiFactoryBean setJndiName  quot java comp env jdbc AppDS quot        return jndiFactoryBean          Bean   public JpaTransactionManager getTransactionManager DataSource dataSource        JpaTransactionManager jpaTransactionManager   new JpaTransactionManager        jpaTransactionManager setEntityManagerFactory getEntityManagerFactory dataSource  getObject         jpaTransactionManager setDataSource dataSource       return jpaTransactionManager          ScheduleConfig java  Configuration  EnableScheduling public class ScheduleConfig      Autowired   private EmployeeSynchronizer employeeSynchronizer        cron pattern  sec  min  hr  day-of-month  month  day-of-week  year  optional     Scheduled cron  quot 0 0 0       quot     public void employeeSync         employeeSynchronizer syncEmployees           As you can see  the web configuration is only a small part of the overall spring web application configuration   Most web applications I ve worked with have many concerns that lie outside of the dispatcher servlet configuration that require a full-blown application context bootstrapped via the org springframework web context ContextLoaderListener in the web xml

User · Answer

The dispatcher-servlet xml file contains all of your configuration for Spring MVC   So in it you will find beans such as ViewHandlerResolvers  ConverterFactories  Interceptors and so forth   All of these beans are part of Spring MVC which is a framework that structures how you handle web requests  providing useful features such as databinding  view resolution and request mapping   The application-context xml can optionally be included when using Spring MVC or any other framework for that matter   This gives you a container that may be used to configure other types of spring beans that provide support for things like data persistence   Basically  in this configuration file is where you pull in all of the other goodies Spring offers   These configuration files are configured in the web xml file as shown   Dispatcher Config   lt servlet gt       lt servlet-name gt dispatcher lt  servlet-name gt       lt servlet-class gt org springframework web servlet DispatcherServlet lt  servlet-class gt       lt init-param gt           lt param-name gt contextConfigLocation lt  param-name gt           lt param-value gt WEB-INF spring servlet-context xml lt  param-value gt       lt  init-param gt       lt load-on-startup gt 1 lt  load-on-startup gt   lt  servlet gt   lt servlet-mapping gt       lt servlet-name gt dispatcher lt  servlet-name gt       lt url-pattern gt   lt  url-pattern gt   lt  servlet-mapping gt    Application Config   lt context-param gt       lt param-name gt contextConfigLocation lt  param-name gt       lt param-value gt  WEB-INF spring application-context xml lt  param-value gt   lt  context-param gt    lt  -- Creates the Spring Container shared by all Servlets and Filters -- gt   lt listener gt       lt listener-class gt org springframework web context ContextLoaderListener lt  listener-class gt   lt  listener gt    To configure controllers  annotate them with  Controller  then include the following in the dispatcher-context xml file    lt mvc annotation-driven  gt   lt context component-scan base-package  package with controllers       gt

User · Answer

lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance       xmlns p  http   www springframework org schema p      xmlns context  http   www springframework org schema context      xmlns mvc  http   www springframework org schema mvc      xmlns cache  http   www springframework org schema cache      xsi schemaLocation           http   www springframework org schema beans         http   www springframework org schema beans spring-beans-3 0 xsd         http   www springframework org schema context         http   www springframework org schema context spring-context-3 0 xsd         http   www springframework org schema mvc         http   www springframework org schema mvc spring-mvc-3 0 xsd  http   www springframework org schema cache          http   www springframework org schema cache spring-cache-3 2 xsd         http   www springframework org schema context http   www springframework org schema context spring-context-3 1 xsd  gt            lt mvc annotation-driven  gt           lt context component-scan base-package  com testpoc controller   gt            lt bean id  ViewResolver  class  org springframework web servlet view InternalResourceViewResolver  gt               lt property name  ViewClass  value  org springframework web servlet view JstlView  gt  lt  property gt               lt property name  prefix  gt                   lt value gt  WEB-INF pages  lt  value gt               lt  property gt               lt property name  suffix  gt                   lt value gt  jsp lt  value gt               lt  property gt           lt  bean gt    lt  beans gt

User · Answer

lt mvc annotation-driven   gt   lt mvc default-servlet-handler   gt   lt mvc resources mapping   resources     location   resources     gt    lt context component-scan base-package  com tridenthyundai ains    gt    lt bean id  multipartResolver      class  org springframework web multipart commons CommonsMultipartResolver    gt    lt bean id  messageSource       class  org springframework context support ReloadableResourceBundleMessageSource  gt       lt property name  basename  value   WEB-INF messages    gt   lt  bean gt    lt bean id  viewResolver      class  org springframework web servlet view InternalResourceViewResolver  gt        lt property name  prefix  gt           lt value gt  WEB-INF pages  lt  value gt       lt  property gt       lt property name  suffix  gt           lt value gt  jsp lt  value gt       lt  property gt   lt  bean gt

[spring] Spring + Web MVC: dispatcher-servlet.xml vs. applicationContext.xml (plus shared security)

Examples related to spring

Examples related to spring-mvc

Examples related to spring-security