I will be speaking at the Software Association of Oregon’s “An Integrated Development Tools Stack: Soup-to-Nuts Implementation in Practice” event this coming thursday if anyone is intrested. More information can be found here:

http://www.sao.org/events/event_details.asp?id=71592

So I wrote one for stripes:

git://github.com/ayax79/stripes-uploadify.git

In my pom I have the following two plugsin configured:

<plugin>

<groupId>org.codehaus.mojo</groupId>

<artifactId>hibernate3-maven-plugin</artifactId>

<version>2.2</version>

<configuration>

<components>

<component>

<name>hbm2ddl</name>

<implementation>annotationconfiguration</implementation>

<!--

Use 'jpaconfiguration' if you're using JPA.

<implementation>jpaconfiguration</implementation>

-->

</component>

</components>

<componentProperties>

<drop>true</drop>

<jdk5>true</jdk5>
<propertyfile>target/classes/jdbc.properties</propertyfile>

<skip>${maven.test.skip}</skip>

</componentProperties>

</configuration>

<executions>

<execution>
<phase>process-test-resources</phase>

<goals>

<goal>hbm2ddl</goal>

</goals>

</execution>

</executions>

<dependencies>

<dependency>

<groupId>${jdbc.groupId}</groupId>

<artifactId>${jdbc.artifactId}</artifactId>

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

</dependency>

</dependencies>

</plugin>
<plugin>

                <groupId>org.codehaus.groovy.maven</groupId>

                <artifactId>gmaven-plugin</artifactId>

                <version>1.0-rc-5</version>

                <configuration>

                    <source>${pom.basedir}/src/test/resources/sampledata.groovy</source>

                </configuration>

                <executions>

                    <execution>

                        <id>populate-db</id>
<phase>test-compile</phase>

                        <goals>

                            <goal>execute</goal>

                        </goals>

                    </execution>

                </executions>

                <dependencies>

                    <dependency>

                        <groupId>${jdbc.groupId}</groupId>

                        <artifactId>${jdbc.artifactId}</artifactId>

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

                    </dependency>

                </dependencies>

            </plugin>

Then I wrote the following script (that is referenced in the plugin above):

// initializes hibernate

this.sessionFactory = new AnnotationConfiguration().configure().buildSessionFactory()

this.call = 0

class SaveDelegate {

  Session session

  DateTime now

  def save(o) {

    session.saveOrUpdate(o)

    session.flush()

    return o;

  }

// Used to save the objects.

def save(o) {

  def con = DriverManager.getConnection(project.properties['jdbc.url'], project.properties['jdbc.username'], project.properties['jdbc.password'])

  def session = this.sessionFactory.openSession(con)

  try {

    println call++

    if (o instanceof Closure) {

      return o.call(new SaveDelegate(session: session, now: this.now))

    }

    else {

      return new SaveDelegate(session: session, now: this.now).save(o)

    }

  } catch (e) {

    System.err.println e.message

    return null;

  } finally {

    session.close()

    con.close()

  }

}

try {

// The save function above lets me handle objects in different ways:

// just save an instance

save new Person(name: 'Issac Brock')

// save with a reference

def f = save(new Person(name:'Jimmy Paige'))

// and finally with a closure

def f = save { s ->

   def f = new Person(name: "Scott Weiland")

... do other stuff

  return s.save f

}

} finally {

//cleanup

this.sessionFactory.close()

}

}

import static junit.framework.Assert.assertEquals;
import static junit.framework.Assert.assertNotNull;

// Static imports for the IsMapContaing matchers
import static org.hamcrest.collection.IsMapContaining.hasEntry;
import static org.hamcrest.collection.IsMapContaining.hasKey;

import org.hamcrest.collection.IsMapContaining;
import static org.hamcrest.core.AllOf.allOf;
import org.hamcrest.core.AllOf;
import org.jmock.Expectations;
import org.jmock.Mockery;
import org.jmock.integration.junit4.JMock;
import org.jmock.integration.junit4.JUnit4Mockery;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import java.util.Map;
import java.util.HashMap;

@RunWith(JMock.class)
public class DefaultReportDaoUnitTest
{

    Mockery mockery = new JUnit4Mockery();

