| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.geode (Apache Geode 1.15.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.geode (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../org/apache/geode/admin/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/geode/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.geode</h1> |
| <div class="docSummary"> |
| <div class="block">The base package of the GemFire Java product, featuring highly |
| concurrent distributed <a href="../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">caching</a> |
| with <a href="../../../org/apache/geode/cache/CacheEvent.html" title="interface in org.apache.geode.cache">cache event</a> delivery, |
| <a href="../../../org/apache/geode/cache/query/package-summary.html#package_description">OQL querying</a>, and |
| <a href="../../../org/apache/geode/admin/package-summary.html#package_description">remote cache administration</a>, built using a <a href="../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> which includes a |
| <a href="../../../org/apache/geode/distributed/DistributedLockService.html" title="class in org.apache.geode.distributed">DistributedLockService</a>.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode">DataSerializable</a></td> |
| <td class="colLast"> |
| <div class="block">An interface for objects whose state can be written/read as primitive types and strings ("data").</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/DataSerializable.Replaceable.html" title="interface in org.apache.geode">DataSerializable.Replaceable</a></td> |
| <td class="colLast"> |
| <div class="block"><code>Replaceable</code> allows an object to write an alternative version of itself to a |
| <code>DataOutput</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/Delta.html" title="interface in org.apache.geode">Delta</a></td> |
| <td class="colLast"> |
| <div class="block">This interface defines a contract between the application and GemFire that allows GemFire to |
| determine whether an application object contains a delta, allows GemFire to extract the delta |
| from an application object, and generate a new application object by applying a delta to an |
| existing application object.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/LogWriter.html" title="interface in org.apache.geode">LogWriter</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Please use Log4J2 instead.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode">StatisticDescriptor</a></td> |
| <td class="colLast"> |
| <div class="block">Describes an individual statistic whose value is updated by an application and may be archived by |
| GemFire.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode">Statistics</a></td> |
| <td class="colLast"> |
| <div class="block">Instances of this interface maintain the values of various application-defined statistics.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/StatisticsFactory.html" title="interface in org.apache.geode">StatisticsFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Instances of this interface provide methods that create instances of <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode">StatisticsType</a></td> |
| <td class="colLast"> |
| <div class="block">Used to describe a logical collection of statistics.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/StatisticsTypeFactory.html" title="interface in org.apache.geode">StatisticsTypeFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Instances of this interface provide methods that create instances of <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> |
| and <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/CancelCriterion.html" title="class in org.apache.geode">CancelCriterion</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract cancellation proxy for cancelling an operation, esp.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/CanonicalInstantiator.html" title="class in org.apache.geode">CanonicalInstantiator</a></td> |
| <td class="colLast"> |
| <div class="block"><code>CanonicalInstantiator</code> is much like its parent <code>Instantiator</code> except that |
| instead of needing to implement <code>newInstance()</code> you now must implement |
| <code>newInstance(DataInput)</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/CopyHelper.html" title="class in org.apache.geode">CopyHelper</a></td> |
| <td class="colLast"> |
| <div class="block">A static helper for optimally creating copies.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/DataSerializer.html" title="class in org.apache.geode">DataSerializer</a></td> |
| <td class="colLast"> |
| <div class="block">Provides static helper methods for reading and writing non-primitive data when working with a |
| <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><code>DataSerializable</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/Instantiator.html" title="class in org.apache.geode">Instantiator</a></td> |
| <td class="colLast"> |
| <div class="block"><code>Instantiator</code> allows classes that implement <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><code>DataSerializable</code></a> to be registered with |
| the data serialization framework.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/SystemFailure.html" title="class in org.apache.geode">SystemFailure</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">since Geode 1.11 because it is potentially counterproductive to try |
| to mitigate a VirtualMachineError since the JVM (spec) makes no guarantees about the |
| soundness of the JVM after such an error.</span></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/CancelException.html" title="class in org.apache.geode">CancelException</a></td> |
| <td class="colLast"> |
| <div class="block">Abstract root class of all GemFire exceptions representing system cancellation</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/CopyException.html" title="class in org.apache.geode">CopyException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates a failure to copy an object.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/DeltaSerializationException.html" title="class in org.apache.geode">DeltaSerializationException</a></td> |
| <td class="colLast"> |
| <div class="block">This exception wraps any checked exception encountered during invocation of |
| <a href="../../../org/apache/geode/Delta.html#fromDelta-java.io.DataInput-"><code>Delta.fromDelta(java.io.DataInput)</code></a> or <a href="../../../org/apache/geode/Delta.html#toDelta-java.io.DataOutput-"><code>Delta.toDelta(java.io.DataOutput)</code></a> in |
| GemFire.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/ForcedDisconnectException.html" title="class in org.apache.geode">ForcedDisconnectException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>ForcedDisconnectException</code> is thrown when a GemFire application is removed from |
| the distributed system due to membership constraints such as network partition detection.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/GemFireCacheException.html" title="class in org.apache.geode">GemFireCacheException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>GemFireCacheException</code> is used to wrap a <a href="../../../org/apache/geode/cache/CacheException.html" title="class in org.apache.geode.cache"><code>CacheException</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/GemFireCheckedException.html" title="class in org.apache.geode">GemFireCheckedException</a></td> |
| <td class="colLast"> |
| <div class="block">This is the abstract superclass of exceptions that are thrown and declared.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/GemFireConfigException.html" title="class in org.apache.geode">GemFireConfigException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>GemFireConfigException</code> is used for failures while processing a GemFire |
| configuration XML file.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/GemFireException.html" title="class in org.apache.geode">GemFireException</a></td> |
| <td class="colLast"> |
| <div class="block">This is the abstract superclass of exceptions that are thrown to indicate incorrect usage of |
| GemFire.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/GemFireIOException.html" title="class in org.apache.geode">GemFireIOException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>GemFireIOException</code> is thrown when a GemFire operation failure is caused by an |
| <code>IOException</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/IncompatibleSystemException.html" title="class in org.apache.geode">IncompatibleSystemException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>IncompatibleSystemException</code> is thrown when a new GemFire process tries to connect |
| to an existing distributed system and its version is not the same as that of the distributed |
| system.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/InternalGemFireException.html" title="class in org.apache.geode">InternalGemFireException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>InternalGemFireException</code> is thrown when a low level, internal, operation fails |
| due to no fault of the user.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/InvalidDeltaException.html" title="class in org.apache.geode">InvalidDeltaException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>InvalidDeltaException</code> is thrown when a delta cannot be successfully applied by |
| the receiving peer/client.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/InvalidValueException.html" title="class in org.apache.geode">InvalidValueException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>InvalidValueException</code> is thrown when an attempt is made to set a configuration |
| attribute to an invalid value is made.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/InvalidVersionException.html" title="class in org.apache.geode">InvalidVersionException</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/NoSystemException.html" title="class in org.apache.geode">NoSystemException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>NoSystemException</code> is thrown when a locator can not be found or connected to.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/OutOfOffHeapMemoryException.html" title="class in org.apache.geode">OutOfOffHeapMemoryException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that attempts to allocate more objects in off-heap memory has failed and the Cache will |
| be closed to prevent it from losing distributed consistency.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/SerializationException.html" title="class in org.apache.geode">SerializationException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception indicating that a serialization or deserialization failed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/SystemConnectException.html" title="class in org.apache.geode">SystemConnectException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>SystemConnectException</code> is thrown when a GemFire application tries to connect to |
| an existing distributed system and is unable to contact all members of the distributed system to |
| announce its presence.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/SystemIsRunningException.html" title="class in org.apache.geode">SystemIsRunningException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>SystemIsRunningException</code> is thrown when an operation is attempted that requires |
| that the locator is stopped.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/ToDataException.html" title="class in org.apache.geode">ToDataException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>ToDataException</code> is thrown during serialization if <a href="../../../org/apache/geode/DataSerializable.html#toData-java.io.DataOutput-"><code>DataSerializable.toData(java.io.DataOutput)</code></a> |
| throws an exception or if <a href="../../../org/apache/geode/DataSerializer.html#toData-java.lang.Object-java.io.DataOutput-"><code>DataSerializer.toData(java.lang.Object, java.io.DataOutput)</code></a> is called and returns false.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/UncreatedSystemException.html" title="class in org.apache.geode">UncreatedSystemException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>UncreatedSystemException</code> is thrown when the specified locator's directory or |
| configuration file can not be found.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/UnmodifiableException.html" title="class in org.apache.geode">UnmodifiableException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>UnmodifiableException</code> is thrown when a an attempt is made to modify a GemFire |
| member configuration attribute that can not currently be modified.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/UnstartedSystemException.html" title="class in org.apache.geode">UnstartedSystemException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>UnstartedSystemException</code> is thrown when the specified locator exists but is not |
| running or could not be connected to.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Error Summary table, listing errors, and an explanation"> |
| <caption><span>Error Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Error</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/GemFireRethrowable.html" title="class in org.apache.geode">GemFireRethrowable</a></td> |
| <td class="colLast"> |
| <div class="block">This error is used by GemFire for internal purposes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/geode/InternalGemFireError.html" title="class in org.apache.geode">InternalGemFireError</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that serious error has occurred within the GemFire system.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.geode Description">Package org.apache.geode Description</h2> |
| <div class="block"><P>The base package of the GemFire Java product, featuring highly |
| concurrent distributed <a href="../../../org/apache/geode/cache/Cache.html" title="interface in org.apache.geode.cache">caching</a> |
| with <a href="../../../org/apache/geode/cache/CacheEvent.html" title="interface in org.apache.geode.cache">cache event</a> delivery, |
| <a href="../../../org/apache/geode/cache/query/package-summary.html#package_description">OQL querying</a>, and |
| <a href="../../../org/apache/geode/admin/package-summary.html#package_description">remote cache administration</a>, built using a <a href="../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed">DistributedSystem</a> which includes a |
| <a href="../../../org/apache/geode/distributed/DistributedLockService.html" title="class in org.apache.geode.distributed">DistributedLockService</a>. |
| </P> |
| |
| <p>This package contains classes that are used throughout GemFire, |
| providing enhanced serialization performance using the <a href="../../../org/apache/geode/DataSerializable.html" title="interface in org.apache.geode"><code>DataSerializable</code></a> feature and the ability to |
| profile your GemFire application using a handy <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a> infrastructure. |
| <p> |
| |
| <!-- ------------------------------------------------------------ --> |
| |
| <A NAME="statistics"><H2>GemFire Statistics</H2></A> |
| |
| <P>The ability to monitor and analyze the behavior and performance of |
| an application can ease the job of optimization. To aid in this |
| analysis, GemFire provides the ability to register and capture |
| application statistics. An application statistic is simply a number |
| that the application is free to modify and that is monitored by |
| the GemFire's statistics collector. |
| The statistics may be |
| monitored at runtime using the Admin API or GemFire JMX Agent.</P> |
| |
| <P>Each application statistic is described by a |
| <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>StatisticDescriptor</code></a> instance. |
| Logical groupings of application statistics are described by a |
| <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>StatisticsType</code></a> instance that contains the name |
| and description of each statistic. Each instance of an type |
| is represented by an instance of |
| <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>Statistics</code></a>. |
| The <a href="../../../org/apache/geode/StatisticDescriptor.html" title="interface in org.apache.geode"><code>descriptors</code></a>, |
| <a href="../../../org/apache/geode/StatisticsType.html" title="interface in org.apache.geode"><code>types</code></a>, and |
| <a href="../../../org/apache/geode/Statistics.html" title="interface in org.apache.geode"><code>instances</code></a> are created using an |
| instance of the <a href="../../../org/apache/geode/StatisticsFactory.html" title="interface in org.apache.geode"><code>StatisticsFactory</code></a> interface. |
| Each statistics instance |
| (there may be multiple instances of a statistics type) can be identified |
| by a <a href="../../../org/apache/geode/Statistics.html#getTextId--"><code>text id</code></a> |
| and/or a <a href="../../../org/apache/geode/Statistics.html#getNumericId--"><code>numeric id</code></a>. |
| The name, description, etc. of the statistic and its type |
| are available in the Admin API or GemFire JMX Agent.</P> |
| |
| <P>An application can get, set, and increment the value of a statistic |
| using methods of the <code>Statistics</code> interface. If statistics |
| sampling has been <A |
| href="distributed/DistributedSystem.html#statistic-sampling-enabled">enabled</A> |
| a thread in the application VM <A |
| href="distributed/DistributedSystem.html#statistic-sample-rate">periodically</A> |
| reads the values of application statistics allowing them to be viewed |
| by the Admin API and GemFire JMX Agent. Statistics may also be archived |
| to a file, the <A |
| href="distributed/DistributedSystem.html#statistic-archive-file ">name |
| and location</A> of which may be configured when creating a <a href="../../../org/apache/geode/distributed/DistributedSystem.html" title="class in org.apache.geode.distributed"><code>DistributedSystem</code></a>. </P> |
| |
| <P>In addition to application statistics, GemFire maintains statistics |
| about the distributed system, the distributed cache, |
| and the physical machine on which it runs. These statistics can be |
| monitored, viewed, and archived just like application statistics.</P></div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../org/apache/geode/admin/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/geode/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
