March 2009 - jboss-osgi-commits - Jboss List Archives

JBoss-OSGI SVN: r86358 - in projects/jboss-osgi/trunk: build/docbook and 6 other directories.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-25 11:46:25 -0400 (Wed, 25 Mar 2009) New Revision: 86358 Added: projects/jboss-osgi/trunk/build/docbook/en/images/jboss-osgi.png projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiStateFormat.java Removed: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/StateFormat.java Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml projects/jboss-osgi/trunk/build/docbook/pom.xml projects/jboss-osgi/trunk/build/eclipse/eclipse.code.style.xml projects/jboss-osgi/trunk/pom.xml projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/BundleStartStopDeployer.java projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/OSGiDeployer.java projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrap.java projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrapProvider.java projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/management/ManagedBundle.java Log: docbook: spi Added: projects/jboss-osgi/trunk/build/docbook/en/images/jboss-osgi.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/jboss-osgi.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-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -8,9 +8,82 @@ <sect1 id="SecSPI"> <title>Service Provider Interface</title> - <note> - <para>TODO: Document the SPI</para> - </note> + <para>The JBossOSGi Service Provider Interface (SPI) is the integration point between the supported OSGi Frameworks and + the <ulink url="http://www.jboss.org/jbossmc">JBoss Microcontainer</ulink>. The configuration defines MC beans for the + framework itself and its associated deployers.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jboss-osgi.png"/> + </imageobject> + </mediaobject> + + <para>The latest version of the <ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc">JBossOSGi SPI</ulink> + JavaDoc is published online as part of the JBossOSGi <ulink url="http://jbmuc.dyndns.org:8280/hudson">Hudson QA Environment</ulink>.</para> + + <itemizedlist> + <listitem><ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc/org/jbos...">org.jboss.osgi.service</ulink> - A collection of SPI provided services.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc/org/jbos...">org.jboss.osgi.spi</ulink> - Common classes and interfaces.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc/org/jbos...">org.jboss.osgi.spi.framework</ulink> - OSGi framework integration and bootstrap.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc/org/jbos...">org.jboss.osgi.spi.junit</ulink> - JUnit test integration.</listitem> + <listitem><ulink url="http://jbmuc.dyndns.org:8280/hudson/job/Container-JDK1.6/javadoc/org/jbos...">org.jboss.osgi.spi.management</ulink> - Management view on deployed bundles.</listitem> + </itemizedlist> + + <emphasis role="bold">Bootstrapping JBossOSGi</emphasis> + + <para>The OSGiBootstrap provides an OSGiFramework through a OSGiBootstrapProvider.</para> + + <para>A OSGiBootstrapProvider is discovered in two stages</para> + + <orderedlist> + <listitem>Read the bootstrap provider class name from a system property</listitem> + <listitem>Read the bootstrap provider class name from a resource file</listitem> + </orderedlist> + + <para>In both cases the key is the fully qalified name of the <code>org.jboss.osgi.spi.framework.OSGiBootstrapProvider</code> interface.</para> + + <programlisting role="JAVA"> + OSGiBootstrapProvider bootProvider = OSGiBootstrap.getBootstrapProvider(); + OSGiFramework framework = bootProvider.getFramework(); + Bundle bundle = framework.getSystemBundle(); + </programlisting> + + <para>The JBossOSGi SPI comes with a OSGiBootstrapProvider that uses a <ulink url="http://www.jboss.org/jbossmc">JBoss Microcontainer</ulink> + bean configuration.</para> + + <programlisting role="XML"><![CDATA[ + <deployment xmlns="urn:jboss:bean-deployer:2.0" ...> + +  + <bean name="jboss.osgi:service=Framework" class="org.jboss.osgi.felix.framework.FelixIntegration"> + <property name="felixProperties"> + <map keyClass="java.lang.String" valueClass="java.lang.String"> + <entry><key>org.osgi.framework.storage.clean</key><value>onFirstInit</value></entry> + <entry> + <key>org.osgi.framework.system.packages</key> + <value> + org.osgi.framework; version=1.4, + org.osgi.util.tracker + </value> + </entry> + </map> + </property> + </bean> + + ... + + </deployment> + ]]></programlisting> + + <para>OSGiBootstrapProvider implementations that read their configurtation from some other source are possible, but currently not + part of the JBossOSGi SPI.</para> + + <tip> + <title>Using the SPI from within an JBossAS deployed components</title> + <para>If you need access to the OSGi Framework from within an JBossAS deployed component (e.g. servlet, ejb, mbean) you + <emphasis role="bold">would not</emphasis> bootstrap JBossOSGi through the SPI. Instead, you would inject the already bootstrapped + OSGi Framework instance in your component.</para> + </tip> </sect1> <sect1 id="SecDeployers"> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -20,7 +20,7 @@ <para>The Apache Felix integration can be configured through a <ulink url="http://www.jboss.org/jbossmc">JBoss Microcontainer</ulink> beans configuration</para> - <programlisting><![CDATA[ + <programlisting role="XML"><![CDATA[ cat server/default/deployers/osgi.deployer/META-INF/osgi-deployers-jboss-beans.xml <deployment xmlns="urn:jboss:bean-deployer:2.0"> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -36,16 +36,12 @@ On top of that you can install multiple versions of the same code and resolve dependencies by version and other criteria. OSGi also offers advanced security and lifecycle, which I'll explain in more detail further down.</para> - - <emphasis role="bold">What kind of applications benefit from OSGi?</emphasis> <para>Any application that is designed in a modular fashion where it is necessary to start, stop, update individual modules with minimal impact on other modules. Modules can define their own transitive dependencies without the need to resolve these dependencies at the container level. The OSGi platform builds an exellent foundation for the next generation JBoss ESB for example.</para> - - <emphasis role="bold">Should Java EE developers adopt the OSGi programming model?</emphasis> <para>Probably not. The OSGi runtime may be used internally by Java EE container providers to achieve the desired isolation and configuration @@ -75,132 +71,130 @@ </mediaobject> - <emphasis role="bold">OSGi Security Layer</emphasis> + <emphasis role="bold">OSGi Security Layer</emphasis> + + <para>The OSGi Security Layer is an optional layer that underlies the OSGi Service Platform. + The layer is based on the Java 2 security architecture. It provides the infrastructure to deploy and manage + applications that must run in fine grained controlled environments.</para> - <para>The OSGi Security Layer is an optional layer that underlies the OSGi Service Platform. - The layer is based on the Java 2 security architecture. It provides the infrastructure to deploy and manage - applications that must run in fine grained controlled environments.</para> - - <para>The OSGi Service Platform can authenticate code in the following ways:</para> + <para>The OSGi Service Platform can authenticate code in the following ways:</para> + + <itemizedlist> + <listitem>By location</listitem> + <listitem>By signer</listitem> + </itemizedlist> + + <para>For example, an Operator can grant the ACME company the right to use networking on their devices. + The ACME company can then use networking in every bundle they digitally sign and deploy on the Operator’s device. + Also, a specific bundle can be granted permission to only manage the life cycle of bundles that are signed by the ACME company.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-delegation.png"/> + </imageobject> + </mediaobject> - <itemizedlist> - <listitem>By location</listitem> - <listitem>By signer</listitem> - </itemizedlist> - - <para>For example, an Operator can grant the ACME company the right to use networking on their devices. - The ACME company can then use networking in every bundle they digitally sign and deploy on the Operator’s device. - Also, a specific bundle can be granted permission to only manage the life cycle of bundles that are signed by the ACME company.</para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/osgi-delegation.png"/> - </imageobject> - </mediaobject> + <emphasis role="bold">OSGi Module Layer</emphasis> + <para>The OSGi Module Layer provides a generic and standardized solution for Java modularization. + The Framework defines a unit of modularization, called a bundle. A bundle is comprised of Java classes and other resources, + which together can provide functions to end users. Bundles can share Java packages among an exporter bundle and an importer bundle + in a well-defined way.</para> + + <para>Once a <emphasis role="bold">Bundle</emphasis> is started, its functionality is provided and services are exposed to other bundles installed in the OSGi Service Platform. + A bundle can carry descriptive information about itself in the manifest file that is contained in its JAR file. + Here are a few important <emphasis role="bold">Manifest Headers</emphasis> defined by the OSGi Framework:</para> + <itemizedlist> + <listitem><emphasis role="bold">Bundle-Activator</emphasis> - class used to start, stop the bundle</listitem> + <listitem><emphasis role="bold">Bundle-SymbolicName</emphasis> - identifies the bundle</listitem> + <listitem><emphasis role="bold">Bundle-Version</emphasis> - specifies the version of the bundle</listitem> + <listitem><emphasis role="bold">Export-Package</emphasis> - declaration of exported packages</listitem> + <listitem><emphasis role="bold">Import-Package</emphasis> - declaration of imported packages</listitem> + </itemizedlist> - <emphasis role="bold">OSGi Module Layer</emphasis> - - <para>The OSGi Module Layer provides a generic and standardized solution for Java modularization. - The Framework defines a unit of modularization, called a bundle. A bundle is comprised of Java classes and other resources, - which together can provide functions to end users. Bundles can share Java packages among an exporter bundle and an importer bundle - in a well-defined way.</para> - - <para>Once a <emphasis role="bold">Bundle</emphasis> is started, its functionality is provided and services are exposed to other bundles installed in the OSGi Service Platform. - A bundle can carry descriptive information about itself in the manifest file that is contained in its JAR file. - Here are a few important <emphasis role="bold">Manifest Headers</emphasis> defined by the OSGi Framework:</para> - - <itemizedlist> - <listitem><emphasis role="bold">Bundle-Activator</emphasis> - class used to start, stop the bundle</listitem> - <listitem><emphasis role="bold">Bundle-SymbolicName</emphasis> - identifies the bundle</listitem> - <listitem><emphasis role="bold">Bundle-Version</emphasis> - specifies the version of the bundle</listitem> - <listitem><emphasis role="bold">Export-Package</emphasis> - declaration of exported packages</listitem> - <listitem><emphasis role="bold">Import-Package</emphasis> - declaration of imported packages</listitem> - </itemizedlist> - - <para>The notion of OSGi Version Range describes a range of versions using a mathematical interval notation. For example</para> - - <programlisting> - Import-Package: com.acme.foo;version="[1.23, 2)", com.acme.bar;version="[4.0, 5.0)" - </programlisting> - - <para>With the OSGi Class Loading Architecture many bundles can share a single virtual machine (VM). - Within this VM, bundles can hide packages and classes from other bundles, as well as share packages with other bundles.</para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/osgi-classloader.png"/> - </imageobject> - </mediaobject> - - <para>For example, the following import and export definition resolve correctly because the version range in the import definition - matches the version in the export definition:</para> - - <programlisting> - A: Import-Package: p; version="[1,2)" - B: Export-Package: p; version=1.5.1 - </programlisting> - - <mediaobject> - <imageobject> - <imagedata fileref="images/osgi-version-constraint.png"/> - </imageobject> - </mediaobject> + <para>The notion of OSGi Version Range describes a range of versions using a mathematical interval notation. For example</para> - <para>Appart from bundle versions, OSGi Attribute Matching is a generic mechanism to allow the importer and exporter to influence the - matching process in a declarative way. For example, the following statements will match.</para> + <programlisting> + Import-Package: com.acme.foo;version="[1.23, 2)", com.acme.bar;version="[4.0, 5.0)" + </programlisting> + + <para>With the OSGi Class Loading Architecture many bundles can share a single virtual machine (VM). + Within this VM, bundles can hide packages and classes from other bundles, as well as share packages with other bundles.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-classloader.png"/> + </imageobject> + </mediaobject> + + <para>For example, the following import and export definition resolve correctly because the version range in the import definition + matches the version in the export definition:</para> + + <programlisting> + A: Import-Package: p; version="[1,2)" + B: Export-Package: p; version=1.5.1 + </programlisting> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-version-constraint.png"/> + </imageobject> + </mediaobject> + + <para>Appart from bundle versions, OSGi Attribute Matching is a generic mechanism to allow the importer and exporter to influence the + matching process in a declarative way. For example, the following statements will match.</para> - <programlisting> - A: Import-Package: com.acme.foo;company=ACME - B: Export-Package: com.acme.foo;company=ACME; security=false - </programlisting> + <programlisting> + A: Import-Package: com.acme.foo;company=ACME + B: Export-Package: com.acme.foo;company=ACME; security=false + </programlisting> - <para>An exporter can limit the visibility of the classes in a package with the include and exclude directives on the export definition.</para> + <para>An exporter can limit the visibility of the classes in a package with the include and exclude directives on the export definition.</para> - <programlisting> - Export-Package: com.acme.foo; include:="Qux*,BarImpl"; exclude:=QuxImpl - </programlisting> + <programlisting> + Export-Package: com.acme.foo; include:="Qux*,BarImpl"; exclude:=QuxImpl + </programlisting> + + <emphasis role="bold">OSGi Life Cycle Layer</emphasis> - <emphasis role="bold">OSGi Life Cycle Layer</emphasis> - - <para>The Life Cycle Layer provides an API to control the security and life cycle operations of bundles.</para> + <para>The Life Cycle Layer provides an API to control the security and life cycle operations of bundles.</para> - <para>A bundle can be in one of the following states:</para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/osgi-life-cycle.png"/> - </imageobject> - </mediaobject> - - <para>A bundle is activated by calling its <emphasis role="bold">Bundle Activator</emphasis> object, if one exists. - The BundleActivator interface defines methods that the Framework invokes when it starts and stops the bundle.</para> + <para>A bundle can be in one of the following states:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-life-cycle.png"/> + </imageobject> + </mediaobject> + + <para>A bundle is activated by calling its <emphasis role="bold">Bundle Activator</emphasis> object, if one exists. + The BundleActivator interface defines methods that the Framework invokes when it starts and stops the bundle.</para> - <para>A Bundle Context object represents the execution context of a single bundle within the OSGi Service Platform, - and acts as a proxy to the underlying Framework. A <emphasis role="bold">Bundle Context</emphasis> object is created by the Framework when a bundle is started. - The bundle can use this private BundleContext object for the following purposes:</para> - - <itemizedlist> - <listitem>Installing new bundles into the OSGi environment</listitem> - <listitem>Interrogating other bundles installed in the OSGi environment</listitem> - <listitem>Obtaining a persistent storage area</listitem> - <listitem>Retrieving service objects of registered services</listitem> - <listitem>Registering services in the Framework service</listitem> - <listitem>Subscribing or unsubscribing to Famework events</listitem> - </itemizedlist> - - <emphasis role="bold">OSGi Service Layer</emphasis> - - <para>The OSGi Service Layer defines a dynamic collaborative model that is highly integrated with the Life Cycle Layer. - The service model is a publish, find and bind model. A service is a normal Java object that is registered under one or more - Java interfaces with the service registry.</para> - - <mediaobject> - <imageobject> - <imagedata fileref="images/osgi-service-registration.png"/> - </imageobject> - </mediaobject> + <para>A Bundle Context object represents the execution context of a single bundle within the OSGi Service Platform, + and acts as a proxy to the underlying Framework. A <emphasis role="bold">Bundle Context</emphasis> object is created by the Framework when a bundle is started. + The bundle can use this private BundleContext object for the following purposes:</para> + + <itemizedlist> + <listitem>Installing new bundles into the OSGi environment</listitem> + <listitem>Interrogating other bundles installed in the OSGi environment</listitem> + <listitem>Obtaining a persistent storage area</listitem> + <listitem>Retrieving service objects of registered services</listitem> + <listitem>Registering services in the Framework service</listitem> + <listitem>Subscribing or unsubscribing to Famework events</listitem> + </itemizedlist> + + <emphasis role="bold">OSGi Service Layer</emphasis> + + <para>The OSGi Service Layer defines a dynamic collaborative model that is highly integrated with the Life Cycle Layer. + The service model is a publish, find and bind model. A service is a normal Java object that is registered under one or more + Java interfaces with the service registry.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-service-registration.png"/> + </imageobject> + </mediaobject> </sect1> <sect1 id="SecServiceCompendium"> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -5,12 +5,6 @@ <title>References</title> - <para><emphasis role="bold">Authors</emphasis></para> - - <itemizedlist> - <listitem><ulink url="email:thomas.diesler@jboss.com">thomas.diesler(a)jboss.com</ulink></listitem> - </itemizedlist> - <para><emphasis role="bold">Links</emphasis></para> <para>[1] JBossOSGi Wiki - <ulink url="http://www.jboss.org/community/docs/DOC-13273">http://www.jboss.org/community/docs/DOC-13273</ulink></para> @@ -22,4 +16,10 @@ <para>[7] User Forum - <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=257">http://www.jboss.org/index.html?module=bb&op=viewforum&f=257</ulink></para> <para>[8] Design Forum - <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=256">http://www.jboss.org/index.html?module=bb&op=viewforum&f=256</ulink></para> + <para><emphasis role="bold">Authors</emphasis></para> + + <itemizedlist> + <listitem><ulink url="email:thomas.diesler@jboss.com">thomas.diesler(a)jboss.com</ulink></listitem> + </itemizedlist> + </chapter> Modified: projects/jboss-osgi/trunk/build/docbook/pom.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/pom.xml 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/build/docbook/pom.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -72,17 +72,17 @@ <formats> <format> <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> <finalName>index.html</finalName> </format> <format> <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> <finalName>index.html</finalName> </format> <format> <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> <finalName>${pom.name}.pdf</finalName> </format> </formats> Modified: projects/jboss-osgi/trunk/build/eclipse/eclipse.code.style.xml =================================================================== --- projects/jboss-osgi/trunk/build/eclipse/eclipse.code.style.xml 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/build/eclipse/eclipse.code.style.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -49,7 +49,7 @@ <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments" value="insert"/> -<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="true"/> +<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16"/> @@ -185,7 +185,7 @@ <setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="16"/> -<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="false"/> +<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/> <setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="168"/> <setting id="org.eclipse.jdt.core.formatter.blank_lines_between_import_groups" value="1"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments" value="do not insert"/> @@ -231,7 +231,7 @@ <setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_member" value="insert"/> <setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="false"/> -<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="true"/> +<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="false"/> <setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant" value="do not insert"/> <setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="0"/> <setting id="org.eclipse.jdt.core.formatter.insert_new_line_in_empty_block" value="insert"/> Modified: projects/jboss-osgi/trunk/pom.xml =================================================================== --- projects/jboss-osgi/trunk/pom.xml 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/pom.xml 2009-03-25 15:46:25 UTC (rev 86358) @@ -50,8 +50,8 @@ <version.jboss.common.core>2.2.11.GA</version.jboss.common.core> <version.jboss.deployers>2.0.5.GA</version.jboss.deployers> <version.jboss.jacc>1.1.0.GA</version.jboss.jacc> - <version.jboss.jdocbook.plugin>2.0.0</version.jboss.jdocbook.plugin> - <version.jboss.jdocbook.style>1.0.0</version.jboss.jdocbook.style> + <version.jboss.jdocbook.plugin>2.1.2</version.jboss.jdocbook.plugin> + <version.jboss.jdocbook.style>1.1.0</version.jboss.jdocbook.style> <version.jboss.logging.spi>2.0.5.GA</version.jboss.logging.spi> <version.jboss.logging.log4j>2.0.5.GA</version.jboss.logging.log4j> <version.jboss.metadata>1.0.0.CR11</version.jboss.metadata> Modified: projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/BundleStartStopDeployer.java =================================================================== --- projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/BundleStartStopDeployer.java 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/BundleStartStopDeployer.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -31,7 +31,7 @@ import org.jboss.deployers.spi.deployer.helpers.AbstractSimpleRealDeployer; import org.jboss.deployers.structure.spi.DeploymentUnit; import org.jboss.osgi.spi.Constants; -import org.jboss.osgi.spi.framework.StateFormat; +import org.jboss.osgi.spi.framework.OSGiStateFormat; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleException; @@ -85,7 +85,7 @@ unresolvedBundles.remove(bundle); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info("Stoped: " + bundle + state); } catch (BundleException e) @@ -99,7 +99,7 @@ try { bundle.start(); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info("Started: " + bundle + state); } catch (BundleException e) @@ -139,7 +139,7 @@ try { auxBundle.start(); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info("Started: " + bundle + state); } catch (BundleException e) Modified: projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/OSGiDeployer.java =================================================================== --- projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/OSGiDeployer.java 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/runtime/deployer/src/main/java/org/jboss/osgi/deployer/OSGiDeployer.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -30,7 +30,7 @@ import org.jboss.deployers.spi.deployer.DeploymentStages; import org.jboss.deployers.spi.deployer.helpers.AbstractSimpleRealDeployer; import org.jboss.deployers.structure.spi.DeploymentUnit; -import org.jboss.osgi.spi.framework.StateFormat; +import org.jboss.osgi.spi.framework.OSGiStateFormat; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleException; @@ -93,7 +93,7 @@ Bundle bundle = systemContext.installBundle(bundleUri.toString()); unit.addAttachment(Bundle.class, bundle); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info("Installed: " + bundle + state); } } @@ -113,7 +113,7 @@ try { bundle.uninstall(); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info("Uninstalled: " + bundle + state); } catch (BundleException ex) Modified: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrap.java =================================================================== --- projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrap.java 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrap.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -28,8 +28,17 @@ import java.net.URL; /** - * The OSGiBootstrap provides an OSGiFramework through a OSGiBootstrapProvider + * The OSGiBootstrap provides an {@link OSGiFramework} through a {@link OSGiBootstrapProvider}. * + * A OSGiBootstrapProvider is discovered in two stages. + * + * <ol> + * <li>Read the bootstrap provider class name from a system property + * <li>Read the bootstrap provider class name from a resource file + * </ol> + * + * In both cases the key is the fully qalified name of the {@link OSGiBootstrapProvider} interface. + * * @author thomas.diesler(a)jboss.com * @since 18-Jun-2008 */ @@ -41,17 +50,7 @@ } /** - * Get an instance of an OSGiBootstrapProvider. - * </p> - * A OSGiBootstrapProvider is discovered in two stages - * <p/> - * - * <ol> - * <li>Read the bootstrap provider class name from a system property - * <li>Read the bootstrap provider class name from a resource file - * </ol> - * - * In both cases the key is the fully qalified name of the {@link OSGiBootstrapProvider} interface. + * Get an instance of an OSGiBootstrapProvider. */ public static OSGiBootstrapProvider getBootstrapProvider() { Modified: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrapProvider.java =================================================================== --- projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrapProvider.java 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiBootstrapProvider.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -29,54 +29,54 @@ /** * An OSGiBootstrapProvider provides an OSGiFramework * <p/> - * Implementations would configure the OSGiFramework through some - * form of descriptor. + * Implementations would configure the OSGiFramework through some form of descriptor. * <p/> - * Natively, the SPI provides an OSGiBootstrapProvider that is based - * on the Microkernel. + * Natively, the SPI provides an OSGiBootstrapProvider that is based on the Microkernel. * * @author thomas.diesler(a)jboss.com * @since 18-Jun-2008 */ public interface OSGiBootstrapProvider extends NamedInstanceProvider { - /* The Framework bean name - jboss.osgi:service=Framework */ + /** The Framework bean name - jboss.osgi:service=Framework */ public static final String DEFAULT_FRAMEWORK_NAME = "jboss.osgi:service=Framework"; - /* The default framework beans: jboss-osgi-bootstrap-beans.xml */ + /** The default framework beans: jboss-osgi-bootstrap-beans.xml */ public static final String DEFAULT_BOOTSTRAP_BEANS = "jboss-osgi-bootstrap-beans.xml"; - /* The default framework beans: jboss-osgi-beans.xml */ + /** The default framework beans: jboss-osgi-beans.xml */ public static final String DEFAULT_FRAMEWORK_BEANS = "jboss-osgi-beans.xml"; - /* + /** * Get the OSGiFramework that registerd with the default name + * * @return The configured instance of a Framework * @throws IllegalArgumentException if this is not AttributeProvider instance */ OSGiFramework getFramework(); - /* + /** * Get an OSGiFramework with a given name from this OSGiBootstrapProvider + * * @param name the framework name * @return The configured instance of a Framework, or null */ OSGiFramework getFramework(String name); - /* + /** * Configure this provider with the default configuration */ void configure(); - /* + /** * Configure this provider from the given URL */ void configure(URL urlConfig); - /* + /** * Configure this provider from a given resource */ void configure(String resourceConfig); - /* + /** * Configure this provider from a given input stream */ void configure(InputStream streamConfig); Copied: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiStateFormat.java (from rev 86290, projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/StateFormat.java) =================================================================== --- projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiStateFormat.java (rev 0) +++ projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiStateFormat.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -0,0 +1,63 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright 2005, JBoss Inc., and individual contributors as indicated + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ +package org.jboss.osgi.spi.framework; + +//$Id$ + +import org.osgi.framework.Bundle; + +/** + * A string format helper for OSGi states + * + * @author thomas.diesler(a)jboss.com + * @since 02-Mar-2009 + */ +public abstract class OSGiStateFormat +{ + // Hide ctor + private OSGiStateFormat() + { + } + + /** + * Return the string representation of a bundle state + */ + public static String formatBundleState(int bundleState) + { + String retState = "[" + bundleState + "]"; + + if (Bundle.UNINSTALLED == bundleState) + retState = "[UNINSTALLED]"; + else if (Bundle.INSTALLED == bundleState) + retState = "[INSTALLED]"; + else if (Bundle.RESOLVED == bundleState) + retState = "[RESOLVED]"; + else if (Bundle.STARTING == bundleState) + retState = "[STARTING]"; + else if (Bundle.STOPPING == bundleState) + retState = "[STOPPING]"; + else if (Bundle.ACTIVE == bundleState) + retState = "[ACTIVE]"; + + return retState; + } +} \ No newline at end of file Property changes on: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/OSGiStateFormat.java ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:mergeinfo + Name: svn:eol-style + LF Deleted: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/StateFormat.java =================================================================== --- projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/StateFormat.java 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/framework/StateFormat.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -1,58 +0,0 @@ -/* - * JBoss, Home of Professional Open Source - * Copyright 2005, JBoss Inc., and individual contributors as indicated - * by the @authors tag. See the copyright.txt in the distribution for a - * full listing of individual contributors. - * - * This is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as - * published by the Free Software Foundation; either version 2.1 of - * the License, or (at your option) any later version. - * - * This software is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this software; if not, write to the Free - * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA - * 02110-1301 USA, or see the FSF site: http://www.fsf.org. - */ -package org.jboss.osgi.spi.framework; - -//$Id$ - -import org.osgi.framework.Bundle; - -/** - * A string format helper for OSGi states - * - * @author thomas.diesler(a)jboss.com - * @since 02-Mar-2009 - */ -public abstract class StateFormat -{ - /** - * Return the string representation of a bundle state - */ - public static String formatBundleState(int bundleState) - { - String retState = "[" + bundleState + "]"; - - if (Bundle.UNINSTALLED == bundleState) - retState = "[UNINSTALLED]"; - else if (Bundle.INSTALLED == bundleState) - retState = "[INSTALLED]"; - else if (Bundle.RESOLVED == bundleState) - retState = "[RESOLVED]"; - else if (Bundle.STARTING == bundleState) - retState = "[STARTING]"; - else if (Bundle.STOPPING == bundleState) - retState = "[STOPPING]"; - else if (Bundle.ACTIVE == bundleState) - retState = "[ACTIVE]"; - - return retState; - } -} \ No newline at end of file Modified: projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/management/ManagedBundle.java =================================================================== --- projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/management/ManagedBundle.java 2009-03-25 15:45:37 UTC (rev 86357) +++ projects/jboss-osgi/trunk/runtime/spi/src/main/java/org/jboss/osgi/spi/management/ManagedBundle.java 2009-03-25 15:46:25 UTC (rev 86358) @@ -27,7 +27,7 @@ import org.jboss.logging.Logger; import org.jboss.osgi.spi.Constants; -import org.jboss.osgi.spi.framework.StateFormat; +import org.jboss.osgi.spi.framework.OSGiStateFormat; import org.osgi.framework.Bundle; import org.osgi.framework.BundleException; @@ -80,7 +80,7 @@ { bundle.start(); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info(bundle.getSymbolicName() + ",state=" + state); } @@ -88,7 +88,7 @@ { bundle.stop(); - String state = StateFormat.formatBundleState(bundle.getState()); + String state = OSGiStateFormat.formatBundleState(bundle.getState()); log.info(bundle.getSymbolicName() + ",state=" + state); } } \ No newline at end of file

16 years, 9 months

1
0
0 / 0

JBoss-OSGI SVN: r86300 - in projects/jboss-osgi/trunk/build/docbook/en: images and 1 other directories.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-25 07:39:57 -0400 (Wed, 25 Mar 2009) New Revision: 86300 Added: projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml Removed: projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml Modified: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg projects/jboss-osgi/trunk/build/docbook/en/master.xml Log: Add references Modified: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg =================================================================== (Binary files differ) Modified: projects/jboss-osgi/trunk/build/docbook/en/master.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/master.xml 2009-03-25 11:07:07 UTC (rev 86299) +++ projects/jboss-osgi/trunk/build/docbook/en/master.xml 2009-03-25 11:39:57 UTC (rev 86300) @@ -7,21 +7,34 @@ <!ENTITY ChapIntroduction SYSTEM "modules/introduction.xml"> <!ENTITY ChapGettingStarted SYSTEM "modules/gettingstarted.xml"> <!ENTITY ChapFrameworkIntegration SYSTEM "modules/frameworkintegration.xml"> -<!ENTITY ChapProvidedServices SYSTEM "modules/providedservices.xml"> +<!ENTITY ChapDeveloperGuide SYSTEM "modules/devguide.xml"> +<!ENTITY ChapReferences SYSTEM "modules/references.xml"> <!ENTITY version "1.0.0.Alpha3"> ]> <book lang="en"> <bookinfo> - <title>JBossOSGi</title> - <subtitle>User Guide</subtitle> - <releaseinfo>&version;</releaseinfo> + <title>JBossOSGi - User Guide</title> + <releaseinfo>Version: &version;</releaseinfo> + +  </bookinfo> - <toc /> + <toc/> &ChapIntroduction; &ChapGettingStarted; &ChapFrameworkIntegration; + &ChapDeveloperGuide; + &ChapReferences; </book> \ No newline at end of file Copied: projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml (from rev 86290, projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml) =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml (rev 0) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml 2009-03-25 11:39:57 UTC (rev 86300) @@ -0,0 +1,56 @@ + +<chapter id="ChapDeveloperGuide"> + + <title>Developer Documentation</title> + + <sect1 id="SecSPI"> + <title>Service Provider Interface</title> + + <note> + <para>TODO: Document the SPI</para> + </note> + </sect1> + + <sect1 id="SecDeployers"> + <title>Bundle Deployers</title> + + <note> + <para>TODO: Document the Deployers</para> + </note> + </sect1> + + <sect1 id="SecJMXView"> + <title>Management View</title> + + <note> + <para>TODO: Document the JMX View</para> + </note> + </sect1> + + <sect1 id="SecClassLoading"> + <title>Class Loading</title> + + <note> + <para>TODO: Document the Class Loading</para> + </note> + </sect1> + + <sect1 id="SecLoggingBridge"> + <title>Logging Bridge</title> + + <note> + <para>TODO: Document the Logging Bridge</para> + </note> + </sect1> + + <sect1 id="SecMicrocontainerService"> + <title>Microcontainer Service</title> + + <note> + <para>TODO: Document the Microcontainer Service</para> + </note> + </sect1> + +</chapter> Property changes on: projects/jboss-osgi/trunk/build/docbook/en/modules/devguide.xml ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:mergeinfo + Name: svn:eol-style + LF Deleted: projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml 2009-03-25 11:07:07 UTC (rev 86299) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml 2009-03-25 11:39:57 UTC (rev 86300) @@ -1,28 +0,0 @@ - -<chapter id="Chap_Provided_Services"> - - <title>Provided Services</title> - - <section id="Sec_Web_Console_Service"> - <title>Web Console Service</title> - <para>TODO</para> - </section> - - <section id="Sec_Logging_Service"> - <title>Logging Service</title> - <para>TODO</para> - </section> - - <section id="Sec_Http_Service"> - <title>Http Service</title> - <para>TODO</para> - </section> - - <section id="Sec_Config_Admin_Service"> - <title>Config Admin Service</title> - <para>TODO</para> - </section> - -</chapter> Added: projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml (rev 0) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml 2009-03-25 11:39:57 UTC (rev 86300) @@ -0,0 +1,25 @@ + +<chapter id="ChapReferences"> + + <title>References</title> + + <para><emphasis role="bold">Authors</emphasis></para> + + <itemizedlist> + <listitem><ulink url="email:thomas.diesler@jboss.com">thomas.diesler(a)jboss.com</ulink></listitem> + </itemizedlist> + + <para><emphasis role="bold">Links</emphasis></para> + + <para>[1] JBossOSGi Wiki - <ulink url="http://www.jboss.org/community/docs/DOC-13273">http://www.jboss.org/community/docs/DOC-13273</ulink></para> + <para>[2] JBossOSGi Blog - <ulink url="http://jbossosgi.blogspot.com">http://jbossosgi.blogspot.com</ulink></para> + <para>[3] Issue Tracking - <ulink url="https://jira.jboss.org/jira/browse/JBOSGI">https://jira.jboss.org/jira/browse/JBOSGI</ulink></para> + <para>[4] Hudson QA - <ulink url="http://jbmuc.dyndns.org:8280/hudson">http://jbmuc.dyndns.org:8280/hudson</ulink></para> + <para>[5] Subversion - <ulink url="https://anonsvn.jboss.org/repos/jbossas/projects/jboss-osgi">https://anonsvn.jboss.org/repos/jbossas/projects/jboss-osgi</ulink></para> + <para>[6] Fisheye - <ulink url="http://fisheye.jboss.com/browse/JBossOSGi">http://fisheye.jboss.com/browse/JBossOSGi</ulink></para> + <para>[7] User Forum - <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=257">http://www.jboss.org/index.html?module=bb&op=viewforum&f=257</ulink></para> + <para>[8] Design Forum - <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=256">http://www.jboss.org/index.html?module=bb&op=viewforum&f=256</ulink></para> + +</chapter> Property changes on: projects/jboss-osgi/trunk/build/docbook/en/modules/references.xml ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF

16 years, 9 months

1
0
0 / 0

JBoss-OSGI SVN: r86293 - in projects/jboss-osgi/trunk/build/docbook/en: images and 1 other directories.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-25 06:11:47 -0400 (Wed, 25 Mar 2009) New Revision: 86293 Added: projects/jboss-osgi/trunk/build/docbook/en/images/hudson_home.png Modified: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg projects/jboss-osgi/trunk/build/docbook/en/master.xml projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml Log: Userguide - Hudson QA Added: projects/jboss-osgi/trunk/build/docbook/en/images/hudson_home.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/hudson_home.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: projects/jboss-osgi/trunk/build/docbook/en/images/izpack-jboss-home.jpg =================================================================== (Binary files differ) Modified: projects/jboss-osgi/trunk/build/docbook/en/master.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/master.xml 2009-03-25 10:05:28 UTC (rev 86292) +++ projects/jboss-osgi/trunk/build/docbook/en/master.xml 2009-03-25 10:11:47 UTC (rev 86293) @@ -1,11 +1,13 @@ -<?xml version="1.0" encoding="UTF-8"?> + <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "../dtd/docbookx.dtd" [ -<!ENTITY Chap_Introduction SYSTEM "modules/introduction.xml"> -<!ENTITY Chap_Getting_Started SYSTEM "modules/gettingstarted.xml"> -<!ENTITY Chap_Framework_Integration SYSTEM "modules/frameworkintegration.xml"> -<!ENTITY Chap_Provided_Services SYSTEM "modules/providedservices.xml"> +<!ENTITY ChapIntroduction SYSTEM "modules/introduction.xml"> +<!ENTITY ChapGettingStarted SYSTEM "modules/gettingstarted.xml"> +<!ENTITY ChapFrameworkIntegration SYSTEM "modules/frameworkintegration.xml"> +<!ENTITY ChapProvidedServices SYSTEM "modules/providedservices.xml"> <!ENTITY version "1.0.0.Alpha3"> ]> @@ -18,9 +20,8 @@ <toc /> - &Chap_Introduction; - &Chap_Getting_Started; - &Chap_Framework_Integration; - &Chap_Provided_Services; + &ChapIntroduction; + &ChapGettingStarted; + &ChapFrameworkIntegration; </book> \ No newline at end of file Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-25 10:05:28 UTC (rev 86292) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-25 10:11:47 UTC (rev 86293) @@ -1,11 +1,11 @@  -<chapter id="Chap_Framework_Integration"> +<chapter id="ChapFrameworkIntegration"> <title>Framework Integration</title> - <sect1> + <sect1 id="SecIntFelix"> <title>Apache Felix Integration</title> <para>JBossOSGi provides integration for the <ulink url="http://felix.apache.org">Apache Felix</ulink> OSGi Framework and some @@ -77,7 +77,7 @@ </table> </sect1> - <sect1> + <sect1 id="SecIntEquinox"> <title>Equinox Integration</title> <note> @@ -85,7 +85,7 @@ </note> </sect1> - <sect1> + <sect1 id="SecIntKnopflerfish"> <title>Knopflerfish Integration</title> <note> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-25 10:05:28 UTC (rev 86292) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-25 10:11:47 UTC (rev 86293) @@ -1,14 +1,14 @@  -<chapter id="Chap_Getting_Started"> +<chapter id="ChapGettingStarted"> <title>Getting Started</title> <para>This chapter takes you through the first steps of getting JBossOSGi and provides the initial pointers to get up and running.</para> - <sect1> + <sect1 id="SecInstall"> <title>Installing JBossOSGi</title> <para>JBossOSGi is distributed as an <ulink url="http://izpack.org">IzPack</ulink> installer archive. @@ -55,7 +55,6 @@ <listitem><emphasis role="bold">JBossOSGi Integration</emphasis> - Integration with an existing JBossAS instance</listitem> </itemizedlist> - <para>In case you have selected 'JBossOSGi Integration', you will be presented with the choice of supported target containers.</para> <mediaobject> @@ -90,7 +89,7 @@ </mediaobject> </sect1> - <sect1> + <sect1 id="SecRuntime"> <title>JBossOSGi Runtime</title> <para>If you selected 'JBossOSGi Runtime' during installation you should see a <emphasis role="bold">runtime</emphasis> folder, which contains @@ -135,46 +134,197 @@ 14:43:55,250 INFO [ServerImpl] JBoss (Microcontainer) [5.0.1.GA ...] Started in 11s:645ms </programlisting> - <sect2> - <title>Bundle Deployment</title> + + <emphasis role="bold">Bundle Deployment</emphasis> - <para>Bundle deployement works, as you would probably expect, by dropping your OSGi Bundle into the - JBossOSGi Runtime <emphasis role="bold">deploy</emphasis> folder.</para> - - <programlisting> - [tdiesler@tdvaio testsuite]$ cp .../test-libs/jbosgi36-bundle.jar .../runtime/server/default/deploy - ... - 15:11:50,490 INFO [OSGiDeployer] Installed: jbosgi36 [9][INSTALLED] - 15:11:50,491 INFO [jbosgi36] BundleEvent INSTALLED - 15:11:50,511 INFO [jbosgi36] BundleEvent RESOLVED - 15:11:50,513 INFO [jbosgi36] ServiceEvent REGISTERED - 15:11:50,514 INFO [jbosgi36] BundleEvent STARTED - 15:11:50,514 INFO [BundleStartStopDeployer] Started: jbosgi36 [9][ACTIVE] - </programlisting> - - <note> - <para>TODO: Provide example bundles and use them here</para> - </note> - - </sect2> + <para>Bundle deployement works, as you would probably expect, by dropping your OSGi Bundle into the + JBossOSGi Runtime <emphasis role="bold">deploy</emphasis> folder.</para> - <sect2> - <title>Managing installed Bundles</title> - - <para>JBossOSGi comes with a simple Web Console, which is currently based on the - <ulink url="http://felix.apache.org/site/apache-felix-web-console.html">Apache Felix Web Console</ulink> project. - By default the JBossOSGi Web Console is available at <ulink url="http://localhost:8090/jboss-osgi">http://localhost:8090/jboss-osgi</ulink></para> + <programlisting> + [tdiesler@tdvaio testsuite]$ cp .../test-libs/jbosgi36-bundle.jar .../runtime/server/default/deploy + ... + 15:11:50,490 INFO [OSGiDeployer] Installed: jbosgi36 [9][INSTALLED] + 15:11:50,491 INFO [jbosgi36] BundleEvent INSTALLED + 15:11:50,511 INFO [jbosgi36] BundleEvent RESOLVED + 15:11:50,513 INFO [jbosgi36] ServiceEvent REGISTERED + 15:11:50,514 INFO [jbosgi36] BundleEvent STARTED + 15:11:50,514 INFO [BundleStartStopDeployer] Started: jbosgi36 [9][ACTIVE] + </programlisting> + + <note> + <para>TODO: Provide example bundles and use them here</para> + </note> + + + <emphasis role="bold">Managing installed Bundles</emphasis> + + <para>JBossOSGi comes with a simple Web Console, which is currently based on the + <ulink url="http://felix.apache.org/site/apache-felix-web-console.html">Apache Felix Web Console</ulink> project. + By default the JBossOSGi Web Console is available at <ulink url="http://localhost:8090/jboss-osgi">http://localhost:8090/jboss-osgi</ulink></para> - <mediaobject> - <imageobject> - <imagedata fileref="images/webconsole.jpg" contentwidth="120%"/> - </imageobject> - </mediaobject> + <mediaobject> + <imageobject> + <imagedata fileref="images/webconsole.jpg" contentwidth="120%"/> + </imageobject> + </mediaobject> + + <note> + <para>TODO: Cleanup and document console provided functionality</para> + </note> + </sect1> + + <sect1 id="SecHudson"> + <title>Hudson QA Environment</title> - <note> - <para>TODO: Cleanup and document console provided functionality</para> - </note> - </sect2> + <emphasis role="bold">Setup the Hudson QA Environment</emphasis> + + <para>The JBossOSGi <ulink url="http://jbmuc.dyndns.org:8280/hudson">Hudson QA Environment</ulink> is an integral part of the JBossOSGi code base. + It is designed for simplicity because we believe that comprehensive QA will only get done if it is dead simple to do so.</para> + + <para>Consequently, you only have to execute two simple ant targets to setup the QA environment that was used to QA the JBossOSGi + release that you currently work with.</para> + + <para>If in future we should discover a problem with a previous JBossOSGi release, it will be possible to provide a patch and verify that change using + the original QA environment for that release.</para> + + <para>With every release we test the matrix of supported target containers and JDKs.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/hudson_home.png" contentwidth="120%"/> + </imageobject> + </mediaobject> + + <emphasis role="bold">Set Hudson Properties</emphasis> + + <para>You need to set a few properties, especially these</para> + + <itemizedlist> + <listitem>hudson.maven.path</listitem> + <listitem>hudson.username</listitem> + <listitem>hudson.password</listitem> + <listitem>hudson.root</listitem> + </itemizedlist> + + <programlisting> + cd build/hudson + cp ant.properties.example ant.properties + vi ant.properties + + # JBoss remote repository + jboss.repository=http://repository.jboss.org + + # The JBoss settings + jboss.server.instance=default + jboss.bind.address=127.0.0.1 + + # JDK settings + java.home.jdk15=/usr/java/jdk1.5.0_17 + java.home.jdk16=/usr/java/jdk1.6.0_11 + + # Hudson QA Environment + hudson.username=chageme + hudson.password=chageme + + hudson.maven.path=/usr/java/apache-maven-2.0.9 + + hudson.root=/home/tdiesler/workspace/hudson/jboss-osgi + + hudson.maven.profile=$HUDSONDIR/profiles.xml.local.qa + + hudson.host=jbpm.dyndns.org + hudson.admin.port=8250 + hudson.http.port=8280 + + #hudson.jboss501.zip=file:///home/tdiesler/Download/java/jboss/jboss-5.0.1.GA.zip + + hudson.mail.recipients= + hudson.smtp.host=localhost + + # Hudson (1.290) + apache-tomcat=5.5.20 + sun-hudson=2402/128862 + </programlisting> + + <emphasis role="bold">Run Hudson Setup</emphasis> + + <programlisting> + [tdiesler@tdvaio hudson]$ ant hudson-setup + Buildfile: build.xml + + init: + [echo] V1.0.0.Alpha3 + + init-hudson: + [echo] + [echo] hudson.root = /home/tdiesler/workspace/hudson/jboss-osgi + [echo] hudson.home = /home/tdiesler/workspace/hudson/jboss-osgi/hudson-home + [echo] + + ... + + hudson-setup: + [copy] Copying 2 files to /home/.../hudson/jboss-osgi/apache-tomcat + ... + [echo] + [echo] ************************************* + [echo] * Hudson setup successfully * + [echo] * ant hudson-start * + [echo] ************************************* + [echo] + </programlisting> + + <emphasis role="bold">Run Hudson Start</emphasis> + + <programlisting> + [tdiesler@tdvaio hudson]$ ant hudson-start + Buildfile: build.xml + + init: + [echo] V1.0.0.Alpha3 + + init-hudson: + [echo] + [echo] hudson.root = /home/tdiesler/workspace/hudson/jboss-osgi + [echo] hudson.home = /home/tdiesler/workspace/hudson/jboss-osgi/hudson-home + [echo] + + hudson-start: + [echo] + [echo] ************************************* + [echo] * Hudson started successfully * + [echo] * http://localhost:8280/hudson * + [echo] ************************************* + [echo] + + BUILD SUCCESSFUL + </programlisting> + + <emphasis role="bold">Run Hudson Stop</emphasis> + + <programlisting> + [tdiesler@tdvaio hudson]$ ant hudson-stop + Buildfile: build.xml + + init: + [echo] V1.0.0.Alpha3 + + init-hudson: + [echo] + [echo] hudson.root = /home/tdiesler/workspace/hudson/jboss-osgi + [echo] hudson.home = /home/tdiesler/workspace/hudson/jboss-osgi/hudson-home + [echo] + + hudson-stop: + [echo] + [echo] ************************************* + [echo] * Hudson stopped successfully * + [echo] * ant hudson-start * + [echo] ************************************* + [echo] + + BUILD SUCCESSFUL + </programlisting> </sect1> </chapter> \ No newline at end of file Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml 2009-03-25 10:05:28 UTC (rev 86292) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml 2009-03-25 10:11:47 UTC (rev 86293) @@ -5,7 +5,7 @@ <title>Introduction</title> - <sect1> + <sect1 id="SecWhatIsOsgi"> <title>What is OSGi</title> <para>The <ulink url="http://www2.osgi.org/Release4/HomePage">Open Services Gateway Initiative (OSGi)</ulink>, @@ -28,34 +28,34 @@ <listitem>Provide an OSGi compliant framework implementation based on the <ulink url="http://www.jboss.org/jbossmc">JBoss Microcontainer</ulink></listitem> </orderedlist> - <sect2> - <title>What does OSGi offer to Java developers?</title> - - <para>OSGi modules provide classloader semantics to partially expose code that can then be consumed by other modules. - The implementation details of a module, although scoped public by the Java programming language, remain private to the module. - On top of that you can install multiple versions of the same code and resolve dependencies by version and other criteria. - OSGi also offers advanced security and lifecycle, which I'll explain in more detail further down.</para> - </sect2> + + <emphasis role="bold">What does OSGi offer to Java developers?</emphasis> + + <para>OSGi modules provide classloader semantics to partially expose code that can then be consumed by other modules. + The implementation details of a module, although scoped public by the Java programming language, remain private to the module. + On top of that you can install multiple versions of the same code and resolve dependencies by version and other criteria. + OSGi also offers advanced security and lifecycle, which I'll explain in more detail further down.</para> - <sect2> - <title>What kind of applications benefit from OSGi?</title> - - <para>Any application that is designed in a modular fashion where it is necessary to start, stop, update individual modules with minimal impact - on other modules. Modules can define their own transitive dependencies without the need to resolve these dependencies at the container level. - The OSGi platform builds an exellent foundation for the next generation JBoss ESB for example.</para> - </sect2> + - <sect2> - <title>Should Java EE developers adopt the OSGi programming model?</title> - - <para>Probably not. The OSGi runtime may be used internally by Java EE container providers to achieve the desired isolation and configuration - flexibility that the container whishes to provide. At the application programming level, the Java EE model will continue to exist in its own right, - wheras the OSGi model may provide the more suitable runtime environment for applications that require the modular isolation, security and lifecycle - management that OSGi offers.</para> - </sect2> + <emphasis role="bold">What kind of applications benefit from OSGi?</emphasis> + + <para>Any application that is designed in a modular fashion where it is necessary to start, stop, update individual modules with minimal impact + on other modules. Modules can define their own transitive dependencies without the need to resolve these dependencies at the container level. + The OSGi platform builds an exellent foundation for the next generation JBoss ESB for example.</para> + + + + <emphasis role="bold">Should Java EE developers adopt the OSGi programming model?</emphasis> + + <para>Probably not. The OSGi runtime may be used internally by Java EE container providers to achieve the desired isolation and configuration + flexibility that the container whishes to provide. At the application programming level, the Java EE model will continue to exist in its own right, + wheras the OSGi model may provide the more suitable runtime environment for applications that require the modular isolation, security and lifecycle + management that OSGi offers.</para> + </sect1> - <sect1> + <sect1 id="SecFramworkOverview"> <title>OSGi Framework Overview</title> <para>The functionality of the Framework is divided in the following layers:</para> @@ -74,9 +74,9 @@ </imageobject> </mediaobject> - <sect2> - <title>OSGi Security Layer</title> + <emphasis role="bold">OSGi Security Layer</emphasis> + <para>The OSGi Security Layer is an optional layer that underlies the OSGi Service Platform. The layer is based on the Java 2 security architecture. It provides the infrastructure to deploy and manage applications that must run in fine grained controlled environments.</para> @@ -97,10 +97,10 @@ <imagedata fileref="images/osgi-delegation.png"/> </imageobject> </mediaobject> - </sect2> - <sect2> - <title>OSGi Module Layer</title> + + + <emphasis role="bold">OSGi Module Layer</emphasis> <para>The OSGi Module Layer provides a generic and standardized solution for Java modularization. The Framework defines a unit of modularization, called a bundle. A bundle is comprised of Java classes and other resources, @@ -161,10 +161,8 @@ <programlisting> Export-Package: com.acme.foo; include:="Qux*,BarImpl"; exclude:=QuxImpl </programlisting> - </sect2> - <sect2> - <title>OSGi Life Cycle Layer</title> + <emphasis role="bold">OSGi Life Cycle Layer</emphasis> <para>The Life Cycle Layer provides an API to control the security and life cycle operations of bundles.</para> @@ -192,10 +190,7 @@ <listitem>Subscribing or unsubscribing to Famework events</listitem> </itemizedlist> - </sect2> - - <sect2> - <title>OSGi Service Layer</title> + <emphasis role="bold">OSGi Service Layer</emphasis> <para>The OSGi Service Layer defines a dynamic collaborative model that is highly integrated with the Life Cycle Layer. The service model is a publish, find and bind model. A service is a normal Java object that is registered under one or more @@ -206,151 +201,105 @@ <imagedata fileref="images/osgi-service-registration.png"/> </imageobject> </mediaobject> - </sect2> </sect1> - <sect1> + <sect1 id="SecServiceCompendium"> <title>OSGi Service Compendium</title> + <para>The OSGi Service Compendium specifies a number of services that may be available in an OSGi runtime environment. Although the OSGi Framework specification is useful in itself already, it only defines the OSGi core infrastructure. The services defined in the compendium specification define the scope and functionality of some common services that bundle developers might want to use. Here is a quick summary:</para> - - <sect2> - <title>Log Service</title> - <para>The Log Service provides a general purpose message logger for the OSGi Service Platform. It consists of two services, - one for logging information and another for retrieving current or previously recorded log information.</para> - </sect2> - - <sect2> - <title>Http Service</title> - <para>The Http Service supports two standard techniques for registering servlets and resources to develop communication and - user interface solutions for standard technologies such as HTTP, HTML, XML, etc.</para> - </sect2> - <sect2> - <title>Device Access Specification</title> - <para>The Device Access specification supports the coordination of automatic detection and attachment of existing devices on - an OSGi Service Platform, facilitates hot-plugging and -unplugging of new devices, and downloads and installs device drivers on demand.</para> - </sect2> - - <sect2> - <title>Configuration Admin Service</title> - <para>The Configuration Admin service allows an Operator to set the configuration information of deployed bundles.</para> - <mediaobject> - <imageobject> - <imagedata fileref="images/osgi-config-service.png" contentwidth="450"/> - </imageobject> - </mediaobject> - </sect2> - - <sect2> - <title>Metatype Service</title> - <para>The Metatype Service specification defines interfaces that allow bundle developers to describe attribute - types in a computer readable form using so-called metadata.</para> - </sect2> - - <sect2> - <title>Preferences Service</title> - <para>The Preferences Service allows storage of data that is specific to a particular user.</para> - </sect2> - - <sect2> - <title>User Admin Service</title> - <para>Bundles can use the User Admin Service to authenticate an initiator and represent this authentication as an Authorization object. - Bundles that execute actions on behalf of this user can use the Authorization object to verify if that user is authorized.</para> - </sect2> - - <sect2> - <title>Wire Admin Service</title> - <para>The Wire Admin Service is an administrative service that is used to control a wiring topology in the OSGi Service Platform. - It is intended to be used by user interfaces or management programs that control the wiring of services in an OSGi Service Platform.</para> - </sect2> - - <sect2> - <title>IO Connector Service</title> - <para>The IO Connector Service specification adopts the Java 2 Micro Edition (J2ME) javax.microedition.io packages as a basic communications - infrastructure.</para> - </sect2> - - <sect2> - <title>UPnP Device Service</title> - <para>The UPnP Device Service specifies how OSGi bundles can be developed that interoperate with UPnP (Universal Plug and Play) - devices and UPnP control points.</para> - </sect2> - - <sect2> - <title>Declarative Services Specification</title> - <para>The Declarative Services specification addresses some of the complications that arise when the OSGi service model is - used for larger systems and wider deployments, such as: Startup Time, Memory Footprint, Complexity. The service component - model uses a declarative model for publishing, finding and binding to OSGi services.</para> - </sect2> - - <sect2> - <title>Event Admin Service</title> - <para>The Event Admin Service provides an inter-bundle communication mechanism. It is based on a event publish and subscribe model, popular in many message based systems.</para> - </sect2> - - <sect2> - <title>Deployment Admin Service</title> - <para>The Deployment Admin Service specification, standardizes the access to some of the responsibilities of the management agent: - that is, the lifecycle management of interlinked resources on an OSGi Service Platform.</para> - </sect2> - - <sect2> - <title>Auto Configuration Specification</title> - <para>The Auto Configuration Specification is to allow the configuration of bundles. - These bundles can be embedded in Deployment Packages or bundles that are already present on the OSGi Service Platform.</para> - </sect2> - - <sect2> - <title>Application Admin Service</title> - <para>The Application Admin Service is intended to simplify the management of an environment with many different types of applications - that are simultaneously available.</para> - </sect2> - - <sect2> - <title>DMT Admin Service</title> - <para>The DMT Admin Service specification defines an API for managing a device using concepts from the OMA DM specifications.</para> - </sect2> - - <sect2> - <title>Monitor Admin Service</title> - <para>The Monitor Admin Service specification outlines how a bundle can publish Status Variables and how administrative bundles - can discover Status Variables as well as read and reset their values.</para> - </sect2> - - <sect2> - <title>Foreign Application Access Specification</title> - <para>The Foreign Application Access specification is to enable foreign application models like MIDP, Xlets, Applets, other Java - application models to participate in the OSGi service oriented architecture.</para> - </sect2> - - <sect2> - <title>Service Tracker Specification</title> - <para>The Service Tracker specification defines a utility class, ServiceTracker, that makes tracking the registration, modification, - and unregistration of services much easier.</para> - </sect2> - - <sect2> - <title>XML Parser Service Specification</title> - <para>The XML Parser Service specification addresses how the classes defined in JAXP can be used in an OSGi Service Platform.</para> - </sect2> - - <sect2> - <title>Position Specification</title> - <para>The Position Specification provides bundle developers with a consistent way of handling geographic positions in OSGi applications.</para> - </sect2> - - <sect2> - <title>Measurement and State Specification</title> - <para>The Measurement and State Specification provides a consistent way of handling a diverse range of measurements for bundle developers.</para> - </sect2> - - <sect2> - <title>Execution Environment Specification</title> - <para>This Execution Environment Specification defines different execution environments for OSGi Server Platform Servers.</para> - </sect2> + <emphasis role="bold">Log Service</emphasis> + <para>The Log Service provides a general purpose message logger for the OSGi Service Platform. It consists of two services, + one for logging information and another for retrieving current or previously recorded log information.</para> + + <emphasis role="bold">Http Service</emphasis> + <para>The Http Service supports two standard techniques for registering servlets and resources to develop communication and + user interface solutions for standard technologies such as HTTP, HTML, XML, etc.</para> + + <emphasis role="bold">Device Access Specification</emphasis> + <para>The Device Access specification supports the coordination of automatic detection and attachment of existing devices on + an OSGi Service Platform, facilitates hot-plugging and -unplugging of new devices, and downloads and installs device drivers on demand.</para> + + <emphasis role="bold">Configuration Admin Service</emphasis> + <para>The Configuration Admin service allows an Operator to set the configuration information of deployed bundles.</para> + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-config-service.png" contentwidth="450"/> + </imageobject> + </mediaobject> + + <emphasis role="bold">Metatype Service</emphasis> + <para>The Metatype Service specification defines interfaces that allow bundle developers to describe attribute + types in a computer readable form using so-called metadata.</para> + + <emphasis role="bold">Preferences Service</emphasis> + <para>The Preferences Service allows storage of data that is specific to a particular user.</para> + + <emphasis role="bold">User Admin Service</emphasis> + <para>Bundles can use the User Admin Service to authenticate an initiator and represent this authentication as an Authorization object. + Bundles that execute actions on behalf of this user can use the Authorization object to verify if that user is authorized.</para> + + <emphasis role="bold">Wire Admin Service</emphasis> + <para>The Wire Admin Service is an administrative service that is used to control a wiring topology in the OSGi Service Platform. + It is intended to be used by user interfaces or management programs that control the wiring of services in an OSGi Service Platform.</para> + + <emphasis role="bold">IO Connector Service</emphasis> + <para>The IO Connector Service specification adopts the Java 2 Micro Edition (J2ME) javax.microedition.io packages as a basic communications + infrastructure.</para> + + <emphasis role="bold">UPnP Device Service</emphasis> + <para>The UPnP Device Service specifies how OSGi bundles can be developed that interoperate with UPnP (Universal Plug and Play) + devices and UPnP control points.</para> + + <emphasis role="bold">Declarative Services Specification</emphasis> + <para>The Declarative Services specification addresses some of the complications that arise when the OSGi service model is + used for larger systems and wider deployments, such as: Startup Time, Memory Footprint, Complexity. The service component + model uses a declarative model for publishing, finding and binding to OSGi services.</para> + + <emphasis role="bold">Event Admin Service</emphasis> + <para>The Event Admin Service provides an inter-bundle communication mechanism. It is based on a event publish and subscribe model, popular in many message based systems.</para> + + <emphasis role="bold">Deployment Admin Service</emphasis> + <para>The Deployment Admin Service specification, standardizes the access to some of the responsibilities of the management agent: + that is, the lifecycle management of interlinked resources on an OSGi Service Platform.</para> + + <emphasis role="bold">Auto Configuration Specification</emphasis> + <para>The Auto Configuration Specification is to allow the configuration of bundles. + These bundles can be embedded in Deployment Packages or bundles that are already present on the OSGi Service Platform.</para> + + <emphasis role="bold">Application Admin Service</emphasis> + <para>The Application Admin Service is intended to simplify the management of an environment with many different types of applications + that are simultaneously available.</para> + + <emphasis role="bold">DMT Admin Service</emphasis> + <para>The DMT Admin Service specification defines an API for managing a device using concepts from the OMA DM specifications.</para> + + <emphasis role="bold">Monitor Admin Service</emphasis> + <para>The Monitor Admin Service specification outlines how a bundle can publish Status Variables and how administrative bundles + can discover Status Variables as well as read and reset their values.</para> + + <emphasis role="bold">Foreign Application Access Specification</emphasis> + <para>The Foreign Application Access specification is to enable foreign application models like MIDP, Xlets, Applets, other Java + application models to participate in the OSGi service oriented architecture.</para> + + <emphasis role="bold">Service Tracker Specification</emphasis> + <para>The Service Tracker specification defines a utility class, ServiceTracker, that makes tracking the registration, modification, + and unregistration of services much easier.</para> + + <emphasis role="bold">XML Parser Service Specification</emphasis> + <para>The XML Parser Service specification addresses how the classes defined in JAXP can be used in an OSGi Service Platform.</para> + + <emphasis role="bold">Position Specification</emphasis> + <para>The Position Specification provides bundle developers with a consistent way of handling geographic positions in OSGi applications.</para> + + <emphasis role="bold">Measurement and State Specification</emphasis> + <para>The Measurement and State Specification provides a consistent way of handling a diverse range of measurements for bundle developers.</para> + + <emphasis role="bold">Execution Environment Specification</emphasis> + <para>This Execution Environment Specification defines different execution environments for OSGi Server Platform Servers.</para> </sect1> </chapter>

16 years, 9 months

1
0
0 / 0

JBoss-OSGI SVN: r86267 - projects/jboss-osgi/trunk/build/docbook/en/modules.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-24 12:38:32 -0400 (Tue, 24 Mar 2009) New Revision: 86267 Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml Log: fix links to jbossmc Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-24 16:31:28 UTC (rev 86266) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-24 16:38:32 UTC (rev 86267) @@ -17,7 +17,7 @@ <listitem><ulink url="http://felix.apache.org/site/apache-felix-configuration-admin-service.html">Config Admin Service</ulink> - Management of configuration data for configurable components</listitem> </itemizedlist> - <para>The <ulink url="http://felix.apache.org">Apache Felix</ulink> integration can be configured through a JBoss Microcontainer beans + <para>The Apache Felix integration can be configured through a <ulink url="http://www.jboss.org/jbossmc">JBoss Microcontainer</ulink> beans configuration</para> <programlisting><![CDATA[ @@ -40,8 +40,7 @@ </deployment> ]]></programlisting> - <para>The following is a description of the configuration properties for the <ulink url="http://felix.apache.org">Apache Felix</ulink> - integration.</para> + <para>The following is a description of the configuration properties for the Apache Felix integration.</para> <table> <tr><th>Key</th><th>Value</th><th>Description</th></tr>

16 years, 9 months

1
0
0 / 0

JBoss-OSGI SVN: r86266 - projects/jboss-osgi/trunk/build/docbook/en/modules.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-24 12:31:28 -0400 (Tue, 24 Mar 2009) New Revision: 86266 Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml Log: Userguide - Framework integration Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-24 16:26:28 UTC (rev 86265) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-24 16:31:28 UTC (rev 86266) @@ -1,3 +1,6 @@ + <chapter id="Chap_Framework_Integration"> <title>Framework Integration</title> @@ -9,7 +12,7 @@ of its core services</para> <itemizedlist> - <listitem><ulink url="http://felix.apache.org/site/subprojects.html">Log Service</ulink> - General purpose message logger</listitem> + <listitem>Log Service - General purpose message logger</listitem> <listitem><ulink url="http://felix.apache.org/site/apache-felix-http-service.html">HTTP Service</ulink> - Http access to servlets and resources</listitem> <listitem><ulink url="http://felix.apache.org/site/apache-felix-configuration-admin-service.html">Config Admin Service</ulink> - Management of configuration data for configurable components</listitem> </itemizedlist> @@ -37,6 +40,9 @@ </deployment> ]]></programlisting> + <para>The following is a description of the configuration properties for the <ulink url="http://felix.apache.org">Apache Felix</ulink> + integration.</para> + <table> <tr><th>Key</th><th>Value</th><th>Description</th></tr> <tr valign="top"> @@ -70,7 +76,6 @@ <td>Bundles can be deployed in any order</td> </tr> </table> - </sect1> <sect1> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-24 16:26:28 UTC (rev 86265) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-24 16:31:28 UTC (rev 86266) @@ -1,3 +1,6 @@ + <chapter id="Chap_Getting_Started"> <title>Getting Started</title> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml 2009-03-24 16:26:28 UTC (rev 86265) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml 2009-03-24 16:31:28 UTC (rev 86266) @@ -1,3 +1,6 @@ + <chapter id="Chap_Provided_Services"> <title>Provided Services</title>

16 years, 9 months

1
0
0 / 0

JBoss-OSGI SVN: r86265 - in projects/jboss-osgi/trunk/build/docbook/en: modules and 1 other directory.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-24 12:26:28 -0400 (Tue, 24 Mar 2009) New Revision: 86265 Added: projects/jboss-osgi/trunk/build/docbook/en/images/webconsole.jpg Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml Log: Userguide - Framework integration Added: projects/jboss-osgi/trunk/build/docbook/en/images/webconsole.jpg =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/webconsole.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-24 16:21:29 UTC (rev 86264) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-24 16:26:28 UTC (rev 86265) @@ -2,19 +2,91 @@ <title>Framework Integration</title> - <section id="Sec_Integration_Felix"> + <sect1> <title>Apache Felix Integration</title> - <para>TODO</para> - </section> + + <para>JBossOSGi provides integration for the <ulink url="http://felix.apache.org">Apache Felix</ulink> OSGi Framework and some + of its core services</para> + + <itemizedlist> + <listitem><ulink url="http://felix.apache.org/site/subprojects.html">Log Service</ulink> - General purpose message logger</listitem> + <listitem><ulink url="http://felix.apache.org/site/apache-felix-http-service.html">HTTP Service</ulink> - Http access to servlets and resources</listitem> + <listitem><ulink url="http://felix.apache.org/site/apache-felix-configuration-admin-service.html">Config Admin Service</ulink> - Management of configuration data for configurable components</listitem> + </itemizedlist> + + <para>The <ulink url="http://felix.apache.org">Apache Felix</ulink> integration can be configured through a JBoss Microcontainer beans + configuration</para> + + <programlisting><![CDATA[ + cat server/default/deployers/osgi.deployer/META-INF/osgi-deployers-jboss-beans.xml + + <deployment xmlns="urn:jboss:bean-deployer:2.0"> + +  + <bean name="jboss.osgi:service=Framework" class="org.jboss.osgi.felix.framework.FelixIntegration"> + <property name="felixProperties"> + ... + </property> + <property name="autoStart"> + <list elementClass="java.net.URI"> + ... + </list> + </property> + </bean> + ... + </deployment> + ]]></programlisting> + + <table> + <tr><th>Key</th><th>Value</th><th>Description</th></tr> + <tr valign="top"> + <td>org.osgi.framework.storage</td> + <td>.../osgi-store</td> + <td>OSGi Framework storage area</td> + </tr> + <tr valign="top"> + <td>org.osgi.framework.storage.clean</td> + <td>onFirstInit</td> + <td>Clean the storage area on first init</td> + </tr> + <tr valign="top"> + <td>org.osgi.service.http.port</td> + <td>8090</td> + <td>The default Http Service port</td> + </tr> + <tr valign="top"> + <td>felix.cm.dir</td> + <td>.../osgi-configadmin</td> + <td>Config Admin Service storage area</td> + </tr> + <tr valign="top"> + <td>org.osgi.framework.system.packages</td> + <td>javax.management, javax.xml...</td> + <td>Packages provided by the OSGi System ClassLoader</td> + </tr> + <tr valign="top"> + <td>org.jboss.osgi.deferred.start</td> + <td>true</td> + <td>Bundles can be deployed in any order</td> + </tr> + </table> + + </sect1> - <section id="Sec_Integration_Equinox"> + <sect1> <title>Equinox Integration</title> - <para>TODO</para> - </section> + + <note> + <para>TODO: Provide and document Equinox Integration</para> + </note> + </sect1> - <section id="Sec_Integration_Knopflerfish"> + <sect1> <title>Knopflerfish Integration</title> - <para>TODO</para> - </section> + + <note> + <para>TODO: Provide and document Knopflerfish Integration</para> + </note> + </sect1> </chapter> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-24 16:21:29 UTC (rev 86264) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-24 16:26:28 UTC (rev 86265) @@ -158,9 +158,19 @@ <sect2> <title>Managing installed Bundles</title> - <para>JBossOSGi comes with a simple Web Console - integrates the <ulink url="http://felix.apache.org/site/apache-felix-web-console.html">Apache Felix Web Console</ulink> - project.</para> + <para>JBossOSGi comes with a simple Web Console, which is currently based on the + <ulink url="http://felix.apache.org/site/apache-felix-web-console.html">Apache Felix Web Console</ulink> project. + By default the JBossOSGi Web Console is available at <ulink url="http://localhost:8090/jboss-osgi">http://localhost:8090/jboss-osgi</ulink></para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/webconsole.jpg" contentwidth="120%"/> + </imageobject> + </mediaobject> + + <note> + <para>TODO: Cleanup and document console provided functionality</para> + </note> </sect2> </sect1>

16 years, 9 months

1
0
0 / 0

JBoss-OSGI SVN: r86210 - in projects/jboss-osgi/trunk/build: docbook and 3 other directories.

by jboss-osgi-commits＠lists.jboss.org

Author: thomas.diesler(a)jboss.com Date: 2009-03-23 11:12:01 -0400 (Mon, 23 Mar 2009) New Revision: 86210 Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-classloader.png projects/jboss-osgi/trunk/build/docbook/en/images/osgi-config-service.png projects/jboss-osgi/trunk/build/docbook/en/images/osgi-delegation.png projects/jboss-osgi/trunk/build/docbook/en/images/osgi-layers.png projects/jboss-osgi/trunk/build/docbook/en/images/osgi-life-cycle.png projects/jboss-osgi/trunk/build/docbook/en/images/osgi-service-registration.png projects/jboss-osgi/trunk/build/docbook/en/images/osgi-version-constraint.png projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml Modified: projects/jboss-osgi/trunk/build/distribution/pom.xml projects/jboss-osgi/trunk/build/docbook/en/master.xml projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml projects/jboss-osgi/trunk/build/docbook/pom.xml Log: Userguide - Intro Modified: projects/jboss-osgi/trunk/build/distribution/pom.xml =================================================================== --- projects/jboss-osgi/trunk/build/distribution/pom.xml 2009-03-23 15:11:04 UTC (rev 86209) +++ projects/jboss-osgi/trunk/build/distribution/pom.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -104,21 +104,21 @@ <dependency> <groupId>org.jboss.osgi</groupId> <artifactId>jboss-osgi-userguide</artifactId> - <classifier>pdf</classifier> + <classifier>html</classifier> <version>${version}</version> <type>war</type> </dependency> <dependency> <groupId>org.jboss.osgi</groupId> <artifactId>jboss-osgi-userguide</artifactId> - <classifier>html</classifier> + <classifier>html_single</classifier> <version>${version}</version> <type>war</type> </dependency> <dependency> <groupId>org.jboss.osgi</groupId> <artifactId>jboss-osgi-userguide</artifactId> - <classifier>html_single</classifier> + <classifier>pdf</classifier> <version>${version}</version> <type>war</type> </dependency> Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-classloader.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-classloader.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-config-service.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-config-service.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-delegation.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-delegation.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-layers.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-layers.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-life-cycle.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-life-cycle.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-service-registration.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-service-registration.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-version-constraint.png =================================================================== (Binary files differ) Property changes on: projects/jboss-osgi/trunk/build/docbook/en/images/osgi-version-constraint.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: projects/jboss-osgi/trunk/build/docbook/en/master.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/master.xml 2009-03-23 15:11:04 UTC (rev 86209) +++ projects/jboss-osgi/trunk/build/docbook/en/master.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -2,8 +2,10 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "../dtd/docbookx.dtd" [ -<!ENTITY introduction SYSTEM "modules/introduction.xml"> -<!ENTITY gettingstarted SYSTEM "modules/gettingstarted.xml"> +<!ENTITY Chap_Introduction SYSTEM "modules/introduction.xml"> +<!ENTITY Chap_Getting_Started SYSTEM "modules/gettingstarted.xml"> +<!ENTITY Chap_Framework_Integration SYSTEM "modules/frameworkintegration.xml"> +<!ENTITY Chap_Provided_Services SYSTEM "modules/providedservices.xml"> <!ENTITY version "1.0.0.Alpha3"> ]> @@ -12,16 +14,13 @@ <title>JBossOSGi</title> <subtitle>User Guide</subtitle> <releaseinfo>&version;</releaseinfo> - <mediaobject> - <imageobject> - <imagedata fileref="images/jbpm_logotype_jpdl.svg" align="center" /> - </imageobject> - </mediaobject> </bookinfo> <toc /> - &introduction; - &gettingstarted; + &Chap_Introduction; + &Chap_Getting_Started; + &Chap_Framework_Integration; + &Chap_Provided_Services; </book> \ No newline at end of file Added: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml (rev 0) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -0,0 +1,20 @@ +<chapter id="Chap_Framework_Integration"> + + <title>Framework Integration</title> + + <section id="Sec_Integration_Felix"> + <title>Apache Felix Integration</title> + <para>TODO</para> + </section> + + <section id="Sec_Integration_Equinox"> + <title>Equinox Integration</title> + <para>TODO</para> + </section> + + <section id="Sec_Integration_Knopflerfish"> + <title>Knopflerfish Integration</title> + <para>TODO</para> + </section> + +</chapter> Property changes on: projects/jboss-osgi/trunk/build/docbook/en/modules/frameworkintegration.xml ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-23 15:11:04 UTC (rev 86209) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/gettingstarted.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -1,16 +1,16 @@ -<chapter id="gettingstarted"> +<chapter id="Chap_Getting_Started"> <title>Getting Started</title> <para>This chapter takes you through the first steps of getting JBossOSGi and provides the initial pointers to get up and running in no time.</para> - <section id="download_and_install"> - <title>Downloading and Installing JBossOSGi</title> + <section id="Sec_Download_Install"> + <title>Installing JBossOSGi</title> </section> <section> - <title>The JBossOSGi Wiki</title> + <title>Project Infrastructure</title> <para>The <ulink url="http://www.jboss.org/community/docs/DOC-13273">JBossOSGi Wiki</ulink> provides news, details about forums, mailing lists, issue tracker, downloads, source repositories, etc. </para> Modified: projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml 2009-03-23 15:11:04 UTC (rev 86209) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/introduction.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -1,18 +1,349 @@ -<chapter id="introduction"> + +<chapter id="ChapIntroduction"> <title>Introduction</title> - <para>The <ulink url="http://www2.osgi.org/Release4/HomePage">Open Services Gateway Initiative (OSGi)</ulink>, - specifications define a standardized, component-oriented, computing environment for networked services that is the foundation - of an enhanced service-oriented architecture.</para> + <sect1> + <title>What is OSGi</title> + + <para>The <ulink url="http://www2.osgi.org/Release4/HomePage">Open Services Gateway Initiative (OSGi)</ulink>, + specifications define a standardized, component-oriented, computing environment for networked services that is the foundation + of an enhanced service-oriented architecture.</para> + + <para>The OSGi specification defines two things:</para> + + <itemizedlist> + <listitem>A set of services that an OSGi container must implement</listitem> + <listitem>A contract between the container and your application</listitem> + </itemizedlist> + + <para>Developing on the OSGi platform means first building your application using OSGi APIs, then deploying it in an OSGi container.</para> + + <sect2> + <title>What does OSGi offer to Java developers?</title> + + <para>OSGi modules provide classloader semantics to partially expose code that can then be consumed by other modules. + The implementation details of a module, although scoped public by the Java programming language, remain private to the module. + On top of that you can install multiple versions of the same code and resolve dependencies by version and other criteria. + OSGi also offers advanced security and lifecycle, which I'll explain in more detail further down.</para> + </sect2> + + <sect2> + <title>What kind of applications benefit from OSGi?</title> + + <para>Any application that is designed in a modular fashion where it is necessary to start, stop, update individual modules with minimal impact + on other modules. Modules can define their own transitive dependencies without the need to resolve these dependencies at the container level. + The OSGi platform builds an exellent foundation for the next generation JBoss ESB for example.</para> + </sect2> + + <sect2> + <title>Should Java EE developers adopt the OSGi programming model?</title> + + <para>Probably not. The OSGi runtime may be used internally by Java EE container providers to achieve the desired isolation and configuration + flexibility that the container whishes to provide. At the application programming level, the Java EE model will continue to exist in its own right, + wheras the OSGi model may provide the more suitable runtime environment for applications that require the modular isolation, security and lifecycle + management that OSGi offers.</para> + </sect2> + </sect1> + + <sect1> + <title>OSGi Framework Overview</title> + + <para>The functionality of the Framework is divided in the following layers:</para> + + <itemizedlist> + <listitem>Security Layer</listitem> + <listitem>Module Layer</listitem> + <listitem>Life Cycle Layer</listitem> + <listitem>Service Layer</listitem> + <listitem>Actual Services</listitem> + </itemizedlist> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-layers.png"/> + </imageobject> + </mediaobject> - <para>The OSGi specification defines two things:</para> + <sect2> + <title>OSGi Security Layer</title> + + <para>The OSGi Security Layer is an optional layer that underlies the OSGi Service Platform. + The layer is based on the Java 2 security architecture. It provides the infrastructure to deploy and manage + applications that must run in fine grained controlled environments.</para> + + <para>The OSGi Service Platform can authenticate code in the following ways:</para> + + <itemizedlist> + <listitem>By location</listitem> + <listitem>By signer</listitem> + </itemizedlist> + + <para>For example, an Operator can grant the ACME company the right to use networking on their devices. + The ACME company can then use networking in every bundle they digitally sign and deploy on the Operator’s device. + Also, a specific bundle can be granted permission to only manage the life cycle of bundles that are signed by the ACME company.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-delegation.png"/> + </imageobject> + </mediaobject> + </sect2> + + <sect2> + <title>OSGi Module Layer</title> + + <para>The OSGi Module Layer provides a generic and standardized solution for Java modularization. + The Framework defines a unit of modularization, called a bundle. A bundle is comprised of Java classes and other resources, + which together can provide functions to end users. Bundles can share Java packages among an exporter bundle and an importer bundle + in a well-defined way.</para> + + <para>Once a <emphasis role="bold">Bundle</emphasis> is started, its functionality is provided and services are exposed to other bundles installed in the OSGi Service Platform. + A bundle can carry descriptive information about itself in the manifest file that is contained in its JAR file. + Here are a few important <emphasis role="bold">Manifest Headers</emphasis> defined by the OSGi Framework:</para> + + <itemizedlist> + <listitem><emphasis role="bold">Bundle-Activator</emphasis> - class used to start, stop the bundle</listitem> + <listitem><emphasis role="bold">Bundle-SymbolicName</emphasis> - identifies the bundle</listitem> + <listitem><emphasis role="bold">Bundle-Version</emphasis> - specifies the version of the bundle</listitem> + <listitem><emphasis role="bold">Export-Package</emphasis> - declaration of exported packages</listitem> + <listitem><emphasis role="bold">Import-Package</emphasis> - declaration of imported packages</listitem> + </itemizedlist> + + <para>The notion of OSGi Version Range describes a range of versions using a mathematical interval notation. For example</para> + + <programlisting> + Import-Package: com.acme.foo;version="[1.23, 2)", com.acme.bar;version="[4.0, 5.0)" + </programlisting> + + <para>With the OSGi Class Loading Architecture many bundles can share a single virtual machine (VM). + Within this VM, bundles can hide packages and classes from other bundles, as well as share packages with other bundles.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-classloader.png"/> + </imageobject> + </mediaobject> + + <para>For example, the following import and export definition resolve correctly because the version range in the import definition + matches the version in the export definition:</para> + + <programlisting> + A: Import-Package: p; version="[1,2)" + B: Export-Package: p; version=1.5.1 + </programlisting> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-version-constraint.png"/> + </imageobject> + </mediaobject> + + <para>Appart from bundle versions, OSGi Attribute Matching is a generic mechanism to allow the importer and exporter to influence the + matching process in a declarative way. For example, the following statements will match.</para> - <itemizedlist> - <listitem><para>A set of services that an OSGi container must implement</para></listitem> - <listitem><para>A contract between the container and your application</para></listitem> - </itemizedlist> + <programlisting> + A: Import-Package: com.acme.foo;company=ACME + B: Export-Package: com.acme.foo;company=ACME; security=false + </programlisting> - <para>Developing on the OSGi platform means first building your application using OSGi APIs, then deploying it in an OSGi container.</para> + <para>An exporter can limit the visibility of the classes in a package with the include and exclude directives on the export definition.</para> + + <programlisting> + Export-Package: com.acme.foo; include:="Qux*,BarImpl"; exclude:=QuxImpl + </programlisting> + </sect2> + + <sect2> + <title>OSGi Life Cycle Layer</title> + + <para>The Life Cycle Layer provides an API to control the security and life cycle operations of bundles.</para> + + <para>A bundle can be in one of the following states:</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-life-cycle.png"/> + </imageobject> + </mediaobject> + + <para>A bundle is activated by calling its <emphasis role="bold">Bundle Activator</emphasis> object, if one exists. + The BundleActivator interface defines methods that the Framework invokes when it starts and stops the bundle.</para> + + <para>A Bundle Context object represents the execution context of a single bundle within the OSGi Service Platform, + and acts as a proxy to the underlying Framework. A <emphasis role="bold">Bundle Context</emphasis> object is created by the Framework when a bundle is started. + The bundle can use this private BundleContext object for the following purposes:</para> + + <itemizedlist> + <listitem>Installing new bundles into the OSGi environment</listitem> + <listitem>Interrogating other bundles installed in the OSGi environment</listitem> + <listitem>Obtaining a persistent storage area</listitem> + <listitem>Retrieving service objects of registered services</listitem> + <listitem>Registering services in the Framework service</listitem> + <listitem>Subscribing or unsubscribing to Famework events</listitem> + </itemizedlist> + + </sect2> + + <sect2> + <title>OSGi Service Layer</title> + + <para>The OSGi Service Layer defines a dynamic collaborative model that is highly integrated with the Life Cycle Layer. + The service model is a publish, find and bind model. A service is a normal Java object that is registered under one or more + Java interfaces with the service registry.</para> + + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-service-registration.png"/> + </imageobject> + </mediaobject> + </sect2> + </sect1> + <sect1> + <title>OSGi Service Compendium</title> + <para>The OSGi Service Compendium specifies a number of services that may be available in an OSGi runtime environment. + Although the OSGi Framework specification is useful in itself already, it only defines the OSGi core infrastructure. + The services defined in the compendium specification define the scope and functionality of some common services that + bundle developers might want to use. Here is a quick summary:</para> + + <sect2> + <title>Log Service</title> + <para>The Log Service provides a general purpose message logger for the OSGi Service Platform. It consists of two services, + one for logging information and another for retrieving current or previously recorded log information.</para> + </sect2> + + <sect2> + <title>Http Service</title> + <para>The Http Service supports two standard techniques for registering servlets and resources to develop communication and + user interface solutions for standard technologies such as HTTP, HTML, XML, etc.</para> + </sect2> + + <sect2> + <title>Device Access Specification</title> + <para>The Device Access specification supports the coordination of automatic detection and attachment of existing devices on + an OSGi Service Platform, facilitates hot-plugging and -unplugging of new devices, and downloads and installs device drivers on demand.</para> + </sect2> + + <sect2> + <title>Configuration Admin Service</title> + <para>The Configuration Admin service allows an Operator to set the configuration information of deployed bundles.</para> + <mediaobject> + <imageobject> + <imagedata fileref="images/osgi-config-service.png" contentwidth="450"/> + </imageobject> + </mediaobject> + </sect2> + + <sect2> + <title>Metatype Service</title> + <para>The Metatype Service specification defines interfaces that allow bundle developers to describe attribute + types in a computer readable form using so-called metadata.</para> + </sect2> + + <sect2> + <title>Preferences Service</title> + <para>The Preferences Service allows storage of data that is specific to a particular user.</para> + </sect2> + + <sect2> + <title>User Admin Service</title> + <para>Bundles can use the User Admin Service to authenticate an initiator and represent this authentication as an Authorization object. + Bundles that execute actions on behalf of this user can use the Authorization object to verify if that user is authorized.</para> + </sect2> + + <sect2> + <title>Wire Admin Service</title> + <para>The Wire Admin Service is an administrative service that is used to control a wiring topology in the OSGi Service Platform. + It is intended to be used by user interfaces or management programs that control the wiring of services in an OSGi Service Platform.</para> + </sect2> + + <sect2> + <title>IO Connector Service</title> + <para>The IO Connector Service specification adopts the Java 2 Micro Edition (J2ME) javax.microedition.io packages as a basic communications + infrastructure.</para> + </sect2> + + <sect2> + <title>UPnP Device Service</title> + <para>The UPnP Device Service specifies how OSGi bundles can be developed that interoperate with UPnP (Universal Plug and Play) + devices and UPnP control points.</para> + </sect2> + + <sect2> + <title>Declarative Services Specification</title> + <para>The Declarative Services specification addresses some of the complications that arise when the OSGi service model is + used for larger systems and wider deployments, such as: Startup Time, Memory Footprint, Complexity. The service component + model uses a declarative model for publishing, finding and binding to OSGi services.</para> + </sect2> + + <sect2> + <title>Event Admin Service</title> + <para>The Event Admin Service provides an inter-bundle communication mechanism. It is based on a event publish and subscribe model, popular in many message based systems.</para> + </sect2> + + <sect2> + <title>Deployment Admin Service</title> + <para>The Deployment Admin Service specification, standardizes the access to some of the responsibilities of the management agent: + that is, the lifecycle management of interlinked resources on an OSGi Service Platform.</para> + </sect2> + + <sect2> + <title>Auto Configuration Specification</title> + <para>The Auto Configuration Specification is to allow the configuration of bundles. + These bundles can be embedded in Deployment Packages or bundles that are already present on the OSGi Service Platform.</para> + </sect2> + + <sect2> + <title>Application Admin Service</title> + <para>The Application Admin Service is intended to simplify the management of an environment with many different types of applications + that are simultaneously available.</para> + </sect2> + + <sect2> + <title>DMT Admin Service</title> + <para>The DMT Admin Service specification defines an API for managing a device using concepts from the OMA DM specifications.</para> + </sect2> + + <sect2> + <title>Monitor Admin Service</title> + <para>The Monitor Admin Service specification outlines how a bundle can publish Status Variables and how administrative bundles + can discover Status Variables as well as read and reset their values.</para> + </sect2> + + <sect2> + <title>Foreign Application Access Specification</title> + <para>The Foreign Application Access specification is to enable foreign application models like MIDP, Xlets, Applets, other Java + application models to participate in the OSGi service oriented architecture.</para> + </sect2> + + <sect2> + <title>Service Tracker Specification</title> + <para>The Service Tracker specification defines a utility class, ServiceTracker, that makes tracking the registration, modification, + and unregistration of services much easier.</para> + </sect2> + + <sect2> + <title>XML Parser Service Specification</title> + <para>The XML Parser Service specification addresses how the classes defined in JAXP can be used in an OSGi Service Platform.</para> + </sect2> + + <sect2> + <title>Position Specification</title> + <para>The Position Specification provides bundle developers with a consistent way of handling geographic positions in OSGi applications.</para> + </sect2> + + <sect2> + <title>Measurement and State Specification</title> + <para>The Measurement and State Specification provides a consistent way of handling a diverse range of measurements for bundle developers.</para> + </sect2> + + <sect2> + <title>Execution Environment Specification</title> + <para>This Execution Environment Specification defines different execution environments for OSGi Server Platform Servers.</para> + </sect2> + </sect1> + </chapter> Added: projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml (rev 0) +++ projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -0,0 +1,25 @@ +<chapter id="Chap_Provided_Services"> + + <title>Provided Services</title> + + <section id="Sec_Web_Console_Service"> + <title>Web Console Service</title> + <para>TODO</para> + </section> + + <section id="Sec_Logging_Service"> + <title>Logging Service</title> + <para>TODO</para> + </section> + + <section id="Sec_Http_Service"> + <title>Http Service</title> + <para>TODO</para> + </section> + + <section id="Sec_Config_Admin_Service"> + <title>Config Admin Service</title> + <para>TODO</para> + </section> + +</chapter> Property changes on: projects/jboss-osgi/trunk/build/docbook/en/modules/providedservices.xml ___________________________________________________________________ Name: svn:keywords + Id Revision Name: svn:eol-style + LF Modified: projects/jboss-osgi/trunk/build/docbook/pom.xml =================================================================== --- projects/jboss-osgi/trunk/build/docbook/pom.xml 2009-03-23 15:11:04 UTC (rev 86209) +++ projects/jboss-osgi/trunk/build/docbook/pom.xml 2009-03-23 15:12:01 UTC (rev 86210) @@ -71,11 +71,6 @@ --> <formats> <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource> - <finalName>${pom.name}.pdf</finalName> - </format> - <format> <formatName>html</formatName> <stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource> <finalName>index.html</finalName> @@ -85,6 +80,11 @@ <stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource> <finalName>index.html</finalName> </format> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format> </formats> <options> <xincludeSupported>true</xincludeSupported>

16 years, 9 months

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

jboss-osgi-commits March 2009