Glassfish OSGi

2021-02-272021
15.6% (57/365)
February
93.1% (26/28)
Week 08
72.4% (5/7)
Day 27 Sat
6.9% (1.6/24)

訪問者

total: 9170
today: 1
yesterday: 1
now: 2

↑

更新

MenuBar

サンプル
OSGiとは?
OSGiアプリケーションのベスト・プラクティス
開発環境 (Maven Multi-module)
API バンドルを作る
テスト用の Web アプリを作る
POJO OSGi バンドルを作る
EJB OSGi バンドルを作る
Webアプリを Wab (Web Application Bundle) 化して、OSGi バンドルから OSGi バンドルを呼び出す
OSGi バンドルに jar を入れたい
OSGi バンドルの管理

サンプル †

https://github.com/kagyuu/OSGiExam

↑

OSGiとは? †

Open Services Gateway initiative
- http://www.osgi.org/Main/HomePage
- 1993-
Java のコンポーネント管理技術
- コンポーネントは "bundle" と呼ばれる
- "bundle" は、動的に差し替え可能
- "bundle" は、バージョン管理される
- "bundle" は、他の bundle を参照できる。参照できるバージョンを定義可能 (biz bundle は、logger bundle の 1.0.0～2.0.0 を参照する)
2013年現在の規格バージョンは R4.2
当初は、組込み用途
最近は、大規模 Java アプリで使われる
- Eclipse 自身が、Eclipse Equinox OSGi コンテナ上で動く bundle の集合体。
  - plugin も OSGi bundle にする必要がある
- Glassfish 自身が、Apache Felix OSGi コンテナ上で動く bundle の集合体。
  - ただし、その上で動くアプリ (Ear, War, ejb-jar) は、OSGi bundle ではない
  - War, ejb-jar に少し手を加えれば OSGi bundle として動かすことが可能。(具体的には MANIFEST.MF に記述を追加)
Glassfish と OSGi
- v3.0 から OSGi ベースになった
- V4.0 でもちゃんと動く
- ドメイン自体が、OSGi R4.2 コンテナになっている
- POJO の他に、EJB や WEB アプリも OSGi bundle として配備可能 (Glassfish の独自拡張ではなく OSGi 規格準拠)
- ただし、bundle の管理アプリが貧弱
- (個人的には、将来的に OSGi のほうが主になって行くのではないかと思っている)

↑

OSGiアプリケーションのベスト・プラクティス †

Best practices for developing and working with OSGi applications, developer Works, IBM, 14 Jul 2010, http://www.ibm.com/developerworks/websphere/techjournal/1007_charters/1007_charters.html
OSGi でサービスを作るときには、必ず API bundle と Impl bundle を作る
- API
```
public interface Hello {
  String sayHello(String name);
}
```
- Impl
```
public class HelloImpl {
  public String sayHello(String name) {
    return "Hello " + name;
  }
}
```
- Client
```
public class Client {
  @Inject
  private Hello hello;
  
  public void doSomething() {
    System.out.println(hello.sayHello("sachi"));
  }
}
```
- API が変わらなければ、実装 (Implement) バンドルを差し替えても、Clinet に影響が出ない
  - Client プログラムは、API の Interface 型ですべての操作を行う
  - Interface の実装は、実行時に OSGi なり JNDI が見つけてくる

↑

開発環境 (Maven Multi-module) †

少なくとも API, Impl, テスト用Web の 3 つのプロジェクトを作らなければならないので、Multi-module 構成にする
Parent Project の作成

[新規]-[Maven]-[POMプロジェクト]
こんなプロジェクトができる

pom.xml に、配下の Module で共通的に使われるライブラリを定義する

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.mycompany</groupId>
    <artifactId>OSGiExam</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>OSGiExam</name>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.osgi</groupId>
                <artifactId>org.osgi.core</artifactId>
                <version>4.2.0</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                <groupId>org.glassfish</groupId>
                <artifactId>osgi-cdi-api</artifactId>
                <version>3.1</version>
                <scope>provided</scope>
            </dependency>
            <!-- It's not javaee-api, because we want to test business logic -->
            <dependency>
                <groupId>org.glassfish.main.extras</groupId>
                <artifactId>glassfish-embedded-all</artifactId>
                <version>3.1.2.2</version>
                <scope>provided</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>  
    <repositories>
        <!-- glassfish nexus repo for glassfish dependencies -->
        <repository>
            <id>glassfish-repo-archive</id>
            <name>Nexus repository collection for Glassfish</name>
            <url>http://maven.glassfish.org/content/groups/glassfish</url>
            <snapshots>
                <updatePolicy>never</updatePolicy>
            </snapshots>
        </repository>
    </repositories>  