    @Test
    public void testFoo() {

        final MyStuff mine = mockery.mock(MyStuff.class, "mine");

        mockery.checking(new Expectations()
        {{

            // I usually seperate this from being inline
            // so that I can get the generic type right easier
            Matcher<Map<String, ?>> mapMatcher =
                AllOf.<Map<String, ?>>allOf(
                        hasEntry("foo", "one"),
                        hasEntry("bar", "two"),
                        hasKey("baz")
                );        

            // Use the map mapmatcher we defined
            // expect one call of
            oneOf(mine).doSomething(with(mapMatcher));                                                       
        }};

        Map<String,String> map = new HashMap<String,String>(3);
        map.put("foo", "one");
        map.put("bar", "two");
        map.put("baz", "three");

        mine.doSometing(map);                

    }        

}       

The problem with this that if you use the DispatcherServlet to initialize the files then the CXFServlet isn’t able to find the context while it is initializing.

The only way I was able to get this to work out of the box was to list my config files in both places

<!-- inside the web.xml -->
<!-- don't do this, duplicates bean instances -->

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/myconfig.xml</param-value>
</context-param>
	<listener>
	<listener-class>
    org.springframework.web.context.ContextLoaderListener
    </listener-class>
</listener>

<servlet>
    <servlet-name>spring</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <description>Spring Configuration Files</description>
<param-name>contextConfigLocation</param-name>
<param-value>
            /WEB-INF/myconfig.xml
        </param-value>
    </init-param>
    <load-on-startup>2</load-on-startup>
</servlet>

The problem is that it will duplicate all your bean instances.

My solution is to just create a spring controller that handles the CXF requests. This was relatively easy to do using CXFServlet and AbstractCXFServlet as examples.

The benefit of doing this is that CXFController we create can be directly initialized with the ApplicationContext that it is created in.

package com.foo;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.cxf.Bus;
import org.apache.cxf.BusException;
import org.apache.cxf.BusFactory;
import org.apache.cxf.bus.spring.SpringBusFactory;
import org.apache.cxf.resource.ResourceManager;
import org.apache.cxf.transport.DestinationFactory;
import org.apache.cxf.transport.DestinationFactoryManager;
import org.apache.cxf.transport.servlet.ServletContextResourceResolver;
import org.apache.cxf.transport.servlet.ServletController;
import org.apache.cxf.transport.servlet.ServletTransportFactory;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.ContextStartedEvent;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.ServletConfig;
import javax.servlet.ServletContext;
import java.util.Enumeration;

public class CXFController implements Controller, ApplicationContextAware
{

    private static final Log log = LogFactory.getLog(CXFController.class);

    protected Bus bus;
    protected ServletTransportFactory servletTransportFactory;
    protected ServletController controller;
    protected WebApplicationContext applicationContext;

    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
    {
        this.applicationContext = (WebApplicationContext) applicationContext;
    }

    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception
    {
        try {
            BusFactory.setThreadDefaultBus(bus);
            controller.invoke(request, response);
        }
        catch (Exception e) {
            log.error(e.getMessage(),e);
            throw e;
        }
        finally {
            BusFactory.setThreadDefaultBus(null);
        }
        return null;
    }

    public void init()
    {
        bus = new SpringBusFactory(applicationContext).createBus();

        ResourceManager resourceManager = bus.getExtension(ResourceManager.class);
        resourceManager.addResourceResolver(new ServletContextResourceResolver(
                applicationContext.getServletContext()));

        replaceDestinationFactory();

        // Set up the ServletController
        controller = new ServletController(servletTransportFactory,
                SERVLET_CONFIG,
                applicationContext.getServletContext(),
                bus);
    }

    public void destroy() {
        bus.shutdown(true);
    }

    protected void replaceDestinationFactory()
    {

        DestinationFactoryManager dfm = bus.getExtension(DestinationFactoryManager.class);
        try
        {
            DestinationFactory df = dfm
                    .getDestinationFactory("http://cxf.apache.org/transports/http/configuration");
            if (df instanceof ServletTransportFactory)
            {
                servletTransportFactory = (ServletTransportFactory) df;
                log.info("DESTIONFACTORY_ALREADY_REGISTERED");
                return;
            }
        }
        catch (BusException e)
        {
            // why are we throwing a busexception if the DF isn't found?
        }

        DestinationFactory factory = createServletTransportFactory();

        for (String s : factory.getTransportIds())
        {
            registerTransport(factory, s);
        }
        log.info("REPLACED_HTTP_DESTIONFACTORY");
    }

    private void registerTransport(DestinationFactory factory, String namespace) {
        bus.getExtension(DestinationFactoryManager.class).registerDestinationFactory(namespace, factory);
    }

