You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm@excalibur.apache.org by rd...@apache.org on 2009/06/16 19:55:28 UTC
svn commit: r785324 [21/28] - in /excalibur/site: ./ css/ developing/ event/
fortress/ framework/ images/logos/ instrument/ lifecycle/ sourceresolve/
store/ xmlutil/
Modified: excalibur/site/instrument/xml-client-instrumentable.html
URL: http://svn.apache.org/viewvc/excalibur/site/instrument/xml-client-instrumentable.html?rev=785324&r1=785323&r2=785324&view=diff
==============================================================================
--- excalibur/site/instrument/xml-client-instrumentable.html (original)
+++ excalibur/site/instrument/xml-client-instrumentable.html Tue Jun 16 17:55:25 2009
@@ -1,66 +1,588 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Apache Excalibur - Excalibur Instrument - XML Client - Instrumentable</title><style type="text/css" media="all">
- @import url("../style/maven-base.css");
-
- @import url("../style/maven-theme.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Leif Mortenson"></meta><meta name="email" content="leif.AT.tanukisoftware.DOT.com"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="The Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://excalibur.apache.org/" id="projectLogo"><img alt="Apache Excalibur" src="http://excalibur.apache.org/logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xright">
-
- <a href="../index.html">Home</a>
-
-
-
- <span class="separator">|</span>
-
-
- <a href="../fortress/index.html">Fortress</a>
-
-
-
- <span class="separator">|</span>
-
-
- <a href="../component-list.html">Components</a>
-
-
-
- <span class="separator">|</span>
-
-
- <a href="../containerkit.html">Containerkit</a>
- </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="../index.html">Overview</a></li><li class="none"><a href="../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../svn.html">Subversion</a></li><li class="none"><a href="http://wiki.apache.org/excalibur/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a href="http://wiki.apache.org/excalibur/FrequentlyAskedQuestions" class="externalLink" title="External Link">FAQ</a></li><li class="none"><a href="http://excalibur.apache.org/apidocs/" class="externalLink" title="External Link">Javadocs</a></li><li class="none"><a href="http://excalibur.apache.org/download.cgi" class="externalLink" title="External Link">Download</a></li><li class="none"><a href="../issue-tracking.html">Issue Tracking</a></li><li class="collapsed"><a href="../misc.html">Miscellaneous</a></li></ul></div><div
id="menuFortress"><h5>Fortress</h5><ul><li class="none"><a href="../fortress/index.html">Overview</a></li><li class="none"><a href="../fortress/features.html">Features Oriented</a></li><li class="none"><a href="../fortress/getting-started.html">Getting Started</a></li><li class="none"><a href="../fortress/using-meta-info.html">Using Meta Info</a></li><li class="none"><a href="../fortress/cli.html">CLI</a></li><li class="none"><a href="../fortress/swing.html">Swing</a></li><li class="none"><a href="../fortress/servlet.html">Servlet</a></li><li class="none"><a href="../lifecycle/index.html">Lifecycle Extensions</a></li><li class="none"><a href="../fortress/design-notes.html">Design Notes</a></li></ul></div><div id="menuFramework"><h5>Framework</h5><ul><li class="collapsed"><a href="../framework/index.html">Documentation</a></li><li class="collapsed"><a href="../developing/index.html">Developing</a></li></ul></div><div id="menuComponents"><h5>Components</h5><ul><li class="none
"><a href="../component-list.html">Overview</a></li><li class="collapsed"><a href="../sourceresolve/index.html">Sourceresolver</a></li><li class="collapsed"><a href="../store/index.html">Store</a></li><li class="none"><a href="../thread.html">Thread</a></li><li class="collapsed"><a href="../xmlutil/index.html">XMLUtil</a></li></ul></div><div id="menuContainerkit"><h5>Containerkit</h5><ul><li class="none"><a href="../containerkit.html">Overview</a></li><li class="expanded"><a href="../instrument/index.html">Instrument</a><ul><li class="none"><a href="../instrument/index.html">Overview</a></li><li class="none"><a href="../instrument/html-client.html">HTML Based Client</a></li><li class="expanded"><a href="../instrument/xml-client.html">XML Based Client</a><ul><li class="none"><a href="../instrument/xml-client-instrument-manager.html">Instrument Manager</a></li><li class="none"><strong><a href="../instrument/xml-client-instrumentable.html">Instrumentable</a></strong></li><li cl
ass="none"><a href="../instrument/xml-client-instrument.html">Instrument</a></li><li class="none"><a href="../instrument/xml-client-sample.html">Sample</a></li><li class="none"><a href="../instrument/xml-client-snapshot.html">Snapshot</a></li><li class="none"><a href="../instrument/xml-client-snapshots.html">Snapshots</a></li><li class="none"><a href="../instrument/xml-client-create-sample.html">Create Sample</a></li><li class="none"><a href="../instrument/xml-client-create-samples.html">Create Samples</a></li><li class="none"><a href="../instrument/xml-client-sample-lease.html">Sample Lease</a></li><li class="none"><a href="../instrument/xml-client-sample-leases.html">Sample Leases</a></li><li class="none"><a href="../instrument/xml-client-gc.html">Invoke GC</a></li></ul></li><li class="none"><a href="../instrument/java-client.html">Java Swing Client</a></li><li class="none"><a href="../instrument/configuration.html">Configuration</a></li><li class="none"><a href="../instru
ment/component.html">Component Integration</a></li><li class="none"><a href="../instrument/container.html">Container Integration</a></li><li class="none"><a href="../instrument/manager.html">Advanced Features</a></li></ul></li><li class="collapsed"><a href="../lifecycle/index.html">Lifecycle</a></li><li class="none"><a href="../logger.html">Logger</a></li></ul></div><div id="menuDeprecated_Materials"><h5>Deprecated Materials</h5><ul><li class="none"><a href="../deprecation.html">Overview</a></li><li class="expanded"><a href="../deprecation.html">Old Documentation</a><ul><li class="none"><a href="../component.html">ECM</a></li><li class="collapsed"><a href="../event/index.html">Event</a></li><li class="none"><a href="../configuration.html">Configuration</a></li></ul></li></ul></div><div id="menuThanks"><h5>Thanks</h5><ul><li class="none"><a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="External Link">to our sponsors!</a></li><li class="none">
<a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="External Link">Sponsor the ASF</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="../index.html">About Apache Excalibur</a></li><li class="collapsed"><a href="../project-info.html">Project Info</a></li><li class="collapsed"><a href="../maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html" class="externalLink" title="External Link">Development Process</a></li></ul></div></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="XML_Client_-_Instrumentable"></a><h2>XML Client - Instrumentable</h2><p>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Excalibur - Excalibur Instrument - XML Client - Instrumentable</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Leif Mortenson" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <span id="bannerLeft">
+
+ Excalibur
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2009-06-16
+ </div>
+ <div class="xright"> <a href="../index.html">Home</a>
+ |
+ <a href="../fortress/index.html">Fortress</a>
+ |
+ <a href="../component-list.html">Components</a>
+ |
+ <a href="../containerkit.html">Containerkit</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Essentials</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../svn.html">Subversion</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/excalibur/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/excalibur/FrequentlyAskedQuestions" class="externalLink">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="http://excalibur.apache.org/apidocs/" class="externalLink">Javadocs</a>
+ </li>
+
+ <li class="none">
+ <a href="http://excalibur.apache.org/download.cgi" class="externalLink">Download</a>
+ </li>
+
+ <li class="none">
+ <a href="../issue-tracking.html">Issue Tracking</a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../misc.html">Miscellaneous</a>
+ </li>
+ </ul>
+ <h5>Fortress</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../fortress/index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/features.html">Features Oriented</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/getting-started.html">Getting Started</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/using-meta-info.html">Using Meta Info</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/cli.html">CLI</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/swing.html">Swing</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/servlet.html">Servlet</a>
+ </li>
+
+ <li class="none">
+ <a href="../lifecycle/index.html">Lifecycle Extensions</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/design-notes.html">Design Notes</a>
+ </li>
+ </ul>
+ <h5>Framework</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../framework/index.html">Documentation</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../developing/index.html">Developing</a>
+ </li>
+ </ul>
+ <h5>Components</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../component-list.html">Overview</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../sourceresolve/index.html">Sourceresolver</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../store/index.html">Store</a>
+ </li>
+
+ <li class="none">
+ <a href="../thread.html">Thread</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../xmlutil/index.html">XMLUtil</a>
+ </li>
+ </ul>
+ <h5>Containerkit</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../containerkit.html">Overview</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../instrument/index.html">Instrument</a>
+ <ul>
+
+ <li class="none">
+ <a href="../instrument/index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/html-client.html">HTML Based Client</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../instrument/xml-client.html">XML Based Client</a>
+ <ul>
+
+ <li class="none">
+ <a href="../instrument/xml-client-instrument-manager.html">Instrument Manager</a>
+ </li>
+
+ <li class="none">
+ <strong>Instrumentable</strong>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-instrument.html">Instrument</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-sample.html">Sample</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-snapshot.html">Snapshot</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-snapshots.html">Snapshots</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-create-sample.html">Create Sample</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-create-samples.html">Create Samples</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-sample-lease.html">Sample Lease</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-sample-leases.html">Sample Leases</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-gc.html">Invoke GC</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/java-client.html">Java Swing Client</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/configuration.html">Configuration</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/component.html">Component Integration</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/container.html">Container Integration</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/manager.html">Advanced Features</a>
+ </li>
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../lifecycle/index.html">Lifecycle</a>
+ </li>
+
+ <li class="none">
+ <a href="../logger.html">Logger</a>
+ </li>
+ </ul>
+ <h5>Deprecated Materials</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../deprecation.html">Overview</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../deprecation.html">Old Documentation</a>
+ <ul>
+
+ <li class="none">
+ <a href="../component.html">ECM</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../event/index.html">Event</a>
+ </li>
+
+ <li class="none">
+ <a href="../configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <h5>Thanks</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../foundation/thanks.html">to our sponsors!</a>
+ </li>
+
+ <li class="none">
+ <a href="../../foundation/sponsorship.html">Sponsor the ASF</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2><a name="XML_Client_-_Instrumentable"></a>XML Client - Instrumentable</h2>
+<p>
The Instrumentable URL is used to obtain information about a particular
Instrumentable, including any child Instrumentables or Instruments.
By providing a <b>recurse</b> parameter, it is possible to request
a full instrument tree in a single request.
- </p></div><div class="section"><a name="Request"></a><h2>Request</h2><p>
+ </p>
+</div>
+<div class="section"><h2><a name="Request"></a>Request</h2>
+<p>
Request parameters are set as HTTP GET parameters when sending the
request to the server.
- </p><p>
+ </p>
+<p>
For example, to request the <b>instrument-manager</b> Instrumentable,
the following URL can be used:
</p>
- <div class="source"><pre><a href="http://localhost:15080/instrumentable.xml?name=instrument-manager" class="externalLink" title="External Link">http://localhost:15080/instrumentable.xml?name=instrument-manager</a></pre></div>
- <div class="subsection"><a name="Parameters"></a><h3>Parameters</h3><table class="bodyTable"><tr class="a"><th>Name</th><th>Data Type</th><th>Description</th><th>Notes</th></tr><tr class="b"><td><b>name</b></td><td>String</td><td>
+<div class="source"><pre><a href="http://localhost:15080/instrumentable.xml?name=instrument-manager" class="externalLink">http://localhost:15080/instrumentable.xml?name=instrument-manager</a></pre>
+</div>
+<div class="section"><h3><a name="Parameters"></a>Parameters</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+<th>Notes</th>
+</tr>
+<tr class="b"><td><b>name</b></td>
+<td>String</td>
+<td>
The fully qualified name of the Instrumentable being requested.
- </td><td>Required.</td></tr><tr class="a"><td><b>packed</b></td><td>boolean</td><td>
+ </td>
+<td>Required.</td>
+</tr>
+<tr class="a"><td><b>packed</b></td>
+<td>boolean</td>
+<td>
Normally XML is returned in a human-readable pretty format
with indenting and line feeds. While this makes it easy to
work with, it also adds several percent to the size of the
XML returned to the client. By setting the packed parameter
- to "true", all white space is removed from the generated XML.
- </td><td>Optional. Defaults to "false".</td></tr><tr class="b"><td><b>recurse</b></td><td>boolean</td><td>
+ to "true", all white space is removed from the generated XML.
+ </td>
+<td>Optional. Defaults to "false".</td>
+</tr>
+<tr class="b"><td><b>recurse</b></td>
+<td>boolean</td>
+<td>
By default, the Instrumentable URL will return information
about the Instrumentable itself along with any direct
child Instrumentables and Instruments. By setting the
- recurse parameter to "true", the generated XML will recurse
+ recurse parameter to "true", the generated XML will recurse
all the way down through the Instrument tree returning
information about each object. This can be quite useful to
initialize a client application with the current state of
the Instrument tree. Once initialized, it is more efficient
to monitor the <b>state-version</b> attributes and only
request information which has changed.
- </td><td>Optional. Defaults to "false".</td></tr></table></div></div><div class="section"><a name="Response_XML"></a><h2>Response XML</h2><p>
+ </td>
+<td>Optional. Defaults to "false".</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="section"><h2><a name="Response_XML"></a>Response XML</h2>
+<p>
The XML received in the response will be UTF-8 encoded. The root node
will be named <b>instrumentable</b> and have the following attributes.
- </p><p>
+ </p>
+<p>
Each child Instrumentable will be given a <b>instrumentable</b> child
element and each Instrument will be given a <b>instrument</b> element.
If the <b>recurse</b> parameter was specified in the request
@@ -68,18 +590,34 @@
attributes and child elements described for the
<a href="xml-client-instrumentable.html">Instrumentable</a> and
<a href="xml-client-instrument.html">Instrument</a> URLs.
- </p><div class="subsection"><a name="Attributes"></a><h3>Attributes</h3><table class="bodyTable"><tr class="a"><th>Name</th><th>Data Type</th><th>Description</th></tr><tr class="b"><td><b>name</b></td><td>String</td><td>
+ </p>
+<div class="section"><h3><a name="Attributes"></a>Attributes</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><b>name</b></td>
+<td>String</td>
+<td>
Fully qualified name of the Instrumentable. This
name is used to reference the Instrumentable in
other requests.
- </td></tr><tr class="a"><td><b>description</b></td><td>String</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>description</b></td>
+<td>String</td>
+<td>
A human readable descripton of the Instrumentable. It
is optionally specified in the
<a href="configuration.html">Instrument configuration file</a>
and can not be modified from a client. If not configured
then the description will be equal to the last token in the
name.
- </td></tr><tr class="b"><td><b>state-version</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>state-version</b></td>
+<td>int</td>
+<td>
Current State-Version of the Instrumentable. The
state version will be incremented whenever there are any
changes to the Instrumentable or any of its child
@@ -87,41 +625,72 @@
version to decide whether or not it is necessary to to
request further details.
<p></p>
+
If the application is running long enough, the
state version will eventially overflow. To makes
sure your application will handle this case use
an equality test when comparing state versions.
- </td></tr><tr class="a"><td><b>registered</b></td><td>boolean</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>registered</b></td>
+<td>boolean</td>
+<td>
Indicates whether or not the Instrumentable has been registered
with the Instrument Manager after the application was started.
<p></p>
+
It is possible for the Instrumentable to exist but not to have
been registered if the Instrumentable was declared in the
<a href="configuration.html">Instrument configuration file</a>
or had any outstanding leases that survived from a previous
application invocation.
- </td></tr><tr class="b"><td><b>configured</b></td><td>boolean</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>configured</b></td>
+<td>boolean</td>
+<td>
Indicates whether or not the Instrumentable has been declared
in the <a href="configuration.html">Instrument configuration file</a>.
- </td></tr></table></div><div class="subsection"><a name="Child_Elements"></a><h3>Child Elements</h3><table class="bodyTable"><tr class="a"><th>Name</th><th>Description</th></tr><tr class="b"><td><b>instrumentable</b></td><td>
+ </td>
+</tr>
+</table>
+</div>
+<div class="section"><h3><a name="Child_Elements"></a>Child Elements</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><b>instrumentable</b></td>
+<td>
Instrumentable elements will exist for each direct child
Instrumentable that is currently registered with this
Instrumentable. This list may increase as the application
runs so the <b>state-version</b> of the parent <b>instrumentable</b>
should be monitored for changes.
<p></p>
- If the <b>recurse</b> parameter was set to "true" in the
+
+ If the <b>recurse</b> parameter was set to "true" in the
request, an expanded list of attributes and child
elements will be available. See the documentation for the
<a href="xml-client-instrumentable.html">Instrumentable</a>
URL for further details.
<p></p>
+
Attributes:
- <table class="bodyTable"><tr class="a"><th>Name</th><th>Data Type</th><th>Description</th></tr><tr class="b"><td><b>name</b></td><td>String</td><td>
+ <table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><b>name</b></td>
+<td>String</td>
+<td>
Fully qualified name of the Instrumentable. This
name is used to reference the Instrumentable in
other requests.
- </td></tr><tr class="a"><td><b>state-version</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>state-version</b></td>
+<td>int</td>
+<td>
Current State-Version of the Instrumentable. The
state version will be incremented whenever there
are any changes to the Instrumentable or any of
@@ -129,30 +698,48 @@
last known state version to decide whether or not
it is necessary to to request further details.
<p></p>
+
If the application is running long enough, the
state version will eventially overflow. To make
sure your application will handle this case use
an equality test when comparing state versions.
- </td></tr></table>
- </td></tr><tr class="b"><td><b>instrument</b></td><td>
+ </td>
+</tr>
+</table>
+</td>
+</tr>
+<tr class="b"><td><b>instrument</b></td>
+<td>
Instrument elements will exist for each Instrument that is
currently registered with this Instrumentable. This list may
increase as the application runs so the <b>state-version</b>
of the parent <b>instrumentable</b> should be monitored for
changes.
<p></p>
- If the <b>recurse</b> parameter was set to "true" in the
+
+ If the <b>recurse</b> parameter was set to "true" in the
request, an expanded list of attributes and child
elements will be available. See the documentation for the
<a href="xml-client-instrument.html">Instrument</a>
URL for further details.
<p></p>
+
Attributes:
- <table class="bodyTable"><tr class="a"><th>Name</th><th>Data Type</th><th>Description</th></tr><tr class="b"><td><b>name</b></td><td>String</td><td>
+ <table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><b>name</b></td>
+<td>String</td>
+<td>
Fully qualified name of the Instrument. This
name is used to reference the Instrument in
other requests.
- </td></tr><tr class="a"><td><b>state-version</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>state-version</b></td>
+<td>int</td>
+<td>
Current State-Version of the Instrument. The
state version will be incremented whenever there
are any changes to the Instrument or any of
@@ -160,9 +747,42 @@
last known state version to decide whether or not
it is necessary to to request further details.
<p></p>
+
If the application is running long enough, the
state version will eventially overflow. To make
sure your application will handle this case use
an equality test when comparing state versions.
- </td></tr></table>
- </td></tr></table></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 1997-2007, The Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
+ </td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+</div>
+</div>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2009
+
+ The Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Modified: excalibur/site/instrument/xml-client-sample.html
URL: http://svn.apache.org/viewvc/excalibur/site/instrument/xml-client-sample.html?rev=785324&r1=785323&r2=785324&view=diff
==============================================================================
--- excalibur/site/instrument/xml-client-sample.html (original)
+++ excalibur/site/instrument/xml-client-sample.html Tue Jun 16 17:55:25 2009
@@ -1,121 +1,712 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Apache Excalibur - Excalibur Instrument - XML Client - Instrument Sample</title><style type="text/css" media="all">
- @import url("../style/maven-base.css");
-
- @import url("../style/maven-theme.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Leif Mortenson"></meta><meta name="email" content="leif.AT.tanukisoftware.DOT.com"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="The Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://excalibur.apache.org/" id="projectLogo"><img alt="Apache Excalibur" src="http://excalibur.apache.org/logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xright">
-
- <a href="../index.html">Home</a>
-
-
-
- <span class="separator">|</span>
-
-
- <a href="../fortress/index.html">Fortress</a>
-
-
-
- <span class="separator">|</span>
-
-
- <a href="../component-list.html">Components</a>
-
-
-
- <span class="separator">|</span>
-
-
- <a href="../containerkit.html">Containerkit</a>
- </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="../index.html">Overview</a></li><li class="none"><a href="../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../svn.html">Subversion</a></li><li class="none"><a href="http://wiki.apache.org/excalibur/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a href="http://wiki.apache.org/excalibur/FrequentlyAskedQuestions" class="externalLink" title="External Link">FAQ</a></li><li class="none"><a href="http://excalibur.apache.org/apidocs/" class="externalLink" title="External Link">Javadocs</a></li><li class="none"><a href="http://excalibur.apache.org/download.cgi" class="externalLink" title="External Link">Download</a></li><li class="none"><a href="../issue-tracking.html">Issue Tracking</a></li><li class="collapsed"><a href="../misc.html">Miscellaneous</a></li></ul></div><div
id="menuFortress"><h5>Fortress</h5><ul><li class="none"><a href="../fortress/index.html">Overview</a></li><li class="none"><a href="../fortress/features.html">Features Oriented</a></li><li class="none"><a href="../fortress/getting-started.html">Getting Started</a></li><li class="none"><a href="../fortress/using-meta-info.html">Using Meta Info</a></li><li class="none"><a href="../fortress/cli.html">CLI</a></li><li class="none"><a href="../fortress/swing.html">Swing</a></li><li class="none"><a href="../fortress/servlet.html">Servlet</a></li><li class="none"><a href="../lifecycle/index.html">Lifecycle Extensions</a></li><li class="none"><a href="../fortress/design-notes.html">Design Notes</a></li></ul></div><div id="menuFramework"><h5>Framework</h5><ul><li class="collapsed"><a href="../framework/index.html">Documentation</a></li><li class="collapsed"><a href="../developing/index.html">Developing</a></li></ul></div><div id="menuComponents"><h5>Components</h5><ul><li class="none
"><a href="../component-list.html">Overview</a></li><li class="collapsed"><a href="../sourceresolve/index.html">Sourceresolver</a></li><li class="collapsed"><a href="../store/index.html">Store</a></li><li class="none"><a href="../thread.html">Thread</a></li><li class="collapsed"><a href="../xmlutil/index.html">XMLUtil</a></li></ul></div><div id="menuContainerkit"><h5>Containerkit</h5><ul><li class="none"><a href="../containerkit.html">Overview</a></li><li class="expanded"><a href="../instrument/index.html">Instrument</a><ul><li class="none"><a href="../instrument/index.html">Overview</a></li><li class="none"><a href="../instrument/html-client.html">HTML Based Client</a></li><li class="expanded"><a href="../instrument/xml-client.html">XML Based Client</a><ul><li class="none"><a href="../instrument/xml-client-instrument-manager.html">Instrument Manager</a></li><li class="none"><a href="../instrument/xml-client-instrumentable.html">Instrumentable</a></li><li class="none"><a hre
f="../instrument/xml-client-instrument.html">Instrument</a></li><li class="none"><strong><a href="../instrument/xml-client-sample.html">Sample</a></strong></li><li class="none"><a href="../instrument/xml-client-snapshot.html">Snapshot</a></li><li class="none"><a href="../instrument/xml-client-snapshots.html">Snapshots</a></li><li class="none"><a href="../instrument/xml-client-create-sample.html">Create Sample</a></li><li class="none"><a href="../instrument/xml-client-create-samples.html">Create Samples</a></li><li class="none"><a href="../instrument/xml-client-sample-lease.html">Sample Lease</a></li><li class="none"><a href="../instrument/xml-client-sample-leases.html">Sample Leases</a></li><li class="none"><a href="../instrument/xml-client-gc.html">Invoke GC</a></li></ul></li><li class="none"><a href="../instrument/java-client.html">Java Swing Client</a></li><li class="none"><a href="../instrument/configuration.html">Configuration</a></li><li class="none"><a href="../instru
ment/component.html">Component Integration</a></li><li class="none"><a href="../instrument/container.html">Container Integration</a></li><li class="none"><a href="../instrument/manager.html">Advanced Features</a></li></ul></li><li class="collapsed"><a href="../lifecycle/index.html">Lifecycle</a></li><li class="none"><a href="../logger.html">Logger</a></li></ul></div><div id="menuDeprecated_Materials"><h5>Deprecated Materials</h5><ul><li class="none"><a href="../deprecation.html">Overview</a></li><li class="expanded"><a href="../deprecation.html">Old Documentation</a><ul><li class="none"><a href="../component.html">ECM</a></li><li class="collapsed"><a href="../event/index.html">Event</a></li><li class="none"><a href="../configuration.html">Configuration</a></li></ul></li></ul></div><div id="menuThanks"><h5>Thanks</h5><ul><li class="none"><a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="External Link">to our sponsors!</a></li><li class="none">
<a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="External Link">Sponsor the ASF</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="../index.html">About Apache Excalibur</a></li><li class="collapsed"><a href="../project-info.html">Project Info</a></li><li class="collapsed"><a href="../maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html" class="externalLink" title="External Link">Development Process</a></li></ul></div></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="XML_Client_-_Instrument_Sample"></a><h2>XML Client - Instrument Sample</h2><p>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Excalibur - Excalibur Instrument - XML Client - Instrument Sample</title>
+ <style type="text/css" media="all">
+ @import url("../css/maven-base.css");
+ @import url("../css/maven-theme.css");
+ @import url("../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Leif Mortenson" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <span id="bannerLeft">
+
+ Excalibur
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2009-06-16
+ </div>
+ <div class="xright"> <a href="../index.html">Home</a>
+ |
+ <a href="../fortress/index.html">Fortress</a>
+ |
+ <a href="../component-list.html">Components</a>
+ |
+ <a href="../containerkit.html">Containerkit</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Essentials</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../svn.html">Subversion</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/excalibur/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/excalibur/FrequentlyAskedQuestions" class="externalLink">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="http://excalibur.apache.org/apidocs/" class="externalLink">Javadocs</a>
+ </li>
+
+ <li class="none">
+ <a href="http://excalibur.apache.org/download.cgi" class="externalLink">Download</a>
+ </li>
+
+ <li class="none">
+ <a href="../issue-tracking.html">Issue Tracking</a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../misc.html">Miscellaneous</a>
+ </li>
+ </ul>
+ <h5>Fortress</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../fortress/index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/features.html">Features Oriented</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/getting-started.html">Getting Started</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/using-meta-info.html">Using Meta Info</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/cli.html">CLI</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/swing.html">Swing</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/servlet.html">Servlet</a>
+ </li>
+
+ <li class="none">
+ <a href="../lifecycle/index.html">Lifecycle Extensions</a>
+ </li>
+
+ <li class="none">
+ <a href="../fortress/design-notes.html">Design Notes</a>
+ </li>
+ </ul>
+ <h5>Framework</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../framework/index.html">Documentation</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../developing/index.html">Developing</a>
+ </li>
+ </ul>
+ <h5>Components</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../component-list.html">Overview</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../sourceresolve/index.html">Sourceresolver</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../store/index.html">Store</a>
+ </li>
+
+ <li class="none">
+ <a href="../thread.html">Thread</a>
+ </li>
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../xmlutil/index.html">XMLUtil</a>
+ </li>
+ </ul>
+ <h5>Containerkit</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../containerkit.html">Overview</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../instrument/index.html">Instrument</a>
+ <ul>
+
+ <li class="none">
+ <a href="../instrument/index.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/html-client.html">HTML Based Client</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../instrument/xml-client.html">XML Based Client</a>
+ <ul>
+
+ <li class="none">
+ <a href="../instrument/xml-client-instrument-manager.html">Instrument Manager</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-instrumentable.html">Instrumentable</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-instrument.html">Instrument</a>
+ </li>
+
+ <li class="none">
+ <strong>Sample</strong>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-snapshot.html">Snapshot</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-snapshots.html">Snapshots</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-create-sample.html">Create Sample</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-create-samples.html">Create Samples</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-sample-lease.html">Sample Lease</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-sample-leases.html">Sample Leases</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/xml-client-gc.html">Invoke GC</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/java-client.html">Java Swing Client</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/configuration.html">Configuration</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/component.html">Component Integration</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/container.html">Container Integration</a>
+ </li>
+
+ <li class="none">
+ <a href="../instrument/manager.html">Advanced Features</a>
+ </li>
+ </ul>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../lifecycle/index.html">Lifecycle</a>
+ </li>
+
+ <li class="none">
+ <a href="../logger.html">Logger</a>
+ </li>
+ </ul>
+ <h5>Deprecated Materials</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../deprecation.html">Overview</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../deprecation.html">Old Documentation</a>
+ <ul>
+
+ <li class="none">
+ <a href="../component.html">ECM</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="collapsed">
+ <a href="../event/index.html">Event</a>
+ </li>
+
+ <li class="none">
+ <a href="../configuration.html">Configuration</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <h5>Thanks</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../foundation/thanks.html">to our sponsors!</a>
+ </li>
+
+ <li class="none">
+ <a href="../../foundation/sponsorship.html">Sponsor the ASF</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <div class="section"><h2><a name="XML_Client_-_Instrument_Sample"></a>XML Client - Instrument Sample</h2>
+<p>
The Sample URL is used to obtain information about a particular
Sample. To obtain the actual data points of the sample, the
<a href="xml-client-snapshot.html">Sample Snapshot</a> URL must
be used.
- </p></div><div class="section"><a name="Request"></a><h2>Request</h2><p>
+ </p>
+</div>
+<div class="section"><h2><a name="Request"></a>Request</h2>
+<p>
Request parameters are set as HTTP GET parameters when sending the
request to the server.
- </p><p>
+ </p>
+<p>
For example, to request the <b>instrument-manager.memory.maximum_1000_600</b>
Instrument Sample, the following URL can be used. Note that this assumes
that such a sample lease has been granted for the specified sample.
</p>
- <div class="source"><pre><a href="http://localhost:15080/sample.xml?name=instrument-manager.memory.maximum_1000_600" class="externalLink" title="External Link">http://localhost:15080/sample.xml?name=instrument-manager.memory.maximum_1000_600</a></pre></div>
- <div class="subsection"><a name="Parameters"></a><h3>Parameters</h3><table class="bodyTable"><tr class="b"><th>Name</th><th>Data Type</th><th>Description</th><th>Notes</th></tr><tr class="a"><td><b>name</b></td><td>String</td><td>
+<div class="source"><pre><a href="http://localhost:15080/sample.xml?name=instrument-manager.memory.maximum_1000_600" class="externalLink">http://localhost:15080/sample.xml?name=instrument-manager.memory.maximum_1000_600</a></pre>
+</div>
+<div class="section"><h3><a name="Parameters"></a>Parameters</h3>
+<table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+<th>Notes</th>
+</tr>
+<tr class="b"><td><b>name</b></td>
+<td>String</td>
+<td>
The fully qualified name of the Instrument Sample being requested.
The name is generated by the Instrument Manager when an Instrument
Sample is created. It is built up using three tokens; the type of
the sample, the interval and the size (number of data points).
- </td><td>Required.</td></tr><tr class="b"><td><b>packed</b></td><td>boolean</td><td>
+ </td>
+<td>Required.</td>
+</tr>
+<tr class="a"><td><b>packed</b></td>
+<td>boolean</td>
+<td>
Normally XML is returned in a human-readable pretty format
with indenting and line feeds. While this makes it easy to
work with, it also adds several percent to the size of the
XML returned to the client. By setting the packed parameter
- to "true", all white space is removed from the generated XML.
- </td><td>Optional. Defaults to "false".</td></tr></table></div></div><div class="section"><a name="Response_XML"></a><h2>Response XML</h2><p>
+ to "true", all white space is removed from the generated XML.
+ </td>
+<td>Optional. Defaults to "false".</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="section"><h2><a name="Response_XML"></a>Response XML</h2>
+<p>
The XML received in the response will be UTF-8 encoded. The root node
will be named <b>sample</b> and have the following attributes.
- </p><div class="subsection"><a name="Attributes"></a><h3>Attributes</h3><table class="bodyTable"><tr class="a"><th>Name</th><th>Data Type</th><th>Description</th></tr><tr class="b"><td><b>name</b></td><td>String</td><td>
+ </p>
+<div class="section"><h3><a name="Attributes"></a>Attributes</h3>
+<table class="bodyTable"><tr class="b"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+</tr>
+<tr class="a"><td><b>name</b></td>
+<td>String</td>
+<td>
Fully qualified name of the Instrument. This
name is used to reference the Instrument in
other requests.
The name is generated by the Instrument Manager when an Instrument
Sample is created. It is built up using three tokens; the type of
the sample, the interval and the size (number of data points).
- </td></tr><tr class="a"><td><b>description</b></td><td>String</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>description</b></td>
+<td>String</td>
+<td>
A human readable descripton of the Instrument. If the Instrument
Sample was specified in the <a href="configuration.html">Instrument configuration file</a>
then the description may have been specified there. Otherwise, the
description will have been specified as part of the lease request
for the sample.
- </td></tr><tr class="b"><td><b>type</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>type</b></td>
+<td>int</td>
+<td>
Specifies the type of the Instrument Sample.
- <ul>
- <li><b>101</b> - Counter Sample - Available for Counter Instruments</li>
- <li><b>102</b> - Minumum Value Sample - Available for Value Instruments</li>
- <li><b>103</b> - Maximum Value Sample - Available for Value Instruments</li>
- <li><b>104</b> - Mean Value Sample - Available for Value Instruments</li>
- </ul>
- </td></tr><tr class="a"><td><b>interval</b></td><td>long</td><td>
+ <ul><li><b>101</b> - Counter Sample - Available for Counter Instruments</li>
+<li><b>102</b> - Minumum Value Sample - Available for Value Instruments</li>
+<li><b>103</b> - Maximum Value Sample - Available for Value Instruments</li>
+<li><b>104</b> - Mean Value Sample - Available for Value Instruments</li>
+</ul>
+</td>
+</tr>
+<tr class="b"><td><b>interval</b></td>
+<td>long</td>
+<td>
The interval of time, in milliseconds, covered by each data point in
the Instrument Sample.
- </td></tr><tr class="b"><td><b>size</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>size</b></td>
+<td>int</td>
+<td>
The number of data points maintained by the Instrument Sample. If this
value is 600, and the interval is 1000, then the full Instrument Sample
represents a period of 10 minutes.
- </td></tr><tr class="a"><td><b>value</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>value</b></td>
+<td>int</td>
+<td>
The current value of the most recent data point in the Instrument
Sample.
- </td></tr><tr class="b"><td><b>time</b></td><td>long</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>time</b></td>
+<td>long</td>
+<td>
The time of the beginning of the interval represented by the most
recent data point. If the interval is one 1000, or 1 second, then
this will be the current time rounded down to the second. If it
is a larger value like 60000, then it will the current time rounded
down to the current minute.
- </td></tr><tr class="a"><td><b>expiration-time</b></td><td>long</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>expiration-time</b></td>
+<td>long</td>
+<td>
The time at which the lease on the Instrument Sample will expire.
The lease can be renewed at any time to extend this time. An
expiration time of 0 specifies that the Instrument Sample is
permanent. It is not possible to create a permanent Sample from
a client. They must be configured in the
<a href="configuration.html">Instrument configuration file</a>.
- </td></tr><tr class="b"><td><b>state-version</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>state-version</b></td>
+<td>int</td>
+<td>
Current State-Version of the Instrument Sample. The
state version will be incremented whenever there are any
changes to the Instrument. It can be compared with a last
known state version to decide whether or not it is necessary
to to request further details.
<p></p>
+
Changes to the lease expiration time will cause the state to
be incremented. Individual changes to the <b>value</b> or
<b>time</b> attributes occur as Instrument values are set and
do not affect the state version.
<p></p>
+
If the application is running long enough, the
state version will eventially overflow. To makes
sure your application will handle this case use
an equality test when comparing state versions.
- </td></tr><tr class="a"><td><b>configured</b></td><td>boolean</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>configured</b></td>
+<td>boolean</td>
+<td>
Indicates whether or not the Instrument Sample has been declared
in the <a href="configuration.html">Instrument configuration file</a>.
All configured Samples will be permanent, meaning that their
<b>expiration-time</b> will be 0.
- </td></tr></table></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 1997-2007, The Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
+ </td>
+</tr>
+</table>
+</div>
+</div>
+
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2009
+
+ The Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: scm-unsubscribe@excalibur.apache.org
For additional commands, e-mail: scm-help@excalibur.apache.org