[jboss-cvs] JBossAS SVN: r86378 - in projects/jboss-osgi/trunk: build/docbook/en/modules and 2 other directories.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Thu Mar 26 08:02:32 EDT 2009 

Author: thomas.diesler at jboss.com
Date: 2009-03-26 08:02:32 -0400 (Thu, 26 Mar 2009)
New Revision: 86378

Added:
   projects/jboss-osgi/trunk/build/docbook/en/images/jmx-agent-view.png
Modified:
   projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml
   projects/jboss-osgi/trunk/runtime/deployer/src/main/resources/osgi-deployers-jboss-beans.xml
   projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-beans.xml
   projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-bootstrap-beans.xml
Log:
docbook management

Added: projects/jboss-osgi/trunk/build/docbook/en/images/jmx-agent-view.png
===================================================================
(Binary files differ)


Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/jmx-agent-view.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml
===================================================================
--- projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml	2009-03-26 11:17:31 UTC (rev 86377)
+++ projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml	2009-03-26 12:02:32 UTC (rev 86378)
@@ -150,24 +150,108 @@
     <emphasis role="bold">BundleManagementDeployer</emphasis>
     
     <para>The BundleManagementDeployer registers the Bundle as <ulink url="http://java.sun.com/j2se/1.5.0/docs/api/javax/management/StandardMBean.html">StandardMBean</ulink> with JMX.
-    Please see the section on <ulink url="#SecJMXView">Management View</ulink> for details.</para>
+    Please see the section on <link linkend="SecJMXView">Management View</link> for details.</para>
     
   </sect1>
   
   <sect1 xml:id="SecJMXView">  
     <title>Management View</title>
     
+    <para>JBossOSGi registers the Framework and every deployed Bundle with the JMX <ulink url="http://java.sun.com/j2se/1.5.0/docs/api/javax/management/MBeanServer.html">MBeanServer</ulink>.</para>
+    
+    <emphasis role="bold">The ManagementFramework</emphasis>
+    
+    <para>The <code>ManagedFramework</code> gives you access to the MBean views of the deployed Bundles. It is registerd under the name:</para>
+    
+    <itemizedlist>
+      <listitem><emphasis role="bold">jboss.osgi:service=ManagedFramework</emphasis></listitem>
+    </itemizedlist>
+    
+    <programlisting role="JAVA">
+    public interface ManagedFrameworkMBean
+    {
+       /**
+        * Get the list of all installed bundles
+        */
+       Set&lt;ObjectName> getBundles();
+       
+       /**
+        * Get the installed bundle 
+        */
+       ObjectName getBundle(String symbolicName);
+    }    
+    </programlisting>
+    
+    <emphasis role="bold">The ManagementBundle</emphasis>
+
+    <para>The <code>ManagementBundle</code> gives you access to the MBean views of a deployed Bundle. It is registerd under the name:</para>
+    
+    <itemizedlist>
+      <listitem><emphasis role="bold">jboss.osgi:bundle=[SymbolicName],id=[BundleId]</emphasis></listitem>
+    </itemizedlist>
+    
+    <programlisting role="JAVA">
+    public interface ManagedBundleMBean
+    {
+       /**
+        * Returns this bundle's current state. 
+        * A bundle can be in only one state at any time. 
+        * 
+        * @return An element of UNINSTALLED,INSTALLED, RESOLVED,STARTING, STOPPING,ACTIVE.
+        */
+       int getState();
+    
+       /**
+        * Get the bundles object name.
+        */
+       ObjectName getObjectName();
+       
+       /**
+        * Returns this bundle's unique identifier.
+        */
+       long getBundleId();
+       
+       /**
+        * Returns the symbolic name of this bundle as specified by its Bundle-SymbolicName manifest header
+        */
+       String getSymbolicName();
+       
+       /**
+        * Returns the value of the specified property from the BundleContext.
+        */
+       String getProperty(String key);
+       
+       /**
+        * Starts this bundle with no options
+        */
+       void start() throws BundleException;
+       
+       /**
+        * Stops this bundle with no options.
+        */
+       void stop() throws BundleException;
+    }
+    </programlisting>
+    
+    <emphasis role="bold">Accessing the Management Objects</emphasis>
+    
+    <para>If you work with the JBossOSGi Testsuite you get access to the Managed Objects through the JBossOSGi SPI provided 
+    <ulink url="http://junit.sourceforge.net/">JUnit</ulink> support package <ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc/org/jboss/osgi/spi/junit/package-summary.html">org.jboss.osgi.spi.junit</ulink>.
+    </para> 
+    
+    <para>If you install JBossOSGi in an already existing JBossAS instance you also get access to the Managed Objects through the JBoss provided
+    JMX Console (<ulink url="http://localhost:8080/jmx-console">http://localhost:8080/jmx-console</ulink>).</para> 
+    
+    <mediaobject>
+      <imageobject>
+        <imagedata fileref="images/jmx-agent-view.png"/> 
+      </imageobject>
+    </mediaobject>
+    
     <note>
-      <title>TODO: Document the JMX View</title>
-    </note>
-  </sect1>
-  
-  <sect1 xml:id="SecClassLoading">  
-    <title>Class Loading</title>
+      <para>The JMX Console is <emphasis role="bold">not part</emphasis> of the <link linkend="SecRuntime">JBossOSGi Runtime</link>.</para>
+    </note> 
     
-    <note>
-      <title>TODO: Document the Class Loading</title>
-    </note>
   </sect1>
   
   <sect1 xml:id="SecLoggingBridge">  

Modified: projects/jboss-osgi/trunk/runtime/deployer/src/main/resources/osgi-deployers-jboss-beans.xml
===================================================================
--- projects/jboss-osgi/trunk/runtime/deployer/src/main/resources/osgi-deployers-jboss-beans.xml	2009-03-26 11:17:31 UTC (rev 86377)
+++ projects/jboss-osgi/trunk/runtime/deployer/src/main/resources/osgi-deployers-jboss-beans.xml	2009-03-26 12:02:32 UTC (rev 86378)
@@ -51,7 +51,7 @@
    <property name="kernel"><inject bean="jboss.kernel:service=Kernel" /></property>
   </bean>
 
-  <!-- The OSGi Meta Data Deployer -->
+  <!-- The OSGi MetaData Deployer -->
   <bean name="jboss.osgi:service=BundleMetaDataDeployer" class="org.jboss.osgi.deployer.BundleMetaDataDeployer" />
   
   <!-- The OSGi Bundle Deployer -->
@@ -60,7 +60,7 @@
     <property name="skipBundles"><inject bean="jboss.osgi:service=Framework" property="autoInstall" /></property>
   </bean>
 
-  <!-- The Bundle Class Loader Deployer -->
+  <!-- The Bundle ClassLoader Deployer -->
   <bean name="jboss.osgi:service=BundleClassLoaderDeployer" class="org.jboss.osgi.deployer.BundleClassLoaderDeployer">
     <property name="systemContext"><inject bean="jboss.osgi:service=Framework" property="systemBundleContext" /></property>
   </bean>

Modified: projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-beans.xml
===================================================================
--- projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-beans.xml	2009-03-26 11:17:31 UTC (rev 86377)
+++ projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-beans.xml	2009-03-26 12:02:32 UTC (rev 86378)
@@ -19,16 +19,16 @@
   </property>
  </bean>
 
-  <!-- The OSGi Meta Data Deployer -->
-  <bean name="jboss.osgi:service=MetaDataDeployer" class="org.jboss.osgi.deployer.OSGiMetaDataDeployer" />
+  <!-- The OSGi MetaData Deployer -->
+  <bean name="jboss.osgi:service=BundleMetaDataDeployer" class="org.jboss.osgi.deployer.BundleMetaDataDeployer" />
   
-  <!-- The OSGi Deployer -->
-  <bean name="jboss.osgi:service=Deployer" class="org.jboss.osgi.deployer.OSGiDeployer">
+  <!-- The OSGi Bundle Deployer -->
+  <bean name="jboss.osgi:service=BundleRealDeployer" class="org.jboss.osgi.deployer.BundleRealDeployer">
     <property name="systemContext"><inject bean="jboss.osgi:service=Framework" property="systemBundleContext" /></property>
     <property name="skipBundles"><inject bean="jboss.osgi:service=Framework" property="autoInstall" /></property>
   </bean>
 
-  <!-- The Bundle Class Loader Deployer -->
+  <!-- The Bundle ClassLoader Deployer -->
   <bean name="jboss.osgi:service=BundleClassLoaderDeployer" class="org.jboss.osgi.deployer.BundleClassLoaderDeployer">
     <property name="systemContext"><inject bean="jboss.osgi:service=Framework" property="systemBundleContext" /></property>
   </bean>

Modified: projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-bootstrap-beans.xml
===================================================================
--- projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-bootstrap-beans.xml	2009-03-26 11:17:31 UTC (rev 86377)
+++ projects/jboss-osgi/trunk/testsuite/src/test/resources/jboss-osgi-bootstrap-beans.xml	2009-03-26 12:02:32 UTC (rev 86378)
@@ -108,22 +108,4 @@
       <property name="system"><inject bean="ClassLoaderSystem"/></property>
    </bean>
 
-  <!-- VDFBundleListener 
-  <bean name="VDFBundleListener" class="org.jboss.osgi.deployer.helpers.VDFBundleListener">
-    <constructor>
-      <parameter><inject/></parameter>
-    </constructor>
-  </bean>
-  -->
-
-  <!--
-  <bean name="OSGiCLMDDeployer" class="org.jboss.osgi.deployer.OSGiClassLoadingMetaDataDeployer">
-    <constructor>
-      <parameter>
-        <classloading xmlns="urn:jboss:classloading:1.0" import-all="false"/>
-      </parameter>
-    </constructor>
-  </bean>
-  -->
-
 </deployment>

More information about the jboss-cvs-commits mailing list