</project>

glassfish-embedded を参照している理由 :
ビルドするだけなら、
```
<dependency>
   <groupId>javax</groupId>
   <artifactId>javaee-api</artifactId>
   <version>7.0</version>
   <scope>provided</scope>
</dependency>
```
でも良いけど、RDB 更新込みの Unit Test をやるためには Java EE の実装が必要。
細かいこと言えば JPA の実装 (Eclipse link) だけあればいいけど、面倒なので組み込み glassfish をまるまる参照する。

↑

API バンドルを作る †

OSGiExam? プロジェクトの配下に、API バンドル作成のためのプロジェクトを作る
API バンドルには、アプリケーションのインタフェースのみを定義する
実装が変わっても、この API バンドルを参照しているクライアント側での変更は不要

[新規]-[Maven]-[OSGiバンドル]
作成場所を OSGiExam? の直下にする
自動的に OSGiExamApi? は、OSGiExam? のモジュールになった
OSGiExam?/pom.xml には、配下のモジュール定義が追加されている
```
    </repositories>  
  <modules>
    <module>OSGiExamApi</module>
  </modules>
</project>
```

OSGiExam?/OSGiExamApi?/pom.xml を編集して、親プロジェクト (OSGiExam?) の pom.xml のライブラリ参照定義を継承する。(GUI からやりたければ、ソースツリーの [依存性] を右クリックして、[依存性の追加]-[依存性管理] で、親プロジェクトの管理しているライブラリを追加できる)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
    <artifactId>OSGiExam</artifactId>
    <groupId>com.mycompany</groupId>
    <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.mycompany</groupId>
    <artifactId>OSGiExamApi</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>bundle</packaging>

    <name>OSGiExamApi OSGi Bundle</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.glassfish.main.extras</groupId>
            <artifactId>glassfish-embedded-all</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            ...

インタフェースを作成 (POJO用)

package com.mycompany.osgiexamapi;

public interface Hello {
    String sayHello(String name);
}

インタフェースを作成 (EJB用)

package com.mycompany.osgiexamapi;

import javax.ejb.Local;

@Local
public interface GoodBye {
    String sayGoodBye(String name);
}

ほかのバンドルから参照できる、このバンドルの公開パッケージの設定。(GUI からやりたければ、ソースツリーの [OSGiExamApi?] を右クリックして、[プロパティ]-[パッケージをエクスポート] で、親プロジェクトの管理しているライブラリを追加できる)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
    <artifactId>OSGiExam</artifactId>
    <groupId>com.mycompany</groupId>
    <version>1.0-SNAPSHOT</version>
    </parent>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>2.3.7</version>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-Activator>com.mycompany.osgiexamapi.Activator</Bundle-Activator>
                        <Export-Package >com.mycompany.osgiexamapi</Export-Package>
                        <Private-Package>com.mycompany.osgiexamapi.*</Private-Package>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>

[実行]-[ビルド] で、バンドルができる。バンドルと言っても、普通の Jar。MANIFEST.MF ファイルに追加の記述があるだけ。MANIFEST.MF は、pom.xml に定義された maven-bundle-plugin がビルド時に作成する。

MANIFEST.MF

Manifest-Version: 1.0
Bnd-LastModified: 1378399068929
Build-Jdk: 1.7.0_21
Built-By: atsushi
Bundle-Activator: com.mycompany.osgiexamapi.Activator
Bundle-ManifestVersion: 2
Bundle-Name: OSGiExamApi OSGi Bundle
Bundle-SymbolicName: com.mycompany.OSGiExamApi
Bundle-Version: 1.0.0.SNAPSHOT
Created-By: Apache Maven Bundle Plugin
Export-Package: com.mycompany.osgiexamapi;uses:="org.osgi.framework,java
 x.ejb";version="1.0.0.SNAPSHOT"
Import-Package: javax.ejb,org.osgi.framework;version="[1.5,2)"
Tool: Bnd-1.50.0

Activator について
- バンドルの有効化・無効化の処理を記述する
- 通常は BundleContext? に、オブジェクトを登録 / 登録解除する
- Api には、実装クラスがないので何もしない。
- 何をどう書くかは、POJO OSGi バンドルを作るを参照
- バンドル初期化時には、まだ他のバンドルを参照できないことに注意。Logger も使えないよ (ハマった)、なにか出力したかったら System.out.prinltn() で

↑

テスト用の Web アプリを作る †

プロジェクトを作成
/OSGiExam? 配下にモジュールとして Web アプリを作る (OSGiExam?/OSGiExamWeb? に作成)