    protected DestinationFactory createServletTransportFactory() {
        if (servletTransportFactory == null) {
            servletTransportFactory = new ServletTransportFactory(bus);
        }
        return servletTransportFactory;
    }

    /**
     * Annoying hack...
     *
     * The ServletController class uses the servlet config to get other init parameters. This
     * mostly just prevents ServletController from throwing NullPointerExceptions
     *
     * We don't care about any of them but here is teh list if we decide we do:
     * hide-service-list-page
     * disable-address-updates
     * base-address
     * service-list-stylesheet
     */
    public static ServletConfig SERVLET_CONFIG = new ServletConfig()
    {

        public String getServletName()
        {
            return null;
        }

        public ServletContext getServletContext()
        {
            return null;
        }

        public String getInitParameter(String name)
        {
            return null;
        }

        public Enumeration getInitParameterNames()
        {
            return null;
        }
    };

}

There are three caveats to the examples above:
1. In CXFServlet it uses the ServletConfig to find specific init parameters, this can be done still with a little bit of effort by passing them in through the spring config and then use the SERVLET_CONFIG instance of ServletConfig in the example above to provide the values to the ServletController instance.

2. I don’t need the multiple cxf bus support so I didn’t port it over.

3. I didn’t add reloading support to my controller.

Finally you just need to configure spring to use this new controller:

<bean name="cxfController" class="com.foo.CXFController"
          init-method="init"
          destroy-method="destroy"
          lazy-init="true"/>

    <bean id="beanMappings"
          class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"
          p:order="0" />

    <bean id="urlMappings"
          class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping"
          p:order="1">
<property name="urlMap">
            <util:map>
                <entry key="/cxf*/**" value-ref="cxfController"/>
            </util:map>
        </property>
    </bean>

It is very important to note that the cxfController is lazy initialized. This allows all services to be loaded before the CXFController does. This could probably also be done by making the CXFController an application listener and waiting until the spring context was fully initialized before initializing, but it was quicker to just make it lazy initialized

If you have trouble with it working, try removing your installed extra plugins.
(Under ~/Library/Application Support/IntelliJIDEA80 on the mac)

Normally with hessian you add your custom SerializerFactory to the main hessian SerializerFactory via the addFactory method. This is particularly spring friendly. You will need to create a subclass of SerializerFactory like the following:

package com.foo;

import com.caucho.hessian.io.SerializerFactory;
import com.caucho.hessian.io.AbstractSerializerFactory;

import java.util.List;

public class SpringExtensibleSerializerFactory extends SerializerFactory
{

    public void setSerializerFactories(List<AbstractSerializerFactory> factories) {
        for (AbstractSerializerFactory factory : factories)
        {
            addFactory(factory);
        }
    }

}

This will allow you to add a list of custom SerializerFactory to the main hessian SerializerFactory. This SerializerFactory will need to be setup on both the client and server.

<bean id="hessianSerializerFactory"
          class="com.foo.SpringExtensibleSerializerFactory">
<property name="serializerFactories">
        <util:list>
             <bean class="com.foo.BigIntegerSerializerFactory"/>
        </util:list>
    </property>
 </bean>

Next on the server side I create an abstract hessian exporter bean.

<bean id="baseHessianService" class="org.springframework.remoting.caucho.HessianServiceExporter" abstract="true">
<property name="serializerFactory" ref="hessianSerializerFactory" />
</bean>

Services can then be exposed simply by extended the baseHessianService

<bean id="myHessianService" parent="baseHessianProxyFactory">
<property name="serviceUrl"
            value="http://foo.com/hessian/MyHessianService" />
<property name="serviceInterface"
            value="com.foo.MyHessianService" />
</bean>

On the client side create an abstract bean for HessianProxyFactoryBean with an instance of the hessianSerializerFactory described above.

<bean id="baseHessianProxyFactory" class="org.springframework.remoting.caucho.HessianProxyFactoryBean"
          abstract="true" >
<property name="serializerFactory" ref="hessianSerializerFactory" />
</bean>

Services can then be consumed by extending this abstract bean

<bean id="myHessianServiceProxy" parent="baseHessianProxyFactory">
<property name="serviceUrl"
            value="http://foo.com/hessian/MyHessianService" />
<property name="serviceInterface"
            value="com.foo.MyHessianService" />
</bean>

The deserializer:

package com.foo.hessian;

import com.caucho.hessian.io.AbstractDeserializer;
import com.caucho.hessian.io.AbstractHessianInput;

import java.io.IOException;
import java.math.BigInteger;

public class BigIntegerDeSerializer extends AbstractDeserializer
{

