16.10. Provisioning

デフォルトでは、機能によってデプロイされるバンドルの開始レベルは、karaf.startlevel.bundle プロパティーの etc/config.properties 設定ファイルで定義された値と等しくなります。

この値を、features XML の <bundle/> 要素の start-level 属性で "オーバーライド" できます。

  <feature name="my-project" version="1.0.0">
    <bundle start-level="80">mvn:com.mycompany.myproject/myproject-dao</bundle>
    <bundle start-level="85">mvn:com.mycompany.myproject/myproject-service</bundle>
  </feature>

start-level 属性は、それを使用するバンドルの前に myproject-dao バンドルが開始されるようにします。

開始レベルを使用するのではなく、単純に必要なパッケージやサービスを定義して、OSGi フレームワークに依存関係を認識させるものが、ソリューションとしてより優れています。また、開始レベルを設定するよりも堅牢です。

-t オプションを feature:install コマンドに使用して、機能のインストールをシミュレートできます。

バンドルは、起動せずにインストールできます。デフォルトでは、機能のバンドルは自動的に開始されます。

機能は、バンドルが自動的に開始されないように指定できます (バンドルは解決された状態のままになります)。これを行うために、機能は <bundle/> 要素で start 属性を false に指定できます。

  <feature name="my-project" version="1.0.0">
    <bundle start-level="80" start="false">mvn:com.mycompany.myproject/myproject-dao</bundle>
    <bundle start-level="85" start="false">mvn:com.mycompany.myproject/myproject-service</bundle>
  </feature>

<bundle/> 要素で dependency 属性を true に設定して、バンドルに依存関係としてフラグを付けることができます。

リゾルバーでこの情報を使用して、インストールするバンドルの完全リストを算出することができます。

必要な機能は、特別な種類の依存関係です。prerequisite 属性を依存する機能タグに追加する場合、実際の機能をインストールする前に、依存機能でのバンドルのインストールとアクティベーションが強制されます。これは、特定の機能に登録されたバンドルが wrap、war などの事前インストールされた URL を使用しない場合に便利です。

機能では、想定される要件を指定することもできます。機能リゾルバーは、要件を満たそうとします。そのために、機能とバンドル機能をチェックし、要件を満たすためにバンドルを自動的にインストールします。

たとえば、機能には次のものを含めることができます。

<requirement>osgi.ee;filter:=&quot;(&amp;(osgi.ee=JavaSE)(!(version&gt;=1.8)))&quot;</requirement>

この要件では、JDK のバージョンが 1.8 でない場合にのみ (基本的に 1.7)、機能が動作することを指定しています。

機能リゾルバーは、オプションの依存関係が満たされたときにバンドルを更新して、オプションのインポートを再設定することもできます。

feature:repo-list コマンドは、登録されたすべての features リポジトリーをリスト表示します。

karaf@root()> feature:repo-list
Repository               | URL
--------------------------------------------------------------------------------------
org.ops4j.pax.cdi-0.12.0 | mvn:org.ops4j.pax.cdi/pax-cdi-features/0.12.0/xml/features
org.ops4j.pax.web-4.1.4  | mvn:org.ops4j.pax.web/pax-web-features/4.1.4/xml/features
standard-4.0.0           | mvn:org.apache.karaf.features/standard/4.0.0/xml/features
enterprise-4.0.0         | mvn:org.apache.karaf.features/enterprise/4.0.0/xml/features
spring-4.0.0             | mvn:org.apache.karaf.features/spring/4.0.0/xml/features

各リポジトリーには、機能 XML への名前と URL があります。

Apache Karaf は、features リポジトリーの URL を登録する際に機能 XML を解析します (後ほど説明する feature:repo-add コマンドまたは FeatureMBean を使用します)。Apache Karaf が features リポジトリーの URL をリロードするよう強制する場合 (たとえば機能定義を更新)、-r オプションを使用できます。

karaf@root()> feature:repo-list -r
Reloading all repositories from their urls

Repository               | URL
--------------------------------------------------------------------------------------
org.ops4j.pax.cdi-0.12.0 | mvn:org.ops4j.pax.cdi/pax-cdi-features/0.12.0/xml/features
org.ops4j.pax.web-4.1.4  | mvn:org.ops4j.pax.web/pax-web-features/4.1.4/xml/features
standard-4.0.0           | mvn:org.apache.karaf.features/standard/4.0.0/xml/features
enterprise-4.0.0         | mvn:org.apache.karaf.features/enterprise/4.0.0/xml/features
spring-4.0.0             | mvn:org.apache.karaf.features/spring/4.0.0/xml/features

