You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@esme.apache.org by bu...@apache.org on 2011/07/17 15:41:32 UTC
svn commit: r792905 -
/websites/staging/esme/trunk/content/docs/apis/jmx-rest-api.html
Author: buildbot
Date: Sun Jul 17 13:41:32 2011
New Revision: 792905
Log:
Staging update by buildbot
Modified:
websites/staging/esme/trunk/content/docs/apis/jmx-rest-api.html
Modified: websites/staging/esme/trunk/content/docs/apis/jmx-rest-api.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/apis/jmx-rest-api.html (original)
+++ websites/staging/esme/trunk/content/docs/apis/jmx-rest-api.html Sun Jul 17 13:41:32 2011
@@ -84,71 +84,74 @@ POST /jmx/mbean/[mbean name](mbean-name.
<Attribute name="att1" value="val1" />
<Attrubute name="att2" value="val2" />
</AttributeList>
-== SAMPLES ==
-GET /jmx/mbeans
-<esme_api operation="mbeans" success="true">
-<MBeans>
-<MBean name="java.lang:type=Memory"/>
-<MBean name="java.lang:type=GarbageCollector,name=Copy"/>
-<MBean name="java.lang:type=MemoryPool,name=Code Cache"/>
-<MBean name="java.lang:type=Runtime"/>
-<MBean name="java.lang:type=ClassLoading"/>
-<MBean name="java.lang:type=MemoryPool,name=Perm Gen klzzwxh:0018shared-rwklzzwxh:0019(shared-rwklzzwxh:0020html)
-"/>
-<MBean name="java.lang:type=Threading"/>
-<MBean name="java.util.logging:type=Logging"/>
-<MBean name="java.lang:type=MemoryPool,name=Perm Gen klzzwxh:0021shared-roklzzwxh:0022(shared-roklzzwxh:0023html)
-"/>
-<MBean name="java.lang:type=Compilation"/>
-<MBean name="java.lang:type=MemoryPool,name=Eden Space"/>
-<MBean name="org.apache.esme.stats:type=Stats"/>
-<MBean name="StatsAgent:name=htmlAdaptor,port=9092"/>
-<MBean name="com.sun.management:type=HotSpotDiagnostic"/>
-<MBean name="java.lang:type=GarbageCollector,name=MarkSweepCompact"/>
-<MBean name="java.lang:type=MemoryPool,name=Survivor Space"/>
-<MBean name="java.lang:type=MemoryPool,name=Tenured Gen"/>
-<MBean name="java.lang:type=MemoryPool,name=Perm Gen"/>
-<MBean name="java.lang:type=OperatingSystem"/>
-<MBean name="JMImplementation:type=MBeanServerDelegate"/>
-<MBean name="java.lang:type=MemoryManager,name=CodeCacheManager"/>
-</MBeans>
-</esme_api>
-GET /jmx/mbean/org.apache.esme.stats:type=Stats/attributes
-<esme_api operation="mbean" success="true">
-<MBeanAttributes name="org.apache.esme.stats:type=Stats">
-<MBeanAttribute value="1" name="counter_userCount"/>
-<MBeanAttribute value="1" name="counter_liftSessions"/>
-<MBeanAttribute value="1.0" name="gauge_users"/>
-<MBeanAttribute value="1.0" name="gauge_listener"/>
-</MBeanAttributes>
-</esme_api>
-GET /jmx/mbean/org.apache.esme.stats:type=Stats/info
-<esme_api operation="mbean" success="true">
-<MBeanInfo name="org.apache.esme.stats:type=Stats">
-<MBeanAttributes>
-<MBeanAttributeInfo isIs="false" type="java.lang.Long"
-description="counter"
-isReadable="true" name="counter_userCount" isWritable="false"/>
-<MBeanAttributeInfo isIs="false" type="java.lang.Long"
-description="counter"
-isReadable="true" name="counter_liftSessions" isWritable="false"/>
-<MBeanAttributeInfo isIs="false" type="java.lang.Long" description="gauge"
-isReadable="true" name="gauge_users" isWritable="false"/>
-<MBeanAttributeInfo isIs="false" type="java.lang.Long" description="gauge"
-isReadable="true" name="gauge_listener" isWritable="false"/>
-</MBeanAttributes>
-<MBeanOperations>
-<MBeanOperationInfo impact="ACTION" description="Remove all Counters,
-Timers, Gauges and restart gathering timestamp."
-returnType="java.lang.String" name="clear">
-<Signature>
-</Signature>
-</MBeanOperationInfo>
-</MBeanOperations>
-<MBeanNotifications/>
-</MBeanInfo>
-</esme_api>
-=================
+== SAMPLES ==</p>
+<div class="codehilite"><pre><span class="n">GET</span> <span class="sr">/jmx/m</span><span class="n">beans</span>
+<span class="o"><</span><span class="n">esme_api</span> <span class="n">operation</span><span class="o">=</span><span class="s">"mbeans"</span> <span class="n">success</span><span class="o">=</span><span class="s">"true"</span><span class="o">></span>
+<span class="sr"><MBeans></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=Memory"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=GarbageCollector,name=Copy"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Code Cache"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=Runtime"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=ClassLoading"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Perm Gen \[shared-rw\](shared-rw\.html)</span>
+<span class="s">"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=Threading"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.util.logging:type=Logging"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Perm Gen \[shared-ro\](shared-ro\.html)</span>
+<span class="s">"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=Compilation"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Eden Space"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"org.apache.esme.stats:type=Stats"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"StatsAgent:name=htmlAdaptor,port=9092"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"com.sun.management:type=HotSpotDiagnostic"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=GarbageCollector,name=MarkSweepCompact"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Survivor Space"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Tenured Gen"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryPool,name=Perm Gen"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=OperatingSystem"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"JMImplementation:type=MBeanServerDelegate"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBean</span> <span class="n">name</span><span class="o">=</span><span class="s">"java.lang:type=MemoryManager,name=CodeCacheManager"</span><span class="o">/></span>
+<span class="sr"></MBeans></span>
+<span class="sr"></esme_api></span>
+<span class="n">GET</span> <span class="sr">/jmx/m</span><span class="n">bean</span><span class="sr">/org.apache.esme.stats:type=Stats/</span><span class="n">attributes</span>
+<span class="o"><</span><span class="n">esme_api</span> <span class="n">operation</span><span class="o">=</span><span class="s">"mbean"</span> <span class="n">success</span><span class="o">=</span><span class="s">"true"</span><span class="o">></span>
+<span class="o"><</span><span class="n">MBeanAttributes</span> <span class="n">name</span><span class="o">=</span><span class="s">"org.apache.esme.stats:type=Stats"</span><span class="o">></span>
+<span class="o"><</span><span class="n">MBeanAttribute</span> <span class="n">value</span><span class="o">=</span><span class="s">"1"</span> <span class="n">name</span><span class="o">=</span><span class="s">"counter_userCount"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBeanAttribute</span> <span class="n">value</span><span class="o">=</span><span class="s">"1"</span> <span class="n">name</span><span class="o">=</span><span class="s">"counter_liftSessions"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBeanAttribute</span> <span class="n">value</span><span class="o">=</span><span class="s">"1.0"</span> <span class="n">name</span><span class="o">=</span><span class="s">"gauge_users"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBeanAttribute</span> <span class="n">value</span><span class="o">=</span><span class="s">"1.0"</span> <span class="n">name</span><span class="o">=</span><span class="s">"gauge_listener"</span><span class="o">/></span>
+<span class="sr"></MBeanAttributes></span>
+<span class="sr"></esme_api></span>
+<span class="n">GET</span> <span class="sr">/jmx/m</span><span class="n">bean</span><span class="sr">/org.apache.esme.stats:type=Stats/i</span><span class="n">nfo</span>
+<span class="o"><</span><span class="n">esme_api</span> <span class="n">operation</span><span class="o">=</span><span class="s">"mbean"</span> <span class="n">success</span><span class="o">=</span><span class="s">"true"</span><span class="o">></span>
+<span class="o"><</span><span class="n">MBeanInfo</span> <span class="n">name</span><span class="o">=</span><span class="s">"org.apache.esme.stats:type=Stats"</span><span class="o">></span>
+<span class="sr"><MBeanAttributes></span>
+<span class="o"><</span><span class="n">MBeanAttributeInfo</span> <span class="n">isIs</span><span class="o">=</span><span class="s">"false"</span> <span class="n">type</span><span class="o">=</span><span class="s">"java.lang.Long"</span>
+<span class="n">description</span><span class="o">=</span><span class="s">"counter"</span>
+<span class="n">isReadable</span><span class="o">=</span><span class="s">"true"</span> <span class="n">name</span><span class="o">=</span><span class="s">"counter_userCount"</span> <span class="n">isWritable</span><span class="o">=</span><span class="s">"false"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBeanAttributeInfo</span> <span class="n">isIs</span><span class="o">=</span><span class="s">"false"</span> <span class="n">type</span><span class="o">=</span><span class="s">"java.lang.Long"</span>
+<span class="n">description</span><span class="o">=</span><span class="s">"counter"</span>
+<span class="n">isReadable</span><span class="o">=</span><span class="s">"true"</span> <span class="n">name</span><span class="o">=</span><span class="s">"counter_liftSessions"</span> <span class="n">isWritable</span><span class="o">=</span><span class="s">"false"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBeanAttributeInfo</span> <span class="n">isIs</span><span class="o">=</span><span class="s">"false"</span> <span class="n">type</span><span class="o">=</span><span class="s">"java.lang.Long"</span> <span class="n">description</span><span class="o">=</span><span class="s">"gauge"</span>
+<span class="n">isReadable</span><span class="o">=</span><span class="s">"true"</span> <span class="n">name</span><span class="o">=</span><span class="s">"gauge_users"</span> <span class="n">isWritable</span><span class="o">=</span><span class="s">"false"</span><span class="o">/></span>
+<span class="o"><</span><span class="n">MBeanAttributeInfo</span> <span class="n">isIs</span><span class="o">=</span><span class="s">"false"</span> <span class="n">type</span><span class="o">=</span><span class="s">"java.lang.Long"</span> <span class="n">description</span><span class="o">=</span><span class="s">"gauge"</span>
+<span class="n">isReadable</span><span class="o">=</span><span class="s">"true"</span> <span class="n">name</span><span class="o">=</span><span class="s">"gauge_listener"</span> <span class="n">isWritable</span><span class="o">=</span><span class="s">"false"</span><span class="o">/></span>
+<span class="sr"></MBeanAttributes></span>
+<span class="sr"><MBeanOperations></span>
+<span class="o"><</span><span class="n">MBeanOperationInfo</span> <span class="n">impact</span><span class="o">=</span><span class="s">"ACTION"</span> <span class="n">description</span><span class="o">=</span><span class="s">"Remove all Counters,</span>
+<span class="s">Timers, Gauges and restart gathering timestamp."</span>
+<span class="n">returnType</span><span class="o">=</span><span class="s">"java.lang.String"</span> <span class="n">name</span><span class="o">=</span><span class="s">"clear"</span><span class="o">></span>
+<span class="sr"><Signature></span>
+<span class="sr"></Signature></span>
+<span class="sr"></MBeanOperationInfo></span>
+<span class="sr"></MBeanOperations></span>
+<span class="sr"><MBeanNotifications/></span>
+<span class="sr"></MBeanInfo></span>
+<span class="sr"></esme_api></span>
+</pre></div>
+
+
+<p>=================
There is no security on the api. This obviously should not stay like this
and should only be accessable with an administrator account.
I tested it with the Stats MBean and the java.util.Logging MBean and it is