    public Class getType()
    {
        return BigInteger.class;
    }

    public Object readMap(AbstractHessianInput in)
            throws IOException
    {
        int ref = in.addRef(null);

        String initValue = null;

        while (!in.isEnd())
        {
            String key = in.readString();

            if (key.equals("value"))
                initValue = in.readString();
            else
                in.readString();
        }

        in.readMapEnd();

        Object value = new BigInteger(initValue);

        in.setRef(ref, value);

        return value;
    }

    public Object readObject(AbstractHessianInput in, String[] fieldNames)
            throws IOException
    {
        int ref = in.addRef(null);

        String initValue = null;

        for (String key : fieldNames)
        {
            if (key.equals("value"))
                initValue = in.readString();
            else
                in.readObject();
        }

        Object value = new BigInteger(initValue);

        in.setRef(ref, value);

        return value;
    }

}

The serializer:

package com.foo.hessian;

import com.caucho.hessian.io.AbstractSerializer;
import com.caucho.hessian.io.AbstractHessianOutput;

import java.io.IOException;
import java.math.BigInteger;

public class BigIntegerSerializer extends AbstractSerializer
{
    public void writeObject(Object obj, AbstractHessianOutput out) throws IOException
    {

        if (obj == null)
            out.writeNull();
        else
        {
            Class cl = obj.getClass();

            if (out.addRef(obj))
                return;

            int ref = out.writeObjectBegin(cl.getName());

            BigInteger bi = (BigInteger) obj;

            if (ref < -1)
            {
                out.writeString("value");
                out.writeString(bi.toString());
                out.writeMapEnd();
            }
            else
            {
                if (ref == -1)
                {
                    out.writeInt(1);
                    out.writeString("value");
                    out.writeObjectBegin(cl.getName());
                }

                out.writeString(bi.toString());
            }
        }
    }
}

Next you will need a serializer factory for the BigInteger Serializer/Deserializer

public class BigIntegerSerializerFactory extends AbstractSerializerFactory
{
    public Serializer getSerializer(Class cl) throws HessianProtocolException
    {
        if (BigInteger.class.isAssignableFrom(cl)) {
            return new BigIntegerSerializer();
        }
        return null;
    }

    public Deserializer getDeserializer(Class cl) throws HessianProtocolException
    {
        if (BigInteger.class.isAssignableFrom(cl)) {
            return new BigIntegerDeSerializer();
        }
        return null;
    }
}

Finally add this to the main via the SerializerFactory#addFactory method.

In the next post I will show how to tie this all into spring.
]]> http://ayax79.wordpress.com/2009/02/11/big-integers-and-hessian/feed/ 0 ayax79 http://ayax79.wordpress.com/2007/12/04/spring-configuration-of-dwr/ http://ayax79.wordpress.com/2007/12/04/spring-configuration-of-dwr/#comments Tue, 04 Dec 2007 17:24:51 +0000 AJ http://ayax79.wordpress.com/2007/12/04/spring-configuration-of-dwr/ ]]> I have found there really aren’t any great guides for getting DWR configured with spring. Here is my experiences.
Prerequisites:

• Assuming some previous knowledge of DWR and spring.
• Spring is configured and working.
• DWR has been added the WEB-INF/lib.

1. Add DWR to the web.xml

Instead of using the DwrServlet, make sure you use the SpringDwrServlet:

<servlet>
    <servlet-name>dwr-invoker</servlet-name>
    <display-name>DWR Servlet</display-name>

        <description>Direct Web Remoter Servlet</description>
        <servlet-class>org.directwebremoting.spring.DwrSpringServlet</servlet-class>
        <init-param>
<param-name>logLevel</param-name>
<param-value>INFO</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
    </servlet></tt>

<servlet-mapping>
    <servlet-name>dwr-invoker</servlet-name>
       <url-pattern>/dwr/*</url-pattern>
    </servlet-mapping><

2. Next, add the dwr namespace and schema to your spring configuration file:

The namespace is xmlns:dwr=”http://www.directwebremoting.org/schema/spring-dwr”
The schemaLocation is http://www.directwebremoting.org/schema/spring-dwr http://www.directwebremoting.org/schema/spring-dwr-2.0.xsd

<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:util="http://www.springframework.org/schema/util"
       xmlns:dwr="http://www.directwebremoting.org/schema/spring-dwr"
       xsi:schemaLocation="

http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd

http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd

http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-2.0.xsd

http://www.directwebremoting.org/schema/spring-dwr http://www.directwebremoting.org/schema/spring-dwr-2.0.xsd"

       default-autowire="no" default-lazy-init="false" default-init-method="init" default-destroy-method="destroy"></tt>

</beans>

3. Configure Spring creators.

There are two options for doing this. You can directly expose spring beans:

<bean id="dwrWatchesBean" class="com.jivesoftware.community.action.WatchesAction" >

    <dwr:remote javascript="Watches" />
<property name="communityManagerImpl" ref="communityManagerImpl" />
<property name="forumManagerImpl" ref="forumManagerImpl" />
<property name="watchManagerImpl" ref="watchManagerImpl" />
<property name="documentManagerImpl" ref="documentManagerImpl" />
<property name="blogManagerImpl" ref="blogManagerImpl" />
<property name="userManagerImpl" ref="userManagerImpl" />
</bean>

The dwr:remote element is the element that will expose the bean to dwr. In my opinion this is the best approach as it allows you to wire you dependencies like any other spring object.

Secondly you can configure them in a dwr:configuration much in the same as the standard dwr.xml file works:

<dwr:configuration>
    <dwr:create type="new" javascript="Watches"     class="com.jivesoftware.community.action.WatchesAction" />
</dwr:configuration>

4. Configure spring convertors

The spring configurators must be configured inside of a dwr:configuration element in spring.

<dwr:configuration>
    <dwr:convert type="bean" class="com.jivesoftware.community.Watch" />
</dwr:configuration>

5. Other important elements

dwr:include : Used to include specific methods. Can be used with dwr:convert, dwr:create, or dwr:remote element
dwr:exclude : Used to exclude specific methods. Can be used with dwr:convert, dwr:create, or dwr:remote element
dwr:init : Optional element that will allow you to specify custom creator types and converter types.
dwr:converter : Specifies a custom converter type, must be used within dwr:init.
dwr:create : Specifies a custom creator type, must be used within a dwr:init.
dwr:signature : Used to specify signatures much like the like element in the standard dwr.xml.

6. Full Example

<?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:util="http://www.springframework.org/schema/util"
       xmlns:dwr="http://www.directwebremoting.org/schema/spring-dwr"
       xsi:schemaLocation="
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-2.0.xsd
http://www.directwebremoting.org/schema/spring-dwr http://www.directwebremoting.org/schema/spring-dwr-2.0.xsd"
       default-autowire="no" default-lazy-init="false" default-init-method="init" default-destroy-method="destroy"></tt>

    <bean id="dwrWatchesBean" class="com.jivesoftware.community.action.WatchesAction" >

        <dwr:remote javascript="Watches" />
<property name="communityManagerImpl" ref="communityManagerImpl" />
<property name="forumManagerImpl" ref="forumManagerImpl" />
<property name="watchManagerImpl" ref="watchManagerImpl" />
<property name="documentManagerImpl" ref="documentManagerImpl" />
<property name="blogManagerImpl" ref="blogManagerImpl" />
<property name="userManagerImpl" ref="userManagerImpl" />
         </bean>

        <dwr:configuration>
            <dwr:convert class="com.jivesoftware.community.DraftImpl" type="bean" />
        <dwr:create type="new" javascript="ImagePicker" class="com.jivesoftware.community.action.ImagePicker" >
            <dwr:include method="getImageByName" />
            <dwr:include method="getImageDetailsByName" />
            <dwr:include method="getImageDetailsByURL" />
            <dwr:include method="removeImage" />
        </dwr:create>

        <dwr:convert class="com.jivesoftware.base.User" type="bean" >
            <dwr:include method="username"/>
            <dwr:include method="name"/>
            <dwr:include method="ID"/>
        </dwr:convert>
        <dwr:convert class="com.jivesoftware.community.action.LDAPGroupBean" type="bean" />

        <dwr:signatures>
           <![CDATA[
          import java.util.Map;
          import com.jivesoftware.community.DraftImpl;
          DraftImpl.setProperties(Map<String, String> properties);
          DraftImpl.setImageIDs(List<Long> imageIDs);
          ]]>
        </dwr:signatures>

    </dwr:configuration>
</beans>

CAVEATS

• Do not attempt to use DwrSpringServlet with org.springframework.web.servlet.mvc.ServletWrappingController. DwrSpringServlet expects the spring context to be fully initialized before it attempts to initialize.