Fragmentos do OSGi

Um fragmento do OSGi é um arquivo Java™ archive com cabeçalhos de manifest específicos que permitem que ele se conecte a um pacote configurável do host especificado ou pacotes configuráveis do host especificados para funcionar. Os fragmentos são tratados como parte dos pacotes configuráveis do host. Definições relevantes do fragmento são mescladas com as definições de pacotes configuráveis do host antes de o host ser resolvido, desde que as informações não entrem em conflito. As dependências de fragmentos serão resolvidas, se for possível. Se as dependências de fragmento não puderem ser resolvidas, o fragmento não se conectará ao pacote configurável do host. Um fragmento não pode ter seu próprio carregador de classe ou ativador de pacote configurável. Ele não pode substituir as informações presentes nos pacotes configuráveis do host. Fragmentos estendem pacotes configuráveis com recursos, classes e cabeçalhos permitidos que permitem que você customize seus pacotes configuráveis.

Arquivos de Manifesto de Fragmento do OSGi

Um arquivo JAR de fragmento do OSGi contém um arquivo de manifesto de fragmento. Esse arquivo contém metadados que permitem que a Estrutura OSGi anexe o fragmento a um pacote configurável ou pacotes configuráveis do host.

O código a seguir é um exemplo do conteúdo de um arquivo de manifesto do pacote configurável, META-INF/MANIFEST.MF:
Versão do Manifesto: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Fragment
Bundle-SymbolicName: Fragment
Bundle-Version: 1.0.0.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Fragment-Host: WebBundle;bundle-version=1.0.0.qualifier
Import-Package: org.apache.commons.logging;version="1.0.4"
Export-Package: com.sample.myservice.api;version="1.0.0"
Os metadados nesse arquivo de manifesto incluem as seguintes propriedades-chave:
Fragment-Host
Vincula o fragmento aos seus hosts potenciais do pacote configurável.
Bundle-Version
Descreve a versão do fragmento e permite que diversas versões de um pacote configurável sejam ativas simultaneamente na mesma instância da estrutura.
Bundle-Name
Fornece um nome legível pelo usuário para o fragmento.
Bundle-SymbolicName
Identifica exclusivamente o fragmento na estrutura. Ele não substitui a necessidade de um cabeçalho do Nome do Pacote Configurável.
Import-Package
Declara as dependências externas do fragmento que são usadas pela Estrutura OSGi para resolução de fragmento. Versões ou intervalos de versão específicos para cada pacote podem ser declarados. Neste arquivo de manifesto de exemplo, o pacote org.apache.commons.logging é necessário na Versão 1.0.4 ou posterior.
Use essa propriedade para especificar os nomes de quaisquer pacotes que você deseja que seu fragmento importe a partir do tempo de execução. Se você não especificar o pacote de que seu pacote configurável precisa nessa propriedade, poderá receber uma exceção NoClassDefFound e um erro de compilação quando o pacote configurável for carregado.
Nota: Você deve especificar também esse pacote na propriedade Export-Package do pacote configurável que contém o pacote.
Restrição: 1Se o arquivo de manifesto do pacote configurável usar a propriedade Import-Package para declarar uma dependência de pacote configurável para um pacote configurável que não esteja na área de trabalho ou na plataforma de destino, o editor marcará a dependência como um erro. Para solucionar essa limitação, certifique-se de que todos os pacotes configuráveis que você declara como uma dependência estejam em sua área de trabalho, ou use a correção rápida para incluir o pacote configurável na plataforma de destino. Para usar a correção rápida, alterne para a visualização Marcadores e, em seguida, clique com o botão direito no marcador de erro e selecione Correção Rápida.
Importante: Ao especificar as dependências do pacote configurável em seu arquivo MANIFEST.MF, use a propriedade Import-Package em vez de Require-bundle. Se você usar Require-bundle para especificar dependências do pacote configurável, seu aplicativo não será implementado.
Import-Package é uma maneira mais flexível de declarar dependências:
  • É possível declarar dependências da funcionalidade que você precisa em vez de no pacote configurável no qual a funcionalidade foi originada, pois isto não inclui dependências desnecessárias em pacotes que não são requeridos por seu pacote configurável, mas são incluídas no pacote configurável dependente.
  • É possível especificar versões ou intervalos de versão para o pacote declarado, portanto, você não precisará reagir às suas mudanças em versões diferentes do pacote configurável.
Export-Package
Declara os pacotes que são visíveis fora do fragmento. Qualquer pacote não declarado aqui tem visibilidade apenas dentro do fragmento.
Use essa propriedade para especificar o nome de qualquer pacote que você deseja que seu fragmento exporte para o tempo de execução. Se você não especificar os pacotes que são requeridos por outros pacotes configuráveis nesta propriedade, os pacotes configuráveis dependentes poderão não resolver.
Icon that indicates the type of topic Concept topic
Timestamp icon Last updated: last_date

File name: cbundlefragment.html