Equinox QuickStart Guide

Getting and using the Equinox OSGi implementation

The Equinox OSGi framework implementation forms the underpinnings of the Eclipse RCP and IDE platforms but it is in fact a fully standalone OSGi implementation. To run Equinox OSGi on its own either download the org.eclipse.osgi JAR from the download site or look in your Eclipse install for a file like <install location>/eclipse/plugins/org.eclipse.osgi_3.2.0_xxx.jar. Once you have the Equinox framework JAR, use the following command line:

Equinox OSGi フレームワーク実装はEclipse RCPとIDEプラットフォームの基盤を形成していますが、 それは事実上の完全なスタンドアロンOSGi実装です。 Equinox OSGi を実行するにはorg.eclipse.osgiのJARを ダウンロードサイトからダウンロードするか、 Eclipseをインストールした場所のファイル <インストール場所>/eclipse/plugins/org.eclipse.osgi_3.2.0_xxx.jar を探してください。 Equinox framework JARを手に入れたら、次のコマンドラインを使ってください。

  java -jar org.eclipse.osgi_3.2.0.jar -console

Once this is running you will see an osgi> prompt. This is the OSGi console waiting for you to type commands. Type '?' at the prompt for command help. The most interesting commands for getting started are:

これを実行すると osgi> プロンプトを見ることになります。 これはコマンドの入力を待っているOSGiコンソールです。 ヘルプを表示するためにプロンプトに'?'と入力します。 はじめるために最も興味深いコマンドは:

• install <bundle URL> - Installs the bundle from the given URL
• start <bundle # or bundle name> - Starts the bundle with the given numeric or symbolic id
• stop <bundle # or bundle name> - Stops the bundle with the given numeric or symbolic id
• ss - Reports a summary status of all installed bundles
• diag <bundle # or bundle name> - Reports any resolution problems for the bundle with the given numeric or symbolic id

• install <bundle URL> - 指定したURLからバンドルをインストールする
• start <bundle # or bundle name> - 数字か識別のIDで指定したバンドルを開始する
• stop <bundle # or bundle name> - 数字か識別のIDで指定したバンドルを停止する
• ss - すべてのインストール済みバンドルの状態の要約を報告する
• diag <bundle # or bundle name> - 数字か識別のIDで指定したバンドルのany resolution problemsを報告する

If you don't have Eclipse and just want OSGi, click here to get the JAR from the Equinox download site.

もしEclipseを持っておらず、OSGiだけ欲しい場合は、ここをクリックしてEquinoxダウンロードサイトからJARを取得してください。

Configurations and all that...

The Equinox OSGi implementation is extremely configurable. One of the most common configuration scenarios is to have the framework automatically install and run a set of bundles when it is started. You do this every time you run Eclipse the IDE. Here's how it works and how you can use it in your situation.

Equinox OSGi実装は極限まで設定可能です。 最も一般的な設定のシナリオは開始時にバンドルのセットを 自動的にインストールして実行するフレームワークを持つことです。 Eclipse IDEを実行するときにこれを毎回行っています。 あなたの場合においてどのように動作し、どのように使うことができるかは以下のとおりです。

Say you have bundles B1.jar and B2.jar that you want to have installed and started when Equinox is run. As with other OSGi implementations, you can run the framework (see above) and install and start B1 and B2 using the console. This is a manual process but you need only do it the first time you run Equinox (OSGi frameworks remember the installed and started bundles from run to run). To do something completely automated, create a configuration that lists B1 and B2 as bundles to be installed and started. Set up something like

Equinoxを実行するときにインストールして開始したいB1.jarとB2.jarのバンドルを持っているとします。 他のOSGi実装と同様に、フレームワークを実行し(上記参照)、コンソールを使ってB1とB2をインストールして開始することができます。 これは手動の処理ですが、それをEquinoxを初めて実行するときだけ行う必要があります(OSGiフレームワークはインストールされ、開始されたバンドルを覚えています)。 何かを完全に自動化するにはB1とB2をインストールし開始されるバンドルとしてリストするconfigurationを作成します。 このような類のものを設定します。

somedir/
  org.eclipse.osgi_3.2.0.jar
  B1.jar
  B2.jar
  configuration/
    config.ini

Where config.ini is a Java properties file that contains the following line. Note that the osgi.bundles property is quite powerful. See the doc for details.

config.iniは以下の行を含むJava propertiesファイルです。 osgi.bundlesはとてもパワフルであることに注意してください。 詳細はドキュメントを参照してください。

  osgi.bundles=B1.jar@start, B2.jar@start
  eclipse.ignoreApp=true

When Equinox is started using the command line above, B1 and B2 are installed and started. If you want to specify a different configuration, just add -configuration <location> to the command line. Notice that since you are just running your bundles, we added a line to tell Equinox to skip trying to start an Eclipse application. This setting is not critical but without it a scary but otherwise inoccuous message appears in your log. For more information on the set of command-line args and system properties available to set things up, see