依存ライブラリの設定 (親プロジェクト (OSGiExam?) と APIを参照する)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
    <artifactId>OSGiExam</artifactId>
    <groupId>com.mycompany</groupId>
    <version>1.0-SNAPSHOT</version>
  </parent>

    <groupId>com.mycompany</groupId>
    <artifactId>OSGiExamWeb</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>OSGiExamWeb</name>

    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>OSGiExamApi</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish</groupId>
            <artifactId>osgi-cdi-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.glassfish.main.extras</groupId>
            <artifactId>glassfish-embedded-all</artifactId>
        </dependency>
    </dependencies>
    ...

WEB-INF/beans.xml を作成 (中身は空で良い)。CDIを使うために必要

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://java.sun.com/xml/ns/javaee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">
</beans>

↑

POJO OSGi バンドルを作る †

[新規]-[Maven]-[OSGiバンドル]
/OSGiExam? 配下にモジュールとして OSGi Bundle アプリを作る (OSGiExam?/OSGiExamImpl? に作成)

OSGiExam?/OSGiImpl?/pom.xml を編集して、親プロジェクト (OSGiExam?) の pom.xml のライブラリ参照定義を継承する。(GUI からやりたければ、ソースツリーの [依存性] を右クリックして、[依存性の追加]-[依存性管理] で、親プロジェクトの管理しているライブラリを追加できる)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
    <artifactId>OSGiExam</artifactId>
    <groupId>com.mycompany</groupId>
    <version>1.0-SNAPSHOT</version>
  </parent>

    <groupId>com.mycompany</groupId>
    <artifactId>OSGiExamImpl</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>bundle</packaging>

    <name>OSGiExamImpl OSGi Bundle</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>OSGiExamApi</artifactId>
            <version>${project.version}</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
    ...

OSGiExamAPI にある Hello インタフェースの実装をする

package com.mycompany.osgiexamimpl;

import com.mycompany.osgiexamapi.Hello;

public class HelloImpl implements Hello {

    @Override
    public String sayHello(String name) {
        return "Hello " + name;
    }    
}

Activator#start で、HelloImpl? を BundleContext? に追加する

package com.mycompany.osgiexamimpl;

import com.mycompany.osgiexamapi.Hello;
import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

public class Activator implements BundleActivator {

    @Override
    public void start(final BundleContext context) throws Exception {
        System.out.println(String.format("start::%s", Activator.class.getCanonicalName()));
        context.registerService(Hello.class.getName(), new HelloImpl(), null);
        System.out.println(String.format("activated::%s as %s", HelloImpl.class.getName(), Hello.class.getName()));
    }

    @Override
    public void stop(final BundleContext context) throws Exception {
        context.ungetService(context.getServiceReference(Hello.class.getName()));
        System.out.println(String.format("deactivated::%s", Hello.class.getName()));
        System.out.println(String.format("stop::%s", Activator.class.getCanonicalName()));
    }
}

バンドル初期化時には、まだ他のバンドルを参照できないことに注意。Logger も使えないよ (ハマった)、なにか出力したかったら System.out.prinltn() で

動かしてみる

OSGiExamWeb? に、LookupPojoFromCDI を作って、HelloImpl? が CDI で injection できるか試してみる

package com.mycompany.osgiexamweb;

import com.mycompany.osgiexamapi.Hello;
import java.io.IOException;
import java.io.PrintWriter;
import javax.annotation.Resource;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(name = "LookupPojoFromCDI", urlPatterns = {"/LookupPojoFromCDI"})
public class LookupPojoFromCDI extends HttpServlet {

    @Resource
    private Hello hello;
        
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        try {
            out.println("<!DOCTYPE html>");
            out.println("<html>");
            out.println("<head>");
            out.println("<title>@Resource</title>");            
            out.println("</head>");
            out.println("<body>");
            out.println("<h1>lookup POJO by @Resource</h1>");
            out.println(hello.sayHello("Sachi"));
            out.println("<br/><br/><font color=\"gray\">Hello Class is ");
            out.println(hello.getClass().getCanonicalName());
            out.println("@");
            out.println(hello.hashCode());
            out.println("</font>");
        } catch (Exception ex) {
            out.println("<pre>");
            ex.printStackTrace(out);
            out.println("</pre>");
        } finally {
            out.println("</body>");
            out.println("</html>");
            out.close();
        }
    }
}

ビルド OSGiExam? で、[実行]-[消去してビルド]

...
undle:install]
Installing com/mycompany/OSGiExamImpl/1.0-SNAPSHOT/OSGiExamImpl-1.0-SNAPSHOT.jar
Writing OBR metadata
------------------------------------------------------------------------
Reactor Summary:

