CORS – How to allow origin by domain using wildcard operator

fstarredCode hints, Java, javascript0 Comment

Create a filter class for enabling CORS

CORS ( Cross-Origin Resource Sharing ) is a mechanism provided by modern web browser to allow cross-site HTTP requests like XmlHttpRequest (Ex. Ajax).

This article does not cover discussions and articles about the CORS standard, – for which we refer to Wikipedia or MSDN article – instead we’ll show an example in Java on how dinamically enable CORS and send back the information to the client browser.

According the above scenario, our CORS filter must intercept the Origin value contained on the HEAD part of the request sent by the client.

Configure allowed site or domains

On the web application’s properties file, add a dedicated key where insert thrusted domain.

Something like this:

cors.domain.supported = *.mythrusteddomain.it

Then consider writing a class that implements a javax.servlet.Filter.

@WebFilter(urlPatterns="/*")
public class ApiOriginFilter implements Filter {

	@Inject
	ConfigService config;
	
	@Inject
	Logger logger;
	
	static String origins;
	
	static Pattern pattern;
	
	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		
		origins = config.getProperty("cors.domain.supported");
		
	}
	
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException 
	{						
		if (StringUtils.isNotEmpty(origins))
		{
			String[] list = origins.split(",");
			
			HttpServletRequest httpServletRequest = (HttpServletRequest)request;
			
			String origin = httpServletRequest.getHeader("Origin");
			
			logger.debug("origin: {}", origin);
			
			if (StringUtils.isNotEmpty(origin))
			{
				for (String item : list) {
					
					String input = item.trim();
					
					String regex = "^"   input.replace("*", ".*")   "(?::d )$";
					
					Pattern pattern = Pattern.compile(regex);
					
					Matcher matcher = pattern.matcher(origin);
					
					if (matcher.find())
					{
						String output = matcher.group(0);
						
						logger.info("origin allowed: {}", output);
						
						HttpServletResponse httpServletResponse = (HttpServletResponse) response;
						httpServletResponse.addHeader("Access-Control-Allow-Origin", "*");
						httpServletResponse.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
						httpServletResponse.addHeader("Access-Control-Allow-Headers", "Content-Type, api_key, Authorization");
					}			
				}
			}						
		}
		
		chain.doFilter(request, response);

	}

	@Override
	public void destroy() {

	}

Notice that if you are developting with REST API and JAX-RS 2.0, a better choice would be to implement ContainerResponseFilter class instead.

Test on local environment

In order to test ajax call on the same local environment, a simple way is to edit OS host’s file by adding a line:

127.0.0.1 foo.yourdomain.it

Then every XHRequest will point to http://foo.yourdomain.it/[service_address].

Oct172016

Web Application – Integration test with Arquillian

fstarredJava, JBoss0 Comment

Integration test with Arquillian

Arqullian is an infrastucture for doing integration tests by creating a reproduction archive of the source web app included of the unit test.

It integrates either with JUnit and TestNG.

This is the mission of Arquillian:

managing the lifecycle of the container (start/stop),
bundling the test class with dependent classes and resources into a deployable archive,
enhancing the test class (e.g., resolving @Inject, @EJB and @Resource injections),
deploying the archive to test (deploy/undeploy) and
capturing results and failures.

Basically, once the developer create the test archive using ShrinkWrap class, Arquillian automatically deal with it by deploying the package, run the test and optionally starting / stopping the container.

Arquillian basic example

You can download the Arquillian Example code HERE

Looking at documentation or maven archetypes, you’ll see examples like the following:

@RunWith(Arquillian.class)
public class MemberRegistrationTest {
    @Deployment
    public static Archive<?> createTestArchive() {
        return ShrinkWrap.create(WebArchive.class, "test.war")
                .addClasses(Member.class, MemberRegistration.class, Resources.class)
                .addAsResource("META-INF/test-persistence.xml", "META-INF/persistence.xml")
                .addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml")
                // Deploy our test datasource
                .addAsWebInfResource("test-ds.xml", "test-ds.xml");
    }

    @Inject
    MemberRegistration memberRegistration;

    @Inject
    Logger log;

    @Test
    public void testRegister() throws Exception {
        Member newMember = new Member();
        newMember.setName("Jane Doe");
        newMember.setEmail("jane@mailinator.com");
        newMember.setPhoneNumber("2125551234");
        memberRegistration.register(newMember);
        assertNotNull(newMember.getId());
        log.info(newMember.getName() + " was persisted with id " + newMember.getId());
    }

}

@RunWith(Arquillian.class)

public class MemberRegistrationTest {

@Deployment

public static Archive<?> createTestArchive() {

return ShrinkWrap.create(WebArchive.class, "test.war")

.addClasses(Member.class, MemberRegistration.class, Resources.class)

.addAsResource("META-INF/test-persistence.xml", "META-INF/persistence.xml")

.addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml")

// Deploy our test datasource

.addAsWebInfResource("test-ds.xml", "test-ds.xml");

}

@Inject

MemberRegistration memberRegistration;

@Inject

Logger log;

@Test

public void testRegister() throws Exception {

Member newMember = new Member();

newMember.setName("Jane Doe");

newMember.setEmail("jane@mailinator.com");

newMember.setPhoneNumber("2125551234");

memberRegistration.register(newMember);

assertNotNull(newMember.getId());

log.info(newMember.getName() + " was persisted with id " + newMember.getId());

}

This code is maybe good for showing Arquillian usage, but not for real world, where your web app could be multi-module composed with a many, many dependencies.

Arquillian real world example

In this chapter we’ll create a Rest Integration Test archive that contains ALL the module dependencies automatically imported by the Maven resolver.

First off, create an empty ear archive using maven archetype; for this purpose we’ll create a compliant jboss 6.4 ear module.

mvn archetype:generate  -DarchetypeGroupId=org.jboss.archetype.eap -DarchetypeArtifactId=jboss-javaee6-webapp-blank-archetype -DarchetypeVersion=6.4.0.GA

1	mvn archetype:generate -DarchetypeGroupId=org.jboss.archetype.eap -DarchetypeArtifactId=jboss-javaee6-webapp-blank-archetype -DarchetypeVersion=6.4.0.GA

Then you can create a simple EJB that return “hello” word.

@Local
public interface MyService {