Equinoxが上記のコマンドラインを使用して開始されるとB1とB2はインストールされて開始されます。 異なる設定を指定したいときは、単にコマンドラインに -configuration <location> を追加します。 Eclipseアプリケーションを開始することをスキップすることをEquinoxに伝える行を追加して、 単にあなたのバンドルを実行していることに注目してください。 この設定は重大ではありませんが、怖いこともなく、ログに無害な(innocuous)メッセージが出力されます。 コマンドライン引数と設定するために利用可能なシステムプロパティについての詳細は下記を参照してください。

http://help.eclipse.org/help32/topic/org.eclipse.platform.doc.isv/reference/misc/index.html http://help.eclipse.org/help32/topic/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html

Now, if you want to make things even easier, you can add in a few Eclipse bundles (i.e., org.eclipse.equinox.common and org.eclipse.update.configurator). This gives you automatic bundle discovery/install. Add these bundles on the osgi.bundles list in your config.ini as follows:

さて、より簡単にしたいならば、いくつかのEclipseバンドルを追加することができます(すなわちorg.eclipse.equinox.common と org.eclipse.update.configurator)。 これは自動的なバンドルの発見とインストールを行います。 これらのバンドルをconfig.iniのosgi.bundlesリストに追加すると次のようになります。

  osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start

When the Update configurator bundle starts, it automatically discovers and installs all the bundles in the plugins directory that is beside the Equinox JAR. Note that the configurator does not automatically start these bundles.

Update configuratorバンドルが開始すると、Equinox JARの脇にあるpluginsディレクトリのバンドルを自動的に発見してインストールします。 configuratorはこれらのバンドルを自動的には実行しないことに注意してください。

The steps above should get you running with a reasonably flexible configuration of Equinox and a collection of bundles. Eclipse and Equinox offer a significant set of extensibilty and configuration options that are beyond the scope of a getting started document (e.g., extension registry, application model, shared installs, ...). To use the full power of Eclipse, look at how the Eclipse IDE and RCP applications are structures and check out the Help system links above as well as

上記のステップでEquinoxとバンドルの集合体の理にかなった柔軟な設定で実行できるでしょう。 EclipseとEquinoxはgetting startedドキュメントの範囲を越えて(例えば、拡張レジストリ、アプリケーションモデル、共有インストール、...)拡張性と設定オプションの重要なセットを提供します。 Eclipseの全パワーを使用するには、どのようにEclipse IDE と RCPアプリケーションが 構築されるかを見て、同様に上記のヘルプシステムのリンクを調べてください。

http://help.eclipse.org/help31/topic/org.eclipse.platform.doc.isv/reference/misc/multi_user_installs.html

For those who are interested in some of the Eclipse extensions to OSGi, see

いくつかのOSGiへのEclipseの拡張に興味がある方は、下記を参照してください。

http://help.eclipse.org/help31/topic/org.eclipse.platform.doc.isv/reference/misc/bundle_manifest.html

Most of these facilities are experimental. Some general and have been proposed for inclusion in the OSGi R4.1 or R5 specifications while others are Eclipse-specific. All were put in place to solve real problems that we (or our consumers) were having. You may be having related problems.

これらの便利なもののほとんどは実験的です。 いくつかの一般的なものとOSGi R4.1 か R5 仕様に含めるよう提案しているものとその他はEclipse特有です。 すべては我々(または消費者)が持つ現実の問題を解決するために導入されています。 あなたも関連する問題を持つことになるかもしれません。

Other Information

• The Eclipse SDK includes some very sophisticated tooling for defining, developing, debugging, building and deploying bundles. To use this tooling run the SDK and mentally replace the word "Plugin" with "Bundle" in all the menu/wizard entries. For example, File > New > Plugin Project creates a project suitable for coding OSGi bundles. The "Plugin Editor" is really a bundle editor with some extra support for Eclipse constructs such as the Extension registry.
• Log bug reports in the Equinox/Framework component
• Questions and comments should go in the equinox newsgroup.
• Development questions can go to equinox-dev@eclipse.org.

• Eclipse SDK はいくつかの大変洗練されたバンドルの定義、開発、デバッグ、ビルド、デプロイのための道具を含んでいます。 この道具を使うにはSDKを実行し、心の中でメニューやウィザードの"Plugin"を"Bundle"に置き換えます。 たとえば、File > New > Plugin Project はOSGiバンドルをコーディングするのに適したプロジェクトを作成します。 "Plugin Editor"は実際にはバンドルエディタであり、 いくつかのExtension registryのようなEclipseがコンストラクトするための特別なサポートがついています。
• Equinox/Framework componentにバグ報告を記録してください。
• 質問やコメントはequinox ニュースグループへ。
• 開発上の質問はequinox-dev@eclipse.orgへ。