Author: thomas.diesler(a)jboss.com Date: 2009-07-23 04:57:59 -0400 (Thu, 23 Jul 2009) New Revision: 91601 Modified: projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch050-developer-guide.xml projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch060-husky-testing.xml projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch070-provided-bundles.xml projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch080-provided-examples.xml Log: Update userguide Modified: projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch050-developer-guide.xml =================================================================== --- projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch050-developer-guide.xml 2009-07-23 08:28:39 UTC (rev 91600) +++ projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch050-developer-guide.xml 2009-07-23 08:57:59 UTC (rev 91601) @@ -24,17 +24,17 @@ </imageobject> </mediaobject> - <para>The latest version of the <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... OSGi SPI</ulink>.</para> + <para>The latest version of the <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs">... OSGi SPI</ulink>.</para> <itemizedlist> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - Common classes and interfaces.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - Capabilities that can be installed in the OSGi framework.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - Framework integration and bootstrap.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - Support for Bundle logging.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - Management view on deployed bundles.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - A collection of SPI provided services.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - OSGi test support classes and interfaces.</listitem> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - A collection of SPI provided utilities.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - Common classes and interfaces.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - Capabilities that can be installed in the OSGi framework.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - Framework integration and bootstrap.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - Support for Bundle logging.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - Management view on deployed bundles.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - A collection of SPI provided services.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - OSGi test support classes and interfaces.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... - A collection of SPI provided utilities.</listitem> </itemizedlist> <emphasis role="bold">Bootstrapping JBoss OSGi</emphasis> @@ -72,8 +72,8 @@ <para>The JBoss OSGi SPI comes with two bootstrap providers:</para> <itemizedlist> - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... - <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... + <listitem><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... </itemizedlist> <para>OSGiBootstrapProvider implementations that read their configurtation from some other source are possible, but currently not @@ -181,7 +181,7 @@ <emphasis role="bold">The ManagedFramework</emphasis> - <para>The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + <para>The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... ManagedFramework</ulink> gives you access to the MBean views of the deployed Bundles. It is registerd under the name:</para> <itemizedlist> @@ -190,7 +190,7 @@ <emphasis role="bold">The ManagedBundle</emphasis> - <para>The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + <para>The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... ManagedBundle</ulink> gives you access to the MBean views of a deployed Bundle. It is registerd under the name:</para> <itemizedlist> @@ -200,7 +200,7 @@ <emphasis role="bold">Accessing the Management Objects</emphasis> <para>If you work with the JBoss OSGi Testsuite you get access to the Managed Objects through the JBoss OSGi SPI provided - <ulink url="http://junit.sourceforge.net/">JUnit</ulink> support package <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a...;. + <ulink url="http://junit.sourceforge.net/">JUnit</ulink> support package <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos...;. </para> <para>If you install JBoss OSGi in an already existing JBossAS instance you also get access to the Managed Objects through the JBoss provided @@ -221,7 +221,7 @@ <title>Writing Test Cases</title> <para>JBoss OSGi comes with <ulink url="http://www.junit.org">JUnit</ulink> test support as part of the SPI provided - <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... package. There are two distinct test scenarios that we support:</para> <itemizedlist> Modified: projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch060-husky-testing.xml =================================================================== --- projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch060-husky-testing.xml 2009-07-23 08:28:39 UTC (rev 91600) +++ projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch060-husky-testing.xml 2009-07-23 08:57:59 UTC (rev 91601) @@ -64,39 +64,39 @@ <para>Here is how it works </para> <orderedlist> - <listitem>A <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>A <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... intercepts a test and determines the FQN of the test case and the test method from the call stack. It then delegates the execution to the same (or another) test in and isolated test environment. An isolated test environment is one that does not have the same class loading space as the test itself.</listitem> - <listitem>A Bridge is associated with an <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>A Bridge is associated with an <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... Invoker</ulink>. Invokers may be arbitarily complex. Local 'in proccess' invokers are possible just as well as remote invokers. </listitem> - <listitem>The Invoker sends the <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... - Request</ulink> to a <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>The Invoker sends the <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... + Request</ulink> to a <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... Connector</ulink> in the isolated test environment.</listitem> - <listitem>A Connector has associated <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>A Connector has associated <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... PackageListeners</ulink> that are responsible for processing test cases for their respective test packages.</listitem> - <listitem>A PackageListeners delegates the Request to a test <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... - Runner</ulink>, typicaly this would be a <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>A PackageListeners delegates the Request to a test <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... + Runner</ulink>, typicaly this would be a <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... JUnitRunner</ulink>.</listitem> - <listitem>The Runner injects the <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... - Context</ulink> into the test case and returns a <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>The Runner injects the <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... + Context</ulink> into the test case and returns a <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... Response</ulink>, which the Connector returns to the Invoker.</listitem> - <listitem>The Bridge finally translates potential <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + <listitem>The Bridge finally translates potential <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... Failures</ulink> that may be contained in the Result, to test failures on the client side.</listitem> </orderedlist> <para>The JBoss OSGi <emphasis role="bold">jboss-osgi-husky.jar</emphasis> bundle registers the Connectors. - The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... JMXConnector</ulink> is always registered. - The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky... + The <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... SocketConnector</ulink> is registered when the appropriate configuration options are set. It then registers the - <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-husky...;, + <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos...;, which is a <ulink url="http://www.osgi.org/javadoc/r4v41/org/osgi/framework/BundleList... that inspects every incomming bundle for the <emphasis role="bold">Test-Package</emphasis> manifest header. The Extender creates a PackageListener for every package in the 'Test-Package' manifest header and registers them with the available Connectors.</para> Modified: projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch070-provided-bundles.xml =================================================================== --- projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch070-provided-bundles.xml 2009-07-23 08:28:39 UTC (rev 91600) +++ projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch070-provided-bundles.xml 2009-07-23 08:57:59 UTC (rev 91601) @@ -14,8 +14,8 @@ <para>The services are registered with the Framework under the name</para> <itemizedlist> - <listitem><emphasis role="bold">javax.xml.parsers.SAXParserFactory</emphasis></listitem> - <listitem><emphasis role="bold">javax.xml.parsers.DocumentBuilderFactory</emphasis></listitem> + <listitem><emphasis role="bold"><ulink url="http://java.sun.com/javase/6/docs/api/javax/xml/parsers/SAXPars... + <listitem><emphasis role="bold"><ulink url="http://java.sun.com/javase/6/docs/api/javax/xml/parsers/Documen... </itemizedlist> <para>Please see <ulink url="http://www.osgi.org/javadoc/r4v41/org/osgi/util/xml/XMLParserAc... @@ -33,7 +33,7 @@ <para>The service is registered with the Framework under the name</para> <itemizedlist> - <listitem><emphasis role="bold">org.jboss.osgi.jaxb.JAXBService</emphasis></listitem> + <listitem><emphasis role="bold"><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... </itemizedlist> </sect1> @@ -69,9 +69,9 @@ <para>Here is the complete list of services that this bundle provides</para> <itemizedlist> - <listitem><emphasis role="bold">javax.management.MBeanServer</emphasis></listitem> - <listitem><emphasis role="bold">org.jboss.osgi.spi.management.ManagedBundleService</emphasis></listitem> - <listitem><emphasis role="bold">org.jboss.osgi.spi.management.ManagedFrameworkService</emphasis></listitem> + <listitem><emphasis role="bold"><ulink url="http://java.sun.com/javase/6/docs/api/javax/management/MBeanSer... + <listitem><emphasis role="bold"><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... + <!-- https://jira.jboss.org/jira/browse/JBOSGI-125 --> </itemizedlist> </sect1> @@ -106,7 +106,7 @@ <para>Here is the complete list of services that this bundle provides</para> <itemizedlist> - <listitem><emphasis role="bold">javax.naming.InitialContext</emphasis></listitem> + <listitem><emphasis role="bold"><ulink url="http://java.sun.com/javase/6/docs/api/javax/naming/InitialConte... </itemizedlist> </sect1> @@ -168,7 +168,7 @@ <para>On the client side you can install an arbitrary <ulink url="http://www.osgi.org/javadoc/r4v41/org/osgi/service/log/LogListe... with the <ulink url="http://www.osgi.org/javadoc/r4v41/org/osgi/service/log/LogReade...;. The testsuite typically - installs an <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + installs an <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... that filters the received log messages.</para> <programlisting role="JAVA"> @@ -197,7 +197,7 @@ The service is registered with the Framework under the name</para> <itemizedlist> - <listitem><emphasis role="bold">org.jboss.osgi.microcontainer.MicrocontainerService</emphasis></listitem> + <listitem><emphasis role="bold"><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... </itemizedlist> <para>Here is an example of how an OSGi component can access an arbitrary MC bean.</para> @@ -226,6 +226,15 @@ service allows bundles to contain standard blueprint descriptors, which can be used for component wiring and injection of blueprint components. The idea is to use a plain POJO programming model and let Blueprint do the wiring for you. There should be no need for OSGi API to "pollute" your application logic.</para> + + <para>The Blueprint API is divided into the <emphasis role="bold">Blueprint Container</emphasis> and + <emphasis role="bold">Blueprint Reflection</emphasis> packages.</para> + + <itemizedlist> + <listitem><emphasis role="bold"><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/osgi... + <listitem><emphasis role="bold"><ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/osgi... + </itemizedlist> + </sect1> </chapter> Modified: projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch080-provided-examples.xml =================================================================== --- projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch080-provided-examples.xml 2009-07-23 08:28:39 UTC (rev 91600) +++ projects/jboss-osgi/trunk/distribution/docbook/en/modules/ch080-provided-examples.xml 2009-07-23 08:57:59 UTC (rev 91601) @@ -206,7 +206,7 @@ <note> <para>Please note that access to the MBeanServer from the test case is part of the - <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... OSGiRuntime</ulink> abstraction.</para> </note> @@ -252,7 +252,7 @@ <note> <para>Please note that access to the InitialContext from the test case is part of the - <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/jboss-osgi-spi/a... + <ulink url="http://jbmuc.dyndns.org/jboss-osgi-1.0.0.Beta3/apidocs/org/jbos... OSGiRuntime</ulink> abstraction.</para> </note>