OSGiExam .......................................... SUCCESS [21.206s]
OSGiExamApi OSGi Bundle ........................... SUCCESS [6.011s]
OSGiExamWeb ....................................... SUCCESS [4.712s]
OSGiExamImpl OSGi Bundle .......................... SUCCESS [0.717s]
------------------------------------------------------------------------
BUILD SUCCESS
------------------------------------------------------------------------
Total time: 34.398s
Finished at: Sat Sep 07 22:54:43 JST 2013
Final Memory: 37M/90M
------------------------------------------------------------------------

配備

[~]$ cp ~/NetBeansProjects/OSGiExam/OSGiExamApi/target/OSGiExamApi-1.0-SNAPSHOT.jar \
/Applications/NetBeans/glassfish-3.1.2.2/glassfish/domains/domain1/autodeploy/bundles/

[~]$ cp ~/NetBeansProjects/OSGiExam/OSGiExamImpl/target/OSGiExamImpl-1.0-SNAPSHOT.jar \
/Applications/NetBeans/glassfish-3.1.2.2/glassfish/domains/domain1/autodeploy/bundles/

OSGiExamWar? を実行
ちゃんと動いた。インスタンスは Activator で登録したもの (Singleton)

↑

EJB OSGi バンドルを作る †

[新規]-[Maven]-[OSGiバンドル]
作成場所を OSGiExam? の直下にする

pom.xml の編集

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>OSGiExam</artifactId>
        <groupId>com.mycompany</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.mycompany</groupId>
    <artifactId>OSGiExamEjb</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>ejb</packaging>

    <name>OSGiExamEjb</name>

    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>OSGiExamApi</artifactId>
            <version>${project.version}</version>
            <scope>provided</scope>
        </dependency>        
        <dependency>
            <groupId>org.glassfish.main.extras</groupId>
            <artifactId>glassfish-embedded-all</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                    <compilerArguments>
                        <endorseddirs>${endorsed.dir}</endorseddirs>
                    </compilerArguments>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-ejb-plugin</artifactId>
                <version>2.3</version>
                <configuration>
                    <archive>
                        <!-- add bundle plugin generated manifest to the war -->
                        <manifestFile>
                            ${project.build.outputDirectory}/META-INF/MANIFEST.MF
                        </manifestFile>
                    </archive>
                    <ejbVersion>3.1</ejbVersion>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>2.1</version>
                <executions>
                    <execution>
                        <phase>validate</phase>
                        <goals>
                            <goal>copy</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${endorsed.dir}</outputDirectory>
                            <silent>true</silent>
                            <artifactItems>
                                <artifactItem>
                                    <groupId>javax</groupId>
                                    <artifactId>javaee-endorsed-api</artifactId>
                                    <version>6.0</version>
                                    <type>jar</type>
                                </artifactItem>
                            </artifactItems>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>2.2.0</version>
                <extensions>true</extensions>
                <configuration>
                    <supportedProjectTypes>
                        <supportedProjectType>ejb</supportedProjectType>
                        <supportedProjectType>war</supportedProjectType>
                        <supportedProjectType>bundle</supportedProjectType>
                        <supportedProjectType>jar</supportedProjectType>
                    </supportedProjectTypes>
                    <instructions>
                        <!-- Specify elements to add to MANIFEST.MF -->
                        <Export-EJB>ALL</Export-EJB>
                        <!-- By default, nothing is exported -->
                        <Export-Package>!*.impl.*, *</Export-Package>
                    </instructions>
                </configuration>
                <executions>
                    <execution>
                        <id>bundle-manifest</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>bundle-install</id>
                        <phase>install</phase>
                        <goals>
                            <goal>install</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin> 
        </plugins>
    </build>
</project>

<dependencies> に、親プロジェクトへの参照を追加する
<maven-ejb-plugin> に、格納する MANIFEST.MF を maven-bundle-plugin が作ったものにするように指定する
<maven-bundle-plugin> を追加する。ミソは、Export-EJB : ALL (すべての SessionBean? を公開する)

自動生成される MANIFEST.MF はこんな感じ

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: 1.7.0_21 (Oracle Corporation)
Built-By: atsushi
Build-Jdk: 1.7.0_21
Export-Package: com.mycompany.osgiexamejb;uses:="javax.ejb,com.mycompa
 ny.osgiexamapi"
Export-EJB: ALL
Bundle-Version: 1.0.0.SNAPSHOT
Tool: Bnd-1.15.0
Bundle-Name: OSGiExamEjb
Bnd-LastModified: 1378646187379
Bundle-ManifestVersion: 2
Bundle-SymbolicName: com.mycompany.OSGiExamEjb
Import-Package: com.mycompany.osgiexamapi;version="[1.0,2)",javax.ejb

