Contributing to the JBoss 7 Management Console
11 Mar 2011You want to contribute to the management web interface for JBoss ? Then this should get you going.
Codebase
Everything is hosted at github, The best way is to create a fork of either one of the codebases listed below and work on that one.
- Authoritative master: https://github.com/jbossas/console
- Most recent: https://github.com/heiko-braun/as7-console
Prerequisites
The console it self is developed using the Google Web Toolkit. You would need to make yourself familiar with the basics before we et going. The GWT SDK will be installed as part of the maven build. No need to fetch it on it’s own. If you plan to work with Eclipse, then you should consider the development tools for GWT that are provided by Google. But please don’t ask how things are setup correctly in Eclipse. We baseline on maven and that’s it.
Things you need to know
Widgets
We build on GWT 2.2 without any dependencies on external widget libraries. However these is a growing number of widgets (org.jboss.as.console.client.widgets) that should be reused. We aim for keeping the overall number of widgets to a minimum.
But if you need anything that doesn’t exist, take a look at the SmartGWT showcase, tell us about it and we’ll then consider implementing it.
MVP Pattern
But one of the cornerstones is the GWT Platform library, which nicely abstracts the MVP pattern. It act’s as a blueprint for the console design. A good introduction can be found here. (This is a “must read”)
AutoBeans
Internal model representations are build as AutoBean’s. They align well with the default GWT API and have build-in serialization support. A general guideline: Any domain representation that’s used within the console needs to be provided as an AutoBean abstraction. This means that beyond the integration layer (backend calls to the AS 7 domain) entities need to be adopted.
This is necessary to provide a baseline for the data binding used across widgets. Take a look at the form abstractions, then you’ll know what I mean. The CellList and CellTable API’s are another example.
Discussions
We are using the AS7 mailing lists and/or IRC for discussions of technical matters, improvements, proposed patches, etc: