qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Qpid: Management Design notes (page edited)
Date Tue, 12 Aug 2008 18:58:01 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/qpid">qpid</a> :
            <a href="http://cwiki.apache.org/confluence/display/qpid/Management+Design+notes">Management Design notes</a>
        </span>
    </div>

     <p>
        <a href="http://cwiki.apache.org/confluence/display/qpid/Management+Design+notes">Management Design notes</a>
        has been edited by             <a href="http://cwiki.apache.org/confluence/display/~tross">Ted Ross</a>
            <span class="smallfont">(Aug 12, 2008)</span>.
     </p>
    <p>
      Change summary:
      <div class="greybox wiki-content"><p>Added presence bitmasks for optional properties.</p></div>
    </p>
     <p>
                 <a href="http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=69472&originalVersion=19&revisedVersion=20">(View changes)</a>
     </p>

    <span class="label">Content:</span><br/>
    <div class="greybox wiki-content"><h2><a name="ManagementDesignnotes-Introduction"></a>Introduction</h2>

<p>This document describes the management features that are used in the QPID C++ broker as of the M3 milestone.  These features do not appear in earlier milestones nor are they implemented in the Java broker.</p>

<p>This specification is <b>not</b> a standard and is not endorsed by the AMQP working group.  When such a standard is adopted, the QPID implementation will be brought into compliance with that standard.</p>

<h2><a name="ManagementDesignnotes-Links"></a>Links</h2>

<ul>
	<li>The schema is checked into <span class="nobr"><a href="https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid/specs/management-schema.xml" title="Visit page outside Confluence" rel="nofollow">svn<sup><img class="rendericon" src="/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"/></sup></a></span>.</li>
</ul>


<h3><a name="ManagementDesignnotes-DesignnoteforgettinginfoinandoutviaJMX"></a>Design note for getting info in and out via JMX</h3>

<p> <a href="/confluence/display/qpid/JMX+Gateway" title="JMX Gateway">JMX WS-DM Gateway</a></p>


<h2><a name="ManagementDesignnotes-ManagementRequirements"></a>Management Requirements</h2>

<ul>
	<li>Must operate from a formally defined management schema.</li>
	<li>Must natively use the AMQP protocol and its type system.</li>
	<li>Must support the following operations
	<ul>
		<li>SET operation on configurable (persistent) aspects of objects</li>
		<li>GET operation on all aspects of objects</li>
		<li>METHOD invocation on schema-defined object-specific methods</li>
		<li>Distribution of unsolicited periodic updates of instrumentation data
		<ul>
			<li>Data updates shall carry an accurate sample timestamp for rate calculation</li>
			<li>Updates shall carry object create/delete timestamps.</li>
			<li>Transient objects shall be fully accounted for via updates.  Note that short-lived transient objects may come and go within a single update interval.  All of the information pertaining to such an object must be captured and transmitted.</li>
		</ul>
		</li>
		<li>Distribution of unsolicited event and/or alert indications (schema defined)</li>
	</ul>
	</li>
	<li>Role-based access control at object, operation, and method granularity</li>
	<li>End-to-end encryption and signing of management content</li>
	<li>Schema must be self-describing so the management client need not have prior knowledge of the management model of the system under management.</li>
	<li>Must be extensible to support the management of objects beyond the QPID component set.  This allows AMQP to be used as a general-purpose management protocol.</li>
</ul>



<h2><a name="ManagementDesignnotes-DefinitionofTerms"></a>Definition of Terms</h2>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'>class </td>
<td class='confluenceTd'> A type definition for a manageable object.</td>
</tr>
<tr>
<td class='confluenceTd'>package </td>
<td class='confluenceTd'> A grouping of class definitions that are related to a single software component.  The package concept is used to extend the management schema beyond just the QPID software components.</td>
</tr>
<tr>
<td class='confluenceTd'>object </td>
<td class='confluenceTd'> Also "manageable object".  An instantiation of a class.  An object represents a physical or logical component in the core function of the system under management.</td>
</tr>
<tr>
<td class='confluenceTd'>property</td>
<td class='confluenceTd'> A typed member of a class which represents a configurable attribute of the class.  In general, properties don't change frequently or may not change at all.</td>
</tr>
<tr>
<td class='confluenceTd'>statistic </td>
<td class='confluenceTd'> A typed member of a class which represents an instrumentation attribute of the class.  Statistics are always read-only in nature and tend to change rapidly.</td>
</tr>
<tr>
<td class='confluenceTd'>method </td>
<td class='confluenceTd'> A member of a class which represents a callable procedure on an object of the class.  Methods may have an arbitrary set of typed arguments and may supply a return code.  Methods typically have side effects on the associated object.</td>
</tr>
<tr>
<td class='confluenceTd'>event </td>
<td class='confluenceTd'> A member of a class which represents the occurence of an event of interest within the system under management.</td>
</tr>
<tr>
<td class='confluenceTd'>management broker </td>
<td class='confluenceTd'> A software component built into the messaging broker that handles management traffic and distributes management data.</td>
</tr>
<tr>
<td class='confluenceTd'>management agent </td>
<td class='confluenceTd'> A software component that is separate from the messaging broker, connected to the management broker via an AMQP connection, which allows any software component to be managed remotely by QPID.</td>
</tr>
</tbody></table>

<h2><a name="ManagementDesignnotes-OperationalScenarios%3ABasicvs.Extended"></a>Operational Scenarios: Basic vs. Extended</h2>

<p>The extensibility requirement introduces complexity to the management protocol that is unnecessary and undesirable for the user/developer that wishes only to manage QPID message brokers.  For this reason, the protocol is partitioned into two parts:  The <b>basic protocol</b>, which contains only the capability to manage a single broker; and the <b>extended protocol</b>, which provides the hooks for managing an extended set of components.  A management console can be implemented using only the basic protocol if the extended capabilities are not needed.</p>

<h2><a name="ManagementDesignnotes-ArchitecturalFramework"></a>Architectural Framework</h2>

<p><a href="/confluence/display/qpid/qmf_architecture" title="qmf_architecture">Architectural Framework</a></p>


<h2><a name="ManagementDesignnotes-TheManagementExchange"></a>The Management Exchange</h2>

<p>The management exchange (called "qpid.management" currently) is a special type of exchange used for remote management access to the Qpid broker.  The management exchange is an extension of the standard "Topic" exchange.  It behaves like a topic exchange with the following exceptions:</p>
<ol>
	<li>When a queue is successfully bound to the exchange, a method is invoked on the broker's management agent to notify it of the presence of a new remote managment client.</li>
	<li>When messages arrive at the exchange for routing, the exchange examines the message's routing key and if the key represents a management command or method, it routes it directly to the management agent rather than routing it to queues using the topic algorithm.<br/>
The management exchange is used by the management agent to distribute unsolicited management data.  Such data is classified by the routing key allowing management clients to register for only the data they need.</li>
</ol>


<h3><a name="ManagementDesignnotes-RoutingKeyStructure"></a>Routing Key Structure</h3>

<p>As noted above, the structure of the binding and routing keys used on the management exchange is important to the function of the management architecture.  The routing key of a management message determines:</p>
<ol>
	<li>The type of message (i.e. operation request or unsolicited update).</li>
	<li>The class of the object that the message pertains to.</li>
	<li>The specific operation or update type.</li>
	<li>The namespace in which the class belongs.  This allows for plug-in expansion of the management schema for manageable objects that are outside of the broker itself.</li>
</ol>


<p>Placing this information in the routing key provides the ability to enforce access control at class, operation, and method granularity.  It also separates the command structure from the content of the management message (i.e. element values) allowing the content to be encrypted and signed end-to-end while still allowing access control at the message-transport level.  This means that special access control code need not be written for the management agent.<br/>
There are two general types of routing/binding key:</p>
<ul>
	<li><b>Command</b> messages use the key: <tt>agent.&lt;bank#&gt;</tt> or <tt>broker</tt></li>
	<li><b>Unsolicited</b> keys have the structure: <tt>mgmt.&lt;agent&gt;.&lt;type&gt;.&lt;package&gt;.&lt;class&gt;.&lt;severity&gt;</tt> where
	<ul>
		<li><tt>&lt;agent&gt;</tt> is the uuid of the originating management agent,</li>
		<li><tt>&lt;type&gt;</tt> is one of "schema", "prop", "stat", or "event",</li>
		<li><tt>&lt;package&gt;</tt> is the namespace in which the &lt;class&gt; name is valid, and</li>
		<li><tt>&lt;class&gt;</tt> is the name of the class as defined in the schema.</li>
		<li><tt>&lt;severity&gt;</tt> is relevant for events only.  It is one of "critical", "error", "warning", or "info".</li>
	</ul>
	</li>
</ul>


<p>In both cases, the content of the message (i.e. method arguments, element values, etc.) is carried in the body segment of the message.</p>

<p>The <tt>&lt;package&gt;</tt> namespace allows this management framework to be extended with the addition of other software packages.</p>


<h2><a name="ManagementDesignnotes-TheProtocol"></a>The Protocol</h2>

<h3><a name="ManagementDesignnotes-ProtocolHeader"></a>Protocol Header</h3>

<p>The body segments of management messages are composed of sequences of binary-encoded data fields, in a manner consistent with the 0-10 version of the AMQP specification.</p>

<p>All management messages begin with a message header:</p>

<div class="preformatted"><div class="preformattedContent">
<pre>          octet 0      1         2         3         4         5         6         7
        +---------+---------+---------+---------+---------+---------+---------+---------+
        |   'A'   |   'M'   |   '1'   | op-code |                sequence               |
        +---------+---------+---------+---------+---------+---------+---------+---------+
</pre>
</div></div>


<p>The first three octets contain the protocol <b>magic number</b> "AM1" which is used to identify the type and version of the message.</p>

<p>The <b>opcode</b> field identifies the operation represented by the message</p>

<h3><a name="ManagementDesignnotes-ProtocolExchangePatterns"></a>Protocol Exchange Patterns</h3>

<p>The following patterns are followed in the design of the protocol:</p>

<ul>
	<li>Request-Response</li>
	<li>Query-Indication</li>
	<li>Unsolicited Indication</li>
</ul>


<h4><a name="ManagementDesignnotes-TheRequestResponsePattern"></a>The Request-Response Pattern</h4>

<p>In the request-response pattern, a requestor sends a <b>request</b> message to one of its peers.  The peer then does one of two things:  If the request can be successfully processed, a single <b>response</b> message is sent back to the requestor.  This response contains the requested results and serves as the positive acknowledgement that the request was successfully completed.</p>

<p>If the request cannot be successfully completed, the peer sends a <b>command complete</b> message back to the requestor with an error code and error text describing what went wrong.</p>

<p>The sequence number in the <b>response</b> or <b>command complete</b> message is the same as the sequence number in the <b>request</b>.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>    Requestor                                                          Peer
        |                                                               |
        | --- Request (seq) ------------------------------------------&gt; |
        |                                                               |
        | &lt;----------------------------------------- Response (seq) --- |
        |                                                               |
</pre>
</div></div>

<div class="preformatted"><div class="preformattedContent">
<pre>    Requestor                                                          Peer
        |                                                               |
        | --- Request (seq) ------------------------------------------&gt; |
        |                                                               |
        | &lt;-------------------------- Command Complete (seq, error) --- |
        |                                                               |
</pre>
</div></div>


<h4><a name="ManagementDesignnotes-TheQueryIndicationPattern"></a>The Query-Indication Pattern</h4>

<p>The query-indication pattern is used when there may be zero or more answers to a question.  In this case, the requestor sends a <b>query</b> message to its peer.  The peer processes the query, sending as many <b>indication</b> messages as needed back to the requestor (zero or more).  Once the last <b>indication</b> has been sent, the peer then sends a <b>command complete</b> message with a success code indicating that the query is complete.</p>

<p>If there is an error in the <b>query</b>, the peer may reply with a <b>command complete</b> message containg an error code.  In this case, no <b>indication</b> messages may be sent.</p>

<p>All <b>indication</b> and <b>command complete</b> messages shall have the same sequence number that appeared in the <b>query</b> message.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>    Requestor                                                          Peer
        |                                                               |
        | --- Query (seq) --------------------------------------------&gt; |
        |                                                               |
        | &lt;--------------------------------------- Indication (seq) --- |
        | &lt;--------------------------------------- Indication (seq) --- |
        | &lt;--------------------------------------- Indication (seq) --- |
        | &lt;--------------------------------------- Indication (seq) --- |
        | &lt;--------------------------------------- Indication (seq) --- |
        |                                                               |
        | &lt;------------------------ Command Complete (seq, success) --- |
        |                                                               |
</pre>
</div></div>

<div class="preformatted"><div class="preformattedContent">
<pre>    Requestor                                                          Peer
        |                                                               |
        | --- Query (seq) --------------------------------------------&gt; |
        |                                                               |
        | &lt;-------------------------- Command Complete (seq, error) --- |
        |                                                               |
</pre>
</div></div>


<h4><a name="ManagementDesignnotes-TheUnsolicitedIndicationPattern"></a>The Unsolicited-Indication Pattern</h4>

<p>The unsolicited-indication pattern is used when one peer needs to send unsolicited information to another peer, or to broadcast information to multiple peers via a topic exchange.  In this case, indication messages are sent with the sequence number field set to zero.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>      Peer                                                             Peer
        |                                                               |
        | &lt;----------------------------------- Indication (seq = 0) --- |
        | &lt;----------------------------------- Indication (seq = 0) --- |
        | &lt;----------------------------------- Indication (seq = 0) --- |
        | &lt;----------------------------------- Indication (seq = 0) --- |
        |                                                               |
</pre>
</div></div>


<h3><a name="ManagementDesignnotes-ObjectIdentifiers"></a>Object Identifiers</h3>

<p>Manageable objects are tagged with a unique 64-bit object identifier.  The object identifier space is owned and managed by the management broker.  Objects managed by a single management broker shall have unique object identifiers.  Objects managed by separate management brokers may have the same object identifier.</p>

<p>If a management console is designed to manage multiple management brokers, it must use the broker identifier as well as the object identifier to ensure global uniqueness.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>           62         48 47                   24 23                    0
        +-+-------------+-----------------------+-----------------------+
        |0|   sequence  |         bank          |        object         |
        +-+-------------+-----------------------+-----------------------+

        bit  63        - reserved, must be zero
        bits 63 .. 48  - broker boot sequence (32K)
        bits 47 .. 24  - bank (16M)
        bits 23 .. 0   - object (16M)
</pre>
</div></div>

<ul>
	<li>For persistent IDs, boot-sequence is zero</li>
	<li>For non-persistent IDs, boot sequence is a constant number which increments each time the management broker is restarted.</li>
	<li>Bank number:
	<ul>
		<li>0    - reserved</li>
		<li>1    - broker-persistent objects</li>
		<li>2..4 - store-persistent objects</li>
		<li>&gt; 4  - transient objects</li>
	</ul>
	</li>
</ul>



<h3><a name="ManagementDesignnotes-EstablishingCommunicationBetweenClientandAgent"></a>Establishing Communication Between Client and Agent</h3>

<p>Communication is established between the management client and management agent using normal AMQP procedures.  The client creates a connection to the broker and then establishes a session with its corresponding channel.</p>

<p>Two private queues are then declared (only one if method invocation is not needed).  A management queue is declared and bound to the qpid.management exchange.  If the binding key is "mgmt.#", all management-related messages sent to the exchange will be received by this client.  A more specific binding key will result in a more restricted set of messages being received (see the section on Routing Key Structure below).</p>

<p>If methods are going to be invoked on managed objects, a second private queue must be declared so the client can receive method replies.  This queue is bound to the amq.direct exchange using a routing key equal to the name of the queue.</p>

<p>When a client successfully binds to the qpid.management exchange, the management agent schedules a schema broadcast to be sent to the exchange.  The agent will publish, via the exchange, a description of the schema for all manageable objects in its control.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>      Client                                                          Broker
        |                                                               |
        | --- AMQP Connection and Session Setup ----------------------&gt; |
        |                                                               |
        | --- Queue.declare (private data queue) ---------------------&gt; |
        | --- Bind queue to exchange 'qpid.management' key 'mgmt.#' --&gt; |
        |                                                               |
        | --- Queue.declare (private method-reply queue) -------------&gt; |
        | --- Bind queue to exchange 'amq.direct' --------------------&gt; |
        |                                                               |
        | --- Broker Request -----------------------------------------&gt; |
        | &lt;---------------------------------------- Broker Response --- |
        |                                                               |
        |                                                               |
        |                                                               |
        | &lt;------- Management schema via exchange 'qpid.management' --- |
        |                                                               |
</pre>
</div></div>

<h3><a name="ManagementDesignnotes-BroadcastofConfigurationandInstrumentationUpdates"></a>Broadcast of Configuration and Instrumentation Updates</h3>

<p>The management agent will periodically publish updates to the configuration and instrumentation of management objects under its control.  Under normal circumstances, these updates are published only if they have changed since the last time they were published.  Configuration updates are only published if configuration has changed and instrumentation updates are only published if instrumentation has changed.  The exception to this rule is that after a management client binds to the qpid.management exchange, all configuration and instrumentation records are published as though they had changed whether or not they actually did.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>      Client                                                          Broker
        |                                                               |
        | &lt;------------------ Object properties via 'mgmt.*.prop.#' --- | |
        | &lt;------------------ Object statistics via 'mgmt.*.stat.#' --- | |
        |                                                               | |
        |                                                               | | Publish Interval
        |                                                               | |
        |                                                               | |
        |                                                               | V
        | &lt;------------------ Object properties via 'mgmt.*.prop.#' --- |
        | &lt;------------------ Object statistics via 'mgmt.*.stat.#' --- |
        |                                                               |
</pre>
</div></div>

<h3><a name="ManagementDesignnotes-InvokingaMethodonaManagedObject"></a>Invoking a Method on a Managed Object</h3>

<p>When the management client wishes to invoke a method on a managed object, it sends a method request message to the qpid.management exchange.  The routing key contains the object class and method name (refer to Routing Key Structure below).  The method request must have a header entry (reply-to) that contains the name of the method-reply queue so that the method response can be properly routed back to the requestor.</p>

<p>The method request contains a sequence number that is copied to the method reply.  This number is opaque to the management agent and may be used by the management client to correlate the reply to the request.  The asynchronous nature of requests and replies allows any number of methods to be in-flight at a time.  Note that there is no guarantee that methods will be replied to in the order in which they were requested.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>      Client                                                          Broker
        |                                                               |
        | --- Method Request (to exchange 'qpid.management') ---------&gt; |
        |                                                               |
        |                                                               |
        | &lt;--------------- Method Reply (via exchange 'amq.direct') --- |
        |                                                               |
</pre>
</div></div>


<h3><a name="ManagementDesignnotes-MessagesfortheBasicScenario"></a>Messages for the Basic Scenario</h3>

<p>The principals in a management exchange are the <em>management client</em> and the <em>management agent</em>.  The management agent is integrated into the QPID broker and the management client is a remote entity.  A management agent may be managed by zero or more management clients at any given time.  Additionally, a management client may manage multiple management agents at the same time.</p>

<p>For authentication and access control, management relies on the mechanisms supplied by the AMQP protocol.</p>

<h4><a name="ManagementDesignnotes-BasicOpcodes"></a>Basic Opcodes</h4>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>opcode</b></td>
<td class='confluenceTd'><b>message</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>'B'</td>
<td class='confluenceTd'>Broker Request</td>
<td class='confluenceTd'>This message contains a broker request, sent from the management console to the broker to initiate a management session.</td>
</tr>
<tr>
<td class='confluenceTd'>'b'</td>
<td class='confluenceTd'>Broker Response</td>
<td class='confluenceTd'>This message contains a broker response, sent from the broker in response to a broker request message.</td>
</tr>
<tr>
<td class='confluenceTd'>'z'</td>
<td class='confluenceTd'>Command Completion</td>
<td class='confluenceTd'>This message is sent to indicate the completion of a request.</td>
</tr>
<tr>
<td class='confluenceTd'>'Q'</td>
<td class='confluenceTd'>Class Query</td>
<td class='confluenceTd'>Class query messages are used by a management console to request a list of schema classes that are known by the management broker.</td>
</tr>
<tr>
<td class='confluenceTd'>'q'</td>
<td class='confluenceTd'>Class Indication</td>
<td class='confluenceTd'>Sent by the management broker, a class indication notifies the peer of the existence of a schema class.</td>
</tr>
<tr>
<td class='confluenceTd'>'S'</td>
<td class='confluenceTd'>Schema Request</td>
<td class='confluenceTd'>Schema request messages are used to request the full schema details for a class.</td>
</tr>
<tr>
<td class='confluenceTd'>'s'</td>
<td class='confluenceTd'>Schema Response</td>
<td class='confluenceTd'>Schema response message contain a full description of the schema for a class.</td>
</tr>
<tr>
<td class='confluenceTd'>'h'</td>
<td class='confluenceTd'>Heartbeat Indication</td>
<td class='confluenceTd'>This message is published once per publish-interval.  It can be used by a client to positively determine which objects did not change during the interval (since updates are not published for objects with no changes).</td>
</tr>
<tr>
<td class='confluenceTd'>'c', 'i', 'g'</td>
<td class='confluenceTd'>Content Indication</td>
<td class='confluenceTd'>This message contains a content record.  Content records contain the values of all properties or statistics in an object.  Such records are broadcast on a periodic interval if 1) a change has been made in the value of one of the elements, or 2) if a new management client has bound a queue to the management exchange.</td>
</tr>
<tr>
<td class='confluenceTd'>'G'</td>
<td class='confluenceTd'>Get Query</td>
<td class='confluenceTd'>Sent by a management console, a get query requests that the management broker provide content indications for all objects that match the query criteria.</td>
</tr>
<tr>
<td class='confluenceTd'>'M'</td>
<td class='confluenceTd'>Method Request</td>
<td class='confluenceTd'>This message contains a method request.</td>
</tr>
<tr>
<td class='confluenceTd'>'m'</td>
<td class='confluenceTd'>Method Response</td>
<td class='confluenceTd'>This message contains a method result.</td>
</tr>
</tbody></table>

<h4><a name="ManagementDesignnotes-BrokerRequestMessage"></a>Broker Request Message</h4>

<p>When a management client first establishes contact with the broker, it sends a Hello message to initiate the exchange.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'B' |           0           |
        +-----+-----+-----+-----+-----------------------+
</pre>
</div></div>

<p>The Broker Request message has no payload.</p>

<h4><a name="ManagementDesignnotes-BrokerResponseMessage"></a>Broker Response Message</h4>

<p>When the broker receives a Broker Request message, it responds with a Broker Response message.  This message contains an identifier unique to the broker.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'b' |           0           |
        +-----+-----+-----+-----+-----------------------+----------------------------+
        | brokerId (uuid)                                                            |
        +----------------------------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-CommandCompletionMessage"></a>Command Completion Message</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'z' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  Completion Code      |
        +-----------------------+-----------------------------------------+
        |  Completion Text                                                |
        +-----------------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-ClassQuery"></a>Class Query</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'Q' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  package name (str8)                                     |
        +----------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-ClassIndication"></a>Class Indication</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'q' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  package name (str8)                                     |
        +----------------------------------------------------------+
        |  class name (str8)                                       |
        +----------------------------------------------------------+
        |  schema hash (bin128)                                    |
        +----------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-SchemaRequest"></a>Schema Request</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'S' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |                packageName (str8)                        |
        +----------------------------------------------------------+
        |                className (str8)                          |
        +----------------------------------------------------------+
        |                schema-hash (bin128)                      |
        +----------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-SchemaResponse"></a>Schema Response</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 's' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |                packageName (str8)                        |
        +----------------------------------------------------------+
        |                className (str8)                          |
        +----------------------------------------------------------+
        |                schema-hash (bin128)                      |
        +-----------+-----------+-----------+-----------+----------+
        | propCnt   | statCnt   | methodCnt | eventCnt  |
        +-----------+-----------+-----------+-----------+----------------------------+
        | propCnt property records                                                   |
        +----------------------------------------------------------------------------+
        | statCnt statistic records                                                  |
        +----------------------------------------------------------------------------+
        | methodCnt method records                                                   |
        +----------------------------------------------------------------------------+
        | eventCnt event records                                                     |
        +----------------------------------------------------------------------------+
</pre>
</div></div>

<p>Each <b>property</b> record is an AMQP map with the following fields.  Optional fields may optionally be omitted from the map.</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>field name</b></td>
<td class='confluenceTd'><b>optional</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>name</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Name of the property</td>
</tr>
<tr>
<td class='confluenceTd'>type</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Type code for the property</td>
</tr>
<tr>
<td class='confluenceTd'>access</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Access code for the property</td>
</tr>
<tr>
<td class='confluenceTd'>index</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>1 = index element, 0 = not an index element</td>
</tr>
<tr>
<td class='confluenceTd'>optional</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>1 = optional element (may be not present), 0 = mandatory (always present)</td>
</tr>
<tr>
<td class='confluenceTd'>unit</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Units for numeric values (i.e. seconds, bytes, etc.)</td>
</tr>
<tr>
<td class='confluenceTd'>min</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Minimum value for numerics</td>
</tr>
<tr>
<td class='confluenceTd'>max</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Maximum value for numerics</td>
</tr>
<tr>
<td class='confluenceTd'>maxlen</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Maximum length for strings</td>
</tr>
<tr>
<td class='confluenceTd'>desc</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Description of the property</td>
</tr>
</tbody></table>

<p>Each <b>statistic</b> record is an AMQP map with the following fields:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>field name</b></td>
<td class='confluenceTd'><b>optional</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>name</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Name of the statistic</td>
</tr>
<tr>
<td class='confluenceTd'>type</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Type code for the statistic</td>
</tr>
<tr>
<td class='confluenceTd'>unit</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Units for numeric values (i.e. seconds, bytes, etc.)</td>
</tr>
<tr>
<td class='confluenceTd'>desc</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Description of the statistic</td>
</tr>
</tbody></table>

<p><b>method</b> and <b>event</b> records contain a main map that describes the method or header followed by zero or more maps describing arguments.  The main map contains the following fields:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>field name</b></td>
<td class='confluenceTd'><b>optional</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>name</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Name of the method or event</td>
</tr>
<tr>
<td class='confluenceTd'>argCount</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Number of argument records to follow</td>
</tr>
<tr>
<td class='confluenceTd'>desc</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Description of the method or event</td>
</tr>
</tbody></table>

<p>Argument maps contain the following fields:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>field name</b></td>
<td class='confluenceTd'><b>method</b></td>
<td class='confluenceTd'><b>event</b></td>
<td class='confluenceTd'><b>optional</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>name</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Argument name</td>
</tr>
<tr>
<td class='confluenceTd'>type</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>Type code for the argument</td>
</tr>
<tr>
<td class='confluenceTd'>dir</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Direction code for method arguments</td>
</tr>
<tr>
<td class='confluenceTd'>unit</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Units for numeric values (i.e. seconds, bytes, etc.)</td>
</tr>
<tr>
<td class='confluenceTd'>min</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Minimum value for numerics</td>
</tr>
<tr>
<td class='confluenceTd'>max</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Maximum value for numerics</td>
</tr>
<tr>
<td class='confluenceTd'>maxlen</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Maximum length for strings</td>
</tr>
<tr>
<td class='confluenceTd'>desc</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Description of the argument</td>
</tr>
<tr>
<td class='confluenceTd'>default</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>Default value for the argument</td>
</tr>
</tbody></table>

<p><b>type codes</b> are numerics with the following values:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>value</b></td>
<td class='confluenceTd'><b>type</b></td>
</tr>
<tr>
<td class='confluenceTd'>1</td>
<td class='confluenceTd'>uint8</td>
</tr>
<tr>
<td class='confluenceTd'>2</td>
<td class='confluenceTd'>uint16</td>
</tr>
<tr>
<td class='confluenceTd'>3</td>
<td class='confluenceTd'>uint32</td>
</tr>
<tr>
<td class='confluenceTd'>4</td>
<td class='confluenceTd'>uint64</td>
</tr>
<tr>
<td class='confluenceTd'>6</td>
<td class='confluenceTd'>str8</td>
</tr>
<tr>
<td class='confluenceTd'>7</td>
<td class='confluenceTd'>str16</td>
</tr>
<tr>
<td class='confluenceTd'>8</td>
<td class='confluenceTd'>absTime(uint64)</td>
</tr>
<tr>
<td class='confluenceTd'>9</td>
<td class='confluenceTd'>deltaTime(uint64)</td>
</tr>
<tr>
<td class='confluenceTd'>10</td>
<td class='confluenceTd'>objectReference(uint64)</td>
</tr>
<tr>
<td class='confluenceTd'>11</td>
<td class='confluenceTd'>boolean(uint8)</td>
</tr>
<tr>
<td class='confluenceTd'>12</td>
<td class='confluenceTd'>float</td>
</tr>
<tr>
<td class='confluenceTd'>13</td>
<td class='confluenceTd'>double</td>
</tr>
<tr>
<td class='confluenceTd'>14</td>
<td class='confluenceTd'>uuid</td>
</tr>
<tr>
<td class='confluenceTd'>15</td>
<td class='confluenceTd'>map</td>
</tr>
<tr>
<td class='confluenceTd'>16</td>
<td class='confluenceTd'>int8</td>
</tr>
<tr>
<td class='confluenceTd'>17</td>
<td class='confluenceTd'>int16</td>
</tr>
<tr>
<td class='confluenceTd'>18</td>
<td class='confluenceTd'>int32</td>
</tr>
<tr>
<td class='confluenceTd'>19</td>
<td class='confluenceTd'>int64</td>
</tr>
</tbody></table>

<p><b>access codes</b> are numerics with the following values:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>value</b></td>
<td class='confluenceTd'><b>access</b></td>
</tr>
<tr>
<td class='confluenceTd'>1</td>
<td class='confluenceTd'>Read-Create access</td>
</tr>
<tr>
<td class='confluenceTd'>2</td>
<td class='confluenceTd'>Read-Write access</td>
</tr>
<tr>
<td class='confluenceTd'>3</td>
<td class='confluenceTd'>Read-Only access</td>
</tr>
</tbody></table>