	public String foo();
}

@Local

public interface MyService {

public String foo();

}

@Stateless
public class MyServiceBean implements MyService {

	@Override
	public String foo() {
		
		return "hello";
	}

}

@Stateless

public class MyServiceBean implements MyService {

@Override

public String foo() {

return "hello";

}

Now open the web module, edit pom.xml and add these dependencies:

<properties>
	<version.shrinkwrap.resolver>2.0.0</version.shrinkwrap.resolver>
</properties>

....

<dependency>
	<groupId>org.jboss.resteasy</groupId>
	<artifactId>resteasy-jaxrs</artifactId>
	<version>2.3.10.Final-redhat-1</version>
	<scope>provided</scope>
</dependency>

<dependency>
	<groupId>commons-logging</groupId>
	<artifactId>commons-logging</artifactId>
	<version>1.1.1</version>
	<scope>compile</scope>
</dependency>

<!-- Optional, but highly recommended -->
<!-- Arquillian allows you to test enterprise code such as EJBs and Transactional(JTA) 
	JPA from JUnit/TestNG -->
<dependency>
	<groupId>org.jboss.arquillian.junit</groupId>
	<artifactId>arquillian-junit-container</artifactId>
	<scope>test</scope>
</dependency>

<dependency>
	<groupId>org.jboss.arquillian.protocol</groupId>
	<artifactId>arquillian-protocol-servlet</artifactId>
	<scope>test</scope>
</dependency>

<dependency>
	<groupId>org.jboss.shrinkwrap.resolver</groupId>
	<artifactId>shrinkwrap-resolver-bom</artifactId>
	<version>${version.shrinkwrap.resolver}</version>
	<type>pom</type>
	<scope>test</scope>
</dependency>

<dependency>
	<groupId>org.jboss.shrinkwrap.resolver</groupId>
	<artifactId>shrinkwrap-resolver-depchain</artifactId>
	<scope>test</scope>
	<type>pom</type>
</dependency>

<version.shrinkwrap.resolver>2.0.0</version.shrinkwrap.resolver>

</properties>

....

<groupId>org.jboss.resteasy</groupId>

<artifactId>resteasy-jaxrs</artifactId>

<version>2.3.10.Final-redhat-1</version>

<scope>provided</scope>

</dependency>

<groupId>commons-logging</groupId>

<artifactId>commons-logging</artifactId>

<scope>compile</scope>

</dependency>

<!-- Arquillian allows you to test enterprise code such as EJBs and Transactional(JTA)

JPA from JUnit/TestNG -->

<groupId>org.jboss.arquillian.junit</groupId>

<artifactId>arquillian-junit-container</artifactId>

</dependency>

<groupId>org.jboss.arquillian.protocol</groupId>

<artifactId>arquillian-protocol-servlet</artifactId>

</dependency>

<groupId>org.jboss.shrinkwrap.resolver</groupId>

<artifactId>shrinkwrap-resolver-bom</artifactId>

<version>${version.shrinkwrap.resolver}</version>

</dependency>

<groupId>org.jboss.shrinkwrap.resolver</groupId>

<artifactId>shrinkwrap-resolver-depchain</artifactId>

</dependency>

So have added:

shrinkwrap artifact and arquillian modules;
a logging library
resteasy library (compliant with JBoss spec)

We can now include a class JaxRsActivator that extends jax rs Application for initialiting our rest methods.

/**
 * A class extending {@link Application} and annotated with @ApplicationPath is the Java EE 6 "no XML" approach to activating
 * JAX-RS.
 * 
 * <p>
 * Resources are served relative to the servlet path specified in the {@link ApplicationPath} annotation.
 * </p>
 */
@ApplicationPath("/rest")
public class JaxRsActivator extends Application {
    /* class body intentionally left blank */
}

/**

* A class extending {@link Application} and annotated with @ApplicationPath is the Java EE 6 "no XML" approach to activating

* JAX-RS.

* <p>

* Resources are served relative to the servlet path specified in the {@link ApplicationPath} annotation.

* </p>

@ApplicationPath("/rest")

public class JaxRsActivator extends Application {

/* class body intentionally left blank */

}

And our rest implementation entity

@Path("/myrest")
@RequestScoped
public class MyRest {

    @Inject
    MyService service;

    @GET
    @Path("/foo")
    @Produces(MediaType.TEXT_PLAIN)
    public String foo() 
    {
    	String output = service.foo();
        
    	return output;
    }	
}

@Path("/myrest")

@RequestScoped

public class MyRest {

@Inject

MyService service;

@GET

@Path("/foo")

@Produces(MediaType.TEXT_PLAIN)

public String foo()

{

String output = service.foo();

return output;

}

Despite is not – obviously – a real world example what we really need to know if how to create an ear test module without the need of importing all classes and dependencies manually

Under maven test package, create a class named ArqTest.java with the following lines:

@RunWith(Arquillian.class)
public class ArqTest {

	@Deployment
    public static Archive<?> createTestArchive() {
		System.out.println("START CREATE ARCHIVE");
		
		//create ear archive  
	    EnterpriseArchive ear = ShrinkWrap
	    		.create(EnterpriseArchive.class, "test-app.ear");  
		
	    System.out.println("RESOLVING EJB DEPENDENCIES");	    
	    // resolve and add ejbDependencies to ear lib  
	    File[] ejbDependencies = Maven.resolver()
	    		.loadPomFromFile("../ejb/pom.xml")
//	    		.importRuntimeAndTestDependencies()
	    		.importDependencies(ScopeType.COMPILE, ScopeType.TEST)
	    		.resolve()
	    		.withTransitivity()
	    		.asFile();
	    
//	    System.out.println(MyService.class.getPackage().getName());
	    
	    System.out.println("START CREATE EJB");
	    // create ejb-jar  
	    JavaArchive ejb = ShrinkWrap
	    		.create(JavaArchive.class, "test-ejb.jar")	    		
	    		.addPackage("it.test.arqear.ejb")	    		
	    		.addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml")
	    		;
	    
	    for (File file : ejbDependencies)
	    	ejb.addAsResource(file);
	    	    
	    System.out.println("START CREATE WAR");
            //resolve war and add beans.xml and my html files manually  
	    WebArchive war = ShrinkWrap
				.create(MavenImporter.class, "test-web.war")
				.loadPomFromFile("pom.xml")				
				.importBuildOutput()								
				.as(WebArchive.class)				
				.addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml")
//				.addAsWebResource(new File("src/main/webapp", "web.xml"));  
				;
		
		//add built modules to ear and my application.xml  
	    ear.addAsModule(ejb);  
	    ear.addAsModule(war);
//	    ear.addAsLibraries(ejbDependencies);
	    ear.setApplicationXML("test-application.xml");
		
        System.out.println("END CREATE ARCHIVE");
        
        return ear;
    }
	
	
	@BeforeClass 
	@RunAsClient // runs as client
	public static void shouldBeAbleToRunOnClientSideBeforeRemoteTest() throws Exception {
		System.out.println("STARTING CLIENT");
	}
	
