Example: Spring-MVC Spring-JDBC Spring-WS CastorMarshaller and jQuery

This is a web application, which front end is all about jQuery, back end is Spring-MVC to provide JSON web services, and Spring-JDBC to access a relational database, and Spring-WS to access a remote SOAP web services, and CastorMarshaller to convert between Java POJO and SOAP XML.

It starts with a Maven pom.xml.

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelversion>4.0.0</modelVersion> <groupid>myGroup</groupId> <artifactid>myApp</artifactId> <packaging>war</packaging> <version>1.0-SNAPSHOT</version> <name>My App Name</name> <url>http://www.mycomp.com/</url> <build> <finalname>myapp</finalName> </build> <repositories> <repository> <id>codehaus</id> <name>Maven Codehaus repository</name> <url>http://repository.codehaus.org/</url> </repository> </repositories> <properties> <spring.version>3.2.4.RELEASE</spring.version> <spring.ws.version>2.1.4.RELEASE</spring.ws.version> <jackson.version>1.9.13</jackson.version> <castor.version>1.2</castor.version> </properties> <dependencies> <dependency> <groupid>org.codehaus.castor</groupId> <artifactid>castor</artifactId> <version>${castor.version}</version> <exclusions> <exclusion> <artifactid>cglib-full</artifactId> <groupid>cglib</groupId> </exclusion> </exclusions> </dependency> <dependency> <groupid>org.codehaus.jackson</groupId> <artifactid>jackson-core-asl</artifactId> <version>${jackson.version}</version> <scope>runtime</scope> </dependency> <dependency> <groupid>org.codehaus.jackson</groupId> <artifactid>jackson-mapper-asl</artifactId> <version>${jackson.version}</version> <scope>runtime</scope> </dependency> <dependency> <groupid>org.springframework</groupId> <artifactid>spring-context</artifactId> <version>${spring.version}</version> <scope>runtime</scope> </dependency> <dependency> <groupid>org.springframework</groupId> <artifactid>spring-jdbc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupid>org.springframework</groupId> <artifactid>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupid>org.springframework.ws</groupId> <artifactid>spring-ws-core</artifactId> <version>${spring.ws.version}</version> </dependency> </dependencies> </project>

The access to the relational database and the access to the remote SOAP web services are totally parallel so I don't want any cross point between them. I set up two source folders to hold them respectively but point both output folder to src/main/webapp/WEB-INF/classes.

Now it comes to the web.xml.

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"> <display-name>myAppName</display-name> <context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:app1Context.xml, classpath:app2Context.xml</param-value> </context-param> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <servlet> <servlet-name>rest</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/rest-context.xml</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>rest</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>home.html</welcome-file> </welcome-file-list> </web-app>

As you can see, I use rest-context.xml to define the rest servlet.

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:oxm="http://www.springframework.org/schema/oxm" xmlns:util="http://www.springframework.org/schema/util" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-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/context http://www.springframework.org/schema/context/spring-context-3.0.xsd http://www.springframework.org/schema/oxm http://www.springframework.org/schema/oxm/spring-oxm-3.0.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"> <!-- Enables automatic mapping of objects to and from JSON --> <mvc:annotation-driven /> <!-- Setup spring to pull in @Controller, @RequestMapping, etc Configuration scans specified packages for classes configured as Spring managed beans and automatically sets up objects annotated with @Controller, @Service etc. --> <context:component-scan base-package="com.mycomp.app1.controllers, com.mycomp.app2.controllers" /> </beans>

This rest xml is rather simple. It simply scans two controllers packages for @Controller. But I have defined in the web.xml to delegate all app1 related spring beans to app1Context.xml and app2 to app2Context.xml which sit right at their source folders respectively.

The app1Context.xml is for accessing the relational database.

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" 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"> <context:annotation-config /> <bean id="myApp1Service" class="com.mycomp.app1.services.SimpleApp1ServiceImpl"> <property name="reader"> <ref bean="myApp1Reader"></ref> </property> </bean> <bean id="myApp1Reader" class="com.mycomp.app1.data.SimpleApp1ReaderImpl"> <property name="dataSource"> <ref bean="myApp1DataSource"></ref> </property> </bean> <bean id="myApp1DataSource" class="org.springframework.jndi.JndiObjectFactoryBean"> <property name="jndiName" value="java:/myApp1DS" /> </bean> </beans>

You will be wondering about where is the java:/myApp1DS. This comes to the JBoss JNDI datasource configuration. Create a xml file called myApp1-ds.xml.

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE datasources PUBLIC "-//JBoss//DTD Datasource 1.5//EN" "http://www.jboss.org/j2ee/dtd/jboss-ds_1_5.dtd"> <datasources> <local-tx-datasource> <jndi-name>myApp1DS</jndi-name> <connection-url>jdbc:mysql://mydbserver:3306/mydbname </connection-url> <driver-class>com.mysql.jdbc.Driver</driver-class> <user-name>mydbuser</user-name> <password>mydbpassword</password> <exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLExceptionSorter </exception-sorter-class-name> <metadata> <type-mapping>mySQL</type-mapping> </metadata> </local-tx-datasource> </datasources>

You will of course first enable that JDBC driver on the JBoss, but it should be an easy walk for any JBoss guy. Then deploy the myApp1-ds.xml to the server/default/deploy folder. Remember this file name has to be -ds.xml. It rather makes JBoss look like a toy.