pacotes configuráveis OSGi
Um pacote configurável OSGi é um Java™ archive que contém o código Java, recursos e um manifesto que descreve o pacote configurável e suas dependências. O pacote configurável é a unidade de implementação para um aplicativo.
Tipos de Pacotes Configuráveis
- Pacotes Configuráveis de Aplicativo
- Pacotes configuráveis de aplicativos são pacotes configuráveis criados especificamente para o aplicativo. Eles são específicos às instâncias ou isolados; isto é, não são destinados a ser compartilhados. Eles são referenciados no manifesto do aplicativo no cabeçalho Conteúdo do Aplicativo.
- Pacotes Configuráveis Compartilhados
- Os pacotes configuráveis compartilhados não são específicos ao aplicativo. Uma única instância de um pacote a partir de um pacote configurável compartilhado pode ser usada por muitos aplicativos. Os pacotes configuráveis compartilhados não podem importar pacotes ou serviços a partir de pacotes configuráveis de aplicativos. Os pacotes configuráveis compartilhados em um aplicativo devem ser fornecidos pela referência, em vez de contidos diretamente em um aplicativo.
- Os pacotes configuráveis compartilhados são subdivididos adicionalmente em pacotes configuráveis de uso e de provisão:
- Pacotes Configuráveis de Uso
- Um pacote configurável de uso é um pacote configurável compartilhado, que fornece pelo menos um pacote a um pacote configurável do aplicativo. Os pacotes configuráveis de uso são referenciados no manifesto do aplicativo no cabeçalho Pacote Configurável de Uso.
- Pacotes Configuráveis de Provisão
- Um pacote configurável de provisão é um pacote configurável compartilhado que fornece pelo menos um pacote ou serviço a um pacote configurável do aplicativo, um pacote configurável para uso, ou um outro pacote configurável de provisão. Os pacotes configuráveis de provisão não são referenciados no manifesto do aplicativo, e o aplicativo não sabe como o requisito para cada pacote configurável de provisão é satisfeito.
- O arquivo Enterprise Bundle Archive (EBA) para o aplicativo.
- Um repositório interno de pacotes configuráveisos OSGi do servidor.
- Repositórios de pacotes configuráveis OSGi externos.
Os pacotes configuráveis de aplicativos podem ser armazenados no arquivo EBA ou em um repositório. Os pacotes configuráveis compartilhados são armazenados em um repositório (caso contrário, eles não poderão ser compartilhados).
- Pacotes Configuráveis Referenciados
- Um pacote configurável referenciado é um pacote configurável que é referenciado no manifesto do aplicativo e armazenado em um repositório.
- Pacotes Configuráveis de Dependência
- Um pacote configurável de dependência é um pacote configurável que não é referenciado no manifesto do aplicativo, mas que é usado pelos pacotes configuráveis que são referenciados no manifesto do aplicativo ou por outros pacotes configuráveis de dependência.
Os pacotes configuráveis de aplicativos que não estão contidos diretamente no arquivo EBA são pacotes configuráveis referenciados específicos à instância. Os pacotes configuráveis de uso são pacotes configuráveis referenciados compartilhados. Os pacotes configuráveis de provisão são pacotes configuráveis de dependência compartilhados.
Arquivo de Manifesto do Pacote Configurável OSGi
Um arquivo JAR de pacote configurável OSGi contém um arquivo de manifesto JAR. Esse arquivo contém metadados que permitem que a Estrutura OSGi processe os aspectos modulares do pacote configurável.
Versão do Manifesto: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: MyService bundle
Bundle-SymbolicName: com.sample.myservice
Bundle-Version: 1.0.0
Bundle-Activator: com.sample.myservice.Activator
Import-Package: org.apache.commons.logging;version="1.0.4"
Exportar-EJB: ExampleBean
Export-Package: com.sample.myservice.api;version="1.0.0"
Os metadados nesse arquivo de manifesto incluem as seguintes propriedades-chave:- Bundle-Version
- Descreve a versão do pacote configurável 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 um pacote configurável.
- Bundle-SymbolicName
- Identifica exclusivamente um pacote configurável na estrutura. Ele não substitui a necessidade de um cabeçalho do Nome do Pacote Configurável.
- Bundle-Activator
- Recebe notificação da estrutura sobre as mudanças no ciclo de vida do pacote configurável. Essa propriedade especifica a classe que implementa a interface org.osgi.framework.BundleActivator.
- Import-Package
- Declara as dependências externas do pacote configurável que são usadas pelo OSGi Framework para resolução do pacote configurável. 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 pacote configurável importe a partir do tempo de execução. Se você não especificar
o pacote que seu pacote configurável precisa nessa propriedade, poderá receber
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.
- Exportar-EJB:
- Se um projeto EJB for convertido para um pacote configurável OSGi, uma seção Exportar-EJB será incluída no manifesto. Use essa seção para listar EJBs que você deseja expor. EJBs podem ser incluídos nessa seção editando manualmente ou dando um clique direito em um projeto EJB convertido e selecionando.
- Export-Package
- Declara os pacotes que estão visíveis fora do pacote configurável. Qualquer pacote não declarado aqui possui visibilidade apenas no pacote configurável.
- Use essa propriedade para especificar o nome de qualquer pacote que você deseja que seu pacote configurável 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.
Ciclo de Vida do Pacote Configurável
A estrutura gerencia o ciclo de vida de pacotes configuráveis. Conforme você instala e executa um pacote configurável, ele passa por vários estados.
- INSTALLED
- O pacote configurável foi instalado, mas nem todas as dependências do pacote configurável foram atendidas. O pacote configurável requer pacotes que não foram exportados por nenhum pacote configurável instalado atualmente.
- RESOLVED
- O pacote configurável é instalado e as dependências do pacote configurável foram atendidas, mas ele não está em execução. Se um pacote configurável for iniciado e todas as dependências do pacote configurável forem atendidas, ele ignorará esse estado.
- STARTING
- Um estado temporário pelo qual o pacote configurável passa enquanto ele estiver iniciando.
- ATIVA
- O pacote configurável está em execução.
- INTERRUPÇÃO
- Um estado temporário pelo qual o pacote configurável passa enquanto ele estiver parando.
- UNINSTALLED
- O pacote configurável não existe mais na estrutura.