features リポジトリーを登録する (Apache Karaf で新しい機能を利用できるようにする) には、feature:repo-add コマンドを使用する必要があります。

feature:repo-add コマンドには、name/url 引数が必要です。この引数では、以下が可能です。

etc/org.apache.karaf.features.repos.cfg は、"プリインストールされた/利用可能な" 機能リポジトリーのリストを定義します。

################################################################################
#
#    Licensed to the Apache Software Foundation (ASF) under one or more
#    contributor license agreements.  See the NOTICE file distributed with
#    this work for additional information regarding copyright ownership.
#    The ASF licenses this file to You under the Apache License, Version 2.0
#    (the "License"); you may not use this file except in compliance with
#    the License.  You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS,
#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#    See the License for the specific language governing permissions and
#    limitations under the License.
#
################################################################################

#
# This file describes the features repository URL
# It could be directly installed using feature:repo-add command
#
enterprise=mvn:org.apache.karaf.features/enterprise/LATEST/xml/features
spring=mvn:org.apache.karaf.features/spring/LATEST/xml/features
cellar=mvn:org.apache.karaf.cellar/apache-karaf-cellar/LATEST/xml/features
cave=mvn:org.apache.karaf.cave/apache-karaf-cave/LATEST/xml/features
camel=mvn:org.apache.camel.karaf/apache-camel/LATEST/xml/features
camel-extras=mvn:org.apache-extras.camel-extra.karaf/camel-extra/LATEST/xml/features
cxf=mvn:org.apache.cxf.karaf/apache-cxf/LATEST/xml/features
cxf-dosgi=mvn:org.apache.cxf.dosgi/cxf-dosgi/LATEST/xml/features
cxf-xkms=mvn:org.apache.cxf.services.xkms/cxf-services-xkms-features/LATEST/xml
activemq=mvn:org.apache.activemq/activemq-karaf/LATEST/xml/features
jclouds=mvn:org.apache.jclouds.karaf/jclouds-karaf/LATEST/xml/features
openejb=mvn:org.apache.openejb/openejb-feature/LATEST/xml/features
wicket=mvn:org.ops4j.pax.wicket/features/LATEST/xml/features
hawtio=mvn:io.hawt/hawtio-karaf/LATEST/xml/features
pax-cdi=mvn:org.ops4j.pax.cdi/pax-cdi-features/LATEST/xml/features
pax-jdbc=mvn:org.ops4j.pax.jdbc/pax-jdbc-features/LATEST/xml/features
pax-jpa=mvn:org.ops4j.pax.jpa/pax-jpa-features/LATEST/xml/features
pax-web=mvn:org.ops4j.pax.web/pax-web-features/LATEST/xml/features
pax-wicket=mvn:org.ops4j.pax.wicket/pax-wicket-features/LATEST/xml/features
ecf=http://download.eclipse.org/rt/ecf/latest/site.p2/karaf-features.xml
decanter=mvn:org.apache.karaf.decanter/apache-karaf-decanter/LATEST/xml/features

機能のリポジトリー名は、feature:repo-add コマンドに直接指定できます。PAX JDBC をインストールするには、以下を実行できます。

karaf@root()> feature:repo-add pax-jdbc
Adding feature url mvn:org.ops4j.pax.jdbc/pax-jdbc-features/LATEST/xml/features

オプションの version 引数を指定しないと、Apache Karaf は利用可能な features リポジトリーの最新バージョンをインストールします。version 引数でターゲットバージョンを指定できます。

karaf@root()> feature:repo-add pax-jdbc 1.3.0
Adding feature url mvn:org.ops4j.pax.jdbc/pax-jdbc-features/1.3.0/xml/features

etc/org.apache.karaf.features.repos.cfg 設定ファイルで定義された features リポジトリー名を提供する代わりに、features リポジトリーの URL を feature:repo-add コマンドに直接指定できます。

karaf@root()> feature:repo-add mvn:org.ops4j.pax.jdbc/pax-jdbc-features/1.3.0/xml/features
Adding feature url mvn:org.ops4j.pax.jdbc/pax-jdbc-features/1.3.0/xml/features

デフォルトでは、feature:repo-add コマンドは機能リポジトリーを登録するだけで、機能はインストールされません。-i オプションを指定すると、feature:repo-add コマンドは features リポジトリーを登録し、この features リポジトリーに記述されているすべての機能をインストールします。

karaf@root()> feature:repo-add -i pax-jdbc