OSGiExamAPI にある Goodbye インタフェース (@Local) の実装をする

package com.mycompany.osgiexamejb;

import com.mycompany.osgiexamapi.GoodBye;
import javax.ejb.Stateless;

@Stateless
public class GoodByeEjb implements GoodBye {

    @Override
    public String sayGoodBye(String name) {
        return "GoodBye " + name;
    }
}

Activator は必要ない

動かしてみる

OSGiExamWeb? に、LookupEjbFromJNDI を作って、GoodByeEjb? が JNDI で injection できるか試してみる

package com.mycompany.osgiexamweb;

import com.mycompany.osgiexamapi.GoodBye;
import java.io.IOException;
import java.io.PrintWriter;
import javax.ejb.EJB;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet(name = "LookupEjbFromJNDI", urlPatterns = {"/LookupEjbFromJNDI"})
public class LookupEjbFromJNDI extends HttpServlet {

    @EJB(lookup = "java:global/com.mycompany.OSGiExamEjb_1.0.0.SNAPSHOT/GoodByeEjb")
    private GoodBye goodbye;

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        try {
            out.println("<!DOCTYPE html>");
            out.println("<html>");
            out.println("<head>");
            out.println("<title>@EJB</title>");
            out.println("</head>");
            out.println("<body>");
            out.println("<h1>lookup EJB Object by @EJB</h1>");
            out.println(goodbye.sayGoodBye("Sachi"));
            out.println("<br/><br/><font color=\"gray\">GoodBye Class is ");
            out.println(goodbye.getClass().getCanonicalName());
            out.println("@");
            out.println(goodbye.hashCode());
            out.println("</font>");
        } catch (Exception ex) {
            out.println("<pre>");
            ex.printStackTrace(out);
            out.println("</pre>");
        } finally {
            out.println("</body>");
            out.println("</html>");
            out.close();
        }
    }
}

ビルドして

配備

[~]$ cp ~/NetBeansProjects/OSGiExam/OSGiExamEjb/target/OSGiExamEjb-1.0-SNAPSHOT.jar \
/Applications/NetBeans/glassfish-3.1.2.2/glassfish/domains/domain1/autodeploy/bundles/

OSGiExamWar? を実行

CMT(コンテナ管理トランザクション) の振る舞いに注意が必要
- 通常は、EJB の業務処理内で、RuntimeException? か、@ApplicationException?(rollback=true) が付いている Exception が発行されると、トランザクションが rollback される。
ところが、他の Bundle (共通部品 Bundle) にアプリケーション例外を定義した場合に、問題が起きる
- CommonBundle? に
```
@ApplicationException(rollback=true)
public class BizExceptoin extends Exception {
...
}
```
  が定義されているとする
- これを OrderBundle? から参照して、EJB の業務処理内で発行しても、トランザクションが rollback されない
- (JavaEEコンテナがある。少なくとも Glassfish3/4 はそういう振る舞いをする)
対処方法・詳細 Glassfish Session Bean#na8b1243

OSGi の EJB では Singleton だめ

↑

Webアプリを Wab (Web Application Bundle) 化して、OSGi バンドルから OSGi バンドルを呼び出す †

pom.xml を変更して、MANIFEST.MF を自動生成する

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <artifactId>OSGiExam</artifactId>
        <groupId>com.mycompany</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>com.mycompany</groupId>
    <artifactId>OSGiExamWeb</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <name>OSGiExamWeb</name>

    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>${project.groupId}</groupId>
            <artifactId>OSGiExamApi</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish</groupId>
            <artifactId>osgi-cdi-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.glassfish.main.extras</groupId>
            <artifactId>glassfish-embedded-all</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                    <compilerArguments>
                        <endorseddirs>${endorsed.dir}</endorseddirs>
                    </compilerArguments>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>2.1.1</version>
                <configuration>
                    <archive>
                        <!-- add bundle plugin generated manifest to the war -->
                        <manifestFile>
                            ${project.build.outputDirectory}/META-INF/MANIFEST.MF
                        </manifestFile>
                        <!-- For some reason, adding Bundle-ClassPath in maven-bundle-plugin
                        confuses that plugin and it generates wrong Import-Package, etc.
                        So, we generate it here.-->
                        <manifestEntries>
                            <Bundle-ClassPath>WEB-INF/classes/</Bundle-ClassPath>
                        </manifestEntries>
                    </archive>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <version>2.1</version>
                <executions>
                    <execution>
                        <phase>validate</phase>
                        <goals>
                            <goal>copy</goal>
                        </goals>
                        <configuration>
                            <outputDirectory>${endorsed.dir}</outputDirectory>
                            <silent>true</silent>
                            <artifactItems>
                                <artifactItem>
                                    <groupId>javax</groupId>
                                    <artifactId>javaee-endorsed-api</artifactId>
                                    <version>6.0</version>
                                    <type>jar</type>
                                </artifactItem>
                            </artifactItems>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>2.2.0</version>
                <extensions>true</extensions>
                <configuration>
                    <supportedProjectTypes>
                        <supportedProjectType>ejb</supportedProjectType>
                        <supportedProjectType>war</supportedProjectType>
                        <supportedProjectType>bundle</supportedProjectType>
                        <supportedProjectType>jar</supportedProjectType>
                    </supportedProjectTypes>
                    <instructions>
                        <!-- Specify elements to add to MANIFEST.MF -->
                        <Web-ContextPath>/mavenhellowebclient</Web-ContextPath>
                        <!-- By default, nothing is exported -->
                        <Export-Package>!*.impl.*, *</Export-Package>
                    </instructions>
                </configuration>
                <executions>
                    <execution>
                        <id>bundle-manifest</id>
                        <phase>process-classes</phase>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>bundle-install</id>
                        <phase>install</phase>
                        <goals>
                            <goal>install</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>            
        </plugins>
    </build>