	static final String REST_PATH = "rest";
	
	@Test
	@RunAsClient
	public void testFoo(@ArquillianResource final URL base) throws Exception
	{
		ClientRequest request = new ClientRequest(new URL(base, REST_PATH + "/myrest/foo").toExternalForm());
		
		ClientResponse<String> clientResponse = request.get(String.class);
		
		Assert.assertEquals(clientResponse.getStatus(), HttpResponseCodes.SC_OK);
	}
	
}

@RunWith(Arquillian.class)

public class ArqTest {

@Deployment

public static Archive<?> createTestArchive() {

System.out.println("START CREATE ARCHIVE");

//create ear archive

EnterpriseArchive ear = ShrinkWrap

.create(EnterpriseArchive.class, "test-app.ear");

System.out.println("RESOLVING EJB DEPENDENCIES");

// resolve and add ejbDependencies to ear lib

File[] ejbDependencies = Maven.resolver()

.loadPomFromFile("../ejb/pom.xml")

// .importRuntimeAndTestDependencies()

.importDependencies(ScopeType.COMPILE, ScopeType.TEST)

.resolve()

.withTransitivity()

.asFile();

// System.out.println(MyService.class.getPackage().getName());

System.out.println("START CREATE EJB");

// create ejb-jar

JavaArchive ejb = ShrinkWrap

.create(JavaArchive.class, "test-ejb.jar")

.addPackage("it.test.arqear.ejb")

.addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml")

;

for (File file : ejbDependencies)

ejb.addAsResource(file);

System.out.println("START CREATE WAR");

//resolve war and add beans.xml and my html files manually

WebArchive war = ShrinkWrap

.create(MavenImporter.class, "test-web.war")

.loadPomFromFile("pom.xml")

.importBuildOutput()

.as(WebArchive.class)

.addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml")

// .addAsWebResource(new File("src/main/webapp", "web.xml"));

;

//add built modules to ear and my application.xml

ear.addAsModule(ejb);

ear.addAsModule(war);

// ear.addAsLibraries(ejbDependencies);

ear.setApplicationXML("test-application.xml");

System.out.println("END CREATE ARCHIVE");

return ear;

}

@BeforeClass

@RunAsClient // runs as client

public static void shouldBeAbleToRunOnClientSideBeforeRemoteTest() throws Exception {

System.out.println("STARTING CLIENT");

}

static final String REST_PATH = "rest";

@Test

@RunAsClient

public void testFoo(@ArquillianResource final URL base) throws Exception

{

ClientRequest request = new ClientRequest(new URL(base, REST_PATH + "/myrest/foo").toExternalForm());

ClientResponse<String> clientResponse = request.get(String.class);

Assert.assertEquals(clientResponse.getStatus(), HttpResponseCodes.SC_OK);

}

Since ShrinkWrap doesn’t support EJB archive actually (at least with 2.0.0 version) what we need is:

Create an EAR archive
Import EJB dependencies with Maven resolver
Create an EJB package and add all needed classes (even resolving these by package)
Add imported EJB dependencies as resources within the EJB archive
Create war (don’t forget to create beans.xml both in war end ejb archive in order to make injection work)

We have also created a test-application.xml file, which is needed to conformly create our ear archive

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_6.xsd" version="6">
  <display-name>test-ear</display-name>
  <module>
    <web>
      <web-uri>project-arqear-test-web.war</web-uri>
      <context-root>/test-web</context-root>
    </web>
  </module>
  <module>
    <ejb>test-ejb.jar</ejb>
  </module>
  <library-directory>lib</library-directory>
</application>

<?xml version="1.0" encoding="UTF-8"?>

<display-name>test-ear</display-name>

<web>

<web-uri>project-arqear-test-web.war</web-uri>

<context-root>/test-web</context-root>

</web>

</module>

</module>

<library-directory>lib</library-directory>

</application>

For the test part, @RunAsClient annotation is used because we want these test to run OUTSIDE the container.

Notice also that @ArquillianResource is useful because automatically resolve our deployed ear test URL (which may be even a remote URL by properly configure the arquillian.xml file).

Arquillian configuration

The following is an example of arquillian.xml properly configured for running a test on a local or remote container, even with managed option

<defaultProtocol type="Servlet 3.0" />

<engine>
	<property name="deploymentExportPath">target/deployment</property>
</engine>


<container qualifier="jboss_local" default="true">
	<configuration>
		