Apache Karaf は、登録時に features リポジトリー XML を解析します (feature:repo-add コマンドまたは FeatureMBean を使用)。機能リポジトリーの XML が変更された場合は、変更をロードするために機能リポジトリーを更新するように Apache Karaf に指示する必要があります。

feature:repo-refresh コマンドは、機能リポジトリーを更新します。

引数がない場合に、コマンドはすべての機能リポジトリーを更新します。

karaf@root()> feature:repo-refresh
Refreshing feature url mvn:org.ops4j.pax.cdi/pax-cdi-features/0.12.0/xml/features
Refreshing feature url mvn:org.ops4j.pax.web/pax-web-features/4.1.4/xml/features
Refreshing feature url mvn:org.apache.karaf.features/standard/4.0.0/xml/features
Refreshing feature url mvn:org.apache.karaf.features/enterprise/4.0.0/xml/features
Refreshing feature url mvn:org.apache.karaf.features/spring/4.0.0/xml/features

すべての機能リポジトリーを更新する代わりに、URL または機能リポジトリー名 (およびオプションでバージョン) を指定して、更新する機能リポジトリーを指定できます。

karaf@root()> feature:repo-refresh mvn:org.apache.karaf.features/standard/4.0.0/xml/features
Refreshing feature url mvn:org.apache.karaf.features/standard/4.0.0/xml/features

karaf@root()> feature:repo-refresh pax-jdbc
Refreshing feature url mvn:org.ops4j.pax.jdbc/pax-jdbc-features/LATEST/xml/features

feature:repo-remove コマンドは、登録した features リポジトリーから features リポジトリーを削除します。

feature:repo-remove コマンドには引数が必要です。

karaf@root()> feature:repo-remove org.ops4j.pax.jdbc-1.3.0

karaf@root()> feature:repo-remove mvn:org.ops4j.pax.jdbc/pax-jdbc-features/1.3.0/xml/features

デフォルトでは、feature:repo-remove コマンドは、登録した機能から features リポジトリーを削除します。これは、features リポジトリーによって提供される機能をアンインストールしません。

-u オプションを使用すると、feature:repo-remove コマンドは features リポジトリーによって記述されたすべての機能をアンインストールします。

karaf@root()> feature:repo-remove -u org.ops4j.pax.jdbc-1.3.0

feature:list コマンドは、利用可能なすべての機能をリスト表示します (登録された異なる features リポジトリーによって提供) 。

Name                          | Version                          | Required | State       | Repository               | Description
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
pax-cdi                       | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI support
pax-cdi-1.1                   | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.1 support
pax-cdi-1.2                   | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.2 support
pax-cdi-weld                  | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI support
pax-cdi-1.1-weld              | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.1 support
pax-cdi-1.2-weld              | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.2 support
pax-cdi-openwebbeans          | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | OpenWebBeans CDI support
pax-cdi-web                   | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI support
pax-cdi-1.1-web               | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI 1.1 support
...

名前をアルファベット順に並べたい場合は、-o オプションを使用できます。

karaf@root()> feature:list -o
Name                          | Version                          | Required | State       | Repository               | Description
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
deltaspike-core               | 1.2.1                            |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike core support
deltaspike-data               | 1.2.1                            |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike data support
deltaspike-jpa                | 1.2.1                            |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike jpa support
deltaspike-partial-bean       | 1.2.1                            |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Apache Deltaspike partial bean support
pax-cdi                       | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI support
pax-cdi-1.1                   | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.1 support
pax-cdi-1.1-web               | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Web CDI 1.1 support
pax-cdi-1.1-web-weld          | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld Web CDI 1.1 support
pax-cdi-1.1-weld              | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Weld CDI 1.1 support
pax-cdi-1.2                   | 0.12.0                           |          | Uninstalled | org.ops4j.pax.cdi-0.12.0 | Provide CDI 1.2 support
...

デフォルトでは、feature:list コマンドは現在の状態 (インストール済みまたはインストールされていない) に関わらず、すべての機能を表示します。

-i オプションを使用すると、インストールされた機能だけが表示されます。

karaf@root()> feature:list -i
Name            | Version | Required | State   | Repository     | Description
-------------------------------------------------------------------------------------------------------------------
aries-proxy     | 4.0.0   |          | Started | standard-4.0.0 | Aries Proxy
aries-blueprint | 4.0.0   | x        | Started | standard-4.0.0 | Aries Blueprint
feature         | 4.0.0   | x        | Started | standard-4.0.0 | Features Support
shell           | 4.0.0   | x        | Started | standard-4.0.0 | Karaf Shell
shell-compat    | 4.0.0   | x        | Started | standard-4.0.0 | Karaf Shell Compatibility
deployer        | 4.0.0   | x        | Started | standard-4.0.0 | Karaf Deployer
bundle          | 4.0.0   | x        | Started | standard-4.0.0 | Provide Bundle support
config          | 4.0.0   | x        | Started | standard-4.0.0 | Provide OSGi ConfigAdmin support
diagnostic      | 4.0.0   | x        | Started | standard-4.0.0 | Provide Diagnostic support
instance        | 4.0.0   | x        | Started | standard-4.0.0 | Provide Instance support
jaas            | 4.0.0   | x        | Started | standard-4.0.0 | Provide JAAS support
log             | 4.0.0   | x        | Started | standard-4.0.0 | Provide Log support
package         | 4.0.0   | x        | Started | standard-4.0.0 | Package commands and mbeans
service         | 4.0.0   | x        | Started | standard-4.0.0 | Provide Service support
system          | 4.0.0   | x        | Started | standard-4.0.0 | Provide System support
kar             | 4.0.0   | x        | Started | standard-4.0.0 | Provide KAR (KARaf archive) support
ssh             | 4.0.0   | x        | Started | standard-4.0.0 | Provide a SSHd server on Karaf
management      | 4.0.0   | x        | Started | standard-4.0.0 | Provide a JMX MBeanServer and a set of MBeans in
wrap            | 0.0.0   | x        | Started | standard-4.0.0 | Wrap URL handler

feature:install コマンドは、機能をインストールします。

feature 引数が必要です。feature 引数は、機能の名前または機能の名前/バージョンです。(バージョンではなく) 機能の名前のみが提供されている場合に、使用可能な最新バージョンがインストールされます。

karaf@root()> feature:install eventadmin

-t または --simulate オプションを使用してインストールをシミュレートできます。これは、何が行われるかを表示するだけで、実行はされません。

karaf@root()> feature:install -t -v eventadmin
Adding features: eventadmin/[4.0.0,4.0.0]
No deployment change.
  Managing bundle:
    org.apache.felix.metatype / 1.0.12

インストールする機能のバージョンを指定できます。

karaf@root()> feature:install eventadmin/4.0.0

デフォルトでは、feature:install コマンドは詳細ではありません。feature:install コマンドによって実行されるアクションの詳細を知りたい場合は、-v オプションを使用できます。

karaf@root()> feature:install -v eventadmin
Adding features: eventadmin/[4.0.0,4.0.0]
No deployment change.
Done.

インストール済みのバンドルが機能に含まれている場合に、デフォルトでは、Apache Karaf はこのバンドルを更新します。この更新が原因で、実行中の他のアプリケーションに問題が発生する場合があります。インストールされたバンドルの自動更新を無効にする場合は、-r オプションを使用できます。

karaf@root()> feature:install -v -r eventadmin
Adding features: eventadmin/[4.0.0,4.0.0]
No deployment change.
Done.

-s または --no-auto-start オプションを使用して、機能によってインストールされたバンドルを開始しないよう指定できます。

karaf@root()> feature:install -s eventadmin

デフォルトでは、機能をインストールすると、その機能は自動的にインストールされます。ただし、-s オプションを feature:install コマンドに指定できます。

機能をインストールすると (開始されているかどうかに関係なく)、機能で定義されているバンドルによって提供されるすべてのパッケージが使用可能になり、他のバンドルの設定に使用できるようになります。

機能を開始すると、すべてのバンドルが開始されるため、機能はサービスも公開します。

機能を停止することもできるので、機能によって提供されるすべてのサービスが停止され、サービスレジストリーから削除されます。ただし、パッケージはワイヤリングで引き続き利用できます (バンドルは解決済み状態です)。

feature:uninstall コマンドは、機能をアンインストールします。feature:install コマンドとして、feature:uninstall コマンドには feature 引数が必要です。feature 引数は、機能の名前または機能の名前/バージョンです。(バージョンではなく) 機能の名前のみが提供されている場合に、使用可能な最新バージョンがインストールされます。

karaf@root()> feature:uninstall eventadmin

機能リゾルバーは、機能のアンインストール中に使用されます。アンインストールされた機能でインストールされた一時的な機能は、他の機能によって使用されていない場合には、自分でアンインストールできます。

FeatureMBean は、次の 2 つの属性を提供します。

Repositories 属性は、以下の情報を提供します。

Features 属性は、以下の情報を提供します。

FeatureMBean は、次の 2 種類の通知を送信します (サブスクライプおよび対応)。