</project>

maven-war-plugin で、maven-bundle-plugin が作成した MANIFEST.MF を取り込むように設定する
maven-bundle-plugin を追加する

自動生成される MANIFEST.MF はこんな感じ

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: 1.7.0_21 (Oracle Corporation)
Built-By: atsushi
Build-Jdk: 1.7.0_21
Bundle-ClassPath: WEB-INF/classes/
Export-Package: com.mycompany.osgiexamweb;uses:="javax.servlet,javax.e
 jb,com.mycompany.osgiexamapi,javax.servlet.annotation,javax.servlet.h
 ttp,org.glassfish.osgicdi,javax.inject,javax.annotation"
Bundle-Version: 1.0.0.SNAPSHOT
Tool: Bnd-1.15.0
Bundle-Name: OSGiExamWeb
Bnd-LastModified: 1378649661814
Bundle-ManifestVersion: 2
Bundle-SymbolicName: com.mycompany.OSGiExamWeb
Web-ContextPath: /mavenhellowebclient
Import-Package: com.mycompany.osgiexamapi;version="[1.0,2)",javax.anno
 tation,javax.ejb,javax.inject,javax.servlet,javax.servlet.annotation,
 javax.servlet.http,org.glassfish.osgicdi;version="[1.0,2)"

動かしてみる

OSGiExamWeb? に、LookupPojoFromOSGi を作って、HelloImpl? が OSGi で injection できるか試してみる

package com.mycompany.osgiexamweb;

import com.mycompany.osgiexamapi.Hello;
import java.io.IOException;
import java.io.PrintWriter;
import javax.inject.Inject;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.glassfish.osgicdi.OSGiService;

@WebServlet(name = "LookupPojoFromOSGi", urlPatterns = {"/LookupPojoFromOSGi"})
public class LookupPojoFromOSGi extends HttpServlet {

    @Inject
    @OSGiService(dynamic = true)
    private Hello hello;
        
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        try {
            out.println("<!DOCTYPE html>");
            out.println("<html>");
            out.println("<head>");
            out.println("<title>@OSGi</title>");            
            out.println("</head>");
            out.println("<body>");
            out.println("<h1>lookup POJO by @Inject @OSGiService</h1>");
            out.println(hello.sayHello("Sachi"));
            out.println("<br/><br/><font color=\"gray\">Hello Class is ");
            out.println(hello.getClass().getCanonicalName());
            out.println("@");
            out.println(hello.hashCode());
            out.println("</font>");
        } catch (Exception ex) {
            out.println("<pre>");
            ex.printStackTrace(out);
            out.println("</pre>");
        } finally {
            out.println("</body>");
            out.println("</html>");
            out.close();
        }
    }
}

OSGiExamWeb? に、LookupEjbFromOSGi を作って、GoodByeEjb? が OSGi で injection できるか試してみる

package com.mycompany.osgiexamweb;

import com.mycompany.osgiexamapi.GoodBye;
import java.io.IOException;
import java.io.PrintWriter;
import javax.inject.Inject;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.glassfish.osgicdi.OSGiService;

@WebServlet(name = "LookupEjbFromOSGi", urlPatterns = {"/LookupEjbFromOSGi"})
public class LookupEjbFromOSGi extends HttpServlet {

