Added: karaf/site/production/manual/eik/latest/user-guide/devcomponent.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/devcomponent.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/devcomponent.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/devcomponent.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1,57 @@ +<h1 id="DevelopingOSGicomponentswithEIK">Developing OSGi components with EIK</h1><p>This chapter describes how to develop a osgi component with EIK.<br/>Now we have a functional karaf environment in Eclipse, and we will illustrate howto develop a debug simple Camel route</p><p>For this example we use apache servicemix 4.4.2.</p><p>Using command line, we can create our project:</p><pre>mvn archetype:generate \ + -DarchetypeGroupId=org.apache.karaf.eik.archetypes \ + -DarchetypeArtifactId=eik-camel-archetype \ + -DarchetypeVersion=0.9.0-SNAPSHOT \ + -DgroupId=org.apache \ + -DartifactId=eik-camel-osgi-project \ + -Dversion=1.0.0-SNAPSHOT +</pre><p>as soon as possible this archetype will be available for m2e </p><p><strong>Additional parameters</strong></p><p>During the maven creation process, additional questions will be asked on the console :</p><ul><li>Define value for property 'camel-version':<p> The version of camel we want to use</p></li><li>Define value for property 'slf4j-version':<p> The version of slf4j we want to use</p><p><strong>Result of Maven command execution</strong></p><pre>[INFO] Scanning for projects... +[INFO] +[INFO] ------------------------------------------------------------------------ +[INFO] Building Maven Stub Project (No POM) 1 +[INFO] ------------------------------------------------------------------------ +[INFO] +[INFO] >>> maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom >>> +[INFO] +[INFO] <<< maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom <<< +[INFO] +[INFO] --- maven-archetype-plugin:2.2:generate (default-cli) @ standalone-pom --- +[INFO] Generating project in Interactive mode +[INFO] Archetype repository missing. Using the one from [org.apache.karaf.eik.archetypes:camel-osgi-pde-plugin:3.0.0-SNAPSHOT] found in catalog local +[INFO] Using property: groupId = org.apache +[INFO] Using property: artifactId = eik-camel-osgi-project +[INFO] Using property: version = 1.0.0-SNAPSHOT +[INFO] Using property: package = org.apache +Define value for property 'camel-version': ${camel-version}: : 2.8.5 +Define value for property 'slf4j-version': ${slf4j-version}: : 1.6.1 +Confirm properties configuration: +groupId: org.apache +artifactId: eik-camel-osgi-project +version: 1.0.0-SNAPSHOT +package: org.apache +camel-version: 2.8.5 +slf4j-version: 1.6.1 + Y: : +[INFO] ---------------------------------------------------------------------------- +[INFO] Using following parameters for creating project from Archetype: camel-osgi-pde-plugin:3.0.0-SNAPSHOT +[INFO] ---------------------------------------------------------------------------- +[INFO] Parameter: groupId, Value: org.apache +[INFO] Parameter: artifactId, Value: eik-camel-osgi-project +[INFO] Parameter: version, Value: 1.0.0-SNAPSHOT +[INFO] Parameter: package, Value: org.apache +[INFO] Parameter: packageInPathFormat, Value: org/apache +[INFO] Parameter: camel-version, Value: 2.8.5 +[INFO] Parameter: package, Value: org.apache +[INFO] Parameter: version, Value: 1.0.0-SNAPSHOT +[INFO] Parameter: groupId, Value: org.apache +[INFO] Parameter: slf4j-version, Value: 1.6.1 +[INFO] Parameter: artifactId, Value: eik-camel-osgi-project +[INFO] project created from Archetype in dir: /projects/formazione/manual/test/eik-camel-osgi-project +[INFO] ------------------------------------------------------------------------ +[INFO] BUILD SUCCESS +[INFO] ------------------------------------------------------------------------ +[INFO] Total time: 13.551s +[INFO] Finished at: Wed Oct 10 13:54:28 CEST 2012 +[INFO] Final Memory: 7M/118M +[INFO] ------------------------------------------------------------------------ +</pre></li></ul><p><strong>Import project in eclipse</strong></p><p>To compile and import project in Eclipse, type:</p><p>mvn clean install -DskipTests=true eclipse:eclipse</p><p>then import the project in Eclipse and add to MANIFEST</p><p>then inport project in eclipse and add in MANIFEST</p><ul><li>Bundle ID</li><li>Name</li></ul><p><img border="0" src="../images/devcomponent_1.png"/></p><p>Using Eclipse IDE we can import package for our needs in the project, the package available are those present in target platform.<br/>To do that we need do double click on the MANIFEST.MF > Dependencies you can use UI to import package</p><p>EIK feature allows Automatic deployment of workspace plugin projects.<br/>If you check Run configurations or in Debug configurations. You will see your project</p><p><img border="0" src="../images/devcomponent_2.png"/></p><p>To run your application, select Debug button, wait few seconds for container startup and you will see</p><p><img border="0" s rc="../images/devcomponent_9.png"/></p> \ No newline at end of file
Added: karaf/site/production/manual/eik/latest/user-guide/devcomponentwithm2e.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/devcomponentwithm2e.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/devcomponentwithm2e.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/devcomponentwithm2e.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1,22 @@ +<h1 id="DevelopingOSGicomponentswithm2eandEIK">Developing OSGi components with m2e and EIK</h1><p>Most of the examples and archetype present on the web use maven-bundle-plugins to create bundle. <br/>EIK is able to use these archetype through the help of M2E.</p><p>If m2e is not installed yet please download it from <a href="http://download.eclipse.org/technology/m2e/releases";>m2e</a>.</p><p>Using Karaf-bundle-archetype a simple projects called simpleBundle.</p><p>We need to instruct maven-bundle-plugin configuration like this:</p><ul><li>manifestLocation to META-INF</li><li>unpackBundle to true</li></ul><pre><plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + <version>2.3.7</version> + <extensions>true</extensions> + <configuration> + <manifestLocation>META-INF</manifestLocation> + <unpackBundle>true</unpackBundle> + <instructions> + <Bundle-SymbolicName>manual</Bundle-SymbolicName> + <Bundle-Version>0.10.0-SNAPSHOT</Bundle-Version> + <Bundle-Activator>org.apache.karaf.eik.manual.simpleBundle.Activator</Bundle-Activator> + <Export-Package> + org.apache.karaf.eik.manual.simpleBundle*;version=0.10.0-SNAPSHOT + </Export-Package> + <Import-Package> + * + </Import-Package> + </instructions> + </configuration> +</plugin> +</pre><ul><li>Right click on project -> Maven -> Update Project...</li><li>Right click on project -> RunAs -> Maven install</li></ul><p>from Debug Configurations is possible to see simpleBundle</p><p><img border="0" src="../images/devcomponentwithm2e_1.png"/></p><p>Run Eik and to verify the installed bundle were started type osgi:list</p><p><img border="0" src="../images/devcomponentwithm2e_2.png"/></p> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/index.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/index.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/index.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/index.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1 @@ +<p><img border="0" src="../images/karaf-logo.png"/></p><h1 id="EclipseIntegrationKarafUserGuide">Eclipse Integration Karaf User Guide</h1><ul><li><a href="prerequisites.html">Prerequisites</a></li><li><a href="supportedversions.html">Supported versions</a></li><li><a href="installation.html">Installation</a></li><li><a href="createproject.html">Create EIK Project</a></li><li><a href="launchconf.html">Create Launch configuration</a></li><li><a href="loadbundle.html">View loaded bundle</a></li><li><a href="uninstall.html">Uninstalling</a></li><li><a href="devcomponent.html">Developing OSGi components</a></li><li><a href="devcomponentwithm2e.html">Developing OSGi components with m2e</a></li></ul> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/installation.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/installation.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/installation.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/installation.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1,5 @@ +<h1 id="EIKInstallation">EIK Installation</h1><p>EIK can be installed in two ways.</p><ul><li>Installing from EIK repository (available online)</li><li>Installing from EIK sources (by building the repository locally)</li></ul><h3 id="InstallingfromEIKrepository">Installing from EIK repository</h3><p>Download the EIK repository zip archive from Central.<br/>For instance, download:<br/>http://repo.maven.apache.org/maven2/org/apache/karaf/eik/features/org.apache.karaf.eik.repository/0.9.0/org.apache.karaf.eik.repository-0.9.0.zip</p><p>Uncompress the repository zip archive on your system, in the folder of your choice.</p><p>In Eclipse, pick up this folder in the following menu:</p><p><strong>Select Help > Install new software > Add.. > Local...</strong></p><h3 id="InstallingfromEIKsources">Installing from EIK sources</h3><p>From EIK sources, you start by building the repository:</p><pre>The following avoids running all the unit test cases, we just skip the test running phase an d not the building part +mvn -Dmaven.test.skip=true clean install +or +mvn -DskipTests clean install +</pre><p><strong>Select Help > Install new software > Add.. > Local...</strong><br/>select folder<br/><path_to_source>/features/org.apache.karaf.eik.repository/target/repository</p><p><img border="0" src="../images/installation_2.png"/></p><h3 id="SettingtheOSGiFramework">Setting the OSGi Framework</h3><p>With this step we specify to Eclipse which OSGi framework we need to use <br/><strong>Select Window > Preferences > OSGI Frameworks</strong></p><p><img border="0" src="../images/installation_3.png"/></p><h3 id="SwitchonthetheApacheKarafperspective">Switch on the the Apache Karaf perspective</h3><p>To Switch perspective we need <strong>Select Window > Open Perspective > Other > Select Apache Karaf</strong></p><p><img border="0" src="../images/installation_4.png"/></p><p>Now EIK is installed correctly</p> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/launchconf.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/launchconf.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/launchconf.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/launchconf.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1 @@ +<h1 id="CreateanOSGiFrameworkLauncher">Create an OSGi Framework Launcher</h1><p>To define launch configuration we need <strong>Select Run > Run Configurations > Osgi Framework > new ..</strong></p><p><img border="0" src="../images/launchconf_1.png"/></p><p>From <strong>Karaf tab</strong> in Launch configuration is possible to chance which features need to load. <br/>By Default the feature that loaded are those listed in the file <strong><karaf_installation_dir>/etc/org.apache.karaf.features.cfg</strong>. <br/>Note that all changes modify the org.apache.karaf.features.cfg file present in the runtime installation. To Run karaf runtime Select <strong>Add Required Bundles</strong> > Apply and the <strong>Select Run</strong></p><p><img border="0" src="../images/launchconf_2.png"/></p><p>When the Karaf runtime runs, its output appears in Eclipse Console view at the bottom of the window. <br/>With console we can interact with Karaf console. <a href="http://karaf.apache.org/manua l/latest-2.2.x/commands/commands.html">Please see here to found useful karaf console commands</a></p> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/loadbundle.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/loadbundle.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/loadbundle.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/loadbundle.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1 @@ +<h1 id="ViewBundleLoaded">View Bundle Loaded</h1><p>From Apache Karaf perspective it's possible to see in a view the bundles that are currently loaded at runtime.<br/>Before launch runtime we need create new Launch Configuration : from <strong>Run > Debug Configuration or Run Configuration > Apache Felix Karaf new Launch Configuration</strong></p><p><img border="0" src="../images/loadbundle_1.png"/></p><p>and after lanching Karaf runtime from <strong>Bundles view</strong> we can understanding the Runtime Properties of Apache Karaf without use karaf console</p><p><img border="0" src="../images/loadbundle_2.png"/></p> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/manualinstallation.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/manualinstallation.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/manualinstallation.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/manualinstallation.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1 @@ +<h1 id="EIKManualInstallation">EIK Manual Installation</h1><p>This chapter describes how to install EIK from source code.</p> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/prerequisites.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/prerequisites.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/prerequisites.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/prerequisites.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1 @@ +<h1 id="Prerequisites">Prerequisites</h1><p><strong>Environment:</strong></p><ul><li>Java SE Development Kit 1.6.x or greater (<a href="http://www.oracle.com/technetwork/java/javase/";>http://www.oracle.com/technetwork/java/javase/</a>).</li><li>Apache Maven 3.0.3 (<a href="http://maven.apache.org/download.html";>http://maven.apache.org/download.html</a>).</li><li>Eclipse IDE Eclipse for RCP and RAP Developers (<a href="http://www.eclipse.org/downloads/packages/release/indigo/sr2";>http://www.eclipse.org/downloads/packages/release/indigo/sr2</a>).</li><li>Apache KARAF 2.2.x or 2.3.x (<a href="http://karaf.apache.org/index/community/download.html";>http://karaf.apache.org/index/community/download.html</a>);</li></ul><p>Download and extract the Eclipse IDE for RCP and RAP Developers archives to a directory of your choice (for e.g. $HOME/eclipse).<br/>The archive will be extracted to a directory named eclipse under the directory you specified (for e.g. $HOME/tools/eclipse/eclipse), referred to as <strong><eclipse_installation_dir></strong> from now on. <br/>Make sure that the JDK in the PATH is Sun JDK 6.0. <br/>Launch Eclipse by running <eclipse_installation_dir>/eclipse.</p><p>To install the Karaf, download the Karaf 2.2.x runtime from Apache Karaf downloads and extract the archive to a directory of your choice (for e.g. $HOME/tools/karaf). <br/>The archive will be extracted to a directory apache-karaf-2.2.* (for e.g. $HOME/tools/karaf/apache-karaf-2.2.*). <br/>We will refer to this directory as <strong><karaf_installation_dir></strong> from now on.</p> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/supportedversions.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/supportedversions.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/supportedversions.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/supportedversions.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1,34 @@ +<h1>Supported Versions</h1> + +This section defines the matrix of supported versions: + +<table border="1"> + <tr> + <td></td> + <td><b>Karaf 2.2.4</b></td> + <td><b>Karaf 2.2.9</b></td> + <td><b>Karaf 2.3.0</b></td> + <td><b>ServiceMix 4.5.0</b></td> + </tr> + <tr> + <td><b>Eclipse RCP Helios SR2 (3.6.2)</b></td> + <td><img src="/images/check.gif"/></td> + <td><img src="/images/check.gif"/></td> + <td><img src="/images/check.gif"/></td> + <td><img src="/images/check.gif"/></td> + </tr> + <tr> + <td><b>Eclipse RCP Indigo SR2 (3.7.2)</b></td> + <td><img src="/images/check.gif"/></td> + <td><img src="/images/check.gif"/></td> + <td><img src="/images/check.gif"/></td> + <td><img src="/images/check.gif"/></td> + </tr> + <tr> + <td><b>Eclipse RCP Juno (4.2)</b></td> + <td><img src="/images/error.gif"/></td> + <td><img src="/images/error.gif"/></td> + <td><img src="/images/error.gif"/></td> + <td><img src="/images/error.gif"/></td> + </tr> +</table> \ No newline at end of file Added: karaf/site/production/manual/eik/latest/user-guide/uninstall.html URL: http://svn.apache.org/viewvc/karaf/site/production/manual/eik/latest/user-guide/uninstall.html?rev=1458584&view=auto ============================================================================== --- karaf/site/production/manual/eik/latest/user-guide/uninstall.html (added) +++ karaf/site/production/manual/eik/latest/user-guide/uninstall.html Wed Mar 20 00:18:08 2013 @@ -0,0 +1 @@ +<h1 id="UninstallEIKfromyourEclipseIDE">Uninstall EIK from your Eclipse IDE</h1><p>This chapter describes how to unInstall EIK through the Update Manager <br/>From menu we need <strong>Select Help > About Eclipse > Installation Details</strong>. Select plugins as shown in image.<br/>Select Uninstall</p><p><img border="0" src="../images/uninstall.png"/></p> \ No newline at end of file