	</configuration>
</container>

<container qualifier="jboss_remote">
	<configuration>
		<property name="managementAddress">myhost.remote.it</property>
		<property name="managementPort">9999</property>
		<property name="username">admin</property>
		<property name="password">${password}</property>
	</configuration>
</container>

<container qualifier="jboss_local_managed">
	<configuration>
		<property name="jbossHome">D:\Software\jboss-eap-6.4</property>
	</configuration>
</container>

<property name="deploymentExportPath">target/deployment</property>

</engine>

</configuration>

</container>

<property name="managementAddress">myhost.remote.it</property>

<property name="username">admin</property>

<property name="password">${password}</property>

</configuration>

</container>

<property name="jbossHome">D:\Software\jboss-eap-6.4</property>

</configuration>

</container>

If you are willing to create the archive for the first time, it’s also very important to see the built package for verifying the result, so setting deploymentExportPath will produce the output in the selected path.

Run the Arquillian integration test

If you created the project using a maven archetype like written on the first part of this article, you’ll notice that pom.xml has already some arquillian profiles created.

If you already started your local JBoss environment, simply launch this command:

mvn clean test -Parq-jbossas-remote

1	mvn clean test -Parq-jbossas-remote

If you need to test your web application in a AS remote address, type the following:

mvn clean test -Parq-jbossas-remote -Darquillian.launch=jboss_remote -Dpassword=<remote_mgmt_user_password>

1	mvn clean test -Parq-jbossas-remote -Darquillian.launch=jboss_remote -Dpassword=<remote_mgmt_user_password>

Download example

You can download the Arquillian Example code HERE

Jun72016

Create a Java Restful Web Application (Jersey, EJB3, JPA, JBoss 5.1, JDK 6) from ZERO with Maven

fstarredHibernate, Java, JBoss, JPA1 Comment

Create a web application with JBoss 5.1 and JDK 6

In this post we’ll see how to set up a complete life-cyle webapp within JBoss 5.1 on JDK 6.

Please notice this example is no-IDE dependant, therefore the procedure below is created with maven and manual editing.

The requirements / specs for this example are:

JDK 6
JBoss 5.1 GA
JPA (1.0)
EJB 3.x
Jersey 2.6
MySql

You can download the full example here

MySQL Database

Download full Database definition and script

Basically, create a database called JPADB and two tables definied as below:

Person

CREATE TABLE `person` (
  `id` int(11) NOT NULL,
  `name` varchar(100) NOT NULL,
  `surname` varchar(100) NOT NULL,
  `city_id` int(11) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=cp1251;

CREATE TABLE `person` (

`id` int(11) NOT NULL,

`name` varchar(100) NOT NULL,

`surname` varchar(100) NOT NULL,

`city_id` int(11) NOT NULL

) ENGINE=InnoDB DEFAULT CHARSET=cp1251;

Cities

CREATE TABLE `cities` (
  `location_id` int(11) NOT NULL,
  `name` varchar(100) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=cp1251;

CREATE TABLE `cities` (

`location_id` int(11) NOT NULL,

`name` varchar(100) NOT NULL

) ENGINE=InnoDB DEFAULT CHARSET=cp1251;

Make sure you execute the following scripts:

INSERT INTO `cities` (`location_id`, `name`) VALUES
(1, 'Rome'),
(2, 'Paris');


INSERT INTO `person` (`id`, `name`, `surname`, `city_id`) VALUES
(1, 'Mario', 'Rossi', 1);

INSERT INTO `cities` (`location_id`, `name`) VALUES

(1, 'Rome'),

(2, 'Paris');

INSERT INTO `person` (`id`, `name`, `surname`, `city_id`) VALUES

(1, 'Mario', 'Rossi', 1);

JBoss configuration

To make MySql work on JBoss environment, copy mysql-connector-java-5.1.18.jar under {JBOSS_HOME}/server/default/lib.

Then, create a file called mysql-ds.xml under {JBOSS_HOME}/server/default/deploy with this content:

<?xml version="1.0" encoding="UTF-8"?>

<datasources>

    <local-tx-datasource>

		<jndi-name>MySqlDS</jndi-name>

		<connection-url>jdbc:mysql://hostname:3306/jpadb</connection-url>

		<driver-class>com.mysql.jdbc.Driver</driver-class>

		<user-name>myuser</user-name>

		<password>password</password>

		<valid-connection-checker-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker</valid-connection-checker-class-name>

		<metadata>

			<type-mapping>mySQL</type-mapping>

		</metadata>

    </local-tx-datasource>

</datasources>

<?xml version="1.0" encoding="UTF-8"?>

<local-tx-datasource>

<jndi-name>MySqlDS</jndi-name>

<connection-url>jdbc:mysql://hostname:3306/jpadb</connection-url>

<driver-class>com.mysql.jdbc.Driver</driver-class>

<user-name>myuser</user-name>

<password>password</password>

<valid-connection-checker-class-name>org.jboss.resource.adapter.jdbc.vendor.MySQLValidConnectionChecker</valid-connection-checker-class-name>

<type-mapping>mySQL</type-mapping>

</metadata>

</local-tx-datasource>

</datasources>

Optionally:

If you want to enable remote debugging with JBoss, edit run.conf or run.bat.conf (depending on your sistem) and under the line “Sample JPDA settings for remote socket debugging“, type in the following line:

set "JAVA_OPTS=%JAVA_OPTS% -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"

1	set "JAVA_OPTS=%JAVA_OPTS% -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"

Please notice:

Setting localhost instead of yourhostname can result in access error on mysql db.

Create EJB module

From the command line, type in the following command:

mvn archetype:generate -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=ejb-javaee6

1	mvn archetype:generate -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=ejb-javaee6

This will create an ejb project compatible with Java6.

Edit pom.xml and edit the following line

<configuration>
  <ejbVersion>3.1</ejbVersion>
  <span style="color: #ff0000;"><generateClient>true</generateClient></span>
</configuration>

</configuration>

By enabling the generation of the client, all the modules using the ejb can include the ejb-client on its classpath

<build>
  <span style="color: #ff0000;"><finalName>sample-ejb</finalName></span>

1 2	<build> <span style="color: #ff0000;"><finalName>sample-ejb</finalName></span>

Then, create a file called persistence.xml with the following content:

<?xml version="1.0" encoding="UTF-8"?>

<persistence xmlns="http://java.sun.com/xml/ns/persistence"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"
             version="1.0">

	<persistence-unit name="managerJpa">
		<provider>org.hibernate.ejb.HibernatePersistence</provider>
		<jta-data-source>java:/MySqlDS</jta-data-source>
		<properties>
			<property name="hibernate.dialect" value="org.hibernate.dialect.MySQLDialect" />
		</properties>

	</persistence-unit>
</persistence>

<?xml version="1.0" encoding="UTF-8"?>

<persistence xmlns="http://java.sun.com/xml/ns/persistence"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"

version="1.0">

<persistence-unit name="managerJpa">

<provider>org.hibernate.ejb.HibernatePersistence</provider>

<jta-data-source>java:/MySqlDS</jta-data-source>

</properties>

</persistence-unit>

</persistence>

Create City.java

package it.sample.ejb.model;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name="cities")
public class City {

	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	@Column(name="location_id")
	private int id;

	@Column(name="name")
	private String name;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	@Override
	public String toString() {
		return "City [id=" + id + ", name=" + name + "]";
	}


}

package it.sample.ejb.model;

import javax.persistence.Column;

import javax.persistence.Entity;

import javax.persistence.GeneratedValue;

import javax.persistence.GenerationType;

import javax.persistence.Id;

import javax.persistence.Table;

@Entity

@Table(name="cities")

public class City {

@Id

@GeneratedValue(strategy = GenerationType.AUTO)

@Column(name="location_id")

private int id;

@Column(name="name")

private String name;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

@Override

public String toString() {

return "City [id=" + id + ", name=" + name + "]";

}

and Person.java

package it.sample.ejb.model;

import java.io.Serializable;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.OneToOne;
import javax.persistence.Table;

@Entity
@Table(name="person")
public class Person implements Serializable {

	/**
	 *
	 */
	private static final long serialVersionUID = -6143028707403936296L;

	@Id
	@GeneratedValue(strategy = GenerationType.AUTO)
	@Column(name="id")
	int id;

	@Column(name="name")
	String name;

	@Column(name="surname")
	String surname;

	@OneToOne(cascade = { CascadeType.ALL }, fetch = FetchType.EAGER)
	@JoinColumn(name = "city_id")
	City city;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getSurname() {
		return surname;
	}

	public void setSurname(String surname) {
		this.surname = surname;
	}

	public City getCity() {
		return city;
	}

	public void setCity(City city) {
		this.city = city;
	}
}

package it.sample.ejb.model;

import java.io.Serializable;

import javax.persistence.CascadeType;

import javax.persistence.Column;

import javax.persistence.Entity;

import javax.persistence.FetchType;

import javax.persistence.GeneratedValue;

import javax.persistence.GenerationType;

import javax.persistence.Id;

import javax.persistence.JoinColumn;

import javax.persistence.OneToOne;

import javax.persistence.Table;

@Entity

@Table(name="person")

public class Person implements Serializable {

/**

private static final long serialVersionUID = -6143028707403936296L;

@Id

@GeneratedValue(strategy = GenerationType.AUTO)

@Column(name="id")

int id;

@Column(name="name")

String name;

@Column(name="surname")

String surname;

@OneToOne(cascade = { CascadeType.ALL }, fetch = FetchType.EAGER)

@JoinColumn(name = "city_id")

City city;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public String getSurname() {

return surname;

}

public void setSurname(String surname) {

this.surname = surname;

}

public City getCity() {

return city;

}

public void setCity(City city) {

this.city = city;

}

Create PersonBeanLocal.java as the following:

@Local
public interface PersonLocal {

   Person getPerson(int id);

}

@Local

public interface PersonLocal {

Person getPerson(int id);

}

The PersonRemote.java interface

@Remote
public interface PersonRemote {

   Person getPerson(int id);

}

@Remote

public interface PersonRemote {

Person getPerson(int id);

}

The PersonBean.java implementation

@Stateless
public class PersonBean implements PersonLocal, PersonRemote {

 @PersistenceContext(unitName="managerJpa")
 private EntityManager em;

 @Override
 public Person getPerson(int id) {

 Person output = em.find(Person.class, id);

 return output;

 }
}

@Stateless

public class PersonBean implements PersonLocal, PersonRemote {

@PersistenceContext(unitName="managerJpa")

private EntityManager em;

@Override

public Person getPerson(int id) {

Person output = em.find(Person.class, id);

return output;

}

Your ejb module is now completed. Build and deploy it under {JBOSS_HOME}/server/default/deploy directory with the following command under project directory:

Windows example

@echo off
START /w "maven process" mvn clean package ^&^& exit
copy target\sample-ejb.jar %JOSS_HOME%\server\default\deploy\
START /w "maven process" mvn install:install-file -Dfile=target\sample-ejb-client.jar -DgroupId=it.sample.ejb -DartifactId=sample-ejb-client -Dversion=1.0-SNAPSHOT -Dpackaging=jar ^&^& exit

@echo off

START /w "maven process" mvn clean package ^&^& exit

copy target\sample-ejb.jar %JOSS_HOME%\server\default\deploy\

START /w "maven process" mvn install:install-file -Dfile=target\sample-ejb-client.jar -DgroupId=it.sample.ejb -DartifactId=sample-ejb-client -Dversion=1.0-SNAPSHOT -Dpackaging=jar ^&^& exit

The last line will install the ejb-client.jar under maven local repository in order to be included in the webapp classpath.

Create web module

First off, create a web module with the jersey archetype

mvn archetype:generate -DarchetypeArtifactId=jersey-quickstart-webapp -DarchetypeGroupId=org.glassfish.jersey.archetypes -DinteractiveMode=false -DgroupId=it.sample -DartifactId=sample-web -Dpackage=it.sample -DinteractiveMode=true

1	mvn archetype:generate -DarchetypeArtifactId=jersey-quickstart-webapp -DarchetypeGroupId=org.glassfish.jersey.archetypes -DinteractiveMode=false -DgroupId=it.sample -DartifactId=sample-web -Dpackage=it.sample -DinteractiveMode=true

Edit pom.xml so the result will be the following:

<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/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>

 <groupId>it.sample.web</groupId>
 <artifactId>sample-web</artifactId>
 <version>1.0-SNAPSHOT</version>
 <packaging>war</packaging>

 <name>sample-web</name>

 <properties>
 <jersey.version>2.6</jersey.version>
 <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
 <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 </properties>

 <dependencies>
 <dependency>
 <groupId>org.glassfish.jersey.containers</groupId>
 <artifactId>jersey-container-servlet-core</artifactId>
 <!-- use the following artifactId if you don't need servlet 2.x compatibility -->
 <!-- artifactId>jersey-container-servlet</artifactId -->
 </dependency>
 <dependency>
 <groupId>org.glassfish.jersey.media</groupId>
 <artifactId>jersey-media-moxy</artifactId>
 </dependency>
 <dependency>
 <groupId>org.glassfish.jersey.core</groupId>
 <artifactId>jersey-client</artifactId>
 <version>2.22.2</version>
 </dependency>
 <dependency>
 <groupId>org.jboss.spec</groupId>
 <artifactId>jboss-javaee-6.0</artifactId>
 <version>1.0.0.Final</version>
 <type>pom</type>
 <scope>provided</scope>
 </dependency>
 <dependency>
 <groupId>it.sample.ejb</groupId>
 <artifactId>sample-ejb-client</artifactId>
 <version>1.0-SNAPSHOT</version>

 </dependency>

 </dependencies>

 <dependencyManagement>
 <dependencies>
 <dependency>
 <groupId>org.glassfish.jersey</groupId>
 <artifactId>jersey-bom</artifactId>
 <version>${jersey.version}</version>
 <type>pom</type>
 <scope>import</scope>
 </dependency>
 </dependencies>
 </dependencyManagement>

 <build>
 <finalName>sample-web</finalName>
 <plugins>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-compiler-plugin</artifactId>
 <version>2.3.2</version>
 <configuration>
 <source>1.6</source>
 <target>1.6</target>
 <compilerArguments>
 <endorseddirs>${endorsed.dir}</endorseddirs>
 </compilerArguments>
 </configuration>
 </plugin>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-war-plugin</artifactId>
 <version>2.1.1</version>
 <configuration>
 <failOnMissingWebXml>false</failOnMissingWebXml>
 <packagingExcludes>WEB-INF/lib/*ejb-client*.jar</packagingExcludes>
 </configuration>
 </plugin>
 <plugin>
 <groupId>org.apache.maven.plugins</groupId>
 <artifactId>maven-dependency-plugin</artifactId>
 <version>2.1</version>
 <executions>
 <execution>
 <phase>validate</phase>
 <goals>
 <goal>copy</goal>
 </goals>
 <configuration>
 <outputDirectory>${endorsed.dir}</outputDirectory>
 <silent>true</silent>
 <artifactItems>
 <artifactItem>
 <groupId>javax</groupId>
 <artifactId>javaee-endorsed-api</artifactId>
 <version>6.0</version>
 <type>jar</type>
 </artifactItem>
 </artifactItems>
 </configuration>
 </execution>
 </executions>
 </plugin>
 </plugins>
 </build>

</project>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

<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/xsd/maven-4.0.0.xsd">

<groupId>it.sample.web</groupId>

<artifactId>sample-web</artifactId>

<version>1.0-SNAPSHOT</version>

<name>sample-web</name>

<jersey.version>2.6</jersey.version>

<endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

</properties>

<groupId>org.glassfish.jersey.containers</groupId>

<artifactId>jersey-container-servlet-core</artifactId>

</dependency>

<groupId>org.glassfish.jersey.media</groupId>

<artifactId>jersey-media-moxy</artifactId>

</dependency>

<groupId>org.glassfish.jersey.core</groupId>

<artifactId>jersey-client</artifactId>

</dependency>

<groupId>org.jboss.spec</groupId>

<artifactId>jboss-javaee-6.0</artifactId>

<version>1.0.0.Final</version>

<scope>provided</scope>

</dependency>

<groupId>it.sample.ejb</groupId>

<artifactId>sample-ejb-client</artifactId>

<version>1.0-SNAPSHOT</version>

</dependency>

</dependencies>

<groupId>org.glassfish.jersey</groupId>

<artifactId>jersey-bom</artifactId>

<version>${jersey.version}</version>

<scope>import</scope>

</dependency>

</dependencies>

</dependencyManagement>

<build>

<finalName>sample-web</finalName>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-compiler-plugin</artifactId>

<endorseddirs>${endorsed.dir}</endorseddirs>

</compilerArguments>

</configuration>

</plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-war-plugin</artifactId>

<failOnMissingWebXml>false</failOnMissingWebXml>

<packagingExcludes>WEB-INF/lib/*ejb-client*.jar</packagingExcludes>

</configuration>

</plugin>

<groupId>org.apache.maven.plugins</groupId>

<artifactId>maven-dependency-plugin</artifactId>

<phase>validate</phase>

<goals>

</goals>

<outputDirectory>${endorsed.dir}</outputDirectory>

<groupId>javax</groupId>

<artifactId>javaee-endorsed-api</artifactId>

</artifactItem>

</artifactItems>

</configuration>

</execution>

</executions>

</plugin>

</plugins>

</build>

</project>

According to Jersey Documentation, last Jersey compatible with JDK 6 is version 2.6.

Notice that with the line

 <packagingExcludes>WEB-INF/lib/*ejb-client*.jar</packagingExcludes>

1	<packagingExcludes>WEB-INF/lib/ejb-client.jar</packagingExcludes>

the war package will not include the ejb-client libraries, otherwise the binding to the ejb interfaces will fail.

Under src directory, create a file named jndi.properties with the following:

# JBossNS properties
java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory
java.naming.provider.url=jnp://localhost:1099
java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces

# JBossNS properties

java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory

java.naming.provider.url=jnp://localhost:1099

java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces

Now it’s time to create the model returned from our future rest service; we’ll use JAXB specs in order to return an xml response, if requested.

Create CityResult.java

@XmlRootElement(name = "city")
@XmlAccessorType(XmlAccessType.FIELD)
public class CityResult {

	@XmlElement(required = true)
	private int id;
	@XmlElement(required = true)
	private String name;

	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
}

@XmlRootElement(name = "city")

@XmlAccessorType(XmlAccessType.FIELD)

public class CityResult {

@XmlElement(required = true)

private int id;

@XmlElement(required = true)

private String name;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

Create PersonResult.java

@XmlRootElement(name = "person")
@XmlAccessorType(XmlAccessType.FIELD)
public class PersonResult {

	@XmlElement(required = true)
	int id;

	@XmlElement(required = true)
	String name;

	@XmlElement(required = true)
	String surname;

	@XmlElement(required = false)
	CityResult city;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getSurname() {
		return surname;
	}

	public void setSurname(String surname) {
		this.surname = surname;
	}

	public CityResult getCity() {
		return city;
	}

	public void setCity(CityResult city) {
		this.city = city;
	}
}

@XmlRootElement(name = "person")

@XmlAccessorType(XmlAccessType.FIELD)

public class PersonResult {

@XmlElement(required = true)

int id;

@XmlElement(required = true)

String name;

@XmlElement(required = true)

String surname;

@XmlElement(required = false)

CityResult city;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public String getSurname() {

return surname;

}

public void setSurname(String surname) {

this.surname = surname;

}

public CityResult getCity() {

return city;

}

public void setCity(CityResult city) {

this.city = city;

}

Finally, create PersonService.java

@Path("person")
public class PersonService {

	java.util.logging.Logger logger = Logger.getLogger(PersonService.class.getName());

	@GET
	@Path("/id/{id: \\d+}")
	@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
	public Response getPerson(@PathParam("id") int id)
	{
		PersonResult output = null;

		try {

			InitialContext ctx = new InitialContext();

			PersonLocal local = (PersonLocal)ctx.lookup("PersonBean/local");

			Person person = local.getPerson(id);

			output = new PersonResult();

			output.setId(person.getId());
			output.setName(person.getName());
			output.setSurname(person.getSurname());

			output.setCity(new CityResult());
			output.getCity().setId(person.getCity().getId());
			output.getCity().setName(person.getCity().getName());

		} catch (NamingException e) {
			logger.severe(e.getMessage());
			return Response.serverError().entity(e.getMessage()).type(MediaType.TEXT_PLAIN).build();
		}

		return Response.ok().entity(output).build();
	}

}

@Path("person")

public class PersonService {

java.util.logging.Logger logger = Logger.getLogger(PersonService.class.getName());

@GET

@Path("/id/{id: \\d+}")

@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})

public Response getPerson(@PathParam("id") int id)

{

PersonResult output = null;

try {

InitialContext ctx = new InitialContext();

PersonLocal local = (PersonLocal)ctx.lookup("PersonBean/local");

Person person = local.getPerson(id);

output = new PersonResult();

output.setId(person.getId());

output.setName(person.getName());

output.setSurname(person.getSurname());

output.setCity(new CityResult());

output.getCity().setId(person.getCity().getId());

output.getCity().setName(person.getCity().getName());

} catch (NamingException e) {

logger.severe(e.getMessage());

return Response.serverError().entity(e.getMessage()).type(MediaType.TEXT_PLAIN).build();

}

return Response.ok().entity(output).build();

}

That’s all.

Deploy web module with the following command from project root directory:

Windows command example

START /w "maven process" mvn clean package eclipse:clean eclipse:eclipse ^&^& exit
copy target\sample-web.war %JBOSS_HOME%\server\default\deploy\

1 2	START /w "maven process" mvn clean package eclipse:clean eclipse:eclipse ^&^& exit copy target\sample-web.war %JBOSS_HOME%\server\default\deploy\

You can better test PersonService from a rest client browser like postman or restclient:

Type in the following on the address bar:

http://localhost:8084/sample-web/webapi/person/id/1

restclient

Set Accept: application/xml on the request header will return an xml response instead.

Mar182015

MyBatis Generator – How to use MBG

fstarredJava0 Comment

MyBatis Generator – Run MBG

MyBatis Generator can run in several ways, in this guide it will be shown how to run MBG from

Java batch
Ant

First of all, create your environment with a so built directory tree:

src
- mapper
- model
- xml
- batch
- log4j.properties
lib
- mybatis-generator-core-x.x.x.jar
- mybatis-x.x.x.jar
- log4j-x.x.x.jar
- (jdbc drivers.jar)
build.xml
generatorConfig.xml

CONFIGURATION

Here’s a sample of generatorConfig.xml:

<generatorConfiguration>

  <context id="DB2Tables" targetRuntime="MyBatis3">

  	<plugin type="org.mybatis.generator.plugins.MapperConfigPlugin">
    	<property name="targetProject" value="${generated.source.dir}"/>
    	<property name="targetPackage" value="test.mapper.config"/>
    </plugin>

    <plugin type="org.mybatis.generator.plugins.RowBoundsPlugin">
    </plugin>

    <jdbcConnection driverClass="com.ibm.db2.jcc.DB2Driver"
        connectionURL="jdbc:db2://localhost:5025/DB2"
        userId="user"
        password="pwd">
    </jdbcConnection>

    <javaTypeResolver >
      <property name="forceBigDecimals" value="false" />
    </javaTypeResolver>

    <javaModelGenerator targetPackage="model" targetProject="${generated.source.dir}">
      <property name="enableSubPackages" value="false" />
      <property name="trimStrings" value="true" />
    </javaModelGenerator>

    <sqlMapGenerator targetPackage="xml" targetProject="${generated.source.dir}">
      <property name="enableSubPackages" value="false" />
    </sqlMapGenerator>

    <javaClientGenerator type="XMLMAPPER" targetPackage="mapper" targetProject="${generated.source.dir}">
      <property name="enableSubPackages" value="false" />
    </javaClientGenerator>

    <table schema="schemaX" tableName="tableX" domainObjectName="beanX">
    	<property name="useActualColumnNames" value="false"/>
    	<property name="runtimeSchema" value="${@DEFAULT_SCHEMA}"/>
    </table>
    <!-- ... -->
  </context>
</generatorConfiguration>

</plugin>

</plugin>

<jdbcConnection driverClass="com.ibm.db2.jcc.DB2Driver"

connectionURL="jdbc:db2://localhost:5025/DB2"

userId="user"

password="pwd">

</jdbcConnection>

</javaTypeResolver>

</javaModelGenerator>

</sqlMapGenerator>

</javaClientGenerator>

</table>

</context>

</generatorConfiguration>

JAVA BATCH

In batch package, create class called Generator and put this code:

package batch;

import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import org.apache.log4j.Logger;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

public class Generator {

public final static Logger log = Logger.getLogger(Generator.class.getName());
	
	public static void main(String[] args) {
		List<String> warnings = new ArrayList<String>();
		boolean overwrite = true;
		File configFile = new File("generatorConfig.xml");
		try {
			
			Properties p = new Properties();
			p.setProperty("generated.source.dir", new java.io.File( "." ).getCanonicalPath().concat("/src"));
			
			ConfigurationParser cp = new ConfigurationParser(p, warnings);						
			Configuration config = cp.parseConfiguration(configFile);			
			DefaultShellCallback callback = new DefaultShellCallback(overwrite);			
			MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);				
			myBatisGenerator.generate(null);
		} catch (IOException e) {
			log.error(e);
		} catch (XMLParserException e) {
			log.error(e);
		} catch (InvalidConfigurationException e) {
			log.error(e);
		} catch (SQLException e) {
			log.error(e);
		} catch (InterruptedException e) {
			log.error(e);
		}
	}
}

package batch;

import java.io.File;

import java.io.IOException;

import java.sql.SQLException;

import java.util.ArrayList;

import java.util.List;

import java.util.Properties;

import org.apache.log4j.Logger;

import org.mybatis.generator.api.MyBatisGenerator;

import org.mybatis.generator.config.Configuration;

import org.mybatis.generator.config.xml.ConfigurationParser;

import org.mybatis.generator.exception.InvalidConfigurationException;

import org.mybatis.generator.exception.XMLParserException;

import org.mybatis.generator.internal.DefaultShellCallback;

public class Generator {

public final static Logger log = Logger.getLogger(Generator.class.getName());

public static void main(String[] args) {

List<String> warnings = new ArrayList<String>();

boolean overwrite = true;

File configFile = new File("generatorConfig.xml");

try {

Properties p = new Properties();

p.setProperty("generated.source.dir", new java.io.File( "." ).getCanonicalPath().concat("/src"));

ConfigurationParser cp = new ConfigurationParser(p, warnings);

Configuration config = cp.parseConfiguration(configFile);

DefaultShellCallback callback = new DefaultShellCallback(overwrite);

MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);

myBatisGenerator.generate(null);

} catch (IOException e) {

log.error(e);

} catch (XMLParserException e) {

log.error(e);

} catch (InvalidConfigurationException e) {

log.error(e);

} catch (SQLException e) {

log.error(e);

} catch (InterruptedException e) {

log.error(e);

}

ANT TASK

<?xml version="1.0" encoding="UTF-8"?>
<!-- WARNING: Eclipse auto-generated file.
              Any modifications will be overwritten.
              To include a user specific buildfile here, simply create one in the same
              directory with the processing instruction <?eclipse.ant.import?>
              as the first entry and export the buildfile again. -->
<project basedir="." default="clean" name="MyBatisCIGOGenerator">
	<property environment="env" />
	<property name="ECLIPSE_HOME" value="C:/Program Files (x86)/IBM/SDP" />
	<property name="debuglevel" value="source,lines,vars" />
	<property name="target" value="1.6" />
	<property name="source" value="1.6" />
	<property name="lib" value="lib" />
	<property name="generated.source.dir" value="./src" />

	<path id="toollib">
		<pathelement location="${lib}/db2jcc.jar" />
		<pathelement location="${lib}/db2jcc_license_cu.jar" />
		<pathelement location="${lib}/db2jcc_license_cisuz.jar" />
		<pathelement location="${lib}/log4j-1.2.16.jar" />
		<pathelement location="${generated.source.dir}"/>
	</path>

	<target name="genfiles" description="Generate the files">
		<taskdef name="mbgenerator"
			classname="org.mybatis.generator.ant.GeneratorAntTask"
			classpath="${lib}/mybatis-generator-core-1.3.2.jar"
			classpathref="toollib"
			>
		</taskdef>
		<mbgenerator overwrite="true" configfile="generatorConfig.xml" verbose="false">
			<propertyset>
				<propertyref name="generated.source.dir" />
			</propertyset>
		</mbgenerator>
	</target>

	<target name="clean">
		<delete>
			<fileset dir="src" includes="**/*.java" excludes="**/Generator.java" />
			<fileset dir="src" includes="**/*.xml" />
		</delete>
	</target>

</project>

<?xml version="1.0" encoding="UTF-8"?>

<!-- WARNING: Eclipse auto-generated file.

Any modifications will be overwritten.

To include a user specific buildfile here, simply create one in the same

directory with the processing instruction <?eclipse.ant.import?>

as the first entry and export the buildfile again. -->

</path>

<taskdef name="mbgenerator"

classname="org.mybatis.generator.ant.GeneratorAntTask"

classpath="${lib}/mybatis-generator-core-1.3.2.jar"

classpathref="toollib"

</taskdef>

</propertyset>

</mbgenerator>

</target>

</delete>

</target>

</project>

Notice that line:

<pathelement location="${generated.source.dir}"/>

1	<pathelement location="${generated.source.dir}"/>

allow to find log4j.properties into src folder; otherwise, log4j should be located into project root folder.

Feb252015

MyBatis – Create your custom Example class

fstarredCode hints, Java0 Comment

Create own Example class with MyBatis

Sometimes it happens you need to extend the Example class generated with myBatis with some a specific criteria requirement.

For example, with a query like this:

select *
from tablePerson
inner join tableCar
on tablePerson.id = tableCar.person_id
where 
[..}tablePerson criteria[..]
and tableCar.name like #{car_name}

select *

from tablePerson

inner join tableCar

on tablePerson.id = tableCar.person_id

where

[..}tablePerson criteria[..]

and tableCar.name like #{car_name}

the PersonExample model may not be enough, due to the criteria related to tableCar at query last line. How could we write a custom criteria ?
There are severaly ways to do this, however our primary goal is to keep untouched the generated example/critera classes.

The solution comes with extending the PersonExample and Criteria class, in order to achieve an elegant solution like this:

PersonExampleCustom example = new&nbsp;PersonExampleCustom();

PersonExtendCriteria cr = (PersonExtendCriteria) example.createCriteria;

// NOTICE! in a chained condition the custom criteria must be at initial position
cr
 .andCarNameLike("Fiesta%")
[..] other conditions derived from base criteria 

mapper.selectPersonByExample(example);

PersonExampleCustom example = new PersonExampleCustom();

PersonExtendCriteria cr = (PersonExtendCriteria) example.createCriteria;

// NOTICE! in a chained condition the custom criteria must be at initial position

.andCarNameLike("Fiesta%")

[..] other conditions derived from base criteria

mapper.selectPersonByExample(example);

Here’s the hint code to write the PersonExtendedCriteria class:

public class PersonExtendedCriteria extends Criteria {

  	public PersonExample.Criteria andCarName(Character value) {
    		addCriterion("CAR_NAME like", value, "car.name");
    		return this;
  	}
}

public class PersonExtendedCriteria extends Criteria {

public PersonExample.Criteria andCarName(Character value) {

addCriterion("CAR_NAME like", value, "car.name");

return this;

}

and PersonExampleCustom class:

public class PersonExampleCustom extends PersonExample {

  	@Override
  	protected Criteria createCriteriaInternal() {
    		return new PersonExtendedCriteria();
  	}
}