    @Inject
    @OSGiService(dynamic = true)
    private GoodBye goodbye;
        
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        try {
            out.println("<!DOCTYPE html>");
            out.println("<html>");
            out.println("<head>");
            out.println("<title>@OSGi</title>");            
            out.println("</head>");
            out.println("<body>");
            out.println("<h1>lookup EJB Object by @Inject @OSGiService</h1>");
            out.println(goodbye.sayGoodBye("Sachi"));
            out.println("<br/><br/><font color=\"gray\">GoodBye Class is ");
            out.println(goodbye.getClass().getCanonicalName());
            out.println("@");
            out.println(goodbye.hashCode());
            out.println("</font>");
        } catch (Exception ex) {
            out.println("<pre>");
            ex.printStackTrace(out);
            out.println("</pre>");
        } finally {
            out.println("</body>");
            out.println("</html>");
            out.close();
        }
    }
}

配備する

[~]$ cp ~/NetBeansProjects/OSGiExam/OSGiExamWeb/target/OSGiExamWeb-1.0-SNAPSHOT.war \
/Applications/NetBeans/glassfish-3.1.2.2/glassfish/domains/domain1/autodeploy/bundles/

実行する (URL は MANIFEST.MF の「Web-ContextPath?: /mavenhellowebclient」 )

@Injection @OSGiService? は、WAB (OSGiコンテナ内) として動かした時に有効。WAR (OSGiコンテナ外) として動かした場合には、エラーになる

↑

OSGi バンドルに jar を入れたい †

OSGi バンドルアプリケーションは、MANIFEST.MF の Bundle-ClassPath?: で、jar 内の jar ファイルを参照できる
ただし、OSGi の思想的には、3rd party 製の jar も OSGi Bundle として動かすべき
最近、jar で配布されているライブラリが、実は OSGi Bundle としても動く場合が多い。(たとえば、slf4j は、bundle としても動く)

maven-bundle-plugin で、依存ライブラリを Bundle に梱包する

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.mycompany</groupId>
    <artifactId>PrintBundle</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>bundle</packaging>

    <name>PrintBundle OSGi Bundle</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.osgi</groupId>
            <artifactId>org.osgi.core</artifactId>
            <version>4.3.0</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.itextpdf</groupId>
            <artifactId>itextpdf</artifactId>
            <version>5.4.4</version>
        </dependency>
        <dependency>
            <groupId>com.itextpdf</groupId>
            <artifactId>itext-xtra</artifactId>
            <version>5.4.4</version>
        </dependency>
        <dependency>
            <groupId>com.itextpdf</groupId>
            <artifactId>itext-asian</artifactId>
            <version>5.2.0</version>
        </dependency>
        <dependency>
            <groupId>org.bouncycastle</groupId>
            <artifactId>bcmail-jdk16</artifactId>
            <version>1.46</version>
        </dependency>
        <dependency>
            <groupId>org.bouncycastle</groupId>
            <artifactId>bcpg-jdk16</artifactId>
            <version>1.46</version>
        </dependency>
        <dependency>
            <groupId>org.bouncycastle</groupId>
            <artifactId>bcprov-jdk16</artifactId>
            <version>1.46</version>
        </dependency>
        <dependency>
            <groupId>org.bouncycastle</groupId>
            <artifactId>bctsp-jdk16</artifactId>
            <version>1.46</version>
        </dependency>
        <dependency>
            <groupId>org.bouncycastle</groupId>
            <artifactId>bcpkix-jdk15on</artifactId>
            <version>1.49</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>2.3.7</version>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-Activator>com.mycompany.printbundle.Activator</Bundle-Activator>
                        <Embed-Dependency>*;scope=compile|runtime</Embed-Dependency>
                        <Embed-Transitive>true</Embed-Transitive>
                        <Import-Package>
                            !javax.*,
                            !org.w3c.dom,
                            !org.xml.sax,
                            !org.apache.jcp.xml.dsig.internal.dom,
                            !org.apache.xml.security.utils,
                            !junit.*,
                            *
                        </Import-Package>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

<Embed-Dependency>*;scope=compile|runtime</Embed-Dependency> で、compile または runtime スコープの依存ライブラリを OSGi バンドルに同梱する
<Embed-Transitive>true</Embed-Transitive> で、依存ライブラリが依存している package を Import 宣言に入れる
最後に、<Import-Package> で、不要な package を除く
- 依存ライブラリが依存しているが、大本の Bundle からは使わない場合
- 不要な package が Import-Package に残っていると、Glassfish に deploy できない

できた MANIFEST.MF はこうなる

Manifest-Version: 1.0
Bnd-LastModified: 1384872395474
Build-Jdk: 1.7.0_21
Built-By: atsushi
Bundle-Activator: com.mycompany.printbundle.Activator
Bundle-ClassPath: .,itextpdf-5.4.4.jar,itext-xtra-5.4.4.jar,itext-asian-
 5.2.0.jar,bcmail-jdk16-1.46.jar,bcpg-jdk16-1.46.jar,bcprov-jdk16-1.46.j
 ar,bctsp-jdk16-1.46.jar,bcpkix-jdk15on-1.49.jar,bcprov-jdk15on-1.49.jar
