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 [22/28] - in /excalibur/site: ./ css/ developing/ event/
fortress/ framework/ images/logos/ instrument/ lifecycle/ sourceresolve/
store/ xmlutil/
Modified: excalibur/site/instrument/xml-client-snapshot.html
URL: http://svn.apache.org/viewvc/excalibur/site/instrument/xml-client-snapshot.html?rev=785324&r1=785323&r2=785324&view=diff
==============================================================================
--- excalibur/site/instrument/xml-client-snapshot.html (original)
+++ excalibur/site/instrument/xml-client-snapshot.html Tue Jun 16 17:55:25 2009
@@ -1,60 +1,571 @@
-<!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 Snapshot</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"><a href="../instrument/xml-client-sample.html">Sample</a></li><li class="none"><strong><a href="../instrument/xml-client-snapshot.html">Snapshot</a></strong></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_Snapshot"></a><h2>XML Client - Instrument Sample Snapshot</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 Snapshot</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">
+ <a href="../instrument/xml-client-sample.html">Sample</a>
+ </li>
+
+ <li class="none">
+ <strong>Snapshot</strong>
+ </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_Snapshot"></a>XML Client - Instrument Sample Snapshot</h2>
+<p>
The Sample Snapshot URL is used to obtain a snapshot of the data points
in a particular Instrument Sample. All of the attributes returned by the
<a href="xml-client-sample.html">Instrument Sample</a> URL are included,
so there is no need to request that URL first. The snaphot URL includes
the individual data points as well as additional attributes describing
the data points.
- </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 Snapshot, the following URL can be used. Note that
this assumes that such a sample lease has been granted for the specified
sample. (The <b>compact</b> flag is being set because some browsers have
a difficult time rendering large XML files quickly.)
</p>
- <div class="source"><pre><a href="http://localhost:15080/snapshot.xml?name=instrument-manager.memory.maximum_1000_600&compact=true" class="externalLink" title="External Link">http://localhost:15080/snapshot.xml?name=instrument-manager.memory.maximum_1000_600&compact=true</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/snapshot.xml?name=instrument-manager.memory.maximum_1000_600&compact=true" class="externalLink">http://localhost:15080/snapshot.xml?name=instrument-manager.memory.maximum_1000_600&compact=true</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>base-time</b></td><td>long</td><td>
+ </td>
+<td>Required.</td>
+</tr>
+<tr class="a"><td><b>base-time</b></td>
+<td>long</td>
+<td>
Used to specify a base reference time of the data points included
in the snapshots.
<p></p>
+
When requesting a snapshot of an Instrument Sample for the first
time, this parameter should be omitted or set to 0.
<p></p>
+
However on subsequent requests, this can be set to the value of
the <b>time</b> attribute of the previous request. By doing so,
the last data point of the previous request and all newer data
@@ -62,22 +573,34 @@
changed so there is really no reason to have the server resend
them.
<p></p>
+
It can add complexity to a client, but the bandwidth with the
server can be greatly reduced by carefully avoiding the
unnecessary retransmition of data points.
- </td><td>
+ </td>
+<td>
Optional. Defaults to 0, meaning that all data points will be
returned.
- </td></tr><tr class="a"><td><b>packed</b></td><td>boolean</td><td>
+ </td>
+</tr>
+<tr class="b"><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>compact</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="a"><td><b>compact</b></td>
+<td>boolean</td>
+<td>
The data point values can be returned in two different XML
formats.
<p></p>
+
The first is a verbose format where each individual data point
gets its own <b>value</b> child element with <b>value</b> and
<b>time</b> attributes. This can be useful in certain contexts
@@ -85,109 +608,226 @@
drawback is that the XML can be large when the full set of data
points are requested.
<p></p>
+
The second format is specified by setting the <b>compact</b>
- parameter to "true". All of the data point values are placed
+ parameter to "true". All of the data point values are placed
into a comma separated list and stored as the value of a
<b>values</b> child element. This results in much smaller
XML, but requires that the client be able to parse out the
individual values as well as calculate the times of each data
point.
- </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>sample</b> and have the following attributes. Depending
on the value of the <b>compact</b> parameter, either a single <b>values</b>
child element, or set of individual <b>value</b> elements will be included.
- </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>first-time</b></td><td>long</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>first-time</b></td>
+<td>long</td>
+<td>
The time of the beginning of the interval represented by the first
data point returned by the sample. The start time of any data point
can be calculated by adding N * the interval to this value.
- </td></tr><tr class="b"><td><b>count</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>count</b></td>
+<td>int</td>
+<td>
The number of data points returned in the snapshot. If the
<b>base-time</b> parameter was not specified then this will be
equal to the <b>size</b> attribute.
- </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 class="subsection"><a name="Child_Elements"></a><h3>Child Elements</h3><table class="bodyTable"><tr class="b"><th>Name</th><th>Description</th></tr><tr class="a"><td><b>value</b></td><td>
- If the <b>compact</b> parameter was set to "false" or omitted
+ </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>value</b></td>
+<td>
+ If the <b>compact</b> parameter was set to "false" or omitted
then the each individual data point in the snapshot will be
represented by a single <b>value</b> child element.
<p></p>
+
Attributes:
- <table class="bodyTable"><tr class="b"><th>Name</th><th>Data Type</th><th>Description</th></tr><tr class="a"><td><b>time</b></td><td>long</td><td>
+ <table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><b>time</b></td>
+<td>long</td>
+<td>
The time at the beginning of the data point sample.
The difference between the <b>time</b> values of each
data point value will be equal to the value of the
<b>interval</b> attribute.
- </td></tr><tr class="b"><td><b>value</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>value</b></td>
+<td>int</td>
+<td>
The value of the data point
- </td></tr></table>
- </td></tr><tr class="a"><td><b>values</b></td><td>
- If the <b>compact</b> parameter was set to "true", then all of the
+ </td>
+</tr>
+</table>
+</td>
+</tr>
+<tr class="b"><td><b>values</b></td>
+<td>
+ If the <b>compact</b> parameter was set to "true", then all of the
data point values will be placed into a comma separated list and
returned as the value of a single <b>values</b> child element.
<p></p>
+
The <b>values</b> child element does not have any attributes.
- </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>
Modified: excalibur/site/instrument/xml-client-snapshots.html
URL: http://svn.apache.org/viewvc/excalibur/site/instrument/xml-client-snapshots.html?rev=785324&r1=785323&r2=785324&view=diff
==============================================================================
--- excalibur/site/instrument/xml-client-snapshots.html (original)
+++ excalibur/site/instrument/xml-client-snapshots.html Tue Jun 16 17:55:25 2009
@@ -1,39 +1,534 @@
-<!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 Snapshot</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"><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"><strong><a href="../instrument/xml-client-snapshots.html">Snapshots</a></strong></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_Snapshot"></a><h2>XML Client - Instrument Sample Snapshot</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 Snapshot</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">
+ <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">
+ <strong>Snapshots</strong>
+ </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_Snapshot"></a>XML Client - Instrument Sample Snapshot</h2>
+<p>
The Sample Snapshots URL work similar to the
<a href="xml-client-snapshot.html">Sample Snapshot URL</a>
except that it makes it possible to request snapshots for several
Samples 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.memory.maximum_1000_600</b>
and <b>instrument-manager.total-memory.maximum_1000_600</b>
Instrument Sample Snapshots, the following URL can be used. Note that
@@ -41,23 +536,41 @@
samples. (The <b>compact</b> flag is being set because some browsers have
a difficult time rendering large XML files quickly.)
</p>
- <div class="source"><pre><a href="http://localhost:15080/snapshots.xml?name=instrument-manager.memory.maximum_1000_600&name=instrument-manager.total-memory.maximum_1000_600&compact=true" class="externalLink" title="External Link">http://localhost:15080/snapshots.xml?name=instrument-manager.memory.maximum_1000_600<br></br>&name=instrument-manager.total-memory.maximum_1000_600&compact=true</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/snapshots.xml?name=instrument-manager.memory.maximum_1000_600&name=instrument-manager.total-memory.maximum_1000_600&compact=true" class="externalLink">http://localhost:15080/snapshots.xml?name=instrument-manager.memory.maximum_1000_600<br />
+&name=instrument-manager.total-memory.maximum_1000_600&compact=true</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>
One or more fully qualified names of the Instrument Samples being
requested. The names are generated by the Instrument Manager when
the Instrument Samples are created. They are each built up using
three tokens; the type of the sample, the interval and the size
(number of data points).
<p></p>
+
To request multiple snapshots, the <b>name</b> parameter is specified
multiple times.
- </td><td>Optional.</td></tr><tr class="b"><td><b>base-time</b></td><td>long</td><td>
+ </td>
+<td>Optional.</td>
+</tr>
+<tr class="a"><td><b>base-time</b></td>
+<td>long</td>
+<td>
Used to specify a base reference time of the data points included
in the snapshots.
<p></p>
+
When requesting a snapshot of an Instrument Sample for the first
time, this parameter should be omitted or set to 0.
<p></p>
+
However on subsequent requests, this can be set to the value of
the <b>time</b> attribute of the previous request. By doing so,
the last data point of the previous request and all newer data
@@ -65,26 +578,39 @@
changed so there is really no reason to have the server resend
them.
<p></p>
+
It can add complexity to a client, but the bandwidth with the
server can be greatly reduced by carefully avoiding the
unnecessary retransmition of data points.
<p></p>
+
If at least one <b>base-time</b> parameter is specified then the
number of <b>base-time</b>s must equal the number of <b>name</b>
parameters.
- </td><td>
+ </td>
+<td>
Optional. If not specified, then it defaults to 0 for all snapshots
requested, meaning that all data points will be returned.
- </td></tr><tr class="a"><td><b>packed</b></td><td>boolean</td><td>
+ </td>
+</tr>
+<tr class="b"><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>compact</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="a"><td><b>compact</b></td>
+<td>boolean</td>
+<td>
The data point values can be returned in two different XML
formats.
<p></p>
+
The first is a verbose format where each individual data point
gets its own <b>value</b> child element with <b>value</b> and
<b>time</b> attributes. This can be useful in certain contexts
@@ -92,114 +618,232 @@
drawback is that the XML can be large when the full set of data
points are requested.
<p></p>
+
The second format is specified by setting the <b>compact</b>
- parameter to "true". All of the data point values are placed
+ parameter to "true". All of the data point values are placed
into a comma separated list and stored as the value of a
<b>values</b> child element. This results in much smaller
XML, but requires that the client be able to parse out the
individual values as well as calculate the times of each data
point.
- </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>samples</b>. A <b>sample</b> child node will be returned
for each requested sample which still exists at the time of the call.
Samples which have expired will not be returned.
- </p><p>
+ </p>
+<p>
Each individual <b>sample</b> child element will have the following attributes.
Depending on the value of the <b>compact</b> parameter, either a single
<b>values</b> child element, or set of individual <b>value</b> elements will
be included.
- </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>first-time</b></td><td>long</td><td>
+ </td>
+</tr>
+<tr class="b"><td><b>first-time</b></td>
+<td>long</td>
+<td>
The time of the beginning of the interval represented by the first
data point returned by the sample. The start time of any data point
can be calculated by adding N * the interval to this value.
- </td></tr><tr class="b"><td><b>count</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>count</b></td>
+<td>int</td>
+<td>
The number of data points returned in the snapshot. If the
<b>base-time</b> parameter was not specified then this will be
equal to the <b>size</b> attribute.
- </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 class="subsection"><a name="Child_Elements"></a><h3>Child Elements</h3><table class="bodyTable"><tr class="b"><th>Name</th><th>Description</th></tr><tr class="a"><td><b>value</b></td><td>
- If the <b>compact</b> parameter was set to "false" or omitted
+ </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>value</b></td>
+<td>
+ If the <b>compact</b> parameter was set to "false" or omitted
then the each individual data point in the snapshot will be
represented by a single <b>value</b> child element.
<p></p>
+
Attributes:
- <table class="bodyTable"><tr class="b"><th>Name</th><th>Data Type</th><th>Description</th></tr><tr class="a"><td><b>time</b></td><td>long</td><td>
+ <table class="bodyTable"><tr class="a"><th>Name</th>
+<th>Data Type</th>
+<th>Description</th>
+</tr>
+<tr class="b"><td><b>time</b></td>
+<td>long</td>
+<td>
The time at the beginning of the data point sample.
The difference between the <b>time</b> values of each
data point value will be equal to the value of the
<b>interval</b> attribute.
- </td></tr><tr class="b"><td><b>value</b></td><td>int</td><td>
+ </td>
+</tr>
+<tr class="a"><td><b>value</b></td>
+<td>int</td>
+<td>
The value of the data point
- </td></tr></table>
- </td></tr><tr class="a"><td><b>values</b></td><td>
- If the <b>compact</b> parameter was set to "true", then all of the
+ </td>
+</tr>
+</table>
+</td>
+</tr>
+<tr class="b"><td><b>values</b></td>
+<td>
+ If the <b>compact</b> parameter was set to "true", then all of the
data point values will be placed into a comma separated list and
returned as the value of a single <b>values</b> child element.
<p></p>
+
The <b>values</b> child element does not have any attributes.
- </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