Heiko Braun [
http://community.jboss.org/people/heiko.braun] modified the document:
"ManagementConsoleDevGuide"
To view the document, visit:
http://community.jboss.org/docs/DOC-16607
--------------------------------------------------------------
h2. Development Guide
You want to contribute to the management web interface for JBoss ? Then this is the right
place to start.
h3. Codebase
Everything is hosted at
http://help.github.com/ github, The best way is to
http://help.github.com/fork-a-repo/ create a fork of either one of the codebases listed
below and work on that one.
- Authoritative master:
https://github.com/jbossas/console
https://github.com/jbossas/console
- Most recent:
https://github.com/heiko-braun/as7-console
https://github.com/heiko-braun/as7-console
h3. Prerequisites
The console it self is developed using the
http://code.google.com/webtoolkit/overview.html Google Web Toolkit. You would need to make
yourself familiar with the basics before we get 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.
h3. 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 ( http:// 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
http://www.smartclient.com/smartgwt/showcase/ 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
http://code.google.com/p/gwt-platform/wiki/GettingStarted#Using_GWTP introduction can be
found here. (This is a "must read")
AutoBeans
Internal model representations are build as
http://code.google.com/p/google-web-toolkit/wiki/AutoBean 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
http://google-web-toolkit.googlecode.com/svn/javadoc/latest/index.html?ov...
CellList and CellTable API's are another example.
h3. Discussions
We are using the AS7 mailing lists and/or IRC for discussions of technical matters,
improvements, proposed patches, etc:
-
https://lists.jboss.org/mailman/listinfo/jboss-as7-dev
https://lists.jboss.org/mailman/listinfo/jboss-as7-dev
- irc.freenode.net#jboss-as7
--------------------------------------------------------------
Comment by going to Community
[
http://community.jboss.org/docs/DOC-16607]
Create a new document in JBoss AS7 Development at Community
[
http://community.jboss.org/choose-container!input.jspa?contentType=102&am...]