Bundle-ManifestVersion: 2
Bundle-Name: PrintBundle OSGi Bundle
Bundle-SymbolicName: com.mycompany.PrintBundle
Bundle-Version: 1.0.0.SNAPSHOT
Created-By: Apache Maven Bundle Plugin
Embed-Dependency: *;scope=compile|runtime
Embed-Transitive: true
Embedded-Artifacts: itextpdf-5.4.4.jar;g="com.itextpdf";a="itextpdf";v="
 5.4.4",itext-xtra-5.4.4.jar;g="com.itextpdf";a="itext-xtra";v="5.4.4",i
 text-asian-5.2.0.jar;g="com.itextpdf";a="itext-asian";v="5.2.0",bcmail-
 jdk16-1.46.jar;g="org.bouncycastle";a="bcmail-jdk16";v="1.46",bcpg-jdk1
 6-1.46.jar;g="org.bouncycastle";a="bcpg-jdk16";v="1.46",bcprov-jdk16-1.
 46.jar;g="org.bouncycastle";a="bcprov-jdk16";v="1.46",bctsp-jdk16-1.46.
 jar;g="org.bouncycastle";a="bctsp-jdk16";v="1.46",bcpkix-jdk15on-1.49.j
 ar;g="org.bouncycastle";a="bcpkix-jdk15on";v="1.49",bcprov-jdk15on-1.49
 .jar;g="org.bouncycastle";a="bcprov-jdk15on";v="1.49"
Export-Package: com.mycompany.printbundle;uses:="org.osgi.framework";ver
 sion="1.0.0.SNAPSHOT"
Ignore-Package: javax.crypto.interfaces,javax.mail.internet,javax.imagei
 o.stream,javax.xml.crypto.dsig.keyinfo,javax.xml.transform.dom,junit.te
 xtui,org.apache.jcp.xml.dsig.internal.dom,org.xml.sax,javax.imageio,jav
 ax.naming.directory,org.apache.xml.security.utils,junit.framework,javax
 .security.auth.x500,javax.naming,javax.xml.crypto.dsig.dom,javax.xml.pa
 rsers,javax.crypto,javax.imageio.plugins.jpeg,org.w3c.dom,javax.activat
 ion,javax.imageio.metadata,javax.crypto.spec,javax.xml.transform,javax.
 xml.transform.stream,javax.xml.crypto.dsig,javax.xml.crypto,javax.mail,
 javax.xml.crypto.dsig.spec,javax.xml.crypto.dom
Import-Package: org.osgi.framework;version="[1.6,2)"
Tool: Bnd-1.50.0

cf. http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html

↑

OSGi バンドルの管理 †

Glassfish 3.1.2 and later
- 管理コンソールで [構成]-[server-config]-[JVM設定]-[JVMオプション] を開き
```
-Dglassfish.osgi.start.level.final=3
```
  を追加して再起動
- telnet で Felix の管理コンソールにログインできる
- Oracle GlassFish? Server Administration Guide Release 3.1.2, http://docs.oracle.com/cd/E26576_01/doc.312/e24928/overview.htm
- 管理コンソールの osgi-gui プラグインをインストールすると、管理コンソールが起動しなくなった (2013-09-09現在)
- 3.1.1 以前だとやり方が違うらしい
Glassfish 4.0
- Glassfish の管理コンソールで [更新ツール]-[使用可能なアドオン]-[glassfish-osgi-*] を選択してインストール
- [サーバ]-[OSGi] で、バンドルの更新や停止ができる
- コマンドラインの管理ツールは asadmin に統合された (asadmin osgi ${osgiコマンド})
- Running osgi shell commands with asadmin in Glassfish, https://weblogs.java.net/blog/bhaktimehta/archive/2012/11/20/running-osgi-shell-commands-asadmin-glassfish-0

Java#Glassfish }}

目次

訪問者

更新

最新の10件

人気の10件

MenuBar

サンプル †

OSGiとは? †

OSGiアプリケーションのベスト・プラクティス †

開発環境 (Maven Multi-module) †

API バンドルを作る †

テスト用の Web アプリを作る †

POJO OSGi バンドルを作る †

EJB OSGi バンドルを作る †

Webアプリを Wab (Web Application Bundle) 化して、OSGi バンドルから OSGi バンドルを呼び出す †

OSGi バンドルに jar を入れたい †

OSGi バンドルの管理 †