org.directwebremoting.spring
Class DwrController

java.lang.Object
  org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
          org.springframework.web.servlet.support.WebContentGenerator
              org.springframework.web.servlet.mvc.AbstractController
                  org.directwebremoting.spring.DwrController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller

public class DwrController
extends org.springframework.web.servlet.mvc.AbstractController
implements org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.BeanFactoryAware

A Spring Controller that handles DWR requests.
Using this controller allows you to configure DWR entirely in Spring. You do not have to create a separate dwr.xml configuration file when using this controller.

The following configuration provides a basic example of how too define this controller as a bean in your application context.

   <bean id="dwrController" class="org.directwebremoting.spring.DwrController">
      <property name="configurators">
         <list>
            <ref bean="dwrConfiguration"/>
         </list>
      </property>
      <property name="debug" value="true"/>
   </bean>

   <bean id="dwrConfiguration" class="org.directwebremoting.spring.SpringConfigurator">
      <property name="creators">
         <map>
            <entry key="beanName">
               <bean class="org.directwebremoting.spring.CreatorConfig">
                  <property name="creator">
                     <bean class="org.directwebremoting.spring.BeanCreator">
                        <property name="bean" ref="BeanName"/>
                     </bean>
                  </property>
               </bean>
            </entry>
         </map>
      </property>
   </bean>

   <-- the bean you want to remote using DWR -->
   <bean id="beanName" class="BeanName"/>
   

In the near future we want to provide a DWR namespace for Spring, which should allow you to something like the following:

   <dwr:configuration>
      <debug/>
   </dwr:configuration>

   <-- the bean you want to remote using DWR -->
   <bean id="beanName" class="BeanName">
      <dwr:remote javascript="beanName"/>
   </bean>
   

Which should be equivalent to the previous example. Please note that this is still work in progress and is therefore subject to change.

Author:

Joe Walker [joe at getahead dot ltd dot uk], Bram Smeets

Field Summary

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Constructor Summary

DwrController()

Method Summary

void	afterPropertiesSet() Is called by the Spring container after all properties have been set.
void	destroy()
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) Is called by the Spring container to set the bean factory.
void	setBeanName(java.lang.String name) Is called by the Spring container to set the name of this bean.
void	setConfigParams(java.util.Map<java.lang.String,java.lang.String> configParams) Additional parameters such as pollAndCometEnabled.
void	setConfigurators(java.util.List<Configurator> configurators) Sets the configurators to apply to this controller.
void	setDebug(boolean debug) Sets whether DWR should be in debug mode (default is false).
void	setIncludeDefaultConfig(boolean includeDefaultConfig) Sets whether the default DWR configuration should be included (default is true).

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, setApplicationContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DwrController

public DwrController()

Method Detail

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Is called by the Spring container to set the bean factory.
This bean factory is then used to obtain the global DWR configuration from. This global configuration is optional as DWR will provide defaults where possible.

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

See Also:

BeanFactoryAware.setBeanFactory(org.springframework.beans.factory.BeanFactory)

setDebug

public void setDebug(boolean debug)

Sets whether DWR should be in debug mode (default is false).
This allows access to the debug pages provided by DWR under /[WEBAPP]/dwr/. NOTE: make sure to not set this property to true in a production environment.

Parameters:

debug - the indication of whether to start DWR in debug mode

setConfigurators

public void setConfigurators(java.util.List<Configurator> configurators)

Sets the configurators to apply to this controller.
The configurators are used to set up DWR correctly.

Parameters:

configurators - the configurators to apply to this controller

setIncludeDefaultConfig

public void setIncludeDefaultConfig(boolean includeDefaultConfig)

Sets whether the default DWR configuration should be included (default is true).
This default configuration contains all build-in creators and converters. You normally want this default configuration to be included.

Parameters:

includeDefaultConfig - the indication of whether to include the default configuration

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Is called by the Spring container after all properties have been set.
This method actually makes sure the container is correctly initialized and all configurators are processed.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception - in case setting up fails

See Also:

InitializingBean.afterPropertiesSet()

setBeanName

public void setBeanName(java.lang.String name)

Is called by the Spring container to set the name of this bean.

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

Parameters:

name - the name of this bean in the Spring container

See Also:

BeanNameAware.setBeanName(String)

setConfigParams

public void setConfigParams(java.util.Map<java.lang.String,java.lang.String> configParams)

Additional parameters such as pollAndCometEnabled. For a full list see:

Parameters:

configParams - the configParams to set

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception