View source for EIG:Runtime Dependencies/Configuration

== Installation of ECF ==

The ECF Remote Services implementation depends upon some bundles included in Eclipse 3.6, so you should download and use (at least) Eclipse 3.6 M5 SDK. You can download Eclipse 3.6 M5 SDK [http://archive.eclipse.org/eclipse/downloads/drops/S-3.6M5-201001291300/index.php here] or a more recent version from [http://www.eclipse.org/downloads/ here].<br>

The ECF Remote Services bundles are included in the ECF SDK, which can be downloaded or installed via Marketplace or p2.

=== Installation via Marketplace ===

Open the Eclipse Marketplace "Help -> Eclipse Markteplace..." and search for ECF.

=== Adding ECF to the Target Platform / Installation via p2 ===

When developing with Eclipse 3.5 or newer, it's possible to use a concept called a target platform. The target platform specifies the set of bundles used to compile and build against within the Eclipse PDE (plugin development environment). The default target platform is Eclipse itself, but the target platform can be set to any desired set of bundles. One way to develop applications that use some or all of ECF is to add the ECF SDK to your target platform. Then you are able to develop against and build using ECF functionality.<br>

#Select from Menu:  '''Window->Preferences->Plug-in Development->Target Platform'''
#Choose '''Add...''' button
#Initialize the Target Definition with '''Default: Default target for the running platform'''
#Specify Name:  '''ECF SDK'''
#Choose '''Add...''' button
#Select '''Software Site''' and '''Next>'''
#Choose '''Add...''' button
#In Add Repository dialog
##'''Name: ECF SDK'''
##'''Location: http://download.eclipse.org/rt/ecf/3.4/site.p2'''
#Choose '''OK'''
#Open the ECF tree item
#Select the '''Eclipse Communication Framework SDK''' check box
#Unselect '''Include Required Software'''.  This option should '''not''' be selected.
#Choose '''Finish'''
#Select the target platform you just created (i.e. ECF SDK)
#Choose '''OK'''

Your target platform should then be set to your current Eclipse, plus the ECF SDK.  Then you can refer to ECF classes in your own bundles/plugins.

== OSGi Remote Service Bundles ==

If the ECF SDK is installed into Eclipse, then the ECF Remote Services bundles are installed, but also a number of Eclipse views and perspectives are made available for use within Eclipse. If you only would like to use the bundles of the OSGi Remote Service implementation, take these:

=== ECF Bundles (OSGi Remote Service Implementation) ===

{|{{BMTableStyle}}
|-{{BMTHStyle}}
! Bundle
! Description
|-
| org.eclipse.ecf
| ECF Core Bundle
|-
| org.eclipse.ecf.discovery
| 
|-
| org.eclipse.ecf.identity
| 
|-
| org.eclipse.ecf.osgi.services.discovery
| Implementation of the OSGi Discovery API.
|-
| org.eclipse.ecf.osgi.services.distribution
| Implementation of the OSGi Distribution API.
|-
| org.eclipse.ecf.osgi.services.remoteserviceadmin
| Implementation of the OSGi Remote Service and Remote Service Admin API.
|-
| org.eclipse.ecf.provider
| 
|-
| org.eclipse.ecf.remoteservice
| 
|-
| org.eclipse.ecf.sharedobject
| 
|}

=== ECF Distribution Provider Bundles ===

In a common use case you should choose only one(!) of these providers.

{|{{BMTableStyle}}
|-{{BMTHStyle}}
! Bundle
! Description
|-
| org.eclipse.ecf.provider.remoteservice
| Generic provider ("ecf.generic.client" and "ecf.generic.server").
|-
| org.eclipse.ecf.provider.r_osgi
| R-OSGi Provider ("ecf.r_osgi.peer")
|}

=== ECF Discovery Provider Bundles ===

In a common use case you should choose only one(!) of these providers.

{|{{BMTableStyle}}
|-{{BMTHStyle}}
! Bundle
! Description
|-
| org.eclipse.ecf.provider.jmdns
| Zeroconf/Bonjour Provider
|-
| org.eclipse.ecf.provider.jslp
| SLP Provider
|-
| org.eclipse.ecf.provider.localdiscovery
| 
|-
| org.eclipse.ecf.provider.zookeeper
| ZooDiscovery Provider
|-
| org.eclipse.ecf.provider.dnssd
| DNS-SD Provider
|}

=== Other Bundles ===

{|{{BMTableStyle}}
|-{{BMTHStyle}}
! Bundle
! Description
|-
| ch.ethz.iks.r_osgi.remote
| Is only required when using org.eclipse.ecf.provider.r_osgi
|-
| ch.ethz.iks.slp
| Is only required when using org.eclipse.ecf.provider.jslp
|-
| org.apache.zookeeper
| Is only required when using org.eclipse.ecf.provider.zookeeper
|-
| org.objectweb.asm
| Java bytecode manipulation and analysis framework.
|}