Skip to main content

RESTEasy Spring 4 integration

Recently when I was going through the RESTEasy documentation to find out the proper way to integrate it with Spring. There are several ways to do it. This is the first post in this series which will cover the ways to integrate RESTEasy with Spring.

We will start with the one which is mentioned in the RESTEasy documentation. We will be using Maven for dependency management in our project. First of all, add the RESTEasy dependency in your project,


  org.jboss.resteasy
  resteasy-spring
  whatever version you are using


Above code will add resteasy dependencies in your project. Next step is to define RESTEasy configuration in your web.xml.





 Archetype Created Web Application
 
  
   org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap
  
 

 
  
   org.jboss.resteasy.plugins.spring.SpringContextLoaderListener
  
 

 
  Resteasy
  
   org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher
  
Resteasy /* This will initialize RESTEasy and Spring. RESTEasy includes SpringBeanProcesor which is an implementation of BeanFactoryPostProcessor. This bean processor checks whether the created bean contains RESTEasy annotation and if it does then adds it to the RESTEasy repository.
RESTEasy repository is initialized by ResteasyBootstrap class. So the sequence must be in the order which is specified above.

There is a problem (Bug#1012) with Spring 4 and RESTEasy (3.0.6 version) integration. SpringContextLoaderListener of RESTEasy has overridden createContextLoader method from ContextLoaderListener class of Spring which was deprecated in Spring 3.0 and has been removed in Spring 4.
To fix this issue, we need to provide our own implementation of Spring ContextLoaderListener which will register RESTEasy's SpringBeanProcessor and integration will work.
public class PatchedSpringContextLoaderListener extends ContextLoaderListener {

 private SpringContextLoaderSupport springContextLoaderSupport = new SpringContextLoaderSupport();
  
 @Override
 public void contextInitialized(ServletContextEvent event) {
  System.out.println("Initializing context");
  
  boolean scanProviders = false;
  boolean scanResources = false;
 
  String sProviders = event.getServletContext().getInitParameter(
    "resteasy.scan.providers");
  if (sProviders != null) {
   scanProviders = Boolean.valueOf(sProviders.trim());
  }
  String scanAll = event.getServletContext().getInitParameter(
    "resteasy.scan");
  if (scanAll != null) {
   boolean tmp = Boolean.valueOf(scanAll.trim());
   scanProviders = tmp || scanProviders;
   scanResources = tmp || scanResources;
  }
  String sResources = event.getServletContext().getInitParameter(
    "resteasy.scan.resources");
  if (sResources != null) {
   scanResources = Boolean.valueOf(sResources.trim());
  }
 
  if (scanProviders || scanResources) {
   throw new RuntimeException(
     "You cannot use resteasy.scan, resteasy.scan.resources, or resteasy.scan.providers with the SpringContextLoaderLister as this may cause serious deployment errors in your application");
  }
 
  super.contextInitialized(event);
 } 

 @Override
 protected void customizeContext(ServletContext servletContext, ConfigurableWebApplicationContext configurableWebApplicationContext) {
  System.out.println("Customizing context");

  super.customizeContext(servletContext, configurableWebApplicationContext);  
  this.springContextLoaderSupport.customizeContext(servletContext, configurableWebApplicationContext);
 }
 
}

Comments

Popular posts from this blog

Spring AOP : JDK Proxy vs CGLib Proxy

Spring framework is one of the most widely used framework in Enterprise application development. It has so many features such as Dependency injection, Data access integration, MVC, AOP which takes care of most of the boilerplate part of project, and developers can then focus on business logic only.

One of the important feature in Spring is AOP. It is used by almost every enterprise application which is being developed using Spring.

AOP So what is AOP? Definition of AOP -
Aspect oriented programming is a programming paradigm which aims to increase modularity by allowing the separation of cross cutting concerns. Well, my understanding of AOP is - AOP allows us to introduce/join new modules in your project at pre-specified dynamic locations without having to code for it. Traditional examples of AOP is Transaction management, logging etc. You can read more about AOP at here.

This article is for those who know AOP, have used AOP in their projects but do not know how Spring or other DI fra…

Java Tools Plugin for Notepad++

This post and the plugin is outdated. Please use plugin from this link which is updated and allows customization of shortcut key mappings and much more.
Notepad++ is a great free editor. I like notepad++ because its a light weight editor and loads instantly. I use notepad++ for editing many files everyday. One plugin I always wanted was a plugin which lets me compile my java files and execute them from editor itself, but I couldn't find it so I wrote a myself. This plugin can be downloaded from this link.
I am working on this plugin to make it more effective, so that if user have more than one installations of JDK or JRE then user should be able to choose which one to use etc.
This is a simple plugin which has two commands-
Compile - compiles a java file.
Run - executes a java file.
For using this plugin Java must be installed on the system.

Notepad++ Compile and Run Java Programs

Notepad++ is a great file editor. It has many features. The most important feature which I like about Notepad++ is its light weight. It loads up so quickly, that's great. It also provides syntax highlighting for many languages. I use notepad++ to edit general files as well as my simple Java programs.
Although notepad++ provides functionality to run external programs, I prefer NppJavaTools plugin to compile and run Java programs using notepad++.
You can download NppJavaTools plugin from this page - NppJavaTools.

Installation
Installation of plugins in notepad++ is very simple process. All you have to do is copy plugin dll into plugins folder of notepad++ installation directory and restart the notepad++.

Features
This plugin provides following features,


Compile and run your Java files within Notepad++Set custom hotkeys for compiling and running Java CodeLibrary support Compile and RunThis function allows you to run your Java programs to compile and run from Notepad++. Set Custom hotkeysThi…