svn commit: r1147606 - /esme/site/trunk/content/docs/apis/jmx-rest-api.mdtext

[rh...@apache.org]

Author: rhirsch
Date: Sun Jul 17 13:41:23 2011
New Revision: 1147606

URL: http://svn.apache.org/viewvc?rev=1147606&view=rev
Log:
CMS commit to esme by rhirsch

Modified:
    esme/site/trunk/content/docs/apis/jmx-rest-api.mdtext

Modified: esme/site/trunk/content/docs/apis/jmx-rest-api.mdtext
URL: http://svn.apache.org/viewvc/esme/site/trunk/content/docs/apis/jmx-rest-api.mdtext?rev=1147606&r1=1147605&r2=1147606&view=diff
==============================================================================
--- esme/site/trunk/content/docs/apis/jmx-rest-api.mdtext (original)
+++ esme/site/trunk/content/docs/apis/jmx-rest-api.mdtext Sun Jul 17 13:41:23 2011
@@ -1,4 +1,5 @@
 Title: JMX REST API
+
 <a name="JMXRESTAPI-Currently,justaplaceholder."></a>
 ## Currently, just a place holder.
 
@@ -34,69 +35,71 @@ POST /jmx/mbean/\[mbean name\](mbean-nam
 &nbsp;<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 \[shared-rw\](shared-rw\.html)
-"/>
-<MBean name="java.lang:type=Threading"/>
-<MBean name="java.util.logging:type=Logging"/>
-<MBean name="java.lang:type=MemoryPool,name=Perm Gen \[shared-ro\](shared-ro\.html)
-"/>
-<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>
+
+    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 \[shared-rw\](shared-rw\.html)
+    "/>
+    <MBean name="java.lang:type=Threading"/>
+    <MBean name="java.util.logging:type=Logging"/>
+    <MBean name="java.lang:type=MemoryPool,name=Perm Gen \[shared-ro\](shared-ro\.html)
+    "/>
+    <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>
+
 =================
 There is no security on the api. This obviously should not stay like this
 and should only be accessable with an administrator account.