geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Geronimo v2.2: Deployment plans (page edited)
Date Tue, 18 Nov 2008 02:09:00 GMT
<html>
<head>
    <base href="http://cwiki.apache.org/confluence" />
    <style type="text/css">
    <!--
    body, p, td, table, tr, .bodytext, .stepfield {
	font-family: Verdana, arial, sans-serif;
	font-size: 11px;
	line-height: 16px;
	color: #000000;
	font-weight: normal;
}
#PageContent {
	text-align: left;
	background-color: #fff;
	padding: 0px;
	margin: 0px;
    padding-bottom:20px;
}
/*
** when this stylesheet is used for the Tiny MCE Wysiwyg editor's edit area, we can't
** use an id=PageContent or class=wiki-content, so we must
** set the body style to that used for PageContent, and p to that used for wiki-content.
*/

body {
	margin: 0px;
	padding: 0px;
	text-align: center;
    background-color: #f0f0f0;
}

@media print {

body {
    background-color: #fff;
}

}

.monospaceInput {
    font:12px monospace
}

.wiki-content p, .commentblock p {
    margin: 16px 0px 16px 0px;
    padding: 0px;
}

.wiki-content-preview {
    padding: 5px;
    border-left: 1px solid #3c78b5;
    border-right: 1px solid #3c78b5;
}

ul, ol {
    margin-top: 2px;
    margin-bottom: 2px;
    padding-top: 0px;
    padding-bottom: 0px;
}

pre {
    padding: 0px;
    margin-top: 5px;
    margin-left: 15px;
    margin-bottom: 5px;
    margin-right: 5px;
    text-align: left;
}

.helpheading {
    font-weight: bold;
    background-color: #D0D9BD;
        border-bottom: 1px solid #3c78b5;
        padding: 4px 4px 4px 4px;
        margin: 0px;
        margin-top: 10px;
}
.helpcontent {
        padding: 4px 4px 20px 4px;
    background-color: #f5f7f1;
}

.code {
 	border: 1px dashed #3c78b5;
    font-size: 11px;
	font-family: Courier;
    margin: 10px;
	line-height: 13px;
}

.focusedComment {
    background: #ffffce;
}

.commentBox, .focusedComment {
    padding: 10px;
    margin: 5px 0 5px 0;
    border: 1px #bbb solid;
}

.codeHeader {
    background-color: #f0f0f0;
 	border-bottom: 1px dashed #3c78b5;
    padding: 3px;
	text-align: center;
}

.codeContent {
    text-align: left;
    background-color: #f0f0f0;
    padding: 3px;
}

.preformatted {
 	border: 1px dashed #3c78b5;
    font-size: 11px;
	font-family: Courier;
    margin: 10px;
	line-height: 13px;
}

.preformattedHeader {
    background-color: #f0f0f0;
 	border-bottom: 1px dashed #3c78b5;
    padding: 3px;
	text-align: center;
}

.preformattedContent {
    background-color: #f0f0f0;
    padding: 3px;
}

.panel {
 	border: 1px dashed #3c78b5;
    margin: 10px;
    margin-top: 0px;
}

.panelHeader {
    background-color: #f0f0f0;
 	border-bottom: 1px dashed #3c78b5;
    padding: 3px;
	text-align: center;
}

.panelContent {
    background-color: #f0f0f0;
    padding: 5px;
}

.anonymousAlert {
    background-color: #f0f0f0;
 	border: 1px dashed red;
    font-size: 11px;
    padding: 10px 5px 10px 5px;
    margin: 4px;
	line-height: 13px;
}

.lockAlert {
    background-color: #f0f0f0;
    width: 50%;
 	border: 1px dashed red;
    font-size: 11px;
    padding: 10px 5px 10px 5px;
    margin: 4px;
	line-height: 13px;
}


.code-keyword {
  color: #000091;
  background-color: inherit;
}

.code-object {
  color: #910091;
  background-color: inherit;
}

.code-quote {
  color: #009100;
  background-color: inherit;
}

.code-comment {
  color: #808080;
  background-color: inherit;
}


.code-xml .code-keyword {
  color: inherit;
  font-weight: bold;
}

.code-tag {
  color: #000091;
  background-color: inherit;
}

.breadcrumbs {
    background-color: #f0f0f0;
 	border-color: #3c78b5;
	border-width: 1px 0px 1px 0px;
	border-style: solid;
    font-size: 11px;
    padding: 3px 0px 3px 0px;
}

.navmenu {
    border: 1px solid #ccc;
}

.menuheading {
    font-weight: bold;
    background-color: #f0f0f0;
 	border-bottom: 1px solid #3c78b5;
	padding: 4px 4px 2px 4px;
}

.menuitems {
	padding: 4px 4px 20px 4px;
}

.rightpanel {
    border-left: 1px solid #ccc;
    border-bottom: 1px solid #ccc;
}

#helpheading {
    text-align: left;
    font-weight: bold;
    background-color: #D0D9BD;
 	border-bottom: 1px solid #3c78b5;
	padding: 4px 4px 4px 4px;
	margin: 0px;
}
#helpcontent {
	padding: 4px 4px 4px 4px;
    background-color: #f5f7f1;
}
.helptab-unselected {
    font-weight: bold;
	padding: 5px;
    background-color: #f5f7f1;
}
.helptab-selected {
    font-weight: bold;
    background-color: #D0D9BD;
	padding: 5px;
}
.helptabs {
    margin: 0px;
    background-color: #f5f7f1;
	padding: 5px;
}
.infopanel-heading {
    font-weight: bold;
	padding: 4px 0px 2px 0px;
}

.pagebody {
}

.pageheader {
	padding: 5px 5px 5px 0px;
 	border-bottom: 1px solid #3c78b5;
}

.pagetitle {
	font-size: 22px;
	font-weight: bold;
	font-family: Arial, sans-serif;
	color: #003366;
}

.newpagetitle {
    color: #ccc !important;
}

.steptitle {
	font-size: 18px;
	font-weight: bold;
	font-family: Arial, sans-serif;
	color: #003366;
	margin-bottom: 7px;
}

.substeptitle {
    font-size: 12px;
    font-weight: bold;
    font-family: Arial, sans-serif;
    color: #003366;
    margin: 2px 4px 4px 4px;
    padding: 2px 4px 1px 4px;
}

.stepdesc {
    font-family: Verdana, arial, sans-serif;
	font-size: 11px;
	line-height: 16px;
	font-weight: normal;
    color: #666666;
    margin-top: 7px;
    margin-bottom: 7px;
}

.steplabel {
    font-weight: bold;
    margin-right: 4px;
    color: black;
    float: left;
    width: 15%;
    text-align: right;
}

.stepfield {
    background: #f0f0f0;
    padding: 5px;
}

.submitButtons{
    margin-top:5px;
    text-align:right;
}

.formtitle {
	font-size: 12px;
	font-weight: bold;
	font-family: Arial, sans-serif;
	color: #003366;
}

.sectionbottom {
    border-bottom: 1px solid #3c78b5;
}

.topRow {
    border-top: 2px solid #3c78b5;
}

.tabletitle {
	font-size: 14px;
	font-weight: bold;
	font-family: Arial, sans-serif;
    padding: 3px 0px 2px 0px;
    margin: 8px 4px 2px 0px;
	color: #003366;
	border-bottom: 2px solid #3c78b5;
}
.pagesubheading {
    color: #666666;
    font-size: 10px;
    padding: 0px 0px 5px 0px;
}

HR {
	color: 3c78b5;
	height: 1;
}

A:link, A:visited, A:active, A:hover {
	color: #003366;
}

h1 A:link, h1 A:visited, h1 A:active {
	text-decoration: none;
}

h1 A:hover {
    border-bottom: 1px dotted #003366;
}

.wiki-content > :first-child, .commentblock > :first-child {
    margin-top: 3px;
}

.logocell {
    padding: 10px;
}

input {
	font-family: verdana, geneva, arial, sans-serif;
	font-size: 11px;
	color: #000000;
}

textarea, textarea.editor {
	font-family: verdana, geneva, arial, sans-serif;
	font-size: 11px;
	color: #333333;
}

/* use logoSpaceLink instead.
.spacenametitle {
	font: 21px/31px Impact, Arial, Helvetica;
    font-weight: 100;
    color: #999999;
	margin: 0px;
}
.spacenametitle img {
  margin: 0 0 -4px 0;
}
.spacenametitle a {
    text-decoration: none;
    color: #999999;
}
.spacenametitle a:visited {
    text-decoration: none;
    color: #999999;
}*/

.spacenametitle-printable {
	font: 20px/25px Impact, Arial, Helvetica;
    font-weight: 100;
    color: #999999;
	margin: 0px;
}
.spacenametitle-printable a {
    text-decoration: none;
    color: #999999;
}
.spacenametitle-printable a:visited {
    text-decoration: none;
    color: #999999;
}

.blogDate {
	font-weight: bold;
	text-decoration: none;
	color: black;
}

.blogSurtitle {
    background: #f0f0f0;
 	border: 1px solid #ddd;
	padding: 3px;
	margin: 1px 1px 10px 1px;
}

.blogHeading {
    font-size: 20px;
    line-height: normal;
    font-weight: bold;
    padding: 0px;
    margin: 0px;
}

.blogHeading a {
   text-decoration: none;
   color: black;
}

.endsection {
	align: right;
	color: #666666;
	margin-top: 10px;
}
.endsectionleftnav {
	align: right;
	color: #666666;
	margin-top: 10px;
}

h1 {
	font-size: 24px;
	line-height: normal;
	font-weight: bold;
	background-color: #f0f0f0;
	color: #003366;
 	border-bottom: 1px solid #3c78b5;
	padding: 2px;
	margin: 36px 0px 4px 0px;
}

h2 {
	font-size: 18px;
	line-height: normal;
	font-weight: bold;
	background-color: #f0f0f0;
 	border-bottom: 1px solid #3c78b5;
	padding: 2px;
	margin: 27px 0px 4px 0px;
}

h3 {
	font-size: 14px;
	line-height: normal;
	font-weight: bold;
	background-color: #f0f0f0;
	padding: 2px;
	margin: 21px 0px 4px 0px;
}

h4 {
	font-size: 12px;
	line-height: normal;
	font-weight: bold;
	background-color: #f0f0f0;
	padding: 2px;
	margin: 18px 0px 4px 0px;
}

h4.search {
	font-size: 12px;
	line-height: normal;
	font-weight: normal;
	background-color: #f0f0f0;
	padding: 4px;
	margin: 18px 0px 4px 0px;
}

h5 {
	font-size: 10px;
	line-height: normal;
	font-weight: bold;
	background-color: #f0f0f0;
	padding: 2px;
	margin: 14px 0px 4px 0px;
}

h6 {
	font-size: 8px;
	line-height: normal;
	font-weight: bold;
	background-color: #f0f0f0;
	padding: 2px;
	margin: 14px 0px 4px 0px;
}

.smallfont {
    font-size: 10px;
}
.descfont {
    font-size: 10px;
    color: #666666;
}
.smallerfont {
    font-size: 9px;
}
.smalltext {
    color: #666666;
    font-size: 10px;
}
.smalltext a {
    color: #666666;
}
.smalltext-blue {
    color: #3c78b5;
    font-size: 10px;
}
.surtitle {
    margin-left: 1px;
    margin-bottom: 5px;
    font-size: 14px;
    color: #666666;
}

