Setup Lombok with STS/Eclipse based IDE

For those of you who haven't heard about boilerplate code, you can check this link
Now that you already know what's that we found this little library

You can add it to your Maven projects easily, however adding it to your Eclipse is a challenge, especially if you are not using barebones Eclipse like me, who happens to use STS and initially it didn't work:

Why it doesn’t generate getter and setter like in the video? I already installed that thing like 3 times and nothing :(

Well, the solution for me was this:

Paste the JAR manually into MacOS folder

Add the option
-vmargs -javaagent:lombok-1.16.16.jar to the file STS.ini

Finally you NEED to close the STS/eclipse and start again. (Restart doesn’t take effect)

Once you’ve done close and start STS. You’ll see the getter and setter is autogenerated.
In case you see any compilation errors, just clean and build your project.

Voila!

Add Token Based Authentication on Spring Security

Problem I have an application which has already implemented Basic Authentication using Spring Security.
Now as part of a new requirement I have to enable a Token based authentication as well.
My first task was to updgrade to Spring 3.0.7 and to Spring Security 3.1.3 among other dependicies that needed an update as well.
After that, let's go to the meaty part of this implementation :)
While researching I couldn't find any example, only pieces, that's why I'm publishing and sharing my findings with all the community:

At least I knew that I had to implement another Authentication Provider (that's why I needed to Upgrade my App) and something to catch the event of login and tell Spring to perform another authentication (like a Filter, maybe?)

This is my implementation: Spring's config <security:http auto-config="true" access-denied-page="/login" authentication-manager-ref="defaultAuthenticationManager"> <security:intercept-url pattern="/login" access="IS_AUTHENTICATED_ANONYMOUSLY"/> <security:intercept-url pattern="/logout.do" access="IS_AUTHENTICATED_ANONYMOUSLY"/> <security:intercept-url pattern="/**/*.gif" access="IS_AUTHENTICATED_ANONYMOUSLY"/> <security:custom-filter ref="kaplanCustomOncePerRequestFilterFilter" before="PRE_AUTH_FILTER"/> <security:intercept-url pattern="/3.0/onlineprofile" access="ROLE_ktp_user"/> <security:intercept-url pattern="/**" access="ROLE_ktp_user, ROLE_System User"/> <security:form-login authentication-failure-url="/login" default-target-url="/3.0/services" login-page="/login" login-processing-url="/login.do"/> <security:logout logout-success-url="/login" logout-url="/logout.do"/> </security:http> <security:authentication-manager id="defaultAuthenticationManager" alias="authenticationManager"> <security:authentication-provider user-service-ref="kaplanUserDetailsService"> <security:password-encoder ref="kaplanPasswordEncoder"/> </security:authentication-provider> <security:authentication-provider user-service-ref="kaplanOAuth2UserDetailsService"/> </security:authentication-manager> ... <bean id="kaplanOAuth2UserDetailsService" class="kaplan.ktpa.core.auth.oauth2.KaplanOAuth2UserDetailsService"/> <bean id="kaplanCustomOncePerRequestFilterFilter" class="kaplan.ktpa.core.auth.filter.KaplanCustomOncePerRequestFilterFilter"> <property name="accessToken" value="Authentication"/><!-- We can set this in a property --> <property name="tokenValidator" ref="pingIdentityTokenValidator"/> </bean> <bean id="pingIdentityTokenValidator" class="kaplan.ktpa.core.auth.ping.PingIdentityTokenValidatorImpl"> <property name="clientId" value="${security.ping.clientid}"/> <property name="clientSecret" value="${security.ping.clientsecret}"/> <property name="pingUrl" value="${security.ping.url}"/> </bean>
PingIdentityTokenValidatorImpl (Validates Given token) public class PingIdentityTokenValidatorImpl implements TokenValidator{ private static final Logger log = Logger .getLogger(PingIdentityTokenValidatorImpl.class); public static final String PROFILE_ID = "profileId"; public static final String TOKEN_PREFIX = "Bearer "; private String pingUrl; private String clientId; private String clientSecret; public String validateToken(final String accessTokenParam) { log.debug("Token with prefix="+accessTokenParam); String accessToken = StringUtils.substringAfterLast(accessTokenParam, TOKEN_PREFIX); log.debug("Token="+accessToken); String postData = "grant_type=urn:pingidentity.com:oauth2:grant_type:validate_bearer&token=" + accessToken; String result = ""; URL url = null; String profileId = null; try { log.debug("Posting to "+pingUrl); url = new URL(pingUrl); String authInfo = clientId + ":" + clientSecret; log.debug("authInfo="+authInfo); byte[] authinfobytes = authInfo.getBytes(); authInfo = new String(Base64.encodeBase64(authinfobytes)); URLConnection conn = url.openConnection(); conn.setDoOutput(true); conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); conn.setRequestProperty("Authorization", "Basic " + authInfo); conn.setRequestProperty("Content-Length", String.valueOf(postData.length())); conn.setRequestProperty("grant_type", "urn:pingidentity.com:oauth2:grant_type:validate_bearer"); conn.setRequestProperty("token", accessToken); OutputStreamWriter outputStreamWriter = new OutputStreamWriter( conn.getOutputStream()); outputStreamWriter.write(postData); outputStreamWriter.flush(); BufferedReader bufferedReader = new BufferedReader(new InputStreamReader( conn.getInputStream())); StringBuilder stringBuilder = new StringBuilder(); String aux = ""; while ((aux = bufferedReader.readLine()) != null) { stringBuilder.append(aux); } result = stringBuilder.toString(); log.debug("result="+result); if (result.contains(PROFILE_ID)) { log.debug("result contains profileId"); profileId = StringUtils.substringBetween(result, "\""+PROFILE_ID+"\":\"","\"}}"); //profileId = result.substring(result.indexOf("\""+PROFILE_ID+"\":\"") + 13, result.length() - 3); } outputStreamWriter.close(); bufferedReader.close(); } catch (MalformedURLException e) { log.warn("MalformedURLException while validating Token (noPrefix)=" + accessToken, e); } catch (IOException e) { log.warn("IOException while validating Token (noPrefix)=" + accessToken, e); } catch (Exception ex){ log.error("Error while validating Token (noPrefix)=" + accessToken, ex); } log.debug("profileId="+profileId); return profileId; } }
KaplanOAuth2UserDetailsService (Performs Authentication, generates user following spring security standards) public class KaplanOAuth2UserDetailsService implements UserDetailsService { private static final Logger log = Logger .getLogger(KaplanOAuth2UserDetailsService.class); @Override public UserDetails loadUserByUsername(String profileId) throws UsernameNotFoundException { log.debug("Loading profileId="+profileId); KaplanUser kaplanUser = new KaplanUser(profileId, profileId, true, true, true, true, this.grantedAuthorities(), 1L); log.debug("Returning kaplanUser="+kaplanUser); return kaplanUser; } private List<GrantedAuthority> grantedAuthorities() { List<GrantedAuthority> authorities = new ArrayList<GrantedAuthority>(); authorities.add(new SimpleGrantedAuthority("ROLE_"+ KaplanCustomAuthProcessingFilter.OAUTH_ROLE)); return authorities; } }
KaplanCustomOncePerRequestFilterFilter (This filter does the trick) Just add it to your security configuration in the right place of the chain of execution and you're set public class KaplanCustomOncePerRequestFilterFilter extends OncePerRequestFilter { private static final Logger log = Logger .getLogger(KaplanCustomOncePerRequestFilterFilter.class); private String accessToken; //Now looks like a RequestHeaderAuthFilter @Autowired private KaplanOAuth2UserDetailsService authUserDetailsService; @Autowired private TokenValidator tokenValidator; @Override protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException { String authToken = null; UsernamePasswordAuthenticationToken authRequest = null; Authentication authentication = SecurityContextHolder.getContext() .getAuthentication(); if (authentication != null) { authToken = authentication.getName(); } if (StringUtils.isNotBlank(request.getHeader(this.accessToken))) { authToken = request.getHeader(this.accessToken); String profileId = this.tokenValidator.validateToken(authToken); if (profileId == null) { throw new VerificationFailedException("Unable to authenticate using token " + authToken); } List<GrantedAuthority> authorities = new ArrayList<GrantedAuthority>(); authorities.add(new SimpleGrantedAuthority("ROLE_"+KaplanCustomAuthProcessingFilter.OAUTH_ROLE)); authRequest = new UsernamePasswordAuthenticationToken(profileId, profileId, authorities); HttpSession session = request.getSession(false); if (session != null) { request.getSession().setAttribute(KaplanCustomAuthProcessingFilter.SPRING_SECURITY_LAST_USERNAME, TextEscapeUtils.escapeEntities(authToken)); request.getSession().setAttribute(KaplanCustomAuthProcessingFilter.SPRING_SECURITY_SAVED_REQUEST, new DefaultSavedRequest(request, new PortResolverImpl())); } Object details = authUserDetailsService.loadUserByUsername(profileId); authRequest.setDetails(details); SecurityContextHolder.getContext().setAuthentication(authRequest); } filterChain.doFilter(request, response); } Although, my original approach was to extend from AbstractAuthenticationProcessingFilter, however I saw it being invoked multiple times per request (it didn't bother me), but that wasn't good enough for me, also it was more complex :P public class KaplanCustomAuthProcessingFilter extends AbstractAuthenticationProcessingFilter { private static final Logger log = Logger .getLogger(KaplanCustomAuthProcessingFilter.class); private static final String DEFAULT_FILTER_PROCESSES_URL = "/login"; private static final String POST = "POST"; public static final String OAUTH_ROLE = "ktp_user"; public static final String SPRING_SECURITY_LAST_USERNAME = "SPRING_SECURITY_LAST_USERNAME"; public static final String SPRING_SECURITY_SAVED_REQUEST = "SPRING_SECURITY_SAVED_REQUEST"; private String accessToken; //Now looks like a RequestHeaderAuthFilter @Autowired private AuthenticationManager authenticationManager; @Autowired private KaplanOAuth2UserDetailsService authUserDetailsService; @Autowired private TokenValidator tokenValidator; public KaplanCustomAuthProcessingFilter() { super(DEFAULT_FILTER_PROCESSES_URL); super.setAuthenticationManager(authenticationManager); super.setAuthenticationDetailsSource(authenticationDetailsSource); this.setTokenValidator(tokenValidator); } public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws IOException, ServletException { if (request.getMethod().equals(POST)) { log.debug("doFilter Method POST"); super.doFilter(request, response, filterChain); } else { log.debug("doFilter Method GET OR OTHER - not POST"); filterChain.doFilter(request, response); } } @Override protected boolean requiresAuthentication(final HttpServletRequest request, final HttpServletResponse response) { boolean result = false; if (StringUtils.isNotBlank(request.getHeader(this.accessToken))) { result = true; } log.debug("requiresAuthentication? "+result); return result; } @Override protected void successfulAuthentication(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Authentication authResult) throws IOException, ServletException { log.debug("Authentication was successful"); super.successfulAuthentication(request, response, chain, authResult); } @Override public Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response) throws AuthenticationException, IOException, ServletException { String authToken = null; UsernamePasswordAuthenticationToken authRequest = null; Authentication authentication = SecurityContextHolder.getContext() .getAuthentication(); if (authentication != null) { authToken = authentication.getName(); } if (StringUtils.isNotBlank(request.getHeader(this.accessToken))) { authToken = request.getHeader(this.accessToken); String profileId = this.tokenValidator.validateToken(authToken); if (profileId == null) { throw new VerificationFailedException("Unable to authenticate using token " + authToken); } List<GrantedAuthority> authorities = new ArrayList<GrantedAuthority>(); authorities.add(new SimpleGrantedAuthority("ROLE_"+OAUTH_ROLE)); authRequest = new UsernamePasswordAuthenticationToken(profileId, profileId, authorities); HttpSession session = request.getSession(false); if (session != null || getAllowSessionCreation()) { request.getSession().setAttribute(SPRING_SECURITY_LAST_USERNAME, TextEscapeUtils.escapeEntities(authToken)); request.getSession().setAttribute(SPRING_SECURITY_SAVED_REQUEST, new DefaultSavedRequest(request, new PortResolverImpl())); } Object details = authUserDetailsService.loadUserByUsername(profileId); authRequest.setDetails(details); return authRequest; } else throw new VerificationFailedException("Unable to authenticate; missing token value"); } }

Previously initiated loading for a different type with name "javax/management/MBeanServer"

When I was doing a migration / upgrade to Spring 3.1, I faced a really weird Error.

My App was using Jetty to run deploy my WAR file.


Short story / Long Story

Although I was not using MX4J library in my project, I remembered that:
"Jetty defaults to overriding the normal J2SE class loader delegation model  (which calls for delegating to the parent)."

Therefore, this could be fixed by using this System Property:

-Dorg.mortbay.jetty.webapp.parentLoaderPriority=true

This is how you should do it in your pom:
<project> ... <plugins> ... <plugin> <groupid>org.mortbay.jetty</groupId> <artifactid>maven-jetty-plugin</artifactId> <configuration> ... <systemproperties> <systemproperty> <name>org.mortbay.jetty.webapp.parentLoaderPriority</name> <value>true</value> </systemProperty> ... </systemProperties> </configuration> </plugin> </plugins> </project>

And that error will go away.

JSONProvider builds wrong String

Looking at my backlog I found a very interesting ticket:

As a consumer of JSON web services, I would like the services to render fields with consistent types regardless of the content. When postal codes begin with zero, they are rendered as strings. When they begin with a non-zero character, they are rendered as numbers. This makes handling the JSON responses very cumbersome and causes hard to track down bugs in our code. 

It would be better if the conversion checked the type in the xsd (in the case of postal codes, string) and rendered it accordingly. 

Weird, isn't it? Then I realize, I wasn't the only one with this issue, a found a few other clueless developers with the same problem (look here and here), so that, I wasn't alone.

But so far no one had an answer, until I checked the code of my JSONProvider, this one: org.apache.cxf.jaxrs.provider.JSONProvider

My conclusion was simple, depending on the value of the string passed to the Converter, it will be casted to Boolean, String or Number.

There are 2 choices: Create my own custom JSONProvider extending from the original (and try to fix the world) or implement another which really worked as expected.

In a few words, I chose JacksonJsonProvider, however I had to customize it a little bit, because I needed to fix the issue and not create a new one (i needed the same output), and so far this is the result:

This is the original output { "postalCode": [ { "activeFlag": true, "areaCode": 603, "code": "03033", "createdOn": "2001-12-18", "isoCodeAlpha2": "US", "isoCodeAlpha3": "USA", "isoCodeNumeric": 840, "kbsPostalCodeId": 10998, "latitude": 42.740602, "longitude": -71.676612, "modifiedOn": "2006-12-08" }, { "activeFlag": true, "areaCode": 412, "code": 15102, "createdOn": "2001-12-18", "isoCodeAlpha2": "US", "isoCodeAlpha3": "USA", "isoCodeNumeric": 840, "kbsPostalCodeId": 15893, "latitude": 40.323747, "longitude": -80.037982, "modifiedOn": "2006-12-08" } ] }

This is my implementation public class JacksonJsonProvider extends org.codehaus.jackson.jaxrs.JacksonJsonProvider { private static final Logger log = Logger.getLogger(JacksonJsonProvider.class); @Override public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) { boolean result = false; log.debug("Is Writeable? type="+type+", genericType="+genericType+", annotations="+annotations+", mediaType="+mediaType); result = super.isWriteable(type, genericType, annotations, mediaType); log.debug("Result="+result); if (String.class.equals(type)) { //pass strings as-is, they are most likely cached JSON responses return false; } else { return result;//return super.isWriteable(type, genericType, annotations, mediaType); } } public JacksonJsonProvider() { super(); ObjectMapper objectMapper = new ObjectMapper(); final Annotations[] BASIC_ANNOTATIONS = {Annotations.JACKSON, Annotations.JAXB}; objectMapper.configure(SerializationConfig.Feature.AUTO_DETECT_FIELDS, true); objectMapper.configure(SerializationConfig.Feature.INDENT_OUTPUT, true); objectMapper.configure(SerializationConfig.Feature.SORT_PROPERTIES_ALPHABETICALLY, true); objectMapper.configure(SerializationConfig.Feature.USE_ANNOTATIONS, true); objectMapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true); super.setMapper(objectMapper); super.setAnnotationsToUse(BASIC_ANNOTATIONS); } }
And my new output { "ArrayList": [ { "activeFlag": true, "areaCode": "603", "code": "03033", "createdOn": "2001-12-18", "isoCodeAlpha2": "US", "isoCodeAlpha3": "USA", "isoCodeNumeric": 840, "kaplanPremierEligibleFlag": false, "kbsPostalCodeId": 10998, "latitude": 42.740602, "longitude": -71.676612, "modifiedOn": "2006-12-08" }, { "activeFlag": true, "areaCode": "412", "code": "15102", "createdOn": "2001-12-18", "isoCodeAlpha2": "US", "isoCodeAlpha3": "USA", "isoCodeNumeric": 840, "kaplanPremierEligibleFlag": true, "kbsPostalCodeId": 15893, "latitude": 40.323747, "longitude": -80.037982, "modifiedOn": "2006-12-08" } ] } I still have something to fix-customize because that "ArrayList" looks ugly though, but code and areCode now make sense, because they match my XSD and Pojo as well.

Updating Logging Level in Runtime using Spring

As you know, there is one way to achieve this easily by writing Java code, catch the logger and update the logging level. This is what I called: Programmatically!

But there is another way, when you already have Log4J in your WebApp, just like this: <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener>
Just add one additional param to your web.xml, besides log4jConfigLocation <context-param> <param-name>log4jRefreshInterval</param-name> <param-value>2000</param-value> </context-param> By doing this, the Listener will refresh the Log4J configuration each 2 seconds.

mvc:view-controller

This tag is a shortcut for defining a ParameterizableViewController that immediately forwards to a view when invoked. Use it in static cases when there is no Java Controller logic to execute before the view generates the response.

An example of view-controller that forwards to a home page is shown below: <mvc:view-controller path="/" view-name="home"/>
Source: http://static.springsource.org/spring/docs/3.0.x/reference/mvc.html

Using @PathVariable

Let's say that you are creating an user account-based web application in Spring 3.0. You would like to create a controller that would allow users to see each other's profile by using a URL such as
http://myapp/profile/username.

For example:
http://myapp/profile/Juan would show user Juan's profile.
http://myapp/profile/Gaby would show user Gaby's profile.


Spring 3.0's annotated controllers make this kind of mapping easy with the new @PathVariable mapping. @Controller public class ShowProfileController { @RequestMapping("/profile/{username}") public String showProfile(Model model, @PathVariable("username") final String username) { ... return "showProfile"; // show my jsp } } As you can see, the RequestMapping for the showProfile method has something a bit unusual: {username}
This is a PathVariable, and it means that this method will serve any request of the format "/profile/someUserName"

We capture the actual username in the next line using the @PathVariable annotation @PathVariable("username") and store it in the variable

final String username

Now we can use it however we want!
Viva Spring framework!!!

Load Properties in Spring MVC

This is a really trivial case, but I have to cover it, because you never know when you'll need it.

We have our application and we need to load a Properties file and use it, specifically in one of your Controllers, just like this...

I know! When we say spring + properties files, everybody think on this case (don't you?): <!-- Properties file certain specific App Stuff --> <context:property-placeholder location="classpath:my-application.properties"/> <!-- Creates reCaptcha Instance --> <bean id="reCaptcha" class="net.tanesha.recaptcha.ReCaptchaImpl"> <property name="privateKey" value="${recaptcha.private.key}" /> <property name="publicKey" value="${recaptcha.public.key}" /> <property name="includeNoscript" value="false" /> </bean>
But this is not the case I want to cover right now, because the one I want to cover is this one:

String value = (String)properties.get(key);

@Controller @RequestMapping(value = "/sitexfer/*") public class SiteXrefController extends BaseCustomController { private static final Logger log = Logger.getLogger(SiteXrefController.class); @Autowired private HttpClient httpClient; @Autowired @Qualifier("SiteXferProperties") private Properties properties; ... private String executeTest(final String serverType, final String instance, final Enumeration<String> headerNames, final HttpServletRequest request){ log.debug("Testing=" + instance + ", serverType=" + serverType); log.debug("Additional Params: " + headerNames); String result = ""; String url = (String)properties.get(serverType+"."+instance); ... return result; } .... } Ahhhh! That's what I meant :D

How can I do that? Simple, trust in Spring! (may the Spring be with you :P ) By using Util Schema <util:properties id="SiteXferProperties" location="classpath:sitexfer-application.properties"/> <?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" xmlns:p="http://www.springframework.org/schema/p" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"> <util:properties id="SiteXferProperties" location="classpath:sitexfer-application.properties"/> <context:annotation-config/> <context:component-scan base-package="com.bofa.sitexfer.web.controller"/> </beans>

Piece of cake
Pan comido

Log4jConfigListener Deployment Issue on WebLogic

It looks like Spring framework's Log4jConfigListener is having an issue when webapp is deployed as WAR.
Log4jConfigListener is defined in web.xml. I got the below error while deploying the application in weblogic 10.3:

 
weblogic.management.DeploymentException: Cannot set web app root system property when WAR file is not expanded - with nested exception:  [java.lang.IllegalStateException: Cannot set web app root system property when WAR file is not expanded].

The solution is deploy the WAR as exploded or don't use Log4jConfigListener. The spring framework documentation also says the WAR should be exploded.

But... there is a solution available to this without any code change. We just need to set "Archived Real Path Enabled" option checked, just like this:


1. Go to server admin console->Domain-> Web applications. Click the checkbox of Archived Real Path Enabled. This should make an entry into domain config.xml as below. <web-app-container> <show-archived-real-path-enabled>true</show-archived-real-path-enabled> </web-app-container> 2. Second option is at webapp level by updating weblogic.xml as below: true The value of set in the web app has precedence over the value set at the domain level. The default value of this property is false.

This is my example: <?xml version="1.0" encoding="UTF-8"?> <wls:weblogic-web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wls="http://www.bea.com/ns/weblogic/90" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd http://www.bea.com/ns/weblogic/90 http://www.bea.com/ns/weblogic/90/weblogic-web-app.xsd"> <wls:context-root>sitexfer-testing</wls:context-root> <wls:container-descriptor> <wls:show-archived-real-path-enabled>true</wls:show-archived-real-path-enabled> </wls:container-descriptor> </wls:weblogic-web-app>

Accessing a PostgreSQL table using Hibernate

I was goofing around with PostgreSQL, and I wanted to give it a try, so I decided to replicate my Payment table from HSQLDB to PostgreSQL and I got something like this

CREATE TABLE "PAYMENTS"
(
  id_order integer NOT NULL,
  id_customer integer NOT NULL,
  total_amount_transaction double precision,
  transaction_number character varying(50),
  creation_ts timestamp with time zone,
  CONSTRAINT pk_payments PRIMARY KEY (id_order, id_customer)
)
WITH (
  OIDS=FALSE
);
ALTER TABLE "PAYMENTS" OWNER TO payments;

As you well know with Hibernate the switch should be not very painful, and it won't have any impact on existing code!
But...Surprise!

The impact is not a huge impact but it's something really specific, and that's why I'm creating this post.

The usual steps to chnage from one DB to another DB is Hibernate is really simple:
This is my previous DataSource - Because, to accelerate the process I did the change locally before deploying this to my app server, so I can test locally using my existing JUnit test cases <bean id="hSqlDataSource" class="org.apache.tomcat.dbcp.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="org.hsqldb.jdbcDriver"/> <property name="url" value="jdbc:hsqldb:hsql://localhost/"/> <property name="username" value="SA"/> <property name="password" value=""/> <property name="defaultAutoCommit" value="false"/> </bean>
And this is my new DataSource for PostgreSQL
Important: Remove the "defaultAutoCommit" attribute and add "defaultCatalog" attribute <bean id="postgreSqlDataSource" class="org.apache.tomcat.dbcp.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="org.postgresql.Driver"/> <property name="url" value="jdbc:postgresql://localhost:5432/little-store-payments"/> <property name="username" value="payments"/> <property name="password" value="1234"/> <property name="defaultCatalog" value="public"/> </bean>
This is my new Dialect <prop key="hibernate.dialect"> <!-- org.hibernate.dialect.HSQLDialect --> org.hibernate.dialect.PostgreSQLDialect </prop>

And this is the second Important detail:
Add double quotes to your table name!, just like this @Entity @Table(name = "\"PAYMENTS\"") public class Payment implements Serializable { private static final long serialVersionUID = 29461940044295039L; @EmbeddedId private PaymentId id; @Column(name = "total_amount_transaction", nullable = false, precision = 6, scale = 2) private Float totalAmountTransaction; @Column(name = "transaction_number", nullable = false, updatable = false, unique = true, length=50) private String transactionNumber; @Temporal(TemporalType.TIMESTAMP) @Column(name = "creation_ts", length = 19, updatable = false, insertable = true) private Date creationTs; ... }
My original code used to be

@Table(name = "PAYMENTS")

@Embeddable public class PaymentId implements Serializable { private static final long serialVersionUID = 4176341157636925851L; @Column(name = "id_order", nullable = false, updatable = false) private Integer idOrder; @Column(name = "id_customer", nullable = false, updatable = false) private Integer idCustomer; ... }

This is my new Payments DB :)

Hibernate did't again!

JUnit using only annotations

To be honest I tried annotations with JUnit recently, but the first time I tried, it didn't go well, so I procrastinate it.
But for this "experimento", I'd to retake it with excellent results
, and this is one of test cases [I had to create a base TestCase class - you know how lazy I'm:) to avoid the process of loading my context and Log4J]
Don't forget my "golden rule", use Maven!!! I'm using JUnit 4.8
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(locations = { "file:src/main/webapp/WEB-INF/conf/spring/daoApplicationContext.xml", "file:src/main/webapp/WEB-INF/conf/spring/serviceApplicationContext.xml" }) public abstract class BaseTestCase { static{ DOMConfigurator.configure("src/main/webapp/WEB-INF/conf/log4j/log4j-config-minimal.xml"); } } } As you can see, there isn't too much to explain. Only we're using "SpringJUnit4ClassRunner.class", because to do my tests I need my Spring App Context (with all my beans)

This is a portion of my test case public class TestCustomerService extends BaseTestCase { private static final Logger log = Logger .getLogger(TestCustomerService.class); @Autowired private ICustomerService customerService; @BeforeClass public static void executeBeforeClass() { log.info("Execute to inizitalize class with @BeforeClass"); } @AfterClass public static void executeAfterClass() { log.info("Execute to finalize class with @AfterClass"); } @After public void executeAfter() { log.info("This should be executed after each method with @After"); } @Before public void executeBefore() { log.info("This should be executed before each method with @Before"); } } I haven't used much the annotations Before and After, but some day I'll find them an application.

Something really cool is the part where we can define if my test method will be Transactional, if we want to Repeat it or if after test is executed we want to Rollback the Tx.
Because, for a regular Test, just with the annotation @Test will be enough. @Test public void testGetAllCreditCards() { log.info("Starting test - testGetAllCreditCards"); List<CreditCardDTO> result = null; try { result = this.customerService.getAllCreditCards(1); } catch (Exception ex) { ex.printStackTrace(); } Assert.assertNotNull(result); log.debug(result); log.info("End of test - testGetAllCreditCards"); } @Test public void testDoSignIn() { log.info("Starting test - testDoSignIn"); CustomerDTO result = null; try { result = this.customerService.doSignIn("juca.cruz@gmail.com","contraseña"); } catch (Exception ex) { ex.printStackTrace(); } Assert.assertNotNull(result); log.debug(result); log.info("End of test - testDoSignIn"); }
I felt in love with these annotations, because finally I don't have to load the a test Database and Clean it after my testing is done (I know, you still have to re initiate the sequences, but who cares, they're UNIQUE), I can reuse my existing initial DB and play with it, and nobody will see my garbage/testing data; unless I want it
@Test @Transactional @Rollback @Repeat(2) public void testAddUpdatePaymentInformation() { log.info("Starting test - testAddUpdatePaymentInformation"); Boolean result = false; CustomerDTO customerDTO = new CustomerDTO(); customerDTO.setIdCustomer(RandomUtils.JVM_RANDOM.nextInt(2)); CreditCardDTO creditCardDTO = new CreditCardDTO(); creditCardDTO.setCustomerDTO(customerDTO); creditCardDTO.setExpirationDate(DateUtils.formatDate(new java.util.Date(), DateUtils.FORMAT_MMYYYY)); creditCardDTO.setNumber(RandomStringUtils.randomNumeric(16)); creditCardDTO.setSecurityCode(RandomStringUtils.randomNumeric(3)); this.populateCreditCardType(creditCardDTO); try { result = this.customerService.addUpdatePaymentInformation(creditCardDTO); } catch (Exception ex) { ex.printStackTrace(); } Assert.assertTrue(result); log.debug(result); log.info("End of test - testAddUpdatePaymentInformation"); }

 
@Transactional  --> There is a Tx involved on this test
@Rollback  --> When is done (rollback Tx)
@Repeat(2)  --> Repeat 2 Times this execution

That's what I'm talking about!!!
¡JUnit Rules!

@Autowired and @Qualifier

"Your best friends could be @Autowired and @Qualifier"
I have to migrate data from DB2 to Oracle, both databases have the same structure, well, my Oracle has better design, but I'm reusing the some objects, like POJO's and DAO's, the only thing I changed were my mappings, because I have to keep my mappings for DB2 and for Oracle.
If I have the same DAO for both databases, what can I do?
daoApplicationContext.xml <?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:jee="http://www.springframework.org/schema/jee" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-2.5.xsd"> <!-- ========================= Data Sources ============================= --> <bean id="db2DS" class="org.apache.tomcat.dbcp.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="COM.ibm.db2.jdbc.app.DB2Driver"/> <property name="url" value="jdbc:db2:best"/> <property name="username" value="${userId}"/> <property name="password" value="${pwd}"/> </bean> <bean id="oracleDS" class="org.apache.tomcat.dbcp.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="oracle.jdbc.driver.OracleDriver"/> <property name="url" value="jdbc:oracle:thin:@twsifcmtzdt01.tdc.vzwcorp.com:1535:mkssbxdb"/> <property name="username" value="${userId}"/> <property name="password" value="${pwd}"/> </bean> <!--============================= SessionFactory ===============================--> <bean id="sessionFactoryDB2" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"> <property name="dataSource" ref="db2DS" /> <property name="configLocation"> <value>classpath:com/vzw/dvs/mapping/mappingDB2.cfg.xml</value> </property> <property name="hibernateProperties"> <props> <prop key="hibernate.dialect"> org.hibernate.dialect.DB2Dialect </prop> <prop key="hibernate.show_sql">false</prop> <prop key="hibernate.format_sql">true</prop> <prop key="hibernate.order_updates">true</prop> <prop key="hibernate.generate_statistics">true</prop> <prop key="hibernate.use_sql_comments">false</prop> <prop key="hibernate.bytecode.use_reflection_optimizer"> false </prop> <prop key="hibernate.jdbc.batch_size">15</prop> <prop key="hibernate.jdbc.batch_versioned_data"> true </prop> <prop key="hibernate.query.factory_class"> org.hibernate.hql.ast.ASTQueryTranslatorFactory </prop> <prop key="hibernate.connection.isolation">4</prop> </props> </property> </bean> <bean id="sessionFactoryOracle" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"> <property name="dataSource" ref="oracleDS" /> <property name="configLocation"> <value>classpath:com/vzw/dvs/mapping/mappingOracle.cfg.xml</value> </property> <property name="hibernateProperties"> <props> <prop key="hibernate.dialect"> org.hibernate.dialect.Oracle10gDialect </prop> <prop key="hibernate.show_sql">false</prop> <prop key="hibernate.format_sql">true</prop> <prop key="hibernate.order_updates">true</prop> <prop key="hibernate.generate_statistics">true</prop> <prop key="hibernate.use_sql_comments">false</prop> <prop key="hibernate.bytecode.use_reflection_optimizer"> false </prop> <prop key="hibernate.jdbc.batch_size">15</prop> <prop key="hibernate.jdbc.batch_versioned_data"> true </prop> <prop key="hibernate.query.factory_class"> org.hibernate.hql.ast.ASTQueryTranslatorFactory </prop> <prop key="hibernate.connection.isolation">4</prop> </props> </property> </bean> <!-- ============================ DAOs DB2 ================================== --> <bean id="UserDAOdb2" class="com.vzw.dvs.core.persistence.dao.impl.UserDAOImpl"> <property name="sessionFactory" ref="sessionFactoryDB2" /> </bean> <!-- ============================ DAOs Oracle ================================== --> <bean id="UserDAO" class="com.vzw.dvs.core.persistence.dao.impl.UserDAOImpl"> <property name="sessionFactory" ref="sessionFactoryOracle" /> </bean> </beans>
As you can see, I have 2 different DAO's sharing the same Interface & Implementation, but each one belongs to a different "sessionFactory" <bean id="UserDAOdb2" class="com.vzw.dvs.core.persistence.dao.impl.UserDAOImpl"> <property name="sessionFactory" ref="sessionFactoryDB2" /> </bean> <bean id="UserDAO" class="com.vzw.dvs.core.persistence.dao.impl.UserDAOImpl"> <property name="sessionFactory" ref="sessionFactoryOracle" /> </bean> serviceApplicationContext.xml <?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:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx" xmlns:util="http://www.springframework.org/schema/util" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-2.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> <!-- =============== JTA ==========================================--> <bean id="transactionManager" class="org.springframework.orm.hibernate3.HibernateTransactionManager"> <property name="sessionFactory"> <ref bean="sessionFactoryOracle" /> </property> </bean> <!--====================== Transaction Managers with Annotations =====================--> <tx:annotation-driven transaction-manager="transactionManager" /> <!--====================== Enable Autowire =====================--> <context:annotation-config /> <!--================== Implementation of Services =====================--> <bean id="MigrateTablesService" class="com.vzw.dvs.core.business.service.web.impl.MigrateTablesServiceImpl"/> </beans>
Nothing special, right? But now here it comes the interesting part, because @Autowired by itself it will inject the given bean in your ServiceImpl, but you must have only one bean of that type. In my case I have more than 1, so @Autowired will throw an error when loading the context.
Then it comes @Qualifier which will match based on the given name, and problem solved chavos!!!
public class MigrateTablesServiceImpl implements MigrateTablesService { private static final Logger log = Logger.getLogger(MigrateTablesServiceImpl.class); @Autowired @Qualifier("UserDAOdb2") private UserDAO userDAOdb2; @Autowired @Qualifier("UserDAO") private UserDAO userDAO; @Transactional(readOnly = false, propagation = Propagation.REQUIRED) public boolean doMigrateUser() { log.debug("Migrating User"); boolean result = false; try{ List<User> listItems = this.userDAOdb2.getAll(); for(User transientInstance: listItems){ log.debug("Item retrieved from DB2 "+transientInstance); User user = new User(); BeanUtils.copyProperties(transientInstance, user); //Trim Strings user.setDbUserId(StringUtils.trim(transientInstance.getDbUserId())); user.setBudgetmanagerind(StringUtils.trim(transientInstance.getBudgetmanagerind())); user.setDashboardaccess(StringUtils.trim(transientInstance.getDashboardaccess())); user.setDirectorusercd(StringUtils.trim(transientInstance.getDirectorusercd())); user.setEmail(StringUtils.trim(transientInstance.getEmail())); user.setFirstname(StringUtils.trim(transientInstance.getFirstname())); user.setFunctionalareacd(StringUtils.trim(transientInstance.getFunctionalareacd())); user.setHomephone(StringUtils.trim(transientInstance.getHomephone())); user.setInternalit(StringUtils.trim(transientInstance.getInternalit())); user.setLastname(StringUtils.trim(transientInstance.getLastname())); user.setMobilephone(StringUtils.trim(transientInstance.getMobilephone())); user.setPassword(StringUtils.trim(transientInstance.getPassword())); user.setUserid(StringUtils.trim(transientInstance.getUserid())); user.setUserstatuscd(StringUtils.trim(transientInstance.getUserstatuscd())); user.setVpid(StringUtils.trim(transientInstance.getVpid())); user.setUtilizationtarget(StringUtils.trim(transientInstance.getUtilizationtarget())); user.setWorkphone(StringUtils.trim(transientInstance.getWorkphone())); if(user.getDbTimestamp()==null){ user.setDbTimestamp(new Date()); } this.userDAO.save(user); } result = true; }catch (Exception ex) { log.warn(ex); } log.debug("Done"); return result; }
Notes: I used org.springframework.beans.BeanUtils to create a copy of my bean (pojo) returned from DB2 into a non-persistent Pojo which I'll manipulate before inserting into Oracle (DB2 completes each column value with spaces to achieve the given size of that column, so each time you query a DB2 column you'll get a lot of extra spaces)

Spring MVC - Binding VO to a Form

Problema:
I have a VO and I wanted to populate it on my JSP and on my controller just process the VO already populated.

Solution:
@Controller @RequestMapping(value = "/loggers/*") public class LoggersConfigurationController extends BaseCustomController { private static final Logger log = Logger .getLogger(LoggersConfigurationController.class); @SuppressWarnings("unchecked") @RequestMapping(value = "configureLoggers.do", method = RequestMethod.GET) public String showScreen(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { if (!this.isLoggedIn(request)) { return "redirect:/authentication/notLoggedIn.do"; } log.debug("Show Screen when RequestMethod.GET"); //By doing this I'm preparing my diabolic plan!!! LoggerVO loggerVO = new LoggerVO(); modelMap.put("LoggerVO", loggerVO); return "configuration/loggersConfiguration"; } @SuppressWarnings("unchecked") @RequestMapping(value = "configureLoggers.do", method = RequestMethod.POST) public String updateLogger( HttpServletRequest request, HttpServletResponse response, ModelMap modelMap, @ModelAttribute(value="LoggerVO") LoggerVO loggerVO) { if (!this.isLoggedIn(request)) { return "redirect:/authentication/notLoggedIn.do"; } log.debug("Update logger when RequestMethod.POST"); List<String> messages = new ArrayList<String>(); log.debug("@ModelAttribute="+loggerVO); LogUtils.getInstance().setLogger(loggerVO); messages.add(loggerVO.getName()+" updated successfully to "+loggerVO.getLevel()); modelMap.put("KEY_LIST_MESSAGES", messages); //return "configuration/loggersConfiguration"; return "index-tabbed"; } }
On my POST method I'll handle my VO already populated.
This entry will do 50% of the job @ModelAttribute(value="LoggerVO") LoggerVO loggerVO
On my JSP I'll map using spring's tag library <%@taglib prefix="spring" uri="http://www.springframework.org/tags" %> <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %> <%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %> <H2>Loggers Configuration</H2> <form:form id="loggersForm" name="loggersForm" modelAttribute="LoggerVO" commandName="LoggerVO" action="/${pageContext.servletContext.servletContextName}/loggers/configureLoggers.do" method="POST"> <table width="100%"> <tr> <td><label for="name">Logger Name</label></td> <td> <form:select path="name" items="${applicationScope.KEY_LIST_LOGGERS}" itemValue="name" itemLabel="name"/> </td> </tr> <tr> <td><label for="level">Level</label></td> <td> <form:select path="level" items="${applicationScope.KEY_LIST_LOG_LEVELS}"/> </td> </tr> </table> <p> <input type="submit" value="Update"> </p> <div style="visibility: hidden"> <form:select path="appenderVOs"/> </div> </form:form> <c:if test="${!empty requestScope.KEY_LIST_MESSAGES}"> <script>alert("${requestScope.KEY_LIST_MESSAGES}");</script> </c:if>
By doing this modelAttribute="LoggerVO" commandName="LoggerVO"
I'm matching what I have on my form and what I have on my Controller <form:form id="loggersForm" name="loggersForm" modelAttribute="LoggerVO" commandName="LoggerVO" action="/${pageContext.servletContext.servletContextName}/loggers/configureLoggers.do" method="POST">
I hope this will help you!
Salu2

Adding Spring Web MVC part 2

Now I'll show you a couple of examples how it looks like a Controller & a JSP using Spring MVC.

From my personal perspective Defining a controller gives you a lot of power, because you can define a method to handle RequestMethod.GET, just to show a Form, and another method to handle the RequestMethod.POST to handle the "submit", cool isn't it?

import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; /** * Consumers Configuration Controller * * @author Juan Cruz */ @Controller @RequestMapping(value="/configuration/*") public class ConsumersConfigurationController extends BaseCustomController{ @Autowired private SomeInterfaceService myInstanceService; public ConsumersConfigurationController() { //You can intialize something or just use } @RequestMapping(value = "showConsumersConfiguration.do") public String showConsumersConfiguration(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { if(!this.isLoggedIn(request)){ return "redirect:/authentication/logout.do"; } log.debug("showConsumersConfiguration"); modelMap.put("KEY_LIST_EAST_SERVERS", listEastServers); modelMap.put("KEY_LIST_WEST_SERVERS", listWestServers); modelMap.put("KEY_LIST_NORTH_SERVERS", listNorthServers); return "configuration/consumersConfiguration";//show jsp }

By adding @Controller you already told Spring, "hey this dude is going to be a Controller".

@RequestMapping(value="/configuration/*") means: "If my URL is WebContext/configuration/ this Controller is going to handle the Request"

Then on each method I can define my path below /configuration/ @RequestMapping(value = "showConsumersConfiguration.do"), something like this WebContext/configuration/showConsumersConfiguration.do

I almost forgot @Autowired which is for inject implementation of that Bean

If you want to handle an object like a form (bind an object to a form), check this out

<%@taglib prefix="spring" uri="http://www.springframework.org/tags" %> <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %> <form:form id="loginForm" name="loginForm" modelAttribute="UserVO" action="doLogin.do" method="post"> <table width="100%"> <tr> <td><label for="userId">Login</label></td> <td><form:input path="userId" size="20" title="By default you will see your US-WIN."/></td> </tr> <tr> <td><label for="password">Password</label></td> <td><form:password path="password" size="20" title="Enter your US-WIN password."/></td> </tr> </table> <p> <input type="submit" value="Authenticate"> </p> <form:hidden path="email"/> <form:hidden path="firstName"/> <form:hidden path="lastName"/> </form:form>

Important, include these tag libraries!

By using this attribute modelAttribute="UserVO" of form:form tag, I'm binding this line of my controller: modelMap.put("UserVO", userVO); with my form

public class UserVO implements Serializable { private String userId; private String password; private String email; private String firstName; private String lastName; }

If you see carefully, each attribute of my VO, has a reference on my JSP, at least as hidden field, but all of them are there

@Controller @RequestMapping(value = "/authentication/*") public class LoginController extends BaseCustomController{ @RequestMapping(value = "doLogin.do") public String authenticateUser(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap, @ModelAttribute UserVO paramUserVO) { } @RequestMapping(value = "login.do") public String showLogin(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { UserVO userVO = new UserVO(); modelMap.put("UserVO", userVO); return "authentication/login";//show jsp }

Now my form has been binded to my VO @ModelAttribute UserVO paramUserVO

Now you're ready to play around with this thing!!!

Always go to the official documentation to get more details!!!

WebServices with CXF - Configuration files - web.xml

<web-app version = "2.4" xmlns = "http://java.sun.com/xml/ns/j2ee" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>webAppRootKey</param-name> <param-value>my-web-app</param-value> </context-param> <!--Log4J Configuration --> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>/WEB-INF/conf/log4j/log4j-config.xml</param-value> </context-param> <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> <!--Log4J Listener --> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> <!--Spring Context Listener --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!--Another Context Listener --> <listener> <listener-class>mx.com.mylibrary.web.listener.ContextListener</listener-class> </listener> <!--Servlet Declarations --> <servlet> <servlet-name>webApplicationServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping> <!--Servlet Mappings --> <servlet-mapping> <servlet-name>webApplicationServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <!--Session Time-out in minutes --> <session-config> <session-timeout>30</session-timeout> </session-config> <!--Welcome file --> <welcome-file-list> <welcome-file>/index.jsp</welcome-file> </welcome-file-list> <!--Reference to a DB Conection --> <resource-ref> <description>DB Connection</description> <res-ref-name>jdbc/bookStoreDS</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref> </web-app>

WebServices with CXF - Testing using JUnit

As you know JUnit is for Testing, so basically I'm going to test my running/deployed WebApplication by declaring this Test Cases:

This one is just a TestCase which tests my Spring Bean Service public void testGetAllBooks(){ List<BookDTO> books = null; try{ books = this.libraryService.getAllBooks(); }catch(Exception ex){ log.warn(ex); } for(BookDTO bookDTO: books){ log.debug(bookDTO); } assertNotNull(books); }
And this fellow tests our WebService public void testWebService(){ List<BookDTO> books = null; try{ JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean(); factoryBean.setDataBinding(new AegisDatabinding()); factoryBean.getInInterceptors().add(new LoggingInInterceptor()); factoryBean.getOutInterceptors().add(new LoggingOutInterceptor()); factoryBean.setAddress("http://127.0.0.1:9080/little-library/services/LibraryService"); factoryBean.setServiceClass(LibraryService.class); LibraryService libraryService = (LibraryService)factoryBean.create(); books = libraryService.getAllBooks(); }catch(Exception ex){ log.warn(ex); } for(BookDTO bookDTO: books){ log.debug(bookDTO); } Assert.assertNotNull(books); }

As you can see, we need to link using our Service Interface (LibraryService.class) to this JaxWsProxyFactoryBean instance

That was easy! Isn't it???

WebServices with CXF - Configuration files II

I'll just include my Spring configuration files.
Why files? -I though Spring only needs an applicationConext??? Well... Because I prefer to split configuration files according to it's purpose:

• One will have everything related to the Persistence layer
• and the second one will have all my Business layer -services

Following this logic I should have another one for my Web layer

daoApplicationContext <?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:jee = "http://www.springframework.org/schema/jee" xsi:schemaLocation = " http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-2.5.xsd"> <!--========================= Data Sources ============================= --> <jee:jndi-lookup id="myDataSource" jndi-name="java:comp/env/jdbc/bookStoreDS"/> <!--============================= SessionFactory ===============================--> <bean id = "sessionFactory" class = "org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean"> <property name = "dataSource" ref = "myDataSource"/> <property name = "configLocation"> <value>/WEB-INF/conf/mapping/mapping.cfg.xml</value> </property> <property name = "hibernateProperties"> <props> <prop key = "hibernate.dialect">org.hibernate.dialect.MySQLInnoDBDialect</prop> <prop key = "hibernate.show_sql">true</prop> <prop key = "hibernate.format_sql">true</prop> <prop key = "hibernate.order_updates">true</prop> <prop key = "hibernate.generate_statistics">true</prop> <prop key = "hibernate.use_sql_comments">false</prop> <prop key = "hibernate.bytecode.use_reflection_optimizer">false</prop> <prop key = "hibernate.jdbc.batch_size">15</prop> <prop key = "hibernate.jdbc.batch_versioned_data">true</prop> <prop key = "hibernate.query.factory_class">org.hibernate.hql.ast.ASTQueryTranslatorFactory</prop> <prop key = "hibernate.connection.isolation">4</prop> </props> </property> </bean> <!--============================ DAOs ================================== --> <bean id = "AuthorDAO" class = "mx.com.mylibrary.core.persistence.dao.impl.AuthorDAOImpl"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> <bean id = "BookDAO" class = "mx.com.mylibrary.core.persistence.dao.impl.BookDAOImpl"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> <bean id = "EditorDAO" class = "mx.com.mylibrary.core.persistence.dao.impl.EditorDAOImpl"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> </beans>

serviceApplicationContext <?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:aop = "http://www.springframework.org/schema/aop" xmlns:tx = "http://www.springframework.org/schema/tx" xsi:schemaLocation = " http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd"> <!--=============== JTA ==========================================--> <bean id = "transactionManager" class = "org.springframework.orm.hibernate3.HibernateTransactionManager"> <property name = "sessionFactory"> <ref bean = "sessionFactory"/> </property> </bean> <!--====================== Transaction Managers =====================--> <tx:annotation-driven transaction-manager = "transactionManager"/> <!--================== Business Objects/Service Objects =============--> <bean id = "LibraryService" class = "mx.com.mylibrary.core.business.service.impl.LibraryServiceImpl"/> </beans>

When I met Annotations, I just felt in love with them, because one of the main advantages you gain is small configuration files.

On my next entry I'll cover my Apache CXF configuration file and how it fits.

Don't forget to add @Autowired, in case that you want to use this feature by <beans ... xmlns:context="http://www.springframework.org/schema/context" ... http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> ... <context:annotation-config /> ... </beans>

WebServices with CXF - Configuration files I

I'll show 2 basic configuration files: web.xml & my hibernate configuration file (mapping.cfg.xml)

<web-app version = "2.4" xmlns = "http://java.sun.com/xml/ns/j2ee" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>webAppRootKey</param-name> <param-value>my-web-app</param-value> </context-param> <!--Log4J Configuration --> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>/WEB-INF/conf/log4j/log4j-config.xml</param-value> </context-param> <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> <!--Log4J Listener --> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> <!--Spring Context Listener --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!--Servlet Declarations --> <servlet> <servlet-name>webApplicationServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping> <!--Servlet Mappings --> <servlet-mapping> <servlet-name>webApplicationServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <!--Session Time-out in minutes --> <session-config> <session-timeout>30</session-timeout> </session-config> <!--Welcome file --> <welcome-file-list> <welcome-file>/index.jsp</welcome-file> </welcome-file-list> <!--Reference to a my DB Conection --> <resource-ref> <description>DB Connection</description> <res-ref-name>jdbc/bookStoreDS</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref> </web-app>

As you noticed I'm using Spring MVC (see webApplicationServlet), but for now let's focus on Spring and CXF:

My 3 main configuration files are listed here, where the 3rd one is for CXF (really obvious file name) and to enable Apache CXF is so simple, Did you remember XFire? <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> ... ... ... <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping>

This is not rocket science! So simple :)


Now let's see my (small) Hibernate configuration file (which I just called mapping.cfg.xml) <hibernate-configuration> <session-factory> <mapping class="mx.com.mylibrary.core.persistence.domain.Author"/> <mapping class="mx.com.mylibrary.core.persistence.domain.Book"/> <mapping class="mx.com.mylibrary.core.persistence.domain.Editor"/> </session-factory> </hibernate-configuration> Instead of using resource=, I'm using class=, because I don't have any hbm.xml file. I'm mapping directly to the class (due to Java Annotations, my mapping it was declared on each POJO).

Now what do you think? Is not as complex as looks like.

WebServices with CXF - Integrating with CXF II

This is going to be a really small entry, because we're going to finish with my ServiceImplementation.
On the next entries we'll discuss configuration files & finally we'll see everything working (Obviously I'll need to test it).

But before that, let's analyze my implementation:

@WebService(serviceName="LibraryService", endpointInterface = "mx.com.mylibrary.core.business.service.LibraryService", targetNamespace="http://juca-cruz-utilities.blogspot.com") public class LibraryServiceImpl implements LibraryService { //Method's Implemented }

As I've been doing I'm using a lot of WebServices Annotations

What I did???

• Define service name of the Web Service
• Declare the complete name of the service endpoint interface defining the service's abstract Web Service contract (My Interface)
• And set my targetNamespace: the targetNamespace is used for the namespace for the wsdl:portType (and associated XML elements)

WebServices with CXF - Integrating with CXF I

As I said before on Service Interface & Implementation, somehow we'll have to retake that code to implement CXF, and that's what we're going to do.
I want to expose as WebService my LibraryService and as WebMethods these methods:

• public List getAllAuthors()
• public List getAllBooks()
• public List getAllEditors()
• public List getAllOnlyEditors()
• public BookDTO getBook(Integer bookId)

Ok, everything looks nice, but what happens if my client is asking for a "subService" (WebMethod) which returns AllAuthors, but he/she doesn't expect a WebMethod called getAuthors, retrieveAuthors or returnAuthors.

What can we do??? -We're done with our coding and that method (getAllAuthors) is being used in many places in our App.
Are you going to rename your code just because your client doesn't like your naming convention???. Later you'll see my answer.

Let's modify my code, first, Interface then Implementation;
By adding Java WebServices API Annotations @WebService @SOAPBinding(style=Style.DOCUMENT) public interface LibraryService And don't forget for every method we must declare it like a WebMethod @WebMethod(operationName="getAuthors", action="getAuthors") public List<AuthorDTO> getAllAuthors(); In this case I'm declaring a couple of additional attributes, which basically let me give another name to WebMethod, a different name to my original Java Method - this will be the name available on my WebService/WebMethod (this is the second option for my client)

And finally, what can I do if have logic on this interface that I don't want to make it public (available as WebMethod)???
This is the answer: "Just exclude it" @WebMethod(exclude=true) public void updateBook(BookDTO bookDTO);