grails-atmosphere-meteor: A JavaScript repository from jladenfors

Grails plugin for integrating the Atmosphere Framework

The plugin has been tested in the following environment, using the grails-atmosphere-meteor-sample application and grails-plugin-test-script:

atmosphere-runtime 2.0.3
OSX 10.8.5
JDK 1.7.0_40
Grails versions 2.1.0 through 2.3.0

The plugin has worked on Grails versions 2.0.x; however, providing support and maintaining my test environment has become too difficult.

If you have a question, problem, suggestion, or want to report a bug, please submit an issue. I will reply as soon as I can.

Planned Changes

Release Notes

The plugin uses the following pieces of the Atmosphere Framework:

How It Works

Java Servlet

The plugin is designed to create and use a servlet for each main or significant URL pattern. For example, if you download the sample application, you will see that a servlet is created for each URL pattern below:

/jabber/chat/*

/jabber/notification/*

/jabber/public/*

The servlets are registered programmatically and are not defined in web.xml.

Configuration

All servlets are defined in grails-app/conf/AtmosphereMeteorConfig.groovy.

grails-app/conf/AtmosphereResources.groovy has modules for atmosphere.js and jquery.atmosphere.js.

MeteorServlet Class

The create-meteor-servlet script creates a class in grails-app/atmosphere that extends Atmosphere's MeteorServlet. You could probably use a single class throughout your application.

Although the sample application uses the same MeteorServlet class for each URL, you can easily use a different class. Of course, each of the URL patterns above can be further divided using a combination of request headers, path, etc. For example, a chat room could be established under /jabber/chat/private-room that is serviced by the same servlet, MeteorServlet, and MeteorHandler classes as /jabber/chat/*.

MeteorHandler Class

The create-meteor-handler script creates a class in grails-app/atmosphere that extends HttpServlet. This is where you customize how the HTTP requests and responses (including Atmosphere Broadcaster) are handled.

Plugin Installation

The instructions assume you are using Tomcat as the servlet container.

Edit your BuildConfig.groovy:

plugins {
    // other plugins
    compile ":atmosphere-meteor:0.6.2"
    // other plugins
}

Create a MeteorServlet. Changes to these classes are reloaded automatically.

grails create-meteor-servlet com.example.Default

Create a handler. Changes to these classes are reloaded automatically.

grails create-meteor-handler com.example.Default

Edit grails-app/conf/AtmosphereMeteorConfig.groovy. Changes to this file will be implemented when the application is restarted.

import com.example.DefaultMeteorHandler

defaultMapping = "/jabber/*"

servlets = [
    MeteorServletDefault: [
        className: "com.example.DefaultMeteorServlet",
        mapping: "/jabber/*",
       	handler: DefaultMeteorHandler,
 		initParams = [
\			"org.atmosphere.cpr.broadcasterCacheClass": "org.atmosphere.cache.UUIDBroadcasterCache",
			"org.atmosphere.cpr.AtmosphereInterceptor": """
				org.atmosphere.client.TrackMessageSizeInterceptor,
				org.atmosphere.interceptor.AtmosphereResourceLifecycleInterceptor,
				org.atmosphere.interceptor.HeartbeatInterceptor
			"""
		]
    ]
]

Note the changes the plugin installation made to grails-app/conf/BuildConfig.groovy. Your original file was copied to grails-app/conf/BuildConfig_ORIG.groovy.

grails.servlet.version = "3.0"
grails.tomcat.nio = true

You can change the dependency versions your application uses by editing your application's grails-app/conf/BuildConfig.groovy. This will override the versions defined in the plugin.

grails.project.dependency.resolution = {
    dependencies {
    	// other dependencies
        compile('org.atmosphere:atmosphere-runtime:2.0.3') {
            excludes 'slf4j-api'
        }
        compile 'org.codehaus.jackson:jackson-core-asl:1.9.13'
    	// other dependencies
    }
}

You can change the Atmosphere log level by adding a line to your application's grails-app/conf/Config.groovy in the appropriate place. For example, to set the level to warn:

warn 'org.atmosphere'

Update Javascript Files

You can update the Atmosphere Javascript files by running the script below. This will allow you to update the client files without having to wait on a plugin release.

grails update-atmosphere-meteor-javascript

jladenfors/grails-atmosphere-meteor