/* css hack found here:  http://www.fo3nix.pwp.blueyonder.co.uk/tutorials/css/hacks/ */
.navItemOver { font-size: 10px; font-weight: bold; color: #ffffff; background-color: #003366; cursor: hand; voice-family: '\'}\''; voice-family:inherit; cursor: pointer;}
.navItemOver a { color: #ffffff; background-color:#003366; text-decoration: none; }
.navItemOver a:visited { color: #ffffff; background-color:#003366; text-decoration: none; }
.navItemOver a:hover { color: #ffffff; background-color:#003366; text-decoration: none; }
.navItem { font-size: 10px; font-weight: bold; color: #ffffff; background-color: #3c78b5; }
.navItem a { color: #ffffff; text-decoration: none; }
.navItem a:hover { color: #ffffff; text-decoration: none; }
.navItem a:visited { color: #ffffff; text-decoration: none; }

div.padded { padding: 4px; }
div.thickPadded { padding: 10px; }
h3.macrolibrariestitle {
    margin: 0px 0px 0px 0px;
}

div.centered { text-align: center; margin: 10px; }
div.centered table {margin: 0px auto; text-align: left; }

.tableview table {
    margin: 0;
}

.tableview th {
    text-align: left;
    color: #003366;
    font-size: 12px;
    padding: 5px 0px 0px 5px;
    border-bottom: 2px solid #3c78b5;
}
.tableview td {
    text-align: left;
    border-color: #ccc;
    border-width: 0px 0px 1px 0px;
    border-style: solid;
    margin: 0;
    padding: 4px 10px 4px 5px;
}

.grid {
    margin: 2px 0px 5px 0px;
    border-collapse: collapse;
}
.grid th  {
    border: 1px solid #ccc;
    padding: 2px 4px 2px 4px;
    background: #f0f0f0;
    text-align: center;
}
.grid td  {
    border: 1px solid #ccc;
    padding: 3px 4px 3px 4px;
}
.gridHover {
	background-color: #f9f9f9;
}

td.infocell {
    background-color: #f0f0f0;
}
.label {
	font-weight: bold;
	color: #003366;
}

label {
	font-weight: bold;
	color: #003366;
}

.error {
	background-color: #fcc;
}

.errorBox {
	background-color: #fcc;
    border: 1px solid #c00;
    padding: 5px;
    margin: 5px;
}

.errorMessage {
	color: #c00;
}

.success {
	background-color: #dfd;
}

.successBox {
	background-color: #dfd;
    border: 1px solid #090;
    padding: 5px;
    margin-top:5px;
    margin-bottom:5px;
}

blockquote {
	padding-left: 10px;
	padding-right: 10px;
	margin-left: 5px;
	margin-right: 0px;
	border-left: 1px solid #3c78b5;
}

table.confluenceTable
{
    margin: 5px;
    border-collapse: collapse;
}

/* Added as a temporary fix for CONF-4223. The table elements appear to be inheriting the border: none attribute from the sectionMacro class */
table.confluenceTable td.confluenceTd
{
    border-width: 1px;
    border-style: solid;
    border-color: #ccc;
    padding: 3px 4px 3px 4px;
}

/* Added as a temporary fix for CONF-4223. The table elements appear to be inheriting the border: none attribute from the sectionMacro class */
table.confluenceTable th.confluenceTh
{
    border-width: 1px;
    border-style: solid;
    border-color: #ccc;
    padding: 3px 4px 3px 4px;
    background-color: #f0f0f0;
    text-align: center;
}

td.confluenceTd
{
    border-width: 1px;
    border-style: solid;
    border-color: #ccc;
    padding: 3px 4px 3px 4px;
}

th.confluenceTh
{
    border-width: 1px;
    border-style: solid;
    border-color: #ccc;
    padding: 3px 4px 3px 4px;
    background-color: #f0f0f0;
    text-align: center;
}

DIV.small {
	font-size: 9px;
}

H1.pagename {
	margin-top: 0px;
}

IMG.inline  {}

.loginform {
    margin: 5px;
    border: 1px solid #ccc;
}

/* The text how the "This is a preview" comment should be shown. */
.previewnote { text-align: center;
                font-size: 11px;
                    color: red; }

/* How the preview content should be shown */
.previewcontent { background: #E0E0E0; }

/* How the system messages should be shown (DisplayMessage.jsp) */
.messagecontent { background: #E0E0E0; }

/* How the "This page has been modified..." -comment should be shown. */
.conflictnote { }

.createlink {
    color: maroon;
}
a.createlink {
    color: maroon;
}
.templateparameter {
    font-size: 9px;
    color: darkblue;
}

.diffadded {
    background: #ddffdd;
    padding: 1px 1px 1px 4px;
	border-left: 4px solid darkgreen;
}
.diffdeleted {
    color: #999;
    background: #ffdddd;
    padding: 1px 1px 1px 4px;
	border-left: 4px solid darkred;
}
.diffnochange {
    padding: 1px 1px 1px 4px;
	border-left: 4px solid lightgrey;
}
.differror {
    background: brown;
}
.diff {
    font-family: lucida console, courier new, fixed-width;
	font-size: 12px;
	line-height: 14px;
}
.diffaddedchars {
    background-color:#99ff99;
    font-weight:bolder;
}
.diffremovedchars {
    background-color:#ff9999;
    text-decoration: line-through;
    font-weight:bolder;
}

.greybackground {
    background: #f0f0f0
}

.greybox {
 	border: 1px solid #ddd;
	padding: 3px;
	margin: 1px 1px 10px 1px;
}

.borderedGreyBox {
    border: 1px solid #cccccc;
    background-color: #f0f0f0;
    padding: 10px;
}

.greyboxfilled {
 	border: 1px solid #ddd;
    background: #f0f0f0;
    padding: 3px;
	margin: 1px 1px 10px 1px;
}

.navBackgroundBox {
    padding: 5px 5px 5px 5px;
    font-size: 22px;
	font-weight: bold;
	font-family: Arial, sans-serif;
	color: white;
    background: #3c78b5;
    text-decoration: none;
}

.previewBoxTop {
	background-color: #f0f0f0;
    border-width: 1px 1px 0px 1px;
    border-style: solid;
    border-color: #3c78b5;
    padding: 5px;
    margin: 5px 0px 0px 0px;
    text-align: center;
}
.previewContent {
    background-color: #fff;
 	border-color: #3c78b5;
	border-width: 0px 1px 0px 1px;
	border-style: solid;
	padding: 10px;
	margin: 0px;
}
.previewBoxBottom {
	background-color: #f0f0f0;
    border-width: 0px 1px 1px 1px;
    border-style: solid;
    border-color: #3c78b5;
    padding: 5px;
    margin: 0px 0px 5px 0px;
    text-align: center;
}

.functionbox {
    background-color: #f0f0f0;
 	border: 1px solid #3c78b5;
	padding: 3px;
	margin: 1px 1px 10px 1px;
}

.functionbox-greyborder {
    background-color: #f0f0f0;
 	border: 1px solid #ddd;
	padding: 3px;
	margin: 1px 1px 10px 1px;
}

.search-highlight {
    background-color: #ffffcc;
}

/* normal (white) background */
.rowNormal {
    background-color: #ffffff;
 }

/* alternate (pale yellow) background */
.rowAlternate {
    background-color: #f7f7f7;
}

/* used in the list attachments table */
.rowAlternateNoBottomColor {
    background-color: #f7f7f7;
}

.rowAlternateNoBottomNoColor {
}

.rowAlternateNoBottomColor td {
    border-bottom: 0px;
}

.rowAlternateNoBottomNoColor td {
    border-bottom: 0px;
}

/* row highlight (grey) background */
.rowHighlight {
    background-color: #f0f0f0;

}

TD.greenbar {FONT-SIZE: 2px; BACKGROUND: #00df00; BORDER: 1px solid #9c9c9c; PADDING: 0px; }
TD.redbar {FONT-SIZE: 2px; BACKGROUND: #df0000; BORDER: 1px solid #9c9c9c; PADDING: 0px; }
TD.darkredbar {FONT-SIZE: 2px; BACKGROUND: #af0000; BORDER: 1px solid #9c9c9c; PADDING: 0px; }

TR.testpassed {FONT-SIZE: 2px; BACKGROUND: #ddffdd; PADDING: 0px; }
TR.testfailed {FONT-SIZE: 2px; BACKGROUND: #ffdddd; PADDING: 0px; }

.toolbar  {
    margin: 0px;
    border-collapse: collapse;
}

.toolbar td  {
    border: 1px solid #ccc;
    padding: 2px 2px 2px 2px;
    color: #ccc;
}

td.noformatting {
    border-width: 0px;
    border-style: none;
    text-align: center;
	padding: 0px;
}

.commentblock {
    margin: 12px 0 12px 0;
}

/*
 * Divs displaying the license information, if necessary.
 */
.license-eval, .license-none, .license-nonprofit {
    border-top: 1px solid #bbbbbb;
    text-align: center;
    font-size: 10px;
    font-family: Verdana, Arial, Helvetica, sans-serif;
}

.license-eval, .license-none {
    background-color: #ffcccc;
}

.license-eval b, .license-none b {
    color: #990000
}

.license-nonprofit {
    background-color: #ffffff;
}

/*
 * The shadow at the bottom of the page between the main content and the
 * "powered by" section.
 */
.bottomshadow {
    height: 12px;
    background-image: url("$req.contextPath/images/border/border_bottom.gif");
    background-repeat: repeat-x;
}

/*
 * Styling of the operations box
 */
.navmenu .operations li, .navmenu .operations ul {
    list-style: none;
    margin-left: 0;
    padding-left: 0;
}

.navmenu .operations ul {
    margin-bottom: 9px;
}

.navmenu .label {
    font-weight: inherit;
}

/*
 * Styling of ops as a toolbar
 */
.toolbar div {
    display: none;
}

.toolbar .label {
    display: none;
}

.toolbar .operations {
    display: block;
}

.toolbar .operations ul {
    display: inline;
    list-style: none;
    margin-left: 10px;
    padding-left: 0;
}

.toolbar .operations li {
    list-style: none;
    display: inline;
}

/* list page navigational tabs */
#foldertab {
padding: 3px 0px 3px 8px;
margin-left: 0;
border-bottom: 1px solid #3c78b5;
font: bold 11px Verdana, sans-serif;
}

#foldertab li {
list-style: none;
margin: 0;
display: inline;
}

#foldertab li a {
padding: 3px 0.5em;
margin-left: 3px;
border: 1px solid #3c78b5;
border-bottom: none;
background: #3c78b5;
text-decoration: none;
}

#foldertab li a:link { color: #ffffff; }
#foldertab li a:visited { color: #ffffff; }

#foldertab li a:hover {
color: #ffffff;
background: #003366;
border-color: #003366;
}

#foldertab li a.current {
background: white;
border-bottom: 1px solid white;
color: black;
}

#foldertab li a.current:link { color: black; }
#foldertab li a.current:visited { color: black; }
#foldertab li a.current:hover {
background: white;
border-bottom: 1px solid white;
color: black;
}

/* alphabet list */
ul#squaretab {
margin-left: 0;
padding-left: 0;
white-space: nowrap;
font: bold 8px Verdana, sans-serif;
}

#squaretab li {
display: inline;
list-style-type: none;
}

#squaretab a {
padding: 2px 6px;
border: 1px solid #3c78b5;
}

#squaretab a:link, #squaretab a:visited {
color: #fff;
background-color: #3c78b5;
text-decoration: none;
}

#squaretab a:hover {
color: #ffffff;
background-color: #003366;
border-color: #003366;
text-decoration: none;
}

#squaretab li a#current {
background: white;
color: black;
}

.blogcalendar * {
    font-family:verdana, arial, sans-serif;
    font-size:x-small;
    font-weight:normal;
    line-height:140%;
    padding:2px;
}


table.blogcalendar {
    border: 1px solid #3c78b5;
}

.blogcalendar th.calendarhead, a.calendarhead {
    font-size:x-small;
    font-weight:bold;
    padding:2px;
    text-transform:uppercase;
    background-color: #3c78b5;
    color: #ffffff;
    letter-spacing: .3em;
    text-transform: uppercase;
}

.calendarhead:visited {color: white;}
.calendarhead:active {color: white;}
.calendarhead:hover {color: white;}

.blogcalendar th {
    font-size:x-small;
    font-weight:bold;
    padding:2px;
    background-color:#f0f0f0;
}

.blogcalendar td {
    font-size:x-small;
    font-weight:normal;
}

.searchGroup { padding: 0 0 10px 0; background: #f0f0f0; }
.searchGroupHeading { font-size: 10px; font-weight: bold; color: #ffffff; background-color: #3c78b5; padding: 2px 4px 1px 4px; }
.searchItem { padding: 1px 4px 1px 4px; }
.searchItemSelected { padding: 1px 4px 1px 4px; font-weight: bold; background: #ddd; }

/* permissions page styles */
.permissionHeading {
    border-bottom: #bbb; border-width: 0 0 1px 0; border-style: solid; font-size: 16px; text-align: left;
}
.permissionTab {
    border-width: 0 0 0 1px; border-style: solid; background: #3c78b5; color: #ffffff; font-size: 10px;
}
.permissionSuperTab {
    border-width: 0 0 0 1px; border-style: solid; background: #003366; color: #ffffff;
}
.permissionCell {
    border-left: #bbb; border-width: 0 0 0 1px; border-style: solid;
}

/* warning panel */
.warningPanel { background: #FFFFCE; border:#F0C000 1px solid; padding: 8px; margin: 10px; }
/* alert panel */
.alertPanel { background: #FFCCCC; border:#C00 1px solid; padding: 8px; margin: 10px; }
/* info panel */
.infoPanel { background: #D8E4F1; border:#3c78b5 1px solid; padding: 8px; margin: 10px; }

/* side menu highlighting (e.g. space content screen) */
.optionPadded { padding: 2px; }
.optionSelected { background-color: #ffffcc; padding: 2px; border: 1px solid #ddd; margin: -1px; }
.optionSelected a { font-weight: bold; text-decoration: none; color: black; }

/* information macros */
.noteMacro { border-style: solid; border-width: 1px; border-color: #F0C000; background-color: #FFFFCE; text-align:left; margin-top: 5px; margin-bottom: 5px}
.warningMacro { border-style: solid; border-width: 1px; border-color: #c00; background-color: #fcc; text-align:left; margin-top: 5px; margin-bottom: 5px}
.infoMacro { border-style: solid; border-width: 1px; border-color: #3c78b5; background-color: #D8E4F1; text-align:left; margin-top: 5px; margin-bottom: 5px}
.tipMacro { border-style: solid; border-width: 1px; border-color: #090; background-color: #dfd; text-align:left; margin-top: 5px; margin-bottom: 5px}
.informationMacroPadding { padding: 5px 0 0 5px; }

table.infoMacro td, table.warningMacro td, table.tipMacro td, table.noteMacro td, table.sectionMacro td {
    border: none;
}

table.sectionMacroWithBorder td.columnMacro { border-style: dashed; border-width: 1px; border-color: #cccccc;}

.pagecontent
{
    padding: 10px;
    text-align: left;
}

/* styles for links in the top bar */
.topBarDiv a:link {color: #ffffff;}
.topBarDiv a:visited {color: #ffffff;}
.topBarDiv a:active {color: #ffffff;}
.topBarDiv a:hover {color: #ffffff;}
.topBarDiv {color: #ffffff;}

.topBar {
    background-color: #003366;
}


/* styles for extended operations */
.greyLinks a:link {color: #666666; text-decoration:underline;}
.greyLinks a:visited {color: #666666; text-decoration:underline;}
.greyLinks a:active {color: #666666; text-decoration:underline;}
.greyLinks a:hover {color: #666666; text-decoration:underline;}
.greyLinks {color: #666666; display:block; padding: 10px}

.logoSpaceLink {color: #999999; text-decoration: none}
.logoSpaceLink a:link {color: #999999; text-decoration: none}
.logoSpaceLink a:visited {color: #999999; text-decoration: none}
.logoSpaceLink a:active {color: #999999; text-decoration: none}
.logoSpaceLink a:hover {color: #003366; text-decoration: none}

/* basic panel (basicpanel.vmd) style */
.basicPanelContainer {border: 1px solid #3c78b5; margin-top: 2px; margin-bottom: 8px; width: 100%}
.basicPanelTitle {padding: 5px; margin: 0px; background-color: #f0f0f0; color: black; font-weight: bold;}
.basicPanelBody {padding: 5px; margin: 0px}

.separatorLinks a:link {color: white}
.separatorLinks a:visited {color: white}
.separatorLinks a:active {color: white}

.greynavbar {background-color: #f0f0f0; border-top: 1px solid #3c78b5; margin-top: 2px}

div.headerField {
    float: left;
    width: auto;
    height: 100%;
}

.headerFloat {
    margin-left: auto;
    width: 50%;
}

.headerFloatLeft {
    float: left;
    margin-right: 20px;
    margin-bottom: 10px;
}

#headerRow {
    padding: 10px;
}

div.license-personal {
   background-color: #003366;
   color: #ffffff;
}

div.license-personal a {
   color: #ffffff;
}

.greyFormBox {
    border: 1px solid #cccccc;
    padding: 5px;
}

/* IE automatically adds a margin before and after form tags. Use this style to remove that */
.marginlessForm {
    margin: 0px;
}

.openPageHighlight {
    background-color: #ffffcc;
    padding: 2px;
    border: 1px solid #ddd;
}

.editPageInsertLinks, .editPageInsertLinks a
{
    color: #666666;
    font-weight: bold;
    font-size: 10px;
}

/* Style for label heatmap. */
.top10 a {
    font-weight: bold;
    font-size: 2em;
    color: #003366;
}
.top25 a {
    font-weight: bold;
    font-size: 1.6em;
    color: #003366;
}
.top50 a {
    font-size: 1.4em;
    color: #003366;
}
.top100 a {
    font-size: 1.2em;
    color: #003366;
}

.heatmap {
    list-style:none;
    width: 95%;
    margin: 0px auto;
}

.heatmap a {
    text-decoration:none;
}

.heatmap a:hover {
    text-decoration:underline;
}

.heatmap li {
    display: inline;
}

.minitab {
padding: 3px 0px 3px 8px;
margin-left: 0;
margin-top: 1px;
margin-bottom: 0px;
border-bottom: 1px solid #3c78b5;
font: bold 9px Verdana, sans-serif;
text-decoration: none;
float:none;
}
.selectedminitab {
padding: 3px 0.5em;
margin-left: 3px;
margin-top: 1px;
border: 1px solid #3c78b5;
background: white;
border-bottom: 1px solid white;
color: #000000;
text-decoration: none;
}
.unselectedminitab {
padding: 3px 0.5em;
margin-left: 3px;
margin-top: 1px;
border: 1px solid #3c78b5;
border-bottom: none;
background: #3c78b5;
color: #ffffff;
text-decoration: none;
}

a.unselectedminitab:hover {
color: #ffffff;
background: #003366;
border-color: #003366;
}

a.unselectedminitab:link { color: white; }
a.unselectedminitab:visited { color: white; }

a.selectedminitab:link { color: black; }
a.selectedminitab:visited { color: black; }

.linkerror { background-color: #fcc;}

a.labelOperationLink:link {text-decoration: underline}
a.labelOperationLink:active {text-decoration: underline}
a.labelOperationLink:visited {text-decoration: underline}
a.labelOperationLink:hover {text-decoration: underline}

a.newLabel:link {background-color: #ddffdd}
a.newLabel:active {background-color: #ddffdd}
a.newLabel:visited {background-color: #ddffdd}
a.newLabel:hover {background-color: #ddffdd}

ul.square {list-style-type: square}

.inline-control-link {
    background: #ffc;
    font-size: 9px;
    color: #666;
    padding: 2px;
    text-transform: uppercase;
    text-decoration: none;
}


.inline-control-link a:link {text-decoration: none}
.inline-control-link a:active {text-decoration: none}
.inline-control-link a:visited {text-decoration: none}
.inline-control-link a:hover {text-decoration: none}

.inline-control-link {
    background: #ffc;
    font-size: 9px;
    color: #666;
    padding: 2px;
    text-transform: uppercase;
    text-decoration: none;
    cursor: pointer;
}

div.auto_complete {
    width: 350px;
    background: #fff;
}
div.auto_complete ul {
    border: 1px solid #888;
    margin: 0;
    padding: 0;
    width: 100%;
    list-style-type: none;
}
div.auto_complete ul li {
    margin: 0;
    padding: 3px;
}
div.auto_complete ul li.selected {
    background-color: #ffb;
}
div.auto_complete ul strong.highlight {
    color: #800;
    margin: 0;
    padding: 0;
}

/******* Edit Page Styles *******/
.toogleFormDiv{
    border:1px solid #A7A6AA;
    background-color:white;
    padding:5px;
    margin-top: 5px;
}

.toogleInfoDiv{
    border:1px solid #A7A6AA;
    background-color:white;
    display:none;
    padding:5px;
    margin-top: 10px;
}

.inputSection{
    margin-bottom:20px;
}

#editBox{
   border:1px solid lightgray;
   background-color:#F0F0F0;
}

/******* Left Navigation Theme Styles ********/
.leftnav li a {
    text-decoration:none;
    color:white;
    margin:0px;
    display:block;
    padding:2px;
    padding-left:5px;
    background-color: #3c78b5;
    border-top:1px solid #3c78b5;
}

.leftnav li a:active {color:white;}
.leftnav li a:visited {color:white;}
.leftnav li a:hover {background-color: #003366; color:white;}

/* Added by Shaun during i18n */
.replaced
{
    background-color: #33CC66;
}

.topPadding
{
    margin-top: 20px;
}

/* new form style */
.form-block {
    padding: 6px;
}
.form-error-block {
    padding: 6px;
    background: #fcc;
    border-top: #f0f0f0 1px solid;
    border-bottom: #f0f0f0 1px solid;
    margin-bottom: 6px;
    padding: 0 12px 0 12px;
}
.form-element-large {
    font-size: 16px;
    font-weight: bold;
    font-family: Arial, sans-serif;
    color: #003366;
}

.form-element-small {
    font-size: 12px;
    font-weight: bold;
    font-family: Arial, sans-serif;
    color: #003366;
}

.form-header {
    background: lightyellow;
    border-top: #f0f0f0 1px solid;
    border-bottom: #f0f0f0 1px solid;
    margin-bottom: 6px;
    padding: 0 12px 0 12px;
}
.form-header p, .form-block p, .form-error-block p {
    line-height: normal;
    margin: 12px 0 12px 0;
}
.form-example {
    color: #888;
    font-size: 11px;
}
.form-divider {
    border-bottom: #ccc 1px solid;
    margin-bottom: 6px;
}
.form-buttons {
    margin-top: 6px;
    border-top: #ccc 1px solid;
    border-bottom: #ccc 1px solid;
    background: #f0f0f0;
    padding: 10px;
    text-align: center;
}
.form-buttons input {
    width: 100px;
}
.form-block .error {
    padding: 6px;
    margin-bottom: 6px;
}
    -->
    </style>
</head>
<body>

<div id="PageContent">
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%"><tr>
<td valign="top" class="pagebody">

    <div class="pageheader">
        <span class="pagetitle">
            Page Edited :
            <a href="http://cwiki.apache.org/confluence/display/GMOxDOC22">GMOxDOC22</a> :
            <a href="http://cwiki.apache.org/confluence/display/GMOxDOC22/Deployment+plans">Deployment plans</a>
        </span>
    </div>

     <p>
        <a href="http://cwiki.apache.org/confluence/display/GMOxDOC22/Deployment+plans">Deployment plans</a>
        has been edited by             <a href="http://cwiki.apache.org/confluence/display/~dblevins">David Blevins</a>
            <span class="smallfont">(Aug 11, 2008)</span>.
     </p>
    
     <p>
                 <a href="http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=93398&originalVersion=89&revisedVersion=90">(View changes)</a>
     </p>

    <span class="label">Content:</span><br/>
    <div class="greybox wiki-content"><style type='text/css'>/*<![CDATA[*/
table.ScrollbarTable  {border: none;padding: 3px;width: 100%;padding: 3px;margin: 0px;background-color: #f0f0f0}
table.ScrollbarTable td.ScrollbarPrevIcon {text-align: center;width: 16px;border: none;}
table.ScrollbarTable td.ScrollbarPrevName {text-align: left;border: none;}
table.ScrollbarTable td.ScrollbarParent {text-align: center;border: none;}
table.ScrollbarTable td.ScrollbarNextName {text-align: right;border: none;}
table.ScrollbarTable td.ScrollbarNextIcon {text-align: center;width: 16px;border: none;}

/*]]>*/</style><div class="Scrollbar"><table class='ScrollbarTable'><tr><td width='33%' class='ScrollbarPrevName'>&nbsp;</td><td width='33%' class='ScrollbarParent'><sup><a href="/confluence/display/GMOxDOC22/Deployment"><img border='0' align='middle' src='/confluence/images/icons/up_16.gif' width='8' height='8'></a></sup><a href="/confluence/display/GMOxDOC22/Deployment">Deployment</a></td><td width='33%' class='ScrollbarNextName'>&nbsp;<a href="/confluence/display/GMOxDOC22/persistence.xml">persistence.xml</a></td><td class='ScrollbarNextIcon'><a href="/confluence/display/GMOxDOC22/persistence.xml"><img border='0' align='middle' src='/confluence/images/icons/forwd_16.gif' width='16' height='16'></a></td></tr></table></div>
<p>Every module that you install in Geronimo, whether it is a service, application, resource, etc., can be configured via a deployment plan. These deployment plans are XML files based on XML Schemas containing the configuration details for a specific application module or component. The Java EE 5 specification defines standard deployment descriptors such as web.xml, application.xml, etc. In some cases, the deployment descriptor is all that is required to install a module into a Geronimo server. However, in many cases, server-specific configuration is required when modules are installed. This server-specific configuration is accomplished by using Geronimo deployment plans.</p>

<p>Geronimo deployment plans can be packaged along with the application or specified externally at deployment time. If provided during deployment, this plan will overwrite any other Geronimo specific deployment plan provided with the application.</p>

<p>To package the deployment plans in you application you have to follow some naming conventions and place the file in a specific directory within your packaged application. For example, in a web application you would include the <b><tt>geronimo-web.xml</tt></b> under the <b>/WEB-INF</b> directory, same place where you are also providing the  <tt>web.xml</tt> descriptor, all within the WAR. For an enterprise application you would include the   <b><tt>geronimo-application.xml</tt></b> under the <b>/META-INF</b> directory, same place where you are also providing the <tt>application.xml</tt> descriptor, all within the WAR.</p>

<p>The Java EE 5 specification also let's you use Annotations where you add resource references, dependencies, etc. directly in the code. Geronimo provides a <a href="/confluence/display/GMOxDOC22/Plan+Creator" title="Plan Creator">Plan Creator</a> that automatically generates the necessary deployment plans based on the standard deployment descriptors and annotations.</p>

<p>This document is organized in the following sections:</p>
<div>
<ul>
  <li><a href='#Deploymentplans-XMLSchemas'>XML Schemas </a>
<ul>
  <li><a href='#Deploymentplans-JavaEEDeploymentPlans'>Java EE Deployment Plans</a></li>
  <li><a href='#Deploymentplans-CommonElements%26Configuration'>Common Elements &amp; Configuration</a></li>
</ul></li>
  <li><a href='#Deploymentplans-Configurations'>Configurations</a>
<ul>
  <li><a href='#Deploymentplans-Connectionpools'>Connection pools</a>
<ul>
  <li><a href='#Deploymentplans-EmbeddedDerbyDatabaseconnectionpool'>Embedded Derby Database connection pool</a></li>
  <li><a href='#Deploymentplans-EmbeddedActiveMQresourceadapter'>Embedded ActiveMQ resource adapter</a></li>
</ul></li>
  <li><a href='#Deploymentplans-Security'>Security</a>
<ul>
  <li><a href='#Deploymentplans-geronimoadminsecurityrealm'>geronimo-admin security realm</a></li>
</ul></li>
</ul></li>
  <li><a href='#Deploymentplans-Applications'>Applications</a>
<ul>
  <li><a href='#Deploymentplans-WebApplicationdeploymentplan'>Web Application deployment plan</a></li>
  <li><a href='#Deploymentplans-EJBApplicationdeploymentplan'>EJB Application deployment plan</a></li>
  <li><a href='#Deploymentplans-Enterpriseapplicationdeploymentplan'>Enterprise application deployment plan</a></li>
  <li><a href='#Deploymentplans-JEEApplicationClientdeploymentplan'>JEE Application Client deployment plan</a></li>
  <li><a href='#Deploymentplans-MessageDrivenBeandeploymentplan.'>Message Driven Bean deployment plan.</a></li>
</ul></li>
</ul></div>

<h1><a name="Deploymentplans-XMLSchemas"></a>XML Schemas </h1>

<h2><a name="Deploymentplans-JavaEEDeploymentPlans"></a>Java EE Deployment Plans</h2>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Module Type </th>
<th class='confluenceTh'> Geronimo Schema </th>
<th class='confluenceTh'> Preferred Java EE Schema </th>
</tr>
<tr>
<td class='confluenceTd'> General (Tomcat or Jetty) Web Application (WAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-web-2.0.1.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" title="Visit page outside Confluence" rel="nofollow">web-app_2_5.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
<tr>
<td class='confluenceTd'> Tomcat-Only Web Application (WAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-tomcat-2.0.1.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/web/tomcat-2.0.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" title="Visit page outside Confluence" rel="nofollow">web-app_2_5.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
<tr>
<td class='confluenceTd'> Jetty-Only Web Application (WAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-jetty-2.0.2.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/web/jetty-2.0.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" title="Visit page outside Confluence" rel="nofollow">web-app_2_5.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
<tr>
<td class='confluenceTd'> EJB (JAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://openejb.apache.org/xml/ns/openejb-jar-2.2.xsd" title="Visit page outside Confluence" rel="nofollow">http://openejb.apache.org/xml/ns/openejb-jar-2.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd" title="Visit page outside Confluence" rel="nofollow">ejb-jar_3_0.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
<tr>
<td class='confluenceTd'> J2EE Connector (RAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-connector-1.2.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/connector-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/j2ee/connector_1_5.xsd" title="Visit page outside Confluence" rel="nofollow">connector_1_5.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
<tr>
<td class='confluenceTd'> Application Client (JAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-application-client-2.0.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/application-client-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/application-client_5.xsd" title="Visit page outside Confluence" rel="nofollow">application-client_5.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
<tr>
<td class='confluenceTd'> Application (EAR) </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-application-2.0.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/application-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/application_5.xsd" title="Visit page outside Confluence" rel="nofollow">application_5.xsd<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
</tr>
</tbody></table>

<h2><a name="Deploymentplans-CommonElements%26Configuration"></a>Common Elements &amp; Configuration</h2>

<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> Module Type </th>
<th class='confluenceTh'> Geronimo Schema </th>
<th class='confluenceTh'> Description </th>
</tr>
<tr>
<td class='confluenceTd'> Server Plans &amp; Common Elements </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-module-1.2.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/deployment-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Used to deploy new services in Geronimo in a standalone plan, and also contains common elements used by many other plans. </td>
</tr>
<tr>
<td class='confluenceTd'> Geronimo Plugin Descriptor </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/plugins-1.3.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/plugins-1.3<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Metadata on a Geronimo plugin or a list of available Geronimo plugins. </td>
</tr>
<tr>
<td class='confluenceTd'> Security Mapping </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-security-2.0.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/security-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Common security elements used by other plans. </td>
</tr>
<tr>
<td class='confluenceTd'> Security Realms </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-login-config-2.0.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/loginconfig-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Abbreviated syntax for configuring security realm and login module GBeans. You can either manually configure multiple GBeans or declare a single GBean for the realm using this to configure all the login modules. </td>
</tr>
<tr>
<td class='confluenceTd'> Naming </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-naming-1.2.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/naming-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Common elements for references to other components (EJBs, database pools, JMS resources, J2EE Connectors, Web Services, etc.) </td>
</tr>
<tr>
<td class='confluenceTd'> Primary Key Generator </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://openejb.apache.org/xml/ns/pkgen-2.1.xsd" title="Visit page outside Confluence" rel="nofollow">http://openejb.apache.org/xml/ns/pkgen-2.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Abbreviated syntax for configuring primary key generators for CMP entity beans. Avoids manually configuring and wiring up PK generator GBeans. </td>
</tr>
<tr>
<td class='confluenceTd'> CORBA CSS Configuration </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/corba-css-config-2.1.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://openejb.apache.org/xml/ns/corba-css-config-2.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Abbreviated syntax for configuring security for clients accessing remote EJBs via CORBA. </td>
</tr>
<tr>
<td class='confluenceTd'> CORBA TSS Configuration </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/corba-tss-config-2.1.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://openejb.apache.org/xml/ns/corba-tss-config-2.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> Abbreviated syntax for configuring security for EJBs exposed via CORBA. </td>
</tr>
<tr>
<td class='confluenceTd'> config.xml </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/attributes-1.2.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/attributes-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> The format of the <tt>var/config/config.xml</tt> file. </td>
</tr>
<tr>
<td class='confluenceTd'> Tomcat Web App Configuration </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-tomcat-config-1.0.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/web/tomcat/config-1.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> If you use the generic (<tt>geronimo-web-2.0.xsd</tt>) web application configuration, you can use these elements in the container-config element to configure Tomcat-specific behavior. </td>
</tr>
<tr>
<td class='confluenceTd'> Jetty Web App Configuration </td>
<td class='confluenceTd'> <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-jetty-config-1.0.1.xsd.html" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/web/jetty/config-1.0.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> </td>
<td class='confluenceTd'> If you use the generic (<tt>geronimo-web-2.0.xsd</tt>) web application configuration, you can use these elements in the container-config element to configure Jetty-specific behavior. </td>
</tr>
</tbody></table>

<h1><a name="Deploymentplans-Configurations"></a>Configurations</h1>

<p>In this section, we will discuss about the configurations that are already deployed and running in the server when the server is installed and started. </p>

<h2><a name="Deploymentplans-Connectionpools"></a>Connection pools</h2>

<p>Apache geronimo ships with embedded derby database and activemq message broker. There are also connection pools that connect to derby and activemq configured to run in the installed server. The following sections discuss about various such configurations already running in the installed server.</p>

<h3><a name="Deploymentplans-EmbeddedDerbyDatabaseconnectionpool"></a>Embedded Derby Database connection pool</h3>

<p>Apache Geronimo ships with embedded derby database. The derby libraries are present in the server repository at <tt>&lt;geronimo_home&gt;/repository/org/apache/derby</tt>. By default, a derby database by name <tt>SystemDatabase</tt> is created and the files related to the database are stored at <tt>&lt;geronimo_home&gt;/var/derby/SystemDatabase</tt>. Along with that, by default, server deploys a database connection pool over the <tt>SystemDatabase</tt> with the configuration name <tt>org.apache.geronimo.configs/system-database/2.1/car</tt>. The name of the database connection pool is <tt>SystemDatasource</tt>. The configuration artifacts are stored at <tt>&lt;geronimo_home&gt;/repository/org/apache/geronimo/configs/system-database</tt>. The deployment plan used for database connection pool is as follows. </p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>SystemDatasource</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
<span class="code-tag">&lt;connector xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"</span>&gt;</span>
  <span class="code-tag">&lt;dep:environment <span class="code-keyword">xmlns:dep</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;</span>
    <span class="code-tag">&lt;dep:moduleId&gt;</span>
      <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.geronimo.configs<span class="code-tag">&lt;/dep:groupId&gt;</span>
      <span class="code-tag">&lt;dep:artifactId&gt;</span>system-database<span class="code-tag">&lt;/dep:artifactId&gt;</span>
      <span class="code-tag">&lt;dep:version&gt;</span>2.1<span class="code-tag">&lt;/dep:version&gt;</span>
      <span class="code-tag">&lt;dep:type&gt;</span>car<span class="code-tag">&lt;/dep:type&gt;</span>
    <span class="code-tag">&lt;/dep:moduleId&gt;</span>
    <span class="code-tag">&lt;dep:dependencies&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.geronimo.configs<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>transaction<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>2.1<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>car<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.geronimo.modules<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>geronimo-derby<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>2.1<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>jar<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.geronimo.modules<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>geronimo-timer<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>2.1<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>jar<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.derby<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>derby<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>10.2.2.0<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>jar<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.derby<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>derbynet<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>10.2.2.0<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>jar<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.derby<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>derbyclient<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>10.2.2.0<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>jar<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.tranql<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>tranql-connector-derby-embed-xa
        <span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>1.3<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>rar<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
    <span class="code-tag">&lt;/dep:dependencies&gt;</span>
    <span class="code-tag">&lt;dep:hidden-classes/&gt;</span>
    <span class="code-tag">&lt;dep:non-overridable-classes/&gt;</span>
  <span class="code-tag">&lt;/dep:environment&gt;</span>
  <span class="code-tag">&lt;resourceadapter&gt;</span>
    <span class="code-tag">&lt;outbound-resourceadapter&gt;</span>
      <span class="code-tag">&lt;connection-definition&gt;</span>
        <span class="code-tag">&lt;connectionfactory-interface&gt;</span>javax.sql.DataSource
        <span class="code-tag">&lt;/connectionfactory-interface&gt;</span>
        <span class="code-tag">&lt;connectiondefinition-instance&gt;</span>
          <span class="code-tag">&lt;name&gt;</span>SystemDatasource<span class="code-tag">&lt;/name&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"UserName"</span>/&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"Password"</span>/&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"DatabaseName"</span>&gt;</span>
             SystemDatabase
          <span class="code-tag">&lt;/config-property-setting&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"CreateDatabase"</span>&gt;</span>
             true
          <span class="code-tag">&lt;/config-property-setting&gt;</span>
          <span class="code-tag">&lt;connectionmanager&gt;</span>
            <span class="code-tag">&lt;xa-transaction&gt;</span>
              <span class="code-tag">&lt;transaction-caching/&gt;</span>
            <span class="code-tag">&lt;/xa-transaction&gt;</span>
            <span class="code-tag">&lt;single-pool&gt;</span>
              <span class="code-tag">&lt;max-size&gt;</span>100<span class="code-tag">&lt;/max-size&gt;</span>
              <span class="code-tag">&lt;blocking-timeout-milliseconds&gt;</span>
                 5000
              <span class="code-tag">&lt;/blocking-timeout-milliseconds&gt;</span>
              <span class="code-tag">&lt;select-one-assume-match/&gt;</span>
            <span class="code-tag">&lt;/single-pool&gt;</span>
          <span class="code-tag">&lt;/connectionmanager&gt;</span>
        <span class="code-tag">&lt;/connectiondefinition-instance&gt;</span>
        <span class="code-tag">&lt;connectiondefinition-instance&gt;</span>
          <span class="code-tag">&lt;name&gt;</span>NoTxDatasource<span class="code-tag">&lt;/name&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"UserName"</span>/&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"Password"</span>/&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"DatabaseName"</span>&gt;</span>
             SystemDatabase
          <span class="code-tag">&lt;/config-property-setting&gt;</span>
          <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"CreateDatabase"</span>&gt;</span>
             true
          <span class="code-tag">&lt;/config-property-setting&gt;</span>
          <span class="code-tag">&lt;connectionmanager&gt;</span>
            <span class="code-tag">&lt;no-transaction/&gt;</span>
            <span class="code-tag">&lt;single-pool&gt;</span>
              <span class="code-tag">&lt;max-size&gt;</span>100<span class="code-tag">&lt;/max-size&gt;</span>
              <span class="code-tag">&lt;blocking-timeout-milliseconds&gt;</span>5000
              <span class="code-tag">&lt;/blocking-timeout-milliseconds&gt;</span>
              <span class="code-tag">&lt;select-one-assume-match/&gt;</span>
            <span class="code-tag">&lt;/single-pool&gt;</span>
          <span class="code-tag">&lt;/connectionmanager&gt;</span>
        <span class="code-tag">&lt;/connectiondefinition-instance&gt;</span>
      <span class="code-tag">&lt;/connection-definition&gt;</span>
    <span class="code-tag">&lt;/outbound-resourceadapter&gt;</span>
  <span class="code-tag">&lt;/resourceadapter&gt;</span>
  &lt;gbean name=<span class="code-quote">"DerbySystem"</span> 
         class=<span class="code-quote">"org.apache.geronimo.derby.DerbySystemGBean"</span>&gt;
    <span class="code-tag">&lt;reference name=<span class="code-quote">"ServerInfo"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>ServerInfo<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;attribute name=<span class="code-quote">"derbySystemHome"</span>&gt;</span>var/derby<span class="code-tag">&lt;/attribute&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
  &lt;gbean name=<span class="code-quote">"DerbyNetwork"</span> 
         class=<span class="code-quote">"org.apache.geronimo.derby.DerbyNetworkGBean"</span>&gt;
    <span class="code-tag">&lt;reference name=<span class="code-quote">"derbySystem"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>DerbySystem<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;attribute name=<span class="code-quote">"host"</span>&gt;</span>localhost<span class="code-tag">&lt;/attribute&gt;</span>
    <span class="code-tag">&lt;attribute name=<span class="code-quote">"port"</span>&gt;</span>1527<span class="code-tag">&lt;/attribute&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
  &lt;gbean name=<span class="code-quote">"DerbyLog"</span> 
         class=<span class="code-quote">"org.apache.geronimo.derby.DerbyLogGBean"</span>&gt;
    <span class="code-tag">&lt;reference name=<span class="code-quote">"DerbySystem"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>DerbySystem<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
  &lt;gbean name=<span class="code-quote">"DerbyDriver"</span> 
  class=<span class="code-quote">"org.apache.geronimo.system.util.JDBCDriverRegistrationGBean"</span>&gt;
    <span class="code-tag">&lt;attribute name=<span class="code-quote">"driverClassName"</span>&gt;</span>
       org.apache.derby.jdbc.EmbeddedDriver
    <span class="code-tag">&lt;/attribute&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
  &lt;gbean name=<span class="code-quote">"DerbyClientDriver"</span> 
   class=<span class="code-quote">"org.apache.geronimo.system.util.JDBCDriverRegistrationGBean"</span>&gt;
    <span class="code-tag">&lt;attribute name=<span class="code-quote">"driverClassName"</span>&gt;</span>
      org.apache.derby.jdbc.ClientDriver
    <span class="code-tag">&lt;/attribute&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
  <span class="code-tag">&lt;gbean name=<span class="code-quote">"TransactionalThreadPooledTimer"</span> class=<span class="code-quote">"org.apache.geronimo.timer.jdbc.JDBCStoreThreadPooledTransactionalTimer"</span>&gt;</span>
    <span class="code-tag">&lt;attribute name=<span class="code-quote">"repeatCount"</span>&gt;</span>5<span class="code-tag">&lt;/attribute&gt;</span>
    <span class="code-tag">&lt;reference name=<span class="code-quote">"TransactionManager"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>TransactionManager<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;reference name=<span class="code-quote">"ManagedConnectionFactoryWrapper"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>SystemDatasource<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;reference name=<span class="code-quote">"ThreadPool"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>DefaultThreadPool<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;dependency&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>DerbySystem<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/dependency&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
  <span class="code-tag">&lt;gbean name=<span class="code-quote">"NonTransactionalThreadPooledTimer"</span> class=<span class="code-quote">"org.apache.geronimo.timer.jdbc.JDBCStoreThreadPooledNonTransactionalTimer"</span>&gt;</span>
    <span class="code-tag">&lt;reference name=<span class="code-quote">"TransactionManager"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>TransactionManager<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;reference name=<span class="code-quote">"ManagedConnectionFactoryWrapper"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>SystemDatasource<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;reference name=<span class="code-quote">"ThreadPool"</span>&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>DefaultThreadPool<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/reference&gt;</span>
    <span class="code-tag">&lt;dependency&gt;</span>
      <span class="code-tag">&lt;name&gt;</span>DerbySystem<span class="code-tag">&lt;/name&gt;</span>
    <span class="code-tag">&lt;/dependency&gt;</span>
  <span class="code-tag">&lt;/gbean&gt;</span>
<span class="code-tag">&lt;/connector&gt;</span></pre>
</div></div>


<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/connector-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>

<p>After starting the server, the running database connection pool <tt>SystemDatasource</tt> can be observed on the admin console from <tt>console Navigation =&gt; Services =&gt; Database pools</tt>. The resource adapter used to deploy the above database connection pool is <tt>tranql-connector-derby-embed-xa-1.3.rar</tt>. The above plan is actually deployment plan of a outbound resource adapter. If the above plan is packaged along with the <tt>rar</tt> file, the xml content will be placed in <tt>META-INF/geronimo-ra.xml</tt> of the archive. </p>

<p>Closely observe various configurations in the deployment plan. Many derby libraries in the server repository are mentioned as dependencies. After configuring the outbound resource adapter, there are series of gbeans configured for the database connection pool. </p>

<h3><a name="Deploymentplans-EmbeddedActiveMQresourceadapter"></a>Embedded ActiveMQ resource adapter</h3>

<p>By default, a JMS resource adapter that connects to embedded activemq message broker is deployed and running in the apache geronimo server. This is an outbound jms resource adapter that configures a connection factory and two message queues. The configuration name of the resource adapter is <tt>org.apache.geronimo.configs/activemq-ra/2.1/car</tt>. The artifacts of the resource adapter are stored at <tt>&lt;geronimo_home&gt;/repository/org/apache/geronimo/configs/activemq-ra</tt>. The deployment plan is as follows.</p>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>ActiveMQ RA</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
<span class="code-tag">&lt;connector xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"</span>&gt;</span>
  <span class="code-tag">&lt;dep:environment <span class="code-keyword">xmlns:dep</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;</span>
    <span class="code-tag">&lt;dep:moduleId&gt;</span>
      <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.geronimo.configs<span class="code-tag">&lt;/dep:groupId&gt;</span>
      <span class="code-tag">&lt;dep:artifactId&gt;</span>activemq-ra<span class="code-tag">&lt;/dep:artifactId&gt;</span>
      <span class="code-tag">&lt;dep:version&gt;</span>2.1<span class="code-tag">&lt;/dep:version&gt;</span>
      <span class="code-tag">&lt;dep:type&gt;</span>car<span class="code-tag">&lt;/dep:type&gt;</span>
    <span class="code-tag">&lt;/dep:moduleId&gt;</span>
    <span class="code-tag">&lt;dep:dependencies&gt;</span>
      <span class="code-tag">&lt;dep:dependency&gt;</span>
        <span class="code-tag">&lt;dep:groupId&gt;</span>org.apache.geronimo.configs<span class="code-tag">&lt;/dep:groupId&gt;</span>
        <span class="code-tag">&lt;dep:artifactId&gt;</span>activemq-broker<span class="code-tag">&lt;/dep:artifactId&gt;</span>
        <span class="code-tag">&lt;dep:version&gt;</span>2.1<span class="code-tag">&lt;/dep:version&gt;</span>
        <span class="code-tag">&lt;dep:type&gt;</span>car<span class="code-tag">&lt;/dep:type&gt;</span>
      <span class="code-tag">&lt;/dep:dependency&gt;</span>
    <span class="code-tag">&lt;/dep:dependencies&gt;</span>
    <span class="code-tag">&lt;dep:hidden-classes/&gt;</span>
    <span class="code-tag">&lt;dep:non-overridable-classes/&gt;</span>
  <span class="code-tag">&lt;/dep:environment&gt;</span>
  <span class="code-tag">&lt;resourceadapter&gt;</span>
    <span class="code-tag">&lt;resourceadapter-instance&gt;</span>
      <span class="code-tag">&lt;resourceadapter-name&gt;</span>ActiveMQ RA<span class="code-tag">&lt;/resourceadapter-name&gt;</span>
      <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"ServerUrl"</span>&gt;</span>tcp://0.0.0.0:61616<span class="code-tag">&lt;/config-property-setting&gt;</span>
      <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"UserName"</span>&gt;</span>geronimo<span class="code-tag">&lt;/config-property-setting&gt;</span>
      <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"Password"</span>&gt;</span>geronimo<span class="code-tag">&lt;/config-property-setting&gt;</span>
      <span class="code-tag">&lt;workmanager&gt;</span>
        <span class="code-tag">&lt;gbean-link&gt;</span>DefaultWorkManager<span class="code-tag">&lt;/gbean-link&gt;</span>
      <span class="code-tag">&lt;/workmanager&gt;</span>
    <span class="code-tag">&lt;/resourceadapter-instance&gt;</span>
    <span class="code-tag">&lt;outbound-resourceadapter&gt;</span>
      <span class="code-tag">&lt;connection-definition&gt;</span>
        <span class="code-tag">&lt;connectionfactory-interface&gt;</span>javax.jms.ConnectionFactory<span class="code-tag">&lt;/connectionfactory-interface&gt;</span>
        <span class="code-tag">&lt;connectiondefinition-instance&gt;</span>
          <span class="code-tag">&lt;name&gt;</span>DefaultActiveMQConnectionFactory<span class="code-tag">&lt;/name&gt;</span>
          <span class="code-tag">&lt;implemented-interface&gt;</span>javax.jms.QueueConnectionFactory<span class="code-tag">&lt;/implemented-interface&gt;</span>
          <span class="code-tag">&lt;implemented-interface&gt;</span>javax.jms.TopicConnectionFactory<span class="code-tag">&lt;/implemented-interface&gt;</span>
          <span class="code-tag">&lt;connectionmanager&gt;</span>
            <span class="code-tag">&lt;xa-transaction&gt;</span>
              <span class="code-tag">&lt;transaction-caching/&gt;</span>
            <span class="code-tag">&lt;/xa-transaction&gt;</span>
            <span class="code-tag">&lt;single-pool&gt;</span>
              <span class="code-tag">&lt;max-size&gt;</span>10<span class="code-tag">&lt;/max-size&gt;</span>
              <span class="code-tag">&lt;blocking-timeout-milliseconds&gt;</span>5000<span class="code-tag">&lt;/blocking-timeout-milliseconds&gt;</span>
              <span class="code-tag">&lt;match-one/&gt;</span>
            <span class="code-tag">&lt;/single-pool&gt;</span>
          <span class="code-tag">&lt;/connectionmanager&gt;</span>
        <span class="code-tag">&lt;/connectiondefinition-instance&gt;</span>
      <span class="code-tag">&lt;/connection-definition&gt;</span>
    <span class="code-tag">&lt;/outbound-resourceadapter&gt;</span>
  <span class="code-tag">&lt;/resourceadapter&gt;</span>
  <span class="code-tag">&lt;adminobject&gt;</span>
    <span class="code-tag">&lt;adminobject-interface&gt;</span>javax.jms.Queue<span class="code-tag">&lt;/adminobject-interface&gt;</span>
    <span class="code-tag">&lt;adminobject-class&gt;</span>org.apache.activemq.command.ActiveMQQueue<span class="code-tag">&lt;/adminobject-class&gt;</span>
    <span class="code-tag">&lt;adminobject-instance&gt;</span>
      <span class="code-tag">&lt;message-destination-name&gt;</span>MDBTransferBeanOutQueue<span class="code-tag">&lt;/message-destination-name&gt;</span>
      <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"PhysicalName"</span>&gt;</span>MDBTransferBeanOutQueue<span class="code-tag">&lt;/config-property-setting&gt;</span>
    <span class="code-tag">&lt;/adminobject-instance&gt;</span>
  <span class="code-tag">&lt;/adminobject&gt;</span>
  <span class="code-tag">&lt;adminobject&gt;</span>
    <span class="code-tag">&lt;adminobject-interface&gt;</span>javax.jms.Queue<span class="code-tag">&lt;/adminobject-interface&gt;</span>
    <span class="code-tag">&lt;adminobject-class&gt;</span>org.apache.activemq.command.ActiveMQQueue<span class="code-tag">&lt;/adminobject-class&gt;</span>
    <span class="code-tag">&lt;adminobject-instance&gt;</span>
      <span class="code-tag">&lt;message-destination-name&gt;</span>SendReceiveQueue<span class="code-tag">&lt;/message-destination-name&gt;</span>
      <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"PhysicalName"</span>&gt;</span>SendReceiveQueue<span class="code-tag">&lt;/config-property-setting&gt;</span>
    <span class="code-tag">&lt;/adminobject-instance&gt;</span>
  <span class="code-tag">&lt;/adminobject&gt;</span>
<span class="code-tag">&lt;/connector&gt;</span></pre>
</div></div>

<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>
<p>The default namespace of the deployment plan is <tt><span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/connector-1.2" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/connector-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The xml elements that do not have a namespace prefix belong to default namespace.</p></td></tr></table>

<p>The resource adapter used to deploy the above plan is <tt>&lt;geronimo_home&gt;/repository/org/apache/geronimo/modules/geronimo-activemq-ra/2.1</tt>. After the server is started, the running resource adapter can be looked up on the admin console from <tt>Console Navigation =&gt; Services =&gt; JMS Resource</tt>. We can also observe the connection factories and queues deployed by the resource adapter on the admin console.</p>

<h2><a name="Deploymentplans-Security"></a>Security</h2>

<p>A Java EE application may consist of several components that can be deployed into different containers such as WEB container, EJB container, WebServices container in a JEE5 server. This kind of deployment allows multi-tier applications that interact with one another to perform a given user task. Multi-tier JEE5 applications can be secured by properly selecting authenticating mechanisms and designing authorization levels or roles. If the application components use declarative security management, the authentication and authorization aspects are declared in corresponding JEE5 deployment descriptors. The declared security roles or levels are mapped to real security roles or levels in the geronimo deployment plans through security realms. In Apache Geronimo , the security realms abstract away authentication and authorization aspects of the application components. The authentication and authorization together enable access control for the various components of the application.</p>

<p>Depending on the selected authenticating system, a JAAS login module is selected and configured in a security realm. JAAS login modules connect to corresponding user/group repositories and perform authentication and retrieve authorization information. The Geronimo server provides login modules that connect to different types of user/group repositories. These are <b>PropertiesFileLoginModule</b>, <b>LDAPLoginModule</b>, <b>SQLLoginModule</b> and <b>CertificatePropertiesFileLoginModule</b>.</p>

<p>For example, Geronimo uses <b>geronimo-admin</b> security realm to authenticate users when they login to the geronimo administration Console. The deployment plan of the security realm is follows.</p>

<h3><a name="Deploymentplans-geronimoadminsecurityrealm"></a>geronimo-admin security realm</h3>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>geronimo-admin security realm</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;module xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;</span>
    <span class="code-tag">&lt;environment&gt;</span>
        <span class="code-tag">&lt;moduleId&gt;</span>
            <span class="code-tag">&lt;groupId&gt;</span>console.realm<span class="code-tag">&lt;/groupId&gt;</span>
            <span class="code-tag">&lt;artifactId&gt;</span>geronimo-admin<span class="code-tag">&lt;/artifactId&gt;</span>
            <span class="code-tag">&lt;version&gt;</span>1.0<span class="code-tag">&lt;/version&gt;</span>
            <span class="code-tag">&lt;type&gt;</span>car<span class="code-tag">&lt;/type&gt;</span>
        <span class="code-tag">&lt;/moduleId&gt;</span>

        <span class="code-tag">&lt;dependencies&gt;</span>
            <span class="code-tag">&lt;dependency&gt;</span>
                <span class="code-tag">&lt;groupId&gt;</span>org.apache.geronimo.framework<span class="code-tag">&lt;/groupId&gt;</span>
                <span class="code-tag">&lt;artifactId&gt;</span>j2ee-security<span class="code-tag">&lt;/artifactId&gt;</span>
                <span class="code-tag">&lt;type&gt;</span>car<span class="code-tag">&lt;/type&gt;</span>
            <span class="code-tag">&lt;/dependency&gt;</span>
        <span class="code-tag">&lt;/dependencies&gt;</span>
    <span class="code-tag">&lt;/environment&gt;</span>
    
    &lt;gbean name=<span class="code-quote">"geronimo-admin"</span>
           class=<span class="code-quote">"org.apache.geronimo.security.realm.GenericSecurityRealm"</span>
           xsi:type=<span class="code-quote">"dep:gbeanType"</span>
           <span class="code-keyword">xmlns:dep</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>
           <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>&gt;

        <span class="code-tag">&lt;attribute name=<span class="code-quote">"realmName"</span>&gt;</span>geronimo-admin<span class="code-tag">&lt;/attribute&gt;</span>
        <span class="code-tag">&lt;reference name=<span class="code-quote">"ServerInfo"</span>&gt;</span>
            <span class="code-tag">&lt;name&gt;</span>ServerInfo<span class="code-tag">&lt;/name&gt;</span>
        <span class="code-tag">&lt;/reference&gt;</span>
        
        <span class="code-tag">&lt;xml-reference name=<span class="code-quote">"LoginModuleConfiguration"</span>&gt;</span>
            <span class="code-tag">&lt;log:login-config <span class="code-keyword">xmlns:log</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/loginconfig-2.0"</span>&gt;</span>
                <span class="code-tag">&lt;log:login-module control-flag=<span class="code-quote">"REQUIRED"</span> wrap-principals=<span class="code-quote">"false"</span>&gt;</span>
                    <span class="code-tag">&lt;log:login-domain-name&gt;</span>geronimo-admin<span class="code-tag">&lt;/log:login-domain-name&gt;</span>
                    <span class="code-tag">&lt;log:login-module-class&gt;</span>
                        org.apache.geronimo.security.realm.providers.PropertiesFileLoginModule
                    <span class="code-tag">&lt;/log:login-module-class&gt;</span>
                    <span class="code-tag">&lt;log:option name=<span class="code-quote">"groupsURI"</span>&gt;</span>var/security/groups.properties<span class="code-tag">&lt;/log:option&gt;</span>
                    <span class="code-tag">&lt;log:option name=<span class="code-quote">"usersURI"</span>&gt;</span>var/security/users.properties<span class="code-tag">&lt;/log:option&gt;</span>
                <span class="code-tag">&lt;/log:login-module&gt;</span>
            <span class="code-tag">&lt;/log:login-config&gt;</span>
        <span class="code-tag">&lt;/xml-reference&gt;</span>
    <span class="code-tag">&lt;/gbean&gt;</span>

<span class="code-tag">&lt;/module&gt;</span></pre>
</div></div> 
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://geronimo.apache.org/xml/ns/deployment-1.2" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/deployment-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>
<p>The above security realm is deployed over two property files <tt>&lt;geronimo_home&gt;/var/security/users.properties</tt> and <tt>var/security/groups.properties</tt> that contain user/group information using <tt>org.apache.geronimo.security.realm.providers.PropertiesFileLoginModule</tt>. The <a href="/confluence/display/GMOxDOC22/Geronimo+Administration+Console" title="Geronimo Administration Console">Geronimo Administration Console</a> is a web application that uses the above security realm for user authentication.</p>

<p>The security realm deployment plan is an XML file that uses <span class="nobr"><a href="http://geronimo.apache.org/xml/ns/deployment-1.2" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/deployment-1.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> schema for <b>moduleId</b>, dependency and security realm GBean configurations. The XML file uses <span class="nobr"><a href="http://geronimo.apache.org/xml/ns/loginconfig-2.0" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/loginconfig-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> schema for login module configuration. All the XML schema files <tt>(.xsd)</tt> are located at <tt>&lt;geronimo_home&gt;/schema</tt> directory. </p>

<p>The following table provides the summary of user/group repositories and corresponding login modules in Apache Geronimo</p>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> User/Group Repository    </th>
<th class='confluenceTh'> LoginModule                                                                                  </th>
</tr>
<tr>
<td class='confluenceTd'> Property files            </td>
<td class='confluenceTd'> <tt>org.apache.geronimo.security.realm.providers.PropertiesFileLoginModule</tt>                    </td>
</tr>
<tr>
<td class='confluenceTd'> Database                  </td>
<td class='confluenceTd'> <tt>org.apache.geronimo.security.realm.providers.SQLLoginModule</tt>                               </td>
</tr>
<tr>
<td class='confluenceTd'> Ldap repository           </td>
<td class='confluenceTd'> <tt>org.apache.geronimo.security.realm.providers.LDAPLoginModule</tt>                              </td>
</tr>
<tr>
<td class='confluenceTd'> Certificate Repository    </td>
<td class='confluenceTd'> <tt>org.apache.geronimo.security.realm.providers.CertificatePropertiesFileLoginModule</tt>         </td>
</tr>
<tr>
<td class='confluenceTd'> Any other                 </td>
<td class='confluenceTd'> <tt>User has to supply the custom JAAS module. Admin console can be used to deploy a security</tt><br clear="all" />
                              <tt>realm over custom JAAS login modules</tt>                                                      </td>
</tr>
</tbody></table>

<p>Depending on the type of the login module, the options for configuration may change.</p>

<p>Once a security realm is deployed, it is available for any JEE5 application deployed in Geronimo to map declared roles to actual users/groups through a Geronimo specific deployment plan.</p>

<h1><a name="Deploymentplans-Applications"></a>Applications</h1>

<p>An enterprise application archive (EAR) can consist of several application modules. The application modules can be several web application archives (WAR) , EJB modules (JAR), application client modules (JAR) or resource archive modules (RAR). User can either deploy these modules individually or bundle them into a single EAR file and deploy that file.</p>

<p>When deployed individually, each application module should accompany a Geronimo deployment plan to map declared resources names, ejb names, security roles, JMS roles (if any) to actual resources in the server. The Geronimo deployment plans also contain any Geronimo specific settings and configurations. When deployed as a single bundle (EAR), user can create a single Geronimo deployment plan accomplish to perform all the mappings/settings and configurations.</p>

<p>The following table summarizes different JEE5 modules and corresponding Geronimo deployment plans accompany them.</p>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'> JEE module                                   </th>
<th class='confluenceTh'> JEE deployment descriptor (DD)       </th>
<th class='confluenceTh'> Geronimo deployment plan          </th>
</tr>
<tr>
<td class='confluenceTd'> web application archive (WAR)                 </td>
<td class='confluenceTd'>  <tt>web.xml</tt>                          </td>
<td class='confluenceTd'>  <a href="/confluence/display/GMOxDOC22/geronimo-web.xml" title="geronimo-web.xml">geronimo&#45;web.xml</a>                 </td>
</tr>
<tr>
<td class='confluenceTd'> EJB application archive (JAR)                 </td>
<td class='confluenceTd'>  <tt>ejb-jar.xml</tt>                      </td>
<td class='confluenceTd'>  <a href="/confluence/display/GMOxDOC22/openejb-jar.xml" title="openejb-jar.xml">openejb&#45;jar.xml</a>                  </td>
</tr>
<tr>
<td class='confluenceTd'> resource adapter archive (RAR)                </td>
<td class='confluenceTd'>  <tt>ra.xml</tt>                           </td>
<td class='confluenceTd'>  <a href="/confluence/display/GMOxDOC22/geronimo-ra.xml" title="geronimo-ra.xml">geronimo&#45;ra.xml</a>                  </td>
</tr>
<tr>
<td class='confluenceTd'> enterprise application archive (EAR)          </td>
<td class='confluenceTd'>  <tt>application.xml</tt>                  </td>
<td class='confluenceTd'>  <a href="/confluence/display/GMOxDOC22/geronimo-application.xml" title="geronimo-application.xml">geronimo&#45;application.xml</a>         </td>
</tr>
<tr>
<td class='confluenceTd'> enterprise application client archive (JAR)   </td>
<td class='confluenceTd'>  <tt>application-client.xml</tt>           </td>
<td class='confluenceTd'>  <a href="/confluence/display/GMOxDOC22/geronimo-application-client.xml" title="geronimo-application-client.xml">geronimo&#45;application&#45;client.xml</a>  </td>
</tr>
</tbody></table>

<h2><a name="Deploymentplans-WebApplicationdeploymentplan"></a>Web Application deployment plan</h2>

<p>In the <tt>geronimo-web.xml</tt> file, application deployer maps the security roles, ejb names, database resources, JMS resources, etc. declared in <tt>web.xml</tt> to corresponding entities deployed in the server. In addition to that, if there are any web container specific configurations, such as Tomcat or Jetty specific, depending on the application needs, all these settings are configured as well here. If the web application depends on any third party libraries or other services running in the server, all these dependencies are declared in the plan. Some web applications require class loading requirements different from the default class loading behavior. The <tt>geronimo-web.xml</tt> allows application deployer to configure this as well. There are many more configurations that could be done through <tt>geronimo-web.xml</tt> depending on the needs of web application. The following sections briefly explain how <tt>geronimo-web.xml</tt> can be used to configure the web container and web applications.</p>

<p>The <tt>geronimo-web.xml</tt> uses XML elements from <span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> namespace and one or more namespaces mentioned in <a href="#Deploymentplans-CommonelementsandConfiguration" title="Common elements and Configuration on Deployment plans">Common elements and Configuration</a> section earlier in the document. </p>

<p>For example, the following <tt>web.xml</tt> and <tt>geronimo-web.xml</tt> are the deployment descriptor and Geronimo deployment plan respectively, of a web application that connects to a datasource deployed on DB2 and retrieves data from a table.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>web.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"ISO-8859-1"</span>?&gt;</span>
&lt;web-app xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span>
         <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
         http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd<span class="code-quote">" version="</span>2.5"&gt;
    
    <span class="code-tag">&lt;resource-ref&gt;</span>
        <span class="code-tag">&lt;res-ref-name&gt;</span>jdbc/DataSource<span class="code-tag">&lt;/res-ref-name&gt;</span>
        <span class="code-tag">&lt;res-type&gt;</span>javax.sql.DataSource<span class="code-tag">&lt;/res-type&gt;</span>
        <span class="code-tag">&lt;res-auth&gt;</span>Container<span class="code-tag">&lt;/res-auth&gt;</span>
        <span class="code-tag">&lt;res-sharing-scope&gt;</span>Shareable<span class="code-tag">&lt;/res-sharing-scope&gt;</span>
    <span class="code-tag">&lt;/resource-ref&gt;</span>
    
    <span class="code-tag">&lt;welcome-file-list&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>jsp/EMPdemo.jsp<span class="code-tag">&lt;/welcome-file&gt;</span>
    <span class="code-tag">&lt;/welcome-file-list&gt;</span>
<span class="code-tag">&lt;/web-app&gt;</span></pre>
</div></div>

<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://java.sun.com/xml/ns/javaee" title="Visit page outside Confluence" rel="nofollow">http://java.sun.com/xml/ns/javaee<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.

<p>With Servlet 2.5 specification, many of the declarations done through <tt>web.xml</tt> can also be done through corresponding annotations in the servlets and JSPs. When both annotations and web.xml are provided, the declarations in web.xml takes precedence over annotations.</p></td></tr></table>

<p>The web module connects to back end datasource using its JNDI name <tt>jdbc/DataSource</tt> as declared in the <tt>web.xml</tt>. </p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>geronimo-web.xml</b></div><div class="codeContent">
<pre class="code-xml">&lt;web-app xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1"</span>
          <span class="code-keyword">xmlns:naming</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/naming-1.2"</span>
          <span class="code-keyword">xmlns:sec</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/security-2.0"</span>
          <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;

    <span class="code-tag">&lt;sys:environment&gt;</span>
        <span class="code-tag">&lt;sys:moduleId&gt;</span>
            <span class="code-tag">&lt;sys:groupId&gt;</span>samples<span class="code-tag">&lt;/sys:groupId&gt;</span>
            <span class="code-tag">&lt;sys:artifactId&gt;</span>EmployeeDemo<span class="code-tag">&lt;/sys:artifactId&gt;</span>
            <span class="code-tag">&lt;sys:version&gt;</span>2.5<span class="code-tag">&lt;/sys:version&gt;</span>
            <span class="code-tag">&lt;sys:type&gt;</span>war<span class="code-tag">&lt;/sys:type&gt;</span>
        <span class="code-tag">&lt;/sys:moduleId&gt;</span>
        
        <span class="code-tag">&lt;sys:dependencies&gt;</span>
            <span class="code-tag">&lt;sys:dependency&gt;</span>
                <span class="code-tag">&lt;sys:groupId&gt;</span>samples<span class="code-tag">&lt;/sys:groupId&gt;</span>
                <span class="code-tag">&lt;sys:artifactId&gt;</span>EmployeeDatasource<span class="code-tag">&lt;/sys:artifactId&gt;</span>
                <span class="code-tag">&lt;sys:version&gt;</span>2.5<span class="code-tag">&lt;/sys:version&gt;</span>
                <span class="code-tag">&lt;sys:type&gt;</span>rar<span class="code-tag">&lt;/sys:type&gt;</span>
            <span class="code-tag">&lt;/sys:dependency&gt;</span>
        <span class="code-tag">&lt;/sys:dependencies&gt;</span>
    <span class="code-tag">&lt;/sys:environment&gt;</span>
    
    <span class="code-tag">&lt;context-root&gt;</span>/EmployeeDemo<span class="code-tag">&lt;/context-root&gt;</span>
        <span class="code-tag">&lt;naming:resource-ref&gt;</span>
        <span class="code-tag">&lt;naming:ref-name&gt;</span>jdbc/DataSource<span class="code-tag">&lt;/naming:ref-name&gt;</span>
        <span class="code-tag">&lt;naming:resource-link&gt;</span>jdbc/EmployeeDatasource<span class="code-tag">&lt;/naming:resource-link&gt;</span>
    <span class="code-tag">&lt;/naming:resource-ref&gt;</span>
<span class="code-tag">&lt;/web-app&gt;</span></pre>
</div></div> 
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>
<p>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</p></td></tr></table>

<p>Observe the various XML tags and corresponding namespaces used in the deployment plan for various purposes.</p>

<p><b><tt>&lt;sys:environment&gt; .. &lt;/sys:environment&gt;</tt></b> : These elements provide the moduleid configuration and the dependencies. The moduleId elements provide the configuration name for the web module. So, when the web module is deployed, it is given the configuration name <tt>samples/samples/2.5/jar</tt>. The dependencies elements provide the configurations and third party libraries on which the web module is dependent on. These configurations and libraries will be available to the web module via a classloader hierarchy. In this case, the web module is dependent on <tt>samples/EmployeeDatasource/2.5/rar</tt> which is the configuration of the deployed Datasource that connects to a back end DB2 database. The Datasource deploys a database connection pool <tt>(javax.sql.Datasource)</tt> with name <tt>jdbc/EmployeeDatasource</tt>.</p>

<p><b><tt>&lt;sys:context-root&gt; .. &lt;/sys:context-root&gt;</tt></b> : The XML elements used to provide the web context root of the web applications.</p>

<p><b><tt>&lt;naming:resource-ref&gt; .. &lt;/naming:resource-ref&gt;</tt></b> : These elements help us to configure the resource references. In this case, the datasource reference <tt>jdbc/DataSource</tt> is mapped to <tt>jdbc/EmployeeDatasource</tt>. </p>

<p>In the <tt>EMPdemo.jsp</tt>, the following java code snippet is used to obtain a connection from the datasource.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>EMPdemo.jsp</b></div><div class="codeContent">
<pre class="code-java">....
....
Context initContext = <span class="code-keyword">new</span> InitialContext();
Context envContext  = (Context)initContext.lookup(<span class="code-quote">"java:comp/env"</span>);
DataSource ds = (DataSource)envContext.lookup(<span class="code-quote">"jdbc/DataSource"</span>);
Connection con = ds.getConnection();
....
....</pre>
</div></div>

<p>The above descriptor and the plan files are the simple illustrations that explain how web modules are developed and assembled for Apache Geronimo. Similarly, many other configurations can be performed in the <tt>geronimo-web.xml</tt>. </p>

<p>All the XML schema files are located at <tt>&lt;geronimo_home&gt;/schema</tt> directory. Please go through the <tt>.xsd</tt> files to have a feel of XML tags that can be used in <tt>geronimo-web.xml</tt> for configuring web applications.</p>

<h2><a name="Deploymentplans-EJBApplicationdeploymentplan"></a>EJB Application deployment plan</h2>

<p>Geronimo uses OpenEJB container for providing ejb services. With the advent of JEE 5, the ejb container services such as transaction management, security, life cycle management can be declared in the ejb class itself using annotations. However, the ejb deployment descriptor can still be provided through <tt>ejb-jar.xml</tt> file. When both annotations and <tt>ejb-jar.xml</tt> file are provided, the <tt>ejb-jar.xml</tt> file takes precedence over the annotations. </p>

<p>The <tt>openejb-jar.xml</tt> file contains deployment plan for ejb modules. In the <tt>openejb-jar.xml</tt> file, the application deployer maps the security roles, ejb names, database resources, JMS resources, etc. declared in <tt>ejb-jar.xml</tt> file to corresponding entities deployed in the server. In addition to that, if there are any ejb container specific configurations to be done, the required settings are configured as well here. If the ejb module depends on any third party libraries or other services running in the server, all these third party libraries and the services are specified in the <tt>openejb-jar.xml</tt> file. Some ejb applications require class loading requirements different from the default class loading behavior. The <tt>openejb-jar.xml</tt> file allows application deployer to configure this as well. There are many more configurations that could be done through <tt>openejb-jar.xml</tt> file depending on the needs of the ejb application. The following sections briefly explain how <tt>openejb-jar.xml</tt> file can be used to configure the ejb container and ejb applications.</p>

<p>For example, the below XML content is the deployment descriptor (<tt>ejb-jar.xml</tt>) of a stateless session bean that connects to a back end DB2 database.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>ejb-jar.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span> ?&gt;</span> 
&lt;ejb-jar xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span> version=<span class="code-quote">"3.0"</span> 
         <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> 
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
         http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd"&gt;
  
    <span class="code-tag">&lt;description&gt;</span>Stateless Session Bean Example<span class="code-tag">&lt;/description&gt;</span> 
    <span class="code-tag">&lt;display-name&gt;</span>Stateless Session Bean Example<span class="code-tag">&lt;/display-name&gt;</span> 
    
    <span class="code-tag">&lt;enterprise-beans&gt;</span>
        <span class="code-tag">&lt;session&gt;</span>
            <span class="code-tag">&lt;ejb-name&gt;</span>RetrieveEmployeeInfoBean<span class="code-tag">&lt;/ejb-name&gt;</span>
            <span class="code-tag">&lt;business-remote&gt;</span>examples.session.stateless_dd.RetrieveEmployeeInfo<span class="code-tag">&lt;/business-remote&gt;</span>
            <span class="code-tag">&lt;ejb-class&gt;</span>examples.session.stateless_dd.RetrieveEmployeeInfoBean<span class="code-tag">&lt;/ejb-class&gt;</span> 
            <span class="code-tag">&lt;session-type&gt;</span>Stateless<span class="code-tag">&lt;/session-type&gt;</span> 
            <span class="code-tag">&lt;transaction-type&gt;</span>Container<span class="code-tag">&lt;/transaction-type&gt;</span> 
            
            <span class="code-tag">&lt;resource-ref&gt;</span>
                <span class="code-tag">&lt;res-ref-name&gt;</span>jdbc/DataSource<span class="code-tag">&lt;/res-ref-name&gt;</span>
                <span class="code-tag">&lt;res-type&gt;</span>javax.sql.DataSource<span class="code-tag">&lt;/res-type&gt;</span>
                <span class="code-tag">&lt;res-auth&gt;</span>Container<span class="code-tag">&lt;/res-auth&gt;</span>
                <span class="code-tag">&lt;res-sharing-scope&gt;</span>Shareable<span class="code-tag">&lt;/res-sharing-scope&gt;</span>
            <span class="code-tag">&lt;/resource-ref&gt;</span>
        <span class="code-tag">&lt;/session&gt;</span>
    <span class="code-tag">&lt;/enterprise-beans&gt;</span>
    
    <span class="code-tag">&lt;interceptors&gt;</span>
        <span class="code-tag">&lt;interceptor&gt;</span>

            <span class="code-tag">&lt;interceptor-class&gt;</span>
                examples.session.stateless_dd.RetrieveEmployeeInfoCallbacks
            <span class="code-tag">&lt;/interceptor-class&gt;</span>

            <span class="code-tag">&lt;post-construct&gt;</span>
                <span class="code-tag">&lt;lifecycle-callback-method&gt;</span>construct<span class="code-tag">&lt;/lifecycle-callback-method&gt;</span>
            <span class="code-tag">&lt;/post-construct&gt;</span>
            
            <span class="code-tag">&lt;post-activate&gt;</span>
                <span class="code-tag">&lt;lifecycle-callback-method&gt;</span>activate<span class="code-tag">&lt;/lifecycle-callback-method&gt;</span>
            <span class="code-tag">&lt;/post-activate&gt;</span>
            
            <span class="code-tag">&lt;pre-passivate&gt;</span>
                <span class="code-tag">&lt;lifecycle-callback-method&gt;</span>passivate<span class="code-tag">&lt;/lifecycle-callback-method&gt;</span>
            <span class="code-tag">&lt;/pre-passivate&gt;</span>
        <span class="code-tag">&lt;/interceptor&gt;</span>
    <span class="code-tag">&lt;/interceptors&gt;</span>
    
    <span class="code-tag">&lt;assembly-descriptor&gt;</span>
        <span class="code-tag">&lt;interceptor-binding&gt;</span>

            <span class="code-tag">&lt;ejb-name&gt;</span>RetrieveEmployeeInfoBean<span class="code-tag">&lt;/ejb-name&gt;</span>

            <span class="code-tag">&lt;interceptor-class&gt;</span>
                examples.session.stateless_dd.RetrieveEmployeeInfoCallbacks
            <span class="code-tag">&lt;/interceptor-class&gt;</span>
        
        <span class="code-tag">&lt;/interceptor-binding&gt;</span>
    <span class="code-tag">&lt;/assembly-descriptor&gt;</span>

<span class="code-tag">&lt;/ejb-jar&gt;</span></pre>
</div></div>

<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>
<p>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://java.sun.com/xml/ns/javaee" title="Visit page outside Confluence" rel="nofollow">http://java.sun.com/xml/ns/javaee<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</p>

<p>In EJB3.0, most of the deployment descriptor declarations can be done through the corresponding annotations in the bean class. However, if a deployment descriptor is supplied (<tt>ejb-jar.xml</tt>), the declarations in the deployment descriptor will override the annotations.</p></td></tr></table>

<p>The ejb module connects to back end datasource using its JNDI name <tt>jdbc/DataSource</tt> as declared in the <tt>ejb-jar.xml</tt>. It also declares that the ejb is a stateless session bean and provides an interceptor class for the bean. The interceptor class will have callback methods which container calls when the corresponding events occur in the bean's life cycle.</p>

<p>For the above deployment descriptor, we will have to provide a corresponding deployment plan file (<tt>openejb-jar.xml</tt>) that maps the declared datasource to actual datasource deployed in the server. The following is the deployment plan.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>openejb-jar.xml</b></div><div class="codeContent">
<pre class="code-xml">&lt;openejb-jar xmlns=<span class="code-quote">"http://openejb.apache.org/xml/ns/openejb-jar-2.2"</span> 
         <span class="code-keyword">xmlns:naming</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/naming-1.2"</span> 
         <span class="code-keyword">xmlns:sec</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/security-2.0"</span> 
         <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;

    <span class="code-tag">&lt;sys:environment&gt;</span>
        <span class="code-tag">&lt;sys:moduleId&gt;</span>
            <span class="code-tag">&lt;sys:groupId&gt;</span>samples<span class="code-tag">&lt;/sys:groupId&gt;</span>
            <span class="code-tag">&lt;sys:artifactId&gt;</span>EmployeeDemo-ejb-dd<span class="code-tag">&lt;/sys:artifactId&gt;</span>
            <span class="code-tag">&lt;sys:version&gt;</span>3.0<span class="code-tag">&lt;/sys:version&gt;</span>
            <span class="code-tag">&lt;sys:type&gt;</span>jar<span class="code-tag">&lt;/sys:type&gt;</span>
        <span class="code-tag">&lt;/sys:moduleId&gt;</span>
        
        <span class="code-tag">&lt;sys:dependencies&gt;</span>
            <span class="code-tag">&lt;sys:dependency&gt;</span>
                <span class="code-tag">&lt;sys:groupId&gt;</span>console.dbpool<span class="code-tag">&lt;/sys:groupId&gt;</span>
                <span class="code-tag">&lt;sys:artifactId&gt;</span>jdbc/FEmployeeDatasource<span class="code-tag">&lt;/sys:artifactId&gt;</span>
                <span class="code-tag">&lt;sys:version&gt;</span>1.0<span class="code-tag">&lt;/sys:version&gt;</span>
                <span class="code-tag">&lt;sys:type&gt;</span>rar<span class="code-tag">&lt;/sys:type&gt;</span>
           <span class="code-tag">&lt;/sys:dependency&gt;</span>
        <span class="code-tag">&lt;/sys:dependencies&gt;</span>
    <span class="code-tag">&lt;/sys:environment&gt;</span>
    
    <span class="code-tag">&lt;enterprise-beans&gt;</span>
        <span class="code-tag">&lt;session&gt;</span>
            <span class="code-tag">&lt;ejb-name&gt;</span>RetrieveEmployeeInfoBean<span class="code-tag">&lt;/ejb-name&gt;</span>
            <span class="code-tag">&lt;naming:resource-ref&gt;</span>
                <span class="code-tag">&lt;naming:ref-name&gt;</span>jdbc/DataSource<span class="code-tag">&lt;/naming:ref-name&gt;</span>
                <span class="code-tag">&lt;naming:resource-link&gt;</span>jdbc/EmployeeDatasource<span class="code-tag">&lt;/naming:resource-link&gt;</span>
            <span class="code-tag">&lt;/naming:resource-ref&gt;</span>
        <span class="code-tag">&lt;/session&gt;</span>
    <span class="code-tag">&lt;/enterprise-beans&gt;</span>
<span class="code-tag">&lt;/openejb-jar&gt;</span></pre>
</div></div>  
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://openejb.apache.org/xml/ns/openejb-jar-2.2" title="Visit page outside Confluence" rel="nofollow">http://openejb.apache.org/xml/ns/openejb-jar-2.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>
<p>Observe the various XML tags and corresponding namespaces used in the deployment plan for various purposes.</p>

<p><b><tt>&lt;sys:environment&gt; .. &lt;/sys:environment&gt;</tt></b> : These elements provide the moduleId configuration and the dependencies. The moduleId elements provide the configuration name for the ejb module. So, when the ejb module is deployed, it is given the configuration name <tt>samples/EmployeeDemo-ejb-dd/3.0/jar</tt>. The dependencies elements provide the configurations and third party libraries on which the ejb module is dependent on. These configurations and libraries will be available to the ejb module via a classloader hierarchy. In this case, the ejb module is dependent on <tt>console.dbpool/jdbc/FEmployeeDatasource/1.0/jar</tt> which is the configuration of the deployed Datasource that connects to a back end DB2 database. The Datasource deploys a database connection pool (<tt>javax.sql.Datasource</tt>) with name <tt>jdbc/EmployeeDatasource</tt>.</p>

<p><b><tt>&lt;enterprise-beans&gt; .. &lt;/enterprise-beans&gt;</tt></b> : These elements help us to configure the enterprise beans. In this case, the datasource reference <tt>jdbc/DataSource</tt> is mapped to <tt>jdbc/EmployeeDatasource</tt>. </p>

<p>In the ejb bean class, the following java code is used to obtain a connection from the datasource.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>examples.session.stateless_dd.RetrieveEmployeeInfoBean.java</b></div><div class="codeContent">
<pre class="code-java">....
....
Context initContext = <span class="code-keyword">new</span> InitialContext();
Context envContext  = (Context)initContext.lookup(<span class="code-quote">"java:comp/env"</span>);
DataSource ds = (DataSource)envContext.lookup(<span class="code-quote">"jdbc/DataSource"</span>);
Connection con = ds.getConnection();
....
....</pre>
</div></div>


<p>The above descriptor and plan are the simple illustrations that explain how ejb modules are developed and assembled for Apache Geronimo. Similarly, many other configurations can be performed in the <tt>openejb-jar.xml</tt>. The schema for the plan is <span class="nobr"><a href="http://svn.apache.org/repos/asf/geronimo/site/tags/pre-confluence/docs/schemas-1.1/openejb-jar-2.1.xsd" title="Visit page outside Confluence" rel="nofollow">openejb-jar-2.1.xsd <sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></p>

<h2><a name="Deploymentplans-Enterpriseapplicationdeploymentplan"></a>Enterprise application deployment plan</h2>

<p>An enterprise application archive (<tt>EAR</tt>) can consist of many sub modules. The sub modules can be web modules (<tt>WAR</tt>), ejb modules (<tt>JAR</tt>), resource adapter modules (<tt>RAR</tt>) or application client modules (<tt>jar</tt>). When an <tt>EAR</tt> consist of many sub modules, the deployment plans for all the sub modules can be provided in a single file named <tt>geronimo-application.xml</tt>. This single file contains the deployment details of each of the sub modules of the <tt>EAR</tt>. Alternatively, each of the sub modules can package its corresponding deployment plan file within itself. However, the preferable way is to provide a single deployment plan through <tt>geronimo-application.xml</tt> for all the sub modules. This mechanism provides flexibility of allowing us to modify the deployment configuration for all modules through a single file. In this section, we explore <tt>EAR</tt> deployment plan and understand what it contains.</p>

<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>
<p>There are 3 places a deployment plan (partial) can be associated with an ear, and they are used in this order:</p>

<p>1. external plan<br/>
2. ear level geronimo-application.xml<br/>
3. module level geronimo|openejb-*.xml</p>

<p>So, anything in an external plan takes precedence over bits in (2) or (3) configuring the same module.  Anything in (2) takes precedence over a module level plan.  If a module level plan is missing from (1) its looked for in (2),then (3); if missing from (1) and (2), then its looked for in the module (3).</p>

<p>There is no attempt to merge plans from these different locations: e.g. if there's something in (1) for a module, any other plans are ignored.</p></td></tr></table>

<p>An enterprise application archive (<tt>EAR</tt>) should provide its deployment descriptor in the <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/application_5.xsd" title="Visit page outside Confluence" rel="nofollow">application.xml<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> file. The <tt>application.xml</tt> lists all the sub modules in the <tt>EAR</tt> file along with the descriptions. In addition to the standard deployment descriptor, the <tt>EAR</tt> should also provide Geronimo specific deployment plan in <span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/application-2.0" title="Visit page outside Confluence" rel="nofollow">geronimo-application.xml<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span>.  Along with the description of each of the sub modules of the <tt>EAR</tt> file, this file also provides mappings for JEE resources that each of the sub modules refers in their deployment descriptor. The <tt>geronimo-application.xml</tt> is divided into several sections where in each section, the deployment plan for a sub module is provided. <tt>geronimo-application.xml</tt> is the highest level plan that provides deployment plan for all sub modules; hence it can contain XML elements from every other Geronimo XML schema used by Geronimo application deployer. The <tt>geronimo-application.xml</tt> is the super set of all other deployment plans.</p>

<p>For example, following is the structure of an <tt>EAR</tt> that has a web module and an ejb module.</p>

<p><img src="/confluence/download/attachments/93398/ear-structure.GIF" align="absmiddle" border="0" /></p>

<p>The <tt>Order.ear</tt> file shown above contains two modules. One is <tt>OrderWEB.war</tt> file which is a web module and the other is <tt>OrderEJB.jar</tt> file which is an ejb module. The <tt>META-INF</tt> folder in <tt>Order.ear</tt>  contains the application deployment descriptor (<tt>application.xml</tt>) and the Geronimo application deployment plan (<tt>geronimo-application.xml</tt>). The web application and the ejb application have packaged only their respective deployment descriptors. But the deployment plans for these modules are provided in the <tt>geronimo-application.xml</tt>. <br/>
The web application (<tt>OrderWAR.war</tt>) looks up stateless session bean in the <tt>OrderEJB.jar</tt> module to retrieve the order information. The <tt>RetrieveOrderInfoBean</tt> in <tt>OrderEJB.jar</tt> module uses JDBC connection to read the order information from a DB2 database. </p>

<p>The deployment descriptor of the OrderEJB.jar is as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>ejb-jar.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span> ?&gt;</span> 
&lt;ejb-jar xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span> version=<span class="code-quote">"3.0"</span> 
         <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> 
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
         http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd"&gt;
         
    <span class="code-tag">&lt;description&gt;</span>Stateless Session Bean Example<span class="code-tag">&lt;/description&gt;</span>
    <span class="code-tag">&lt;display-name&gt;</span>Stateless Session Bean Example<span class="code-tag">&lt;/display-name&gt;</span> 

    <span class="code-tag">&lt;enterprise-beans&gt;</span>
        <span class="code-tag">&lt;session&gt;</span>
            <span class="code-tag">&lt;ejb-name&gt;</span>RetrieveOrderInfoBean<span class="code-tag">&lt;/ejb-name&gt;</span>
            <span class="code-tag">&lt;business-local&gt;</span>
                examples.session.stateless_dd.RetrieveOrderInfo
            <span class="code-tag">&lt;/business-local&gt;</span>
            <span class="code-tag">&lt;ejb-class&gt;</span>
                examples.session.stateless_dd.RetrieveOrderInfoBean
            <span class="code-tag">&lt;/ejb-class&gt;</span>
            <span class="code-tag">&lt;session-type&gt;</span>Stateless<span class="code-tag">&lt;/session-type&gt;</span>
            <span class="code-tag">&lt;transaction-type&gt;</span>Container<span class="code-tag">&lt;/transaction-type&gt;</span> 
            
            <span class="code-tag">&lt;resource-ref&gt;</span>
                <span class="code-tag">&lt;res-ref-name&gt;</span>jdbc/DB2DataSource<span class="code-tag">&lt;/res-ref-name&gt;</span>
                <span class="code-tag">&lt;res-type&gt;</span>javax.sql.DataSource<span class="code-tag">&lt;/res-type&gt;</span>
                <span class="code-tag">&lt;res-auth&gt;</span>Container<span class="code-tag">&lt;/res-auth&gt;</span>
                <span class="code-tag">&lt;res-sharing-scope&gt;</span>Shareable<span class="code-tag">&lt;/res-sharing-scope&gt;</span>
            <span class="code-tag">&lt;/resource-ref&gt;</span>
        <span class="code-tag">&lt;/session&gt;</span>
    <span class="code-tag">&lt;/enterprise-beans&gt;</span>
    
    <span class="code-tag">&lt;interceptors&gt;</span>
        <span class="code-tag">&lt;interceptor&gt;</span>
            <span class="code-tag">&lt;interceptor-class&gt;</span>
                examples.session.stateless_dd.RetrieveOrderCallbacks
            <span class="code-tag">&lt;/interceptor-class&gt;</span>
            <span class="code-tag">&lt;post-construct&gt;</span>
                <span class="code-tag">&lt;lifecycle-callback-method&gt;</span>construct<span class="code-tag">&lt;/lifecycle-callback-method&gt;</span>
            <span class="code-tag">&lt;/post-construct&gt;</span>
            
            <span class="code-tag">&lt;pre-destroy&gt;</span>
                <span class="code-tag">&lt;lifecycle-callback-method&gt;</span>destroy<span class="code-tag">&lt;/lifecycle-callback-method&gt;</span>
            <span class="code-tag">&lt;/pre-destroy&gt;</span>
        <span class="code-tag">&lt;/interceptor&gt;</span>
    <span class="code-tag">&lt;/interceptors&gt;</span>
    
    <span class="code-tag">&lt;assembly-descriptor&gt;</span>
        <span class="code-tag">&lt;interceptor-binding&gt;</span>
            <span class="code-tag">&lt;ejb-name&gt;</span>RetrieveOrderInfoBean<span class="code-tag">&lt;/ejb-name&gt;</span>
            <span class="code-tag">&lt;interceptor-class&gt;</span>
                examples.session.stateless_dd.RetrieveOrderCallbacks
            <span class="code-tag">&lt;/interceptor-class&gt;</span>
        <span class="code-tag">&lt;/interceptor-binding&gt;</span>
    <span class="code-tag">&lt;/assembly-descriptor&gt;</span>  
<span class="code-tag">&lt;/ejb-jar&gt;</span></pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://java.sun.com/xml/ns/javaee" title="Visit page outside Confluence" rel="nofollow">http://java.sun.com/xml/ns/javaee<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>
<p>In the <tt>RetrieveOrderInfoBean</tt>, the following code is used to look up the Datasource object and obtain a database connection.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>examples.session.stateless_dd.RetrieveOrderInfoBean</b></div><div class="codeContent">
<pre class="code-java">...
...
Context initContext = <span class="code-keyword">new</span> InitialContext();
Context envContext  = (Context)initContext.lookup(<span class="code-quote">"java:comp/env"</span>);
DataSource ds = (DataSource)envContext.lookup(<span class="code-quote">"jdbc/DB2DataSource"</span>);
<span class="code-object">System</span>.out.println(<span class="code-quote">"Got DataSource\n"</span>);
con = ds.getConnection();
<span class="code-object">System</span>.out.println(<span class="code-quote">"Got Connection\n"</span>);
...
...</pre>
</div></div>


<p>The deployment descriptor of the <tt>OrderWEB.war</tt> is as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>web.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;web-app <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> 
         xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span> 
         <span class="code-keyword">xmlns:web</span>=<span class="code-quote">"http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"</span>  
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
         http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
         id=<span class="code-quote">"WebApp_ID"</span> version=<span class="code-quote">"2.5"</span>&gt;
         
    <span class="code-tag">&lt;display-name&gt;</span>OrderWEB<span class="code-tag">&lt;/display-name&gt;</span>
    <span class="code-tag">&lt;welcome-file-list&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>index.html<span class="code-tag">&lt;/welcome-file&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>index.htm<span class="code-tag">&lt;/welcome-file&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>index.jsp<span class="code-tag">&lt;/welcome-file&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>default.html<span class="code-tag">&lt;/welcome-file&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>default.htm<span class="code-tag">&lt;/welcome-file&gt;</span>
        <span class="code-tag">&lt;welcome-file&gt;</span>default.jsp<span class="code-tag">&lt;/welcome-file&gt;</span>
    <span class="code-tag">&lt;/welcome-file-list&gt;</span>
    
    <span class="code-tag">&lt;servlet&gt;</span>
        <span class="code-tag">&lt;description&gt;</span><span class="code-tag">&lt;/description&gt;</span>
        <span class="code-tag">&lt;display-name&gt;</span>RetrieveOrder<span class="code-tag">&lt;/display-name&gt;</span>
        <span class="code-tag">&lt;servlet-name&gt;</span>RetrieveOrder<span class="code-tag">&lt;/servlet-name&gt;</span>
        <span class="code-tag">&lt;servlet-class&gt;</span>
           examples.web.servlet.RetrieveOrder
        <span class="code-tag">&lt;/servlet-class&gt;</span>
    <span class="code-tag">&lt;/servlet&gt;</span>
    
    <span class="code-tag">&lt;ejb-local-ref&gt;</span>
        <span class="code-tag">&lt;ejb-ref-name&gt;</span>ejb/RetrieveOrderInfo<span class="code-tag">&lt;/ejb-ref-name&gt;</span>
        <span class="code-tag">&lt;ejb-ref-type&gt;</span>Session<span class="code-tag">&lt;/ejb-ref-type&gt;</span>
        <span class="code-tag">&lt;local&gt;</span>
            examples.session.stateless_dd.RetrieveOrderInfo
        <span class="code-tag">&lt;/local&gt;</span>
        <span class="code-tag">&lt;ejb-link&gt;</span>RetrieveOrderInfoBean<span class="code-tag">&lt;/ejb-link&gt;</span>
    <span class="code-tag">&lt;/ejb-local-ref&gt;</span>
    
    <span class="code-tag">&lt;servlet-mapping&gt;</span>
        <span class="code-tag">&lt;servlet-name&gt;</span>RetrieveOrder<span class="code-tag">&lt;/servlet-name&gt;</span>
        <span class="code-tag">&lt;url-pattern&gt;</span>/RetrieveOrder<span class="code-tag">&lt;/url-pattern&gt;</span>
    <span class="code-tag">&lt;/servlet-mapping&gt;</span>
<span class="code-tag">&lt;/web-app&gt;</span></pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://java.sun.com/xml/ns/javaee" title="Visit page outside Confluence" rel="nofollow">http://java.sun.com/xml/ns/javaee<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>
<p>In the <tt>RetrieveOrder</tt> servlet, the following code is used to look up the ejb to retrieve the order details.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>examples.web.servlet.RetrieveOrder</b></div><div class="codeContent">
<pre class="code-java">...
...
Context ctx  = <span class="code-keyword">new</span> InitialContext();
<span class="code-object">System</span>.out.println(<span class="code-quote">"Instantiating beans..."</span>);
retrieveOInfo = (RetrieveOrderInfo)ctx.lookup(<span class="code-quote">"java:comp/env/ejb/RetrieveOrderInfo"</span>);
<span class="code-object">String</span> orderIdStr = request.getParameter(<span class="code-quote">"orderid"</span>);
<span class="code-object">int</span> orderId = <span class="code-object">Integer</span>.parseInt(orderIdStr);
OrderInfo oInfo = retrieveOInfo.getOrderInfo(orderId);
...
...</pre>
</div></div>      


<p>The deployment descriptor of the Order.ear is as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>application.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;application <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>
			 xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span> 
			 <span class="code-keyword">xmlns:application</span>=<span class="code-quote">"http://java.sun.com/xml/ns/javaee/application_5.xsd"</span>
			 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
			 http://java.sun.com/xml/ns/j2ee/application_5.xsd<span class="code-quote">" version="</span>5"&gt;
			 
	<span class="code-tag">&lt;description&gt;</span>EAR Example<span class="code-tag">&lt;/description&gt;</span>
	<span class="code-tag">&lt;display-name&gt;</span>Order Sample<span class="code-tag">&lt;/display-name&gt;</span>
	
	<span class="code-tag">&lt;module&gt;</span>
		<span class="code-tag">&lt;web&gt;</span>
			<span class="code-tag">&lt;web-uri&gt;</span>OrderWEB.war<span class="code-tag">&lt;/web-uri&gt;</span>
			<span class="code-tag">&lt;context-root&gt;</span>/OrderDemo<span class="code-tag">&lt;/context-root&gt;</span>
		<span class="code-tag">&lt;/web&gt;</span>
	<span class="code-tag">&lt;/module&gt;</span>
	
	<span class="code-tag">&lt;module&gt;</span>
		<span class="code-tag">&lt;ejb&gt;</span>OrderEJB.jar<span class="code-tag">&lt;/ejb&gt;</span>
	<span class="code-tag">&lt;/module&gt;</span>
<span class="code-tag">&lt;/application&gt;</span></pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://java.sun.com/xml/ns/javaee" title="Visit page outside Confluence" rel="nofollow">http://java.sun.com/xml/ns/javaee<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>
<p>The deployment plan of the <tt>Order.ear</tt> is as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>geronimo-application.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;application xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/application-2.0"</span> 
             <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span> 
             application-name=<span class="code-quote">"Order"</span>&gt;

	<span class="code-tag">&lt;sys:environment&gt;</span>
		<span class="code-tag">&lt;sys:moduleId&gt;</span>
			<span class="code-tag">&lt;sys:groupId&gt;</span>Order<span class="code-tag">&lt;/sys:groupId&gt;</span>
			<span class="code-tag">&lt;sys:artifactId&gt;</span>OrderEAR<span class="code-tag">&lt;/sys:artifactId&gt;</span>
			<span class="code-tag">&lt;sys:version&gt;</span>5.0<span class="code-tag">&lt;/sys:version&gt;</span>
			<span class="code-tag">&lt;sys:type&gt;</span>car<span class="code-tag">&lt;/sys:type&gt;</span>
		<span class="code-tag">&lt;/sys:moduleId&gt;</span>
	<span class="code-tag">&lt;/sys:environment&gt;</span>
  
    <span class="code-tag">&lt;module&gt;</span>
        <span class="code-tag">&lt;web&gt;</span>OrderWEB.war<span class="code-tag">&lt;/web&gt;</span>
        <span class="code-tag">&lt;web-app xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1"</span> &gt;</span>
        <span class="code-tag">&lt;sys:environment&gt;</span>
            <span class="code-tag">&lt;sys:moduleId&gt;</span>
                <span class="code-tag">&lt;sys:groupId&gt;</span>Order<span class="code-tag">&lt;/sys:groupId&gt;</span>
                <span class="code-tag">&lt;sys:artifactId&gt;</span>OrderWEB<span class="code-tag">&lt;/sys:artifactId&gt;</span>
                <span class="code-tag">&lt;sys:version&gt;</span>2.5<span class="code-tag">&lt;/sys:version&gt;</span>
                <span class="code-tag">&lt;sys:type&gt;</span>war<span class="code-tag">&lt;/sys:type&gt;</span>
            <span class="code-tag">&lt;/sys:moduleId&gt;</span>
        <span class="code-tag">&lt;/sys:environment&gt;</span>
            <span class="code-tag">&lt;context-root&gt;</span>/OrderDemo<span class="code-tag">&lt;/context-root&gt;</span>
        <span class="code-tag">&lt;/web-app&gt;</span>
    <span class="code-tag">&lt;/module&gt;</span>
    
    <span class="code-tag">&lt;module&gt;</span>
        <span class="code-tag">&lt;ejb&gt;</span>OrderEJB.jar<span class="code-tag">&lt;/ejb&gt;</span>
        &lt;openejb-jar xmlns=<span class="code-quote">"http://openejb.apache.org/xml/ns/openejb-jar-2.2"</span> 
					 <span class="code-keyword">xmlns:naming</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/naming-1.2"</span>&gt;
					 
			<span class="code-tag">&lt;sys:environment&gt;</span>
				<span class="code-tag">&lt;sys:moduleId&gt;</span>
					<span class="code-tag">&lt;sys:groupId&gt;</span>Order<span class="code-tag">&lt;/sys:groupId&gt;</span>
					<span class="code-tag">&lt;sys:artifactId&gt;</span>OrderEJB<span class="code-tag">&lt;/sys:artifactId&gt;</span>
					<span class="code-tag">&lt;sys:version&gt;</span>3.0<span class="code-tag">&lt;/sys:version&gt;</span>
					<span class="code-tag">&lt;sys:type&gt;</span>jar<span class="code-tag">&lt;/sys:type&gt;</span>
				<span class="code-tag">&lt;/sys:moduleId&gt;</span>
				
				<span class="code-tag">&lt;sys:dependencies&gt;</span>
					<span class="code-tag">&lt;sys:dependency&gt;</span>
						<span class="code-tag">&lt;sys:groupId&gt;</span>console.dbpool<span class="code-tag">&lt;/sys:groupId&gt;</span>
						<span class="code-tag">&lt;sys:artifactId&gt;</span>OrderDS<span class="code-tag">&lt;/sys:artifactId&gt;</span>
						<span class="code-tag">&lt;sys:version&gt;</span>1.0<span class="code-tag">&lt;/sys:version&gt;</span>
						<span class="code-tag">&lt;sys:type&gt;</span>rar<span class="code-tag">&lt;/sys:type&gt;</span>
					<span class="code-tag">&lt;/sys:dependency&gt;</span>
				<span class="code-tag">&lt;/sys:dependencies&gt;</span>
			<span class="code-tag">&lt;/sys:environment&gt;</span>
			
			<span class="code-tag">&lt;enterprise-beans&gt;</span>
				<span class="code-tag">&lt;session&gt;</span>
					<span class="code-tag">&lt;ejb-name&gt;</span>RetrieveOrderInfoBean<span class="code-tag">&lt;/ejb-name&gt;</span>
					<span class="code-tag">&lt;naming:resource-ref&gt;</span>
						<span class="code-tag">&lt;naming:ref-name&gt;</span>jdbc/DB2DataSource<span class="code-tag">&lt;/naming:ref-name&gt;</span>
						<span class="code-tag">&lt;naming:resource-link&gt;</span>OrderDS<span class="code-tag">&lt;/naming:resource-link&gt;</span>
					<span class="code-tag">&lt;/naming:resource-ref&gt;</span>
				<span class="code-tag">&lt;/session&gt;</span>
			<span class="code-tag">&lt;/enterprise-beans&gt;</span>
		<span class="code-tag">&lt;/openejb-jar&gt;</span>
	<span class="code-tag">&lt;/module&gt;</span>
<span class="code-tag">&lt;/application&gt;</span></pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/application-2.0" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/application-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace.</td></tr></table>
<p>Observe how the JEE 5 resource names and ejb names in <tt>ejb-jar.xml</tt> and <tt>web.xml</tt> are mapped to actual resources deployed in the server through <tt>geronimo-application.xml</tt>.</p>

<p>As we can observe from the <tt>geronimo-application.xml</tt>, the deployment plans for web and ejb modules are wrapped in <tt>&lt;module&gt; .... &lt;/module&gt;</tt> elements. The xml elements used to provide deployment plan for the web module are from the schema <span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> which is the schema for <tt>geronimo-web.xml</tt>. Similarly, the xml elements used to provide ejb deployment plan are from the schema <span class="nobr"><a href="http://openejb.apache.org/xml/ns/openejb-jar-2.2" title="Visit page outside Confluence" rel="nofollow">http://openejb.apache.org/xml/ns/openejb-jar-2.2<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> which is the schema for <tt>openejb-jar.xml</tt>. Hence, <tt>geronimo-application.xml</tt> borrows elements from all other schemas to provide deployment plan for its sub modules.</p>

<p>Also, observe that, in the <tt>geronimo-application.xml</tt>, along with moduleId configuration for the <tt>EAR</tt> itself, there is a moduleId configuration for each web and ejb modules. If the above <tt>EAR</tt> file deployed on the server and the configurations are listed, the following output would be displayed on the console.</p>

<p><font color="white"><br/>
<div class="preformatted" style="border-style: solid; "><div class="preformattedContent" style="background-color: #000000; ">
<pre>C:\Geronimo-2.1\bin&gt;deploy.bat --user system --password manager list-modules
Using GERONIMO_BASE:   C:\Geronimo-2.1
Using GERONIMO_HOME:   C:\Geronimo-2.1
Using GERONIMO_TMPDIR: var\temp
Using JRE_HOME:        C:\sun\jre
Found 92 modules
  + Order/OrderEAR/5.0/car
      `-&gt; OrderWEB.war
      `-&gt; OrderEJB.jar
  + console.dbpool/OrderDS/1.0/rar
 </pre>
</div></div></font></p>

<p>The moduleId <tt>Order/OrderEAR/5.0/car</tt> is the configuration for the <tt>Order.ear</tt>. The ejb module declares a dependency on the <tt>console.dbpool/OrderDS/1.0/rar</tt> configuration in <tt>&lt;sys:dependencies&gt;</tt> section. This is the moduleId of the database pool that connects to the DB2 database where the order details are stored.</p>

<h2><a name="Deploymentplans-JEEApplicationClientdeploymentplan"></a>JEE Application Client deployment plan</h2>

<p>JEE application client modules run in client container and also have access to server environment. Usually, JEE client applications are created to administer the running enterprise applications in the server. Client modules run in a separate JVM and connect to enterprise application resources but have access to all the application resources in standard JEE way.</p>

<p>The JEE client module requires <span class="nobr"><a href="http://java.sun.com/xml/ns/javaee/application-client_5.xsd" title="Visit page outside Confluence" rel="nofollow">application-client.xml<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> as deployment descriptor and <span class="nobr"><a href="http://geronimo.apache.org/schemas-2.1/docs/geronimo-application-client-2.0.xsd.html" title="Visit page outside Confluence" rel="nofollow">geronimo-application-client.xml<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> as deployment plan. In the <tt>application-client.xml</tt>, the required ejb names, security role names, resources names etc., are declared while in <tt>geronimo-application-client.xml</tt>, the declared names are mapped to actual resources in server.</p>

<p>The following is the deployment descriptor of the JEE application client module that looks up an ejb and calls a method on it. The ejb converts the Indian Rupess (Rs.) into American Dollars ($). The client sends a double value which is Indian Rupees to ejb. The ejb returns equivalent American Dollars as double value. </p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>application-client.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>

&lt;application-client xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span> 
  <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> 
  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
  http://java.sun.com/xml/ns/javaee/application-client_5.xsd"
  version=<span class="code-quote">"5"</span>&gt;
    
  <span class="code-tag">&lt;ejb-ref&gt;</span>
    <span class="code-tag">&lt;ejb-ref-name&gt;</span>ejb/Converter<span class="code-tag">&lt;/ejb-ref-name&gt;</span>
    <span class="code-tag">&lt;ejb-ref-type&gt;</span>Session<span class="code-tag">&lt;/ejb-ref-type&gt;</span>
    <span class="code-tag">&lt;remote&gt;</span>examples.appclient.Converter<span class="code-tag">&lt;/remote&gt;</span>
  <span class="code-tag">&lt;/ejb-ref&gt;</span>

<span class="code-tag">&lt;/application-client&gt;</span></pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://java.sun.com/xml/ns/javaee" title="Visit page outside Confluence" rel="nofollow">http://java.sun.com/xml/ns/javaee<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace. Hence, in the above XML document, all the XML elements belong to the default namespace.</td></tr></table>
<p>The application client declares the ejb name <tt>ejb/Converter</tt> through <tt>&lt;ejb-ref&gt;&gt;</tt> .. <tt>&lt;/ejb-ref&gt;</tt> elements.</p>

<p>Following is the corresponding deployment plan of the JEE client module.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>geronimo-application-client.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>

&lt;application-client xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/application-client-2.0"</span>
  <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>
  <span class="code-keyword">xmlns:naming</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/naming-1.2"</span>
  <span class="code-keyword">xmlns:security</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/security-2.0"</span>
  <span class="code-keyword">xmlns:connector</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"</span>&gt;
 
 <span class="code-tag">&lt;sys:client-environment&gt;</span>
  <span class="code-tag">&lt;sys:moduleId&gt;</span>
  <span class="code-tag">&lt;sys:groupId&gt;</span>Converter<span class="code-tag">&lt;/sys:groupId&gt;</span>
  <span class="code-tag">&lt;sys:artifactId&gt;</span>Converter-app-client<span class="code-tag">&lt;/sys:artifactId&gt;</span>
  <span class="code-tag">&lt;sys:version&gt;</span>3.0<span class="code-tag">&lt;/sys:version&gt;</span>
  <span class="code-tag">&lt;sys:type&gt;</span>jar<span class="code-tag">&lt;/sys:type&gt;</span>
  <span class="code-tag">&lt;/sys:moduleId&gt;</span>
<span class="code-tag">&lt;/sys:client-environment&gt;</span>
  
  <span class="code-tag">&lt;sys:server-environment&gt;</span> 
   <span class="code-tag">&lt;sys:moduleId&gt;</span>
   <span class="code-tag">&lt;sys:groupId&gt;</span>Converter<span class="code-tag">&lt;/sys:groupId&gt;</span>
   <span class="code-tag">&lt;sys:artifactId&gt;</span>Converter-app-client-server<span class="code-tag">&lt;/sys:artifactId&gt;</span>
   <span class="code-tag">&lt;sys:version&gt;</span>3.0<span class="code-tag">&lt;/sys:version&gt;</span>
   <span class="code-tag">&lt;sys:type&gt;</span>jar<span class="code-tag">&lt;/sys:type&gt;</span>
   <span class="code-tag">&lt;/sys:moduleId&gt;</span>    		
  <span class="code-tag">&lt;/sys:server-environment&gt;</span> 
    
     <span class="code-tag">&lt;ejb-ref&gt;</span>
     	<span class="code-tag">&lt;ref-name&gt;</span>ejb/Converter<span class="code-tag">&lt;/ref-name&gt;</span>
     	<span class="code-tag">&lt;naming:pattern&gt;</span>
         <span class="code-tag">&lt;naming:groupId&gt;</span>Converter<span class="code-tag">&lt;/naming:groupId&gt;</span>
         <span class="code-tag">&lt;naming:artifactId&gt;</span>ConverterEAR<span class="code-tag">&lt;/naming:artifactId&gt;</span>
         <span class="code-tag">&lt;naming:version&gt;</span>5.0<span class="code-tag">&lt;/naming:version&gt;</span>
         <span class="code-tag">&lt;naming:module&gt;</span>ConverterEJB.jar<span class="code-tag">&lt;/naming:module&gt;</span>
         <span class="code-tag">&lt;naming:name&gt;</span>ConverterBean<span class="code-tag">&lt;/naming:name&gt;</span>
       <span class="code-tag">&lt;/naming:pattern&gt;</span>
     <span class="code-tag">&lt;/ejb-ref&gt;</span>
     
<span class="code-tag">&lt;/application-client&gt;</span></pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>The default namespace of the above XML document is <tt><span class="nobr"><a href="http://geronimo.apache.org/xml/ns/j2ee/application-client-2.0" title="Visit page outside Confluence" rel="nofollow">http://geronimo.apache.org/xml/ns/j2ee/application-client-2.0<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>. The XML elements that do not have a namespace prefix belong to the default namespace. Hence, in the above XML document, <tt>&lt;application-client&gt;</tt>, <tt>&lt;ejb-ref&gt;</tt> and <tt>&lt;ref-name&gt;</tt> elements belong to the default namespace.</td></tr></table>

<p>Observe the various xml elements and schemas to which they belong. The plan defines the client environment and the server environment configurations. The server environment configuration runs in the server where as the client environment configuration runs in the client JVM. In the above plan, the ejb name <tt>ejb/Converter</tt> is mapped to <tt>ConverterBean</tt> ejb in the <tt>ConverterEAR</tt>.</p>

<p>The below is the client code that looks up the ejb and calls the method on it.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>ConverterClient.java</b></div><div class="codeContent">
<pre class="code-java"><span class="code-keyword">package</span> examples.appclient.client;
<span class="code-keyword">import</span> javax.naming.Context;
<span class="code-keyword">import</span> javax.naming.InitialContext;
<span class="code-keyword">import</span> examples.appclient.Converter;

<span class="code-keyword">public</span> class ConverterClient {

 <span class="code-comment">//The remote <span class="code-keyword">interface</span> of the ConverterBean packaged with the
</span> <span class="code-comment">//JEE client jar
</span>   <span class="code-keyword">private</span> <span class="code-keyword">static</span> Converter converter;

   <span class="code-keyword">private</span> <span class="code-keyword">static</span> <span class="code-object">double</span> amount = 50;
   <span class="code-keyword">public</span> <span class="code-keyword">static</span> void main(<span class="code-object">String</span>[] args) {
    amount = <span class="code-object">Double</span>.parseDouble(args[0]);
    doConversion();
   }

    <span class="code-keyword">public</span> <span class="code-keyword">static</span> void doConversion() {
     <span class="code-keyword">try</span> {
            
        Context context = <span class="code-keyword">new</span> InitialContext();
        converter = (Converter) 
                 context.lookup(<span class="code-quote">"java:comp/env/ejb/Converter"</span>);
        <span class="code-object">double</span> dollars = converter.getDollars(amount);
        <span class="code-object">System</span>.out.println(<span class="code-quote">"Rs "</span> + amount + <span class="code-quote">" is "</span> + dollars + <span class="code-quote">" Dollars."</span>);
        <span class="code-object">System</span>.exit(0);
            
        } <span class="code-keyword">catch</span> (Exception ex) {
            <span class="code-object">System</span>.err.println(<span class="code-quote">"Caught an unexpected exception!"</span>);
            ex.printStackTrace();
        }
    }
}</pre>
</div></div>
<p>The <tt>META-INF/MANIFEST.MF</tt> file should contain the following entry for the client to run.</p>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>MANIFEST.MF</b></div><div class="codeContent">
<pre class="code-xml">Manifest-Version: 1.0
Main-Class: examples.appclient.client.ConverterClient</pre>
</div></div>
<table cellpadding='5' width='85%' cellspacing='8px' class='warningMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/forbidden.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Do not forget to insert a new line after the Main-Class: entry in the MANIFEST.MF  file.</td></tr></table>

<p>The JEE client is created by packaging <tt>META-INF/application-client.xml</tt>, <tt>META-INF/geronimo-application-client.xml</tt>, <tt>ConverterClient.class</tt>, <tt>Converter.class</tt> and <tt>META-INF/MANIFEST.MF</tt> files into a jar file.</p>

<p>The following command illustrates the packaging.<br/>
<font color="white"><br/>
<div class="preformatted" style="border-style: solid; "><div class="preformattedContent" style="background-color: #000000; ">
<pre>C:\temp\ConverterEJBClient&gt;jar -cvf ConverterEJBClient.jar *
added manifest
adding: examples/(in = 0) (out= 0)(stored 0%)
adding: examples/appclient/(in = 0) (out= 0)(stored 0%)
adding: examples/appclient/client/(in = 0) (out= 0)(stored 0%)
adding: examples/appclient/client/ConverterClient.class(in = 1716) (out= 936)(deflated 45%)
adding: examples/appclient/Converter.class(in = 146) (out= 131)(deflated 10%)
adding: META-INF/application-client.xml(in = 510) (out= 252)(deflated 50%)
adding: META-INF/geronimo-application-client.xml(in = 2049) (out= 474)(deflated 76%)
ignoring entry META-INF/MANIFEST.MF
</pre>
</div></div></font></p>

<p>The following commands illustrates the deployment and running of the client module.<br/>
<font color="white"><br/>
<div class="preformatted" style="border-style: solid; "><div class="preformattedContent" style="background-color: #000000; ">
<pre>C:\\Geronimo-2.1\bin&gt;deploy.bat --user system --password manager deploy C:\temp\ConverterEJBClient.jar
Using GERONIMO_BASE:   C:\Geronimo-2.1
Using GERONIMO_HOME:   C:\Geronimo-2.1
Using GERONIMO_TMPDIR: var\temp
Using JRE_HOME:        C:\JDK\jre
    Deployed Converter/Converter-app-client-server/3.0/jar

C:\Geronimo-2.1\bin&gt;java -Djava.endorsed.dirs="C:\Geronimo-2.1\lib\endorsed" -jar
              C:\Geronimo-2.1\bin\client.jar Converter/Converter-app-client/3.0/jar 4000

Rs 4000.0 is 100.0 Dollars.
</pre>
</div></div></font></p>

<h2><a name="Deploymentplans-MessageDrivenBeandeploymentplan."></a>Message Driven Bean deployment plan.</h2>

<p>Apache geronimo ships with <span class="nobr"><a href="http://activemq.apache.org" title="Visit page outside Confluence" rel="nofollow">ActiveMQ<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span> message broker and an inbound and outbound JMS resource adapter for the ActiveMQ broker. This sample illustrates deploying and running two MDBs that listen to a jms topic <tt>TextTopic</tt>. When the web client publishes a message to this topic,  the two MDBs receive the message and process it. Because the message is published to the topic, all the configured listeners, in this case the two MDBs, receive a copy of the message. In addition to that, we will also illustrate how to deploy a JMS resource adapter within the application scope. Usually, the resource adapters are deployed at the server scope and can be used by all other applications as well. In this example, a JMS resource plan is embedded in the application deployment plan <tt>geronimo-application.xml</tt> and deployed while deploying the application archive. </p>


<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>ejb-jar.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span> ?&gt;</span> 
<span class="code-tag">&lt;ejb-jar&gt;</span>
 <span class="code-tag">&lt;enterprise-beans&gt;</span>

  <span class="code-tag">&lt;message-driven&gt;</span>
  <span class="code-tag">&lt;ejb-name&gt;</span>TextMessageBean1<span class="code-tag">&lt;/ejb-name&gt;</span>
  <span class="code-tag">&lt;ejb-class&gt;</span>
   sample.mdb.TextMessageBean1
  <span class="code-tag">&lt;/ejb-class&gt;</span> 
  <span class="code-tag">&lt;messaging-type&gt;</span>
   javax.jms.MessageListener
  <span class="code-tag">&lt;/messaging-type&gt;</span>
  <span class="code-tag">&lt;transaction-type&gt;</span>Bean<span class="code-tag">&lt;/transaction-type&gt;</span>
  <span class="code-tag">&lt;message-destination-type&gt;</span>
   javax.jms.Topic
  <span class="code-tag">&lt;/message-destination-type&gt;</span>
  
  <span class="code-tag">&lt;activation-config&gt;</span>
   <span class="code-tag">&lt;activation-config-property&gt;</span>
    <span class="code-tag">&lt;activation-config-property-name&gt;</span>
     destinationType
    <span class="code-tag">&lt;/activation-config-property-name&gt;</span>
    <span class="code-tag">&lt;activation-config-property-value&gt;</span>
     javax.jms.Topic
    <span class="code-tag">&lt;/activation-config-property-value&gt;</span>
    <span class="code-tag">&lt;/activation-config-property&gt;</span>
  <span class="code-tag">&lt;/activation-config&gt;</span>
 <span class="code-tag">&lt;/message-driven&gt;</span>
        
 <span class="code-tag">&lt;message-driven&gt;</span>
  <span class="code-tag">&lt;ejb-name&gt;</span>TextMessageBean2<span class="code-tag">&lt;/ejb-name&gt;</span>
  <span class="code-tag">&lt;ejb-class&gt;</span>
   sample.mdb.TextMessageBean2
  <span class="code-tag">&lt;/ejb-class&gt;</span> 
  <span class="code-tag">&lt;messaging-type&gt;</span>
   javax.jms.MessageListener
  <span class="code-tag">&lt;/messaging-type&gt;</span>
  <span class="code-tag">&lt;transaction-type&gt;</span>Bean<span class="code-tag">&lt;/transaction-type&gt;</span>
  <span class="code-tag">&lt;message-destination-type&gt;</span>
   javax.jms.Topic
  <span class="code-tag">&lt;/message-destination-type&gt;</span>
  
  <span class="code-tag">&lt;activation-config&gt;</span>
   <span class="code-tag">&lt;activation-config-property&gt;</span>
   <span class="code-tag">&lt;activation-config-property-name&gt;</span>
    destinationType
   <span class="code-tag">&lt;/activation-config-property-name&gt;</span>
   <span class="code-tag">&lt;activation-config-property-value&gt;</span>
    javax.jms.Topic
   <span class="code-tag">&lt;/activation-config-property-value&gt;</span>
   <span class="code-tag">&lt;/activation-config-property&gt;</span>
  <span class="code-tag">&lt;/activation-config&gt;</span>
 <span class="code-tag">&lt;/message-driven&gt;</span>

<span class="code-tag">&lt;/enterprise-beans&gt;</span>
<span class="code-tag">&lt;/ejb-jar&gt;</span></pre>
</div></div>

<p>The <tt>ejb-jar.xml</tt> declares the two MDBs <tt>sample.mdb.TextMessageBean1</tt> and <tt>sample.mdb.TextMessageBean2</tt> both listen to a javax.jms.Topic destination. </p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>openejb-jar.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;openejb-jar xmlns=<span class="code-quote">"http://openejb.apache.org/xml/ns/openejb-jar-2.2"</span> 
  <span class="code-keyword">xmlns:nam</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/naming-1.2"</span> 
  <span class="code-keyword">xmlns:sec</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/security-2.0"</span> 
  <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;
  
  <span class="code-tag">&lt;sys:environment&gt;</span>
    <span class="code-tag">&lt;sys:moduleId&gt;</span>
      <span class="code-tag">&lt;sys:groupId&gt;</span>Sample<span class="code-tag">&lt;/sys:groupId&gt;</span>
      <span class="code-tag">&lt;sys:artifactId&gt;</span>MDB-EJB<span class="code-tag">&lt;/sys:artifactId&gt;</span>
      <span class="code-tag">&lt;sys:version&gt;</span>1.0<span class="code-tag">&lt;/sys:version&gt;</span>
      <span class="code-tag">&lt;sys:type&gt;</span>car<span class="code-tag">&lt;/sys:type&gt;</span>
    <span class="code-tag">&lt;/sys:moduleId&gt;</span>
  <span class="code-tag">&lt;/sys:environment&gt;</span>
  
  <span class="code-tag">&lt;enterprise-beans&gt;</span>

   <span class="code-tag">&lt;message-driven&gt;</span>
    <span class="code-tag">&lt;ejb-name&gt;</span>
     TextMessageBean1
    <span class="code-tag">&lt;/ejb-name&gt;</span>
    <span class="code-tag">&lt;nam:resource-adapter&gt;</span>
     <span class="code-tag">&lt;nam:resource-link&gt;</span>
      TradeJMSResources
     <span class="code-tag">&lt;/nam:resource-link&gt;</span>
    <span class="code-tag">&lt;/nam:resource-adapter&gt;</span>

    <span class="code-tag">&lt;activation-config&gt;</span>

     <span class="code-tag">&lt;activation-config-property&gt;</span>
      <span class="code-tag">&lt;activation-config-property-name&gt;</span>
       destination
      <span class="code-tag">&lt;/activation-config-property-name&gt;</span>
      <span class="code-tag">&lt;activation-config-property-value&gt;</span>
       TextMessageTopic
      <span class="code-tag">&lt;/activation-config-property-value&gt;</span>
     <span class="code-tag">&lt;/activation-config-property&gt;</span>
      <span class="code-tag">&lt;activation-config-property&gt;</span>
       <span class="code-tag">&lt;activation-config-property-name&gt;</span>
        destinationType
       <span class="code-tag">&lt;/activation-config-property-name&gt;</span>
       <span class="code-tag">&lt;activation-config-property-value&gt;</span>
        javax.jms.Topic<span class="code-tag">&lt;/activation-config-property-value&gt;</span>
       <span class="code-tag">&lt;/activation-config-property&gt;</span>

      <span class="code-tag">&lt;/activation-config&gt;</span>
     <span class="code-tag">&lt;/message-driven&gt;</span>    
    
    <span class="code-tag">&lt;message-driven&gt;</span>
     <span class="code-tag">&lt;ejb-name&gt;</span>TextMessageBean2<span class="code-tag">&lt;/ejb-name&gt;</span>
      <span class="code-tag">&lt;nam:resource-adapter&gt;</span>
       <span class="code-tag">&lt;nam:resource-link&gt;</span>
        TradeJMSResources
       <span class="code-tag">&lt;/nam:resource-link&gt;</span>
       <span class="code-tag">&lt;/nam:resource-adapter&gt;</span>

       <span class="code-tag">&lt;activation-config&gt;</span>

        <span class="code-tag">&lt;activation-config-property&gt;</span>
         <span class="code-tag">&lt;activation-config-property-name&gt;</span>
          destination
         <span class="code-tag">&lt;/activation-config-property-name&gt;</span>
          <span class="code-tag">&lt;activation-config-property-value&gt;</span>
           TextMessageTopic
          <span class="code-tag">&lt;/activation-config-property-value&gt;</span>
        <span class="code-tag">&lt;/activation-config-property&gt;</span>

        <span class="code-tag">&lt;activation-config-property&gt;</span>
          <span class="code-tag">&lt;activation-config-property-name&gt;</span>
           destinationType
         <span class="code-tag">&lt;/activation-config-property-name&gt;</span>
          <span class="code-tag">&lt;activation-config-property-value&gt;</span>
           javax.jms.Topic
          <span class="code-tag">&lt;/activation-config-property-value&gt;</span>
        <span class="code-tag">&lt;/activation-config-property&gt;</span>

      <span class="code-tag">&lt;/activation-config&gt;</span>
    <span class="code-tag">&lt;/message-driven&gt;</span> 
 
  <span class="code-tag">&lt;/enterprise-beans&gt;</span>
<span class="code-tag">&lt;/openejb-jar&gt;</span></pre>
</div></div>

<p>In the deployment plan <tt>openejb-jar.xml</tt>, the two MDBs are configured as end point listeners for the jms topic <tt>TextMessageTopic</tt>. </p>

<p>The code for the two MDBs are as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>TextMessageBean1.java</b></div><div class="codeContent">
<pre class="code-java"><span class="code-keyword">package</span> sample.mdb;
<span class="code-keyword">import</span> javax.jms.JMSException;
<span class="code-keyword">import</span> javax.jms.Message;
<span class="code-keyword">import</span> javax.jms.TextMessage;

<span class="code-keyword">public</span> class TextMessageBean1 {
 
 <span class="code-keyword">public</span> TextMessageBean1() {
 }
 
 <span class="code-keyword">public</span> void onMessage(Message msg) {
  <span class="code-keyword">if</span> (msg <span class="code-keyword">instanceof</span> TextMessage) {
   TextMessage tm = (TextMessage) msg;
   <span class="code-keyword">try</span> {
    <span class="code-object">String</span> text = tm.getText();
    <span class="code-object">System</span>.out.println("Received <span class="code-keyword">new</span> message 
                        in TextMessageBean1 : " 
                        + text);
    <span class="code-object">System</span>.out.println(<span class="code-quote">"CustomerId : "</span> + 
                   tm.getIntProperty(<span class="code-quote">"CustomerId"</span>));
    <span class="code-object">System</span>.out.println(<span class="code-quote">"CustomerName : "</span> +
                   tm.getStringProperty(<span class="code-quote">"CustomerName"</span>));
   } <span class="code-keyword">catch</span> (JMSException e) {
      e.printStackTrace();
   }
  }
 }
}</pre>
</div></div>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>TextMessageBean2.java</b></div><div class="codeContent">
<pre class="code-java"><span class="code-keyword">package</span> sample.mdb;
<span class="code-keyword">import</span> javax.jms.JMSException;
<span class="code-keyword">import</span> javax.jms.Message;
<span class="code-keyword">import</span> javax.jms.TextMessage;

<span class="code-keyword">public</span> class TextMessageBean2 {
 
 <span class="code-keyword">public</span> TextMessageBean2() {
 }
 
 <span class="code-keyword">public</span> void onMessage(Message msg) {
  <span class="code-keyword">if</span> (msg <span class="code-keyword">instanceof</span> TextMessage) {
   TextMessage tm = (TextMessage) msg;
   <span class="code-keyword">try</span> {
    <span class="code-object">String</span> text = tm.getText();
    <span class="code-object">System</span>.out.println("Received <span class="code-keyword">new</span> message 
                        in TextMessageBean2 : " 
                        + text);
    <span class="code-object">System</span>.out.println(<span class="code-quote">"CustomerId : "</span> + 
                   tm.getIntProperty(<span class="code-quote">"CustomerId"</span>));
    <span class="code-object">System</span>.out.println(<span class="code-quote">"CustomerName : "</span> +
                   tm.getStringProperty(<span class="code-quote">"CustomerName"</span>));
   } <span class="code-keyword">catch</span> (JMSException e) {
      e.printStackTrace();
   }
  }
 }
}</pre>
</div></div>

<p>After receiving the message, the MDBs just print the contents of the message.</p>

<p>The web client for the application is as follows.</p>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>web.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;web-app 
 <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> 
 xmlns=<span class="code-quote">"http://java.sun.com/xml/ns/javaee"</span> 
 <span class="code-keyword">xmlns:web</span>=<span class="code-quote">"http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"</span>
 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
 http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
 id=<span class="code-quote">"WebApp_ID"</span> version=<span class="code-quote">"2.5"</span>&gt;

 <span class="code-tag">&lt;display-name&gt;</span>MDBSampleWEB<span class="code-tag">&lt;/display-name&gt;</span>
  <span class="code-tag">&lt;welcome-file-list&gt;</span>
    <span class="code-tag">&lt;welcome-file&gt;</span>index.html<span class="code-tag">&lt;/welcome-file&gt;</span>
    <span class="code-tag">&lt;welcome-file&gt;</span>index.htm<span class="code-tag">&lt;/welcome-file&gt;</span>
    <span class="code-tag">&lt;welcome-file&gt;</span>index.jsp<span class="code-tag">&lt;/welcome-file&gt;</span>
  <span class="code-tag">&lt;/welcome-file-list&gt;</span>
  <span class="code-tag">&lt;servlet&gt;</span>
    <span class="code-tag">&lt;description&gt;</span><span class="code-tag">&lt;/description&gt;</span>
    <span class="code-tag">&lt;display-name&gt;</span>Test<span class="code-tag">&lt;/display-name&gt;</span>
    <span class="code-tag">&lt;servlet-name&gt;</span>Test<span class="code-tag">&lt;/servlet-name&gt;</span>
    <span class="code-tag">&lt;servlet-class&gt;</span>sample.mdb.Test<span class="code-tag">&lt;/servlet-class&gt;</span>
  <span class="code-tag">&lt;/servlet&gt;</span>
  
  <span class="code-tag">&lt;resource-ref&gt;</span>
   <span class="code-tag">&lt;description&gt;</span>jms broker<span class="code-tag">&lt;/description&gt;</span>
   <span class="code-tag">&lt;res-ref-name&gt;</span>jms/broker<span class="code-tag">&lt;/res-ref-name&gt;</span>
   <span class="code-tag">&lt;res-type&gt;</span>
     javax.jms.TopicConnectionFactory
    <span class="code-tag">&lt;/res-type&gt;</span>
    <span class="code-tag">&lt;res-auth&gt;</span>Container<span class="code-tag">&lt;/res-auth&gt;</span>
   <span class="code-tag">&lt;/resource-ref&gt;</span>
   
   <span class="code-tag">&lt;resource-env-ref&gt;</span>
    <span class="code-tag">&lt;description&gt;</span>Predefined Topic<span class="code-tag">&lt;/description&gt;</span>
    <span class="code-tag">&lt;resource-env-ref-name&gt;</span>
     jms/Topic/TextTopic
    <span class="code-tag">&lt;/resource-env-ref-name&gt;</span>
    <span class="code-tag">&lt;resource-env-ref-type&gt;</span>
     javax.jms.Topic<span class="code-tag">&lt;/resource-env-ref-type&gt;</span>
    <span class="code-tag">&lt;/resource-env-ref&gt;</span>
   
    <span class="code-tag">&lt;servlet-mapping&gt;</span>
     <span class="code-tag">&lt;servlet-name&gt;</span>Test<span class="code-tag">&lt;/servlet-name&gt;</span>
     <span class="code-tag">&lt;url-pattern&gt;</span>/Test<span class="code-tag">&lt;/url-pattern&gt;</span>
    <span class="code-tag">&lt;/servlet-mapping&gt;</span>
  <span class="code-tag">&lt;/web-app&gt;</span></pre>
</div></div>

<p>The web client declares the <tt>javax.jms.TopicConnectionFactory</tt> and the topic to which the servlet has to publish the message. The names declared here are mapped to actual resources in the <tt>geronimo-web.xml</tt> as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>geronimo-web.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;web-app 
  xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/web-2.0.1"</span> 
  <span class="code-keyword">xmlns:nam</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/naming-1.2"</span> 
  <span class="code-keyword">xmlns:sec</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/security-2.0"</span> 
  <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span>&gt;
  
 <span class="code-tag">&lt;sys:environment&gt;</span>
  <span class="code-tag">&lt;sys:moduleId&gt;</span>
   <span class="code-tag">&lt;sys:groupId&gt;</span>sample<span class="code-tag">&lt;/sys:groupId&gt;</span>
   <span class="code-tag">&lt;sys:artifactId&gt;</span>MDB-Web<span class="code-tag">&lt;/sys:artifactId&gt;</span>
   <span class="code-tag">&lt;sys:version&gt;</span>1.0<span class="code-tag">&lt;/sys:version&gt;</span>
   <span class="code-tag">&lt;sys:type&gt;</span>car<span class="code-tag">&lt;/sys:type&gt;</span>
  <span class="code-tag">&lt;/sys:moduleId&gt;</span>
 <span class="code-tag">&lt;/sys:environment&gt;</span>

 <span class="code-tag">&lt;context-root&gt;</span>/MDBSampleWEB<span class="code-tag">&lt;/context-root&gt;</span>

 <span class="code-tag">&lt;nam:resource-ref&gt;</span>
  <span class="code-tag">&lt;nam:ref-name&gt;</span>
   jms/broker<span class="code-tag">&lt;/nam:ref-name&gt;</span>
  <span class="code-tag">&lt;nam:resource-link&gt;</span>
   jms/TopicConnectionFactory
  <span class="code-tag">&lt;/nam:resource-link&gt;</span>
  <span class="code-tag">&lt;/nam:resource-ref&gt;</span>
  <span class="code-tag">&lt;nam:resource-env-ref&gt;</span>
   <span class="code-tag">&lt;nam:ref-name&gt;</span>
    jms/Topic/TextTopic
   <span class="code-tag">&lt;/nam:ref-name&gt;</span>
  <span class="code-tag">&lt;nam:message-destination-link&gt;</span>
   TextMessageTopic
  <span class="code-tag">&lt;/nam:message-destination-link&gt;</span>
  <span class="code-tag">&lt;/nam:resource-env-ref&gt;</span>
<span class="code-tag">&lt;/web-app&gt;</span></pre>
</div></div>



<p>Please note that the <tt>jms/TopicConnectionFactory</tt> and <tt>jms/Topic/TextTopic</tt> are the names of the actual connection factory and jms topic. These are deployed by a jms resource plan embedded in the EAR's deployment plan as follows.</p>

<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>application.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"ASCII"</span>?&gt;</span>
&lt;application 
 <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> 
 xmlns=http://java.sun.com/xml/ns/javaee
 <span class="code-keyword">xmlns:app</span>=<span class="code-quote">"http://java.sun.com/xml/ns/javaee/application_5.xsd"</span> 
 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
  http://java.sun.com/xml/ns/javaee/application_5.xsd" 
 version=<span class="code-quote">"5"</span>&gt;
 
 <span class="code-tag">&lt;display-name&gt;</span>MDBSampleEAR<span class="code-tag">&lt;/display-name&gt;</span>
  <span class="code-tag">&lt;module&gt;</span>
    <span class="code-tag">&lt;ejb&gt;</span>MDBSampleEJB.jar<span class="code-tag">&lt;/ejb&gt;</span>
  <span class="code-tag">&lt;/module&gt;</span>
  <span class="code-tag">&lt;module&gt;</span>
    <span class="code-tag">&lt;web&gt;</span>
      <span class="code-tag">&lt;web-uri&gt;</span>MDBSampleWEB.war<span class="code-tag">&lt;/web-uri&gt;</span>
      <span class="code-tag">&lt;context-root&gt;</span>MDBSampleWEB<span class="code-tag">&lt;/context-root&gt;</span>
    <span class="code-tag">&lt;/web&gt;</span>
  <span class="code-tag">&lt;/module&gt;</span>
<span class="code-tag">&lt;/application&gt;</span></pre>
</div></div>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>geronimo-application.xml</b></div><div class="codeContent">
<pre class="code-xml"><span class="code-tag">&lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span>?&gt;</span>
&lt;application 
  xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/application-2.0"</span> 
  <span class="code-keyword">xmlns:sys</span>=<span class="code-quote">"http://geronimo.apache.org/xml/ns/deployment-1.2"</span> 
  application-name=<span class="code-quote">"MDBSampleEAR"</span>&gt;

  <span class="code-tag">&lt;sys:environment&gt;</span>
    <span class="code-tag">&lt;sys:moduleId&gt;</span>
      <span class="code-tag">&lt;sys:groupId&gt;</span>default<span class="code-tag">&lt;/sys:groupId&gt;</span>
      <span class="code-tag">&lt;sys:artifactId&gt;</span>MDBSampleEAR<span class="code-tag">&lt;/sys:artifactId&gt;</span>
      <span class="code-tag">&lt;sys:version&gt;</span>1.0<span class="code-tag">&lt;/sys:version&gt;</span>
      <span class="code-tag">&lt;sys:type&gt;</span>car<span class="code-tag">&lt;/sys:type&gt;</span>
    <span class="code-tag">&lt;/sys:moduleId&gt;</span>
  <span class="code-tag">&lt;/sys:environment&gt;</span>
  
  <span class="code-tag">&lt;ext-module&gt;</span>
    <span class="code-tag">&lt;connector&gt;</span>TopicJMSSample<span class="code-tag">&lt;/connector&gt;</span>
    <span class="code-tag">&lt;external-path&gt;</span>
     <span class="code-tag">&lt;sys:groupId&gt;</span>
      org.apache.geronimo.modules
     <span class="code-tag">&lt;/sys:groupId&gt;</span>
       <span class="code-tag">&lt;sys:artifactId&gt;</span>
        geronimo-activemq-ra
       <span class="code-tag">&lt;/sys:artifactId&gt;</span>
       <span class="code-tag">&lt;sys:version&gt;</span>2.1<span class="code-tag">&lt;/sys:version&gt;</span>
    <span class="code-tag">&lt;/external-path&gt;</span>
    &lt;connector 
     xmlns=<span class="code-quote">"http://geronimo.apache.org/xml/ns/j2ee/connector-1.2"</span>&gt;
     <span class="code-tag">&lt;resourceadapter&gt;</span>
      <span class="code-tag"><span class="code-comment">&lt;!--how to connect to the JMS Server--&gt;</span></span>
      <span class="code-tag">&lt;resourceadapter-instance&gt;</span>
       <span class="code-tag">&lt;resourceadapter-name&gt;</span>
         TradeJMSResources
       <span class="code-tag">&lt;/resourceadapter-name&gt;</span>
       <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"ServerUrl"</span>&gt;</span>
         tcp://localhost:61616
       <span class="code-tag">&lt;/config-property-setting&gt;</span>
       <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"UserName"</span>&gt;</span>
        not needed
       <span class="code-tag">&lt;/config-property-setting&gt;</span>
       <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"Password"</span>&gt;</span>
        not needed
       <span class="code-tag">&lt;/config-property-setting&gt;</span>
       <span class="code-tag">&lt;workmanager&gt;</span>
        <span class="code-tag">&lt;gbean-link&gt;</span>DefaultWorkManager<span class="code-tag">&lt;/gbean-link&gt;</span>
        <span class="code-tag">&lt;/workmanager&gt;</span>
      <span class="code-tag">&lt;/resourceadapter-instance&gt;</span>
        
      <span class="code-tag"><span class="code-comment">&lt;!--defines a ConnectionFactory--&gt;</span></span>
      <span class="code-tag">&lt;outbound-resourceadapter&gt;</span>
       <span class="code-tag">&lt;connection-definition&gt;</span>
        <span class="code-tag">&lt;connectionfactory-interface&gt;</span>
         javax.jms.ConnectionFactory
        <span class="code-tag">&lt;/connectionfactory-interface&gt;</span>
        <span class="code-tag">&lt;connectiondefinition-instance&gt;</span>
         <span class="code-tag">&lt;name&gt;</span>jms/TopicConnectionFactory<span class="code-tag">&lt;/name&gt;</span>
         <span class="code-tag">&lt;implemented-interface&gt;</span>
          javax.jms.TopicConnectionFactory
         <span class="code-tag">&lt;/implemented-interface&gt;</span>
         <span class="code-tag">&lt;connectionmanager&gt;</span>
          <span class="code-tag">&lt;xa-transaction&gt;</span>
           <span class="code-tag">&lt;transaction-caching/&gt;</span>
          <span class="code-tag">&lt;/xa-transaction&gt;</span>
          <span class="code-tag">&lt;single-pool&gt;</span>
           <span class="code-tag">&lt;max-size&gt;</span>10<span class="code-tag">&lt;/max-size&gt;</span>
           <span class="code-tag">&lt;min-size&gt;</span>0<span class="code-tag">&lt;/min-size&gt;</span>
           <span class="code-tag">&lt;blocking-timeout-milliseconds&gt;</span>
            5000
           <span class="code-tag">&lt;/blocking-timeout-milliseconds&gt;</span>
           <span class="code-tag">&lt;idle-timeout-minutes&gt;</span>0<span class="code-tag">&lt;/idle-timeout-minutes&gt;</span>
           <span class="code-tag">&lt;match-one/&gt;</span>
          <span class="code-tag">&lt;/single-pool&gt;</span>
         <span class="code-tag">&lt;/connectionmanager&gt;</span>
        <span class="code-tag">&lt;/connectiondefinition-instance&gt;</span>
       <span class="code-tag">&lt;/connection-definition&gt;</span>
      <span class="code-tag">&lt;/outbound-resourceadapter&gt;</span>
        
      
     <span class="code-tag">&lt;/resourceadapter&gt;</span>
      <span class="code-tag">&lt;adminobject&gt;</span>
       <span class="code-tag">&lt;adminobject-interface&gt;</span>
         javax.jms.Topic<span class="code-tag">&lt;/adminobject-interface&gt;</span>
       <span class="code-tag">&lt;adminobject-class&gt;</span>
         org.activemq.message.ActiveMQTopic
       <span class="code-tag">&lt;/adminobject-class&gt;</span>
       <span class="code-tag">&lt;adminobject-instance&gt;</span>
        <span class="code-tag">&lt;message-destination-name&gt;</span>
         TextMessageTopic
        <span class="code-tag">&lt;/message-destination-name&gt;</span>
        <span class="code-tag">&lt;config-property-setting name=<span class="code-quote">"PhysicalName"</span>&gt;</span>
         TextMessageTopic
        <span class="code-tag">&lt;/config-property-setting&gt;</span>
       <span class="code-tag">&lt;/adminobject-instance&gt;</span>
      <span class="code-tag">&lt;/adminobject&gt;</span>
     <span class="code-tag">&lt;/connector&gt;</span>
    <span class="code-tag">&lt;/ext-module&gt;</span>
<span class="code-tag">&lt;/application&gt;</span></pre>
</div></div>

<p>The plan for resource adapter is provided under <tt>&lt;ext-module&gt;</tt> xml elements. Also, the resource adapter archive <tt>(rar)</tt> file to be used to deploy the plan is mentioned using <tt>external-path</tt> xml element; the resource adapter plan follows these elements. The plan deploys{{ jms/TopicConnectionFactory}} and <tt>TextTopic</tt>.</p>

<table cellpadding='5' width='85%' cellspacing='8px' class='noteMacro' border="0" align='center'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/confluence/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>
<p>The reference to resource archive file is provided using the following xml elements in the above plan.</p>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>Referencing Libraries</b></div><div class="codeContent">
<pre class="code-java">&lt;external-path&gt;
     &lt;sys:groupId&gt;
      org.apache.geronimo.modules
     &lt;/sys:groupId&gt;
       &lt;sys:artifactId&gt;
        geronimo-activemq-ra
       &lt;/sys:artifactId&gt;
       &lt;sys:version&gt;2.1&lt;/sys:version&gt;
    &lt;/external-path&gt;</pre>
</div></div>
<p>The above pattern is the way how geronimo references various libraries available in the server repository. Any external libraries can also be uploaded to server repository using admin console portlet. After starting the server, click on <tt>Console Navigation =&gt; Services =&gt; Repository</tt> to display <tt>Repository Viewer</tt> portlet. In this portlet, users can upload required third party libraries by providing proper <tt>groupId, artifactId and version</tt> values for the libraries being uploaded. The activeMQ rar file is also available in the repository as <tt>org.apache.geronimo.modules/geronimo-activemq-ra/2.1/rar</tt>. Click on this link to get the usage instructions on how to reference this library in other modules.</p></td></tr></table>

<p>The web client that look up the connection factory and topic and sends messages is as follows.</p>
<div class="code" style="border-style: solid; "><div class="codeHeader" style="border-bottom-style: solid; "><b>Test.java</b></div><div class="codeContent">
<pre class="code-java"><span class="code-keyword">package</span> sample.mdb;

<span class="code-keyword">import</span> java.io.IOException;
<span class="code-keyword">import</span> java.io.PrintWriter;

<span class="code-keyword">import</span> javax.jms.DeliveryMode;
<span class="code-keyword">import</span> javax.jms.Session;
<span class="code-keyword">import</span> javax.jms.TextMessage;
<span class="code-keyword">import</span> javax.jms.Topic;
<span class="code-keyword">import</span> javax.jms.TopicConnection;
<span class="code-keyword">import</span> javax.jms.TopicConnectionFactory;
<span class="code-keyword">import</span> javax.jms.TopicPublisher;
<span class="code-keyword">import</span> javax.jms.TopicSession;
<span class="code-keyword">import</span> javax.naming.InitialContext;
<span class="code-keyword">import</span> javax.servlet.ServletException;
<span class="code-keyword">import</span> javax.servlet.http.HttpServletRequest;
<span class="code-keyword">import</span> javax.servlet.http.HttpServletResponse;
<span class="code-keyword">import</span> javax.jms.Connection;

<span class="code-keyword">public</span> class Test <span class="code-keyword">extends</span> 
 javax.servlet.http.HttpServlet 
  <span class="code-keyword">implements</span> javax.servlet.Servlet {
   
 <span class="code-keyword">static</span> <span class="code-keyword">final</span> <span class="code-object">long</span> serialVersionUID = 1L;
 <span class="code-keyword">private</span> TopicConnection connection;
 <span class="code-keyword">private</span> Topic topic;
 
 <span class="code-keyword">public</span> Test() {
  <span class="code-keyword">super</span>();
 }   	
	
 <span class="code-keyword">public</span> void init() 
     <span class="code-keyword">throws</span> ServletException {
  <span class="code-object">String</span> connectionFactoryName = <span class="code-quote">"java:comp/env/jms/broker"</span>;
  <span class="code-object">String</span> topicName = <span class="code-quote">"java:comp/env/jms/Topic/TextTopic"</span>;
  <span class="code-keyword">try</span> {
   InitialContext naming = <span class="code-keyword">new</span> InitialContext();
   TopicConnectionFactory connectionFactory =
	         (TopicConnectionFactory)
               naming.lookup(connectionFactoryName);

   connection = 
     connectionFactory.createTopicConnection();
   topic = (Topic) naming.lookup(topicName);
  }<span class="code-keyword">catch</span>(Exception e) {
   e.printStackTrace();
   <span class="code-keyword">throw</span> <span class="code-keyword">new</span> ServletException(e);
  }
}
	   
<span class="code-keyword">public</span> void doGet(HttpServletRequest request, 
                  HttpServletResponse response)
         <span class="code-keyword">throws</span> ServletException, IOException {

 TopicSession publishSession = <span class="code-keyword">null</span>;
 PrintWriter out = response.getWriter();
 <span class="code-keyword">try</span> {
  <span class="code-object">boolean</span> transacted = <span class="code-keyword">false</span>;
  publishSession = 
    connection.createTopicSession(transacted,
     Session.AUTO_ACKNOWLEDGE);

  TopicPublisher sender = 
    publishSession.createPublisher(topic);
  sender.setDeliveryMode(DeliveryMode.PERSISTENT);

  TextMessage message = 
   publishSession.createTextMessage(<span class="code-quote">"Customer Info"</span>);
  message.setIntProperty(<span class="code-quote">"CustomerId"</span>,
   <span class="code-object">Integer</span>.parseInt(request.getParameter(<span class="code-quote">"CustomerId"</span>)));
  message.setStringProperty(<span class="code-quote">"CustomerName"</span>,
   request.getParameter(<span class="code-quote">"CustomerName"</span>));

  sender.send(message);
  out.println(<span class="code-quote">"Message is successfully sent...!!"</span>);
  
 }
 <span class="code-keyword">catch</span>(Exception e) {
  <span class="code-keyword">throw</span> <span class="code-keyword">new</span> ServletException(e);
 }
   <span class="code-keyword">finally</span> {
    <span class="code-keyword">try</span> {
     <span class="code-keyword">if</span> (publishSession != <span class="code-keyword">null</span>) {
       publishSession.close();
     }
    }
    <span class="code-keyword">catch</span> (Exception e) {}
   }
}

<span class="code-keyword">protected</span> void doPost(HttpServletRequest request,
                      HttpServletResponse response) 
              <span class="code-keyword">throws</span> ServletException, IOException {
}   	
	
<span class="code-keyword">public</span> void destroy() {
 <span class="code-keyword">if</span> (connection != <span class="code-keyword">null</span>) {
  <span class="code-keyword">try</span> {
   <span class="code-keyword">if</span> (connection != <span class="code-keyword">null</span>) {
       connection.close();
   }
 }
 <span class="code-keyword">catch</span> (Exception e) {          }
 }
 }

}</pre>
</div></div>

<p>When the above servlet is accessed on a browser window as <tt><span class="nobr"><a href="http://localhost:8080/MDBSampleWEB/Test?CustomerId=10&amp;CustomerName=Phani" title="Visit page outside Confluence" rel="nofollow">http://localhost:8080/MDBSampleWEB/Test?CustomerId=10&amp;CustomerName=Phani<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span></tt>, the following output is displayed in the server console.<br/>
<font color="white"><br/>
<div class="preformatted" style="border-style: solid; "><div class="preformattedContent" style="background-color: #000000; ">
<pre>-------------------------------------------
Received new message in TextMessageBean1 : Customer Info
CustomerId : 10
CustomerName : Phani
-------------------------------------------
-------------------------------------------
Received new message in TextMessageBean2 : Customer Info
CustomerId : 10
CustomerName : Phani
-------------------------------------------
</pre>
</div></div></font></p></div>


</td></tr></table></div>
<p>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
    <tr>
        <td height="12" background="http://cwiki.apache.org/confluence/images/border/border_bottom.gif"><img src="http://cwiki.apache.org/confluence/images/border/spacer.gif" width="1" height="1" border="0"/></td>
    </tr>
</table>

<div class="smalltext">
    Powered by
    <a href="http://www.atlassian.com/software/confluence/default.jsp?clicked=footer" class="smalltext">Atlassian Confluence</a>
    (Version: 2.2.9 Build:#527 Sep 07, 2006)
    -
    <a href="http://jira.atlassian.com/secure/BrowseProject.jspa?id=10470" class="smalltext">Bug/feature request</a><br/>
    <br>
    <a href="http://cwiki.apache.org/confluence/users/viewnotifications.action">Unsubscribe or edit your notifications preferences</a>

</div>

</body>
</html>


Mime
View raw message