<p><b>direction codes</b> are numerics with the following values:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>value</b></td>
<td class='confluenceTd'><b>direction</b></td>
</tr>
<tr>
<td class='confluenceTd'>1</td>
<td class='confluenceTd'>Input (from client to broker)</td>
</tr>
<tr>
<td class='confluenceTd'>2</td>
<td class='confluenceTd'>Output (from broker to client)</td>
</tr>
<tr>
<td class='confluenceTd'>3</td>
<td class='confluenceTd'>IO (bidirectional)</td>
</tr>
</tbody></table>


<h4><a name="ManagementDesignnotes-HeartbeatIndication"></a>Heartbeat Indication</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'h' |           0           |
        +-----+-----+-----+-----+-----------------------+
        | timestamp of current interval (datetime)      |
        +-----------------------------------------------+
</pre>
</div></div>


<h4><a name="ManagementDesignnotes-ConfigurationandInstrumentationContentMessages"></a>Configuration and Instrumentation Content Messages</h4>

<p>Content messages are published when changes are made to the values of properties or statistics or when new management clients bind a queue to the management exchange.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-------+-----------------------+
        | 'A' | 'M' | '1' |'g/c/i'|          seq          |
        +-----+-----+-----+-------+-----------------------+--------+
        |                packageName (str8)                        |
        +----------------------------------------------------------+
        |                className (str8)                          |
        +----------------------------------------------------------+
        |                class hash (bin128)                       |
        +-----+-----+-----+-----+-----+-----+-----+-----+----------+
        | timestamp of current sample (datetime)        |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | time object was created (datetime)            |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | time object was deleted (datetime)            |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | objectId (uint64)                             |
        +-----+-----+-----+-----+-----+-----+-----+-----+
        | presence bitmasks (0 or more uint8 fields)    |
        +-----+-----+-----+-----+-----+-----+-----+-----+------------------------+
        | config/inst values (in schema order)                                   |
        +------------------------------------------------------------------------+
</pre>
</div></div>

<p>All timestamps are uint64 values representing nanoseconds since the epoch (January 1, 1970).  The objectId is a uint64 value that uniquely identifies this object instance.</p>

<p>If any of the properties in the object are defined as optional, there will be 1 or more "presence bitmask" octets.  There are as many octets as are needed to provide one bit per optional property.  The bits are assigned to the optional properties in schema order (first octet first, lowest order bit first).</p>

<p>For example:  If there are two optional properties in the schema called "option1" and "option2" (defined in that order), there will be one presence bitmask octet and the bits will be assigned as bit 0 controls option1 and bit 1 controls option2.</p>

<p>If the bit for a particular optional property is set (1), the property will be encoded normally in the "values" portion of the message.  If the bit is clear (0), the property will be omitted from the list of encoded values and will be considered "NULL" or "not present".</p>

<p>The element values are encoded by their type into the message in the order in which they appeared in the schema message.</p>

<h4><a name="ManagementDesignnotes-GetQueryMessage"></a>Get Query Message</h4>

<p>A Get Request may be sent by the management console to cause a management agent to immediately send content information for objects of a class.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'G' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        | Get request field table                                  |
        +----------------------------------------------------------+
</pre>
</div></div>

<p>The content of a get request is a field table that specifies what objects are being requested.  Most of the fields are optional and are available for use in more extensive deployments.</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>Field Key</b></td>
<td class='confluenceTd'><b>Mandatory</b></td>
<td class='confluenceTd'><b>Type</b></td>
<td class='confluenceTd'><b>Description</b></td>
</tr>
<tr>
<td class='confluenceTd'>"_class"</td>
<td class='confluenceTd'>yes</td>
<td class='confluenceTd'>short-string</td>
<td class='confluenceTd'>The name of the class of objects being requested.</td>
</tr>
<tr>
<td class='confluenceTd'>"_package"</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>short-string</td>
<td class='confluenceTd'>The name of the extension package the class belongs to.  If omitted, the package defaults to "qpid" for access to objects in the connected broker.</td>
</tr>
<tr>
<td class='confluenceTd'>"_agent"</td>
<td class='confluenceTd'>no</td>
<td class='confluenceTd'>uuid</td>
<td class='confluenceTd'>The management agent that is the target of the request.  If omitted, agent defaults to the connected broker.</td>
</tr>
</tbody></table>

<p>When the management agent receives a get request, it sends content messages describing the requested objects.  Once the last content message is sent, it then sends a Command Completion message with the same sequence number supplied in the request to indicate to the requestor that there are no more messages coming.</p>


<h4><a name="ManagementDesignnotes-MethodRequest"></a>Method Request</h4>

<p>Method request messages have the following structure.  The sequence number is opaque to the management agent.  It is returned unchanged in the method reply so the calling client can correctly associate the reply to the request.  The objectId is the unique ID of the object on which the method is to be executed.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'M' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  objectId (uint64)                            |
        +-----------------------------------------------+
        |  methodName (str8)                            |
        +-----------------------------------------------+------------------------+
        |  input and bidirectional argument values (in schema order)             |
        +------------------------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-MethodResponse"></a>Method Response</h4>

<p>Method reply messages have the following structure.  The sequence number is identical to that supplied in the method request.  The status code (and text) indicate whether or not the method was successful and if not, what the error was.  Output and bidirectional arguments are only included if the status code was 0 (STATUS_OK).</p>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'm' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  status code          |
        +-----------------------+----------------------------------+
        |  status text (str8)                                      |
        +-----------------------+----------------------------------+-------------+
        |  output and bidirectional argument values (in schema order)            |
        +------------------------------------------------------------------------+
</pre>
</div></div>

<p><b>status code</b> values are:</p>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>value</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>0</td>
<td class='confluenceTd'> STATUS_OK - successful completion</td>
</tr>
<tr>
<td class='confluenceTd'>1</td>
<td class='confluenceTd'> STATUS_UNKNOWN_OBJECT - objectId not found in the agent</td>
</tr>
<tr>
<td class='confluenceTd'>2</td>
<td class='confluenceTd'> STATUS_UNKNOWN_METHOD - method is not known by the object type</td>
</tr>
<tr>
<td class='confluenceTd'>3</td>
<td class='confluenceTd'> STATUS_NOT_IMPLEMENTED - method is not currently implemented</td>
</tr>
</tbody></table>




<h3><a name="ManagementDesignnotes-MessagesforExtendedScenario"></a>Messages for Extended Scenario</h3>

<h4><a name="ManagementDesignnotes-ExtendedManagementProtocol"></a>Extended Management Protocol</h4>

<p>Qpid supports management extensions that allow the management broker to be a central point for the management of multiple external entities with their own management schemas.</p>

<div class="preformatted"><div class="preformattedContent">
<pre>      Broker                                                       Remote Agent
        |                                                               |
        | &lt;----------------------------------------- Attach Request --- |
        | --- Attach Response ----------------------------------------&gt; |
        |                                                               |
        | &lt;------------------------------------- Package Indication --- |
        | &lt;------------------------------------- Package Indication --- |
        |                                                               |
        | &lt;--------------------------------------- Class Indication --- |
        | &lt;--------------------------------------- Class Indication --- |
        | &lt;--------------------------------------- Class Indication --- |
        | &lt;--------------------------------------- Class Indication --- |
        | &lt;--------------------------------------- Class Indication --- |
        |                                                               |
        | --- Schema Request (class key) -----------------------------&gt; |
        | &lt;---------------------------------------- Schema Response --- |
        |                                                               |
        | --- Schema Request (class key) -----------------------------&gt; |
        | &lt;---------------------------------------- Schema Response --- |
        |                                                               |
        |                                                               |
</pre>
</div></div>


<h4><a name="ManagementDesignnotes-ExtendedOpcodes"></a>Extended Opcodes</h4>

<table class='confluenceTable'><tbody>
<tr>
<td class='confluenceTd'><b>opcode</b></td>
<td class='confluenceTd'><b>message</b></td>
<td class='confluenceTd'><b>description</b></td>
</tr>
<tr>
<td class='confluenceTd'>'P'</td>
<td class='confluenceTd'>Package Query</td>
<td class='confluenceTd'>This message contains a schema package query request, requesting that the broker dump the list of known packages</td>
</tr>
<tr>
<td class='confluenceTd'>'p'</td>
<td class='confluenceTd'>Package Indication</td>
<td class='confluenceTd'>This message contains a schema package indication, identifying a package known by the broker</td>
</tr>
<tr>
<td class='confluenceTd'>'A'</td>
<td class='confluenceTd'>Agent Attach Request</td>
<td class='confluenceTd'>This message is sent by a remote agent when it wishes to attach to a management broker</td>
</tr>
<tr>
<td class='confluenceTd'>'a'</td>
<td class='confluenceTd'>Agent Attach Response</td>
<td class='confluenceTd'>The management broker sends this response if an attaching remote agent is permitted to join</td>
</tr>
<tr>
<td class='confluenceTd'>'x'</td>
<td class='confluenceTd'>Console Added Indication</td>
<td class='confluenceTd'>This message is sent to all remote agents by the management broker when a new console binds to the management exchange</td>
</tr>
</tbody></table>

<h4><a name="ManagementDesignnotes-PackageQuery"></a>Package Query</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'P' |          seq          |
        +-----+-----+-----+-----+-----------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-PackageIndication"></a>Package Indication</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'p' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  package name (str8)                                     |
        +----------------------------------------------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-AttachRequest"></a>Attach Request</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'A' |          seq          |
        +-----+-----+-----+-----+-----------------------+----------+
        |  label (str8)                                            |
        +-----------------------+----------------------------------+
        |  system-id (uuid)                                        |
        +-----------------------+----------------------------------+
        |  requested objId bank |
        +-----------------------+
</pre>
</div></div>


<h4><a name="ManagementDesignnotes-AttachResponse%28success%29"></a>Attach Response (success)</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'a' |          seq          |
        +-----+-----+-----+-----+-----------------------+
        |  assigned objId bank  |
        +-----------------------+
</pre>
</div></div>

<h4><a name="ManagementDesignnotes-ConsoleAddedIndication"></a>Console Added Indication</h4>

<div class="preformatted"><div class="preformattedContent">
<pre>        +-----+-----+-----+-----+-----------------------+
        | 'A' | 'M' | '1' | 'x' |          seq          |
        +-----+-----+-----+-----+-----------------------+
</pre>
</div></div>
</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