Regras de Acesso

O tempo de execução do Eclipse 3.1 fornece ao desenvolvedor de plug-ins a opção para controlar a visibilidade do código do plug-in para plug-ins de recebimento de dados por pacote.

Um pacote pode ser classificado como um dos seguintes:

  1. Acessível
  2. Proibido
  3. Interno
  4. Interno com amigos

O PDE traduz essas regras de visibilidade do tempo de execução em regras de restrição de acesso no tempo de compilação. Como resultado, uma violação de regra de visibilidade é sinalizada pelo compilador como um aviso ou erro - dependendo da gravidade dessa violação.

Com esse tipo de suporte no tempo de compilação, alguém nunca é surpreendido pelos erros de carregamento da classe de tempo de execução e está sempre ciente das referências de tipos internos.

Pacotes Acessíveis

Pacotes acessíveis são visíveis para plug-ins de recebimento de dados incondicionalmente.   Embora os pacotes de API devem claramente cair nessa categoria, o desenvolvedor é quem decide quais outros pacotes exportados pelo plug-in devem receber esse nível de visibilidade.

Para declarar um pacote como acessível, você deve listá-lo na seção Pacotes Exportados no Tempo de Execução do editor de manifesto de plug-in e deixar a configuração de visibilidade padrão no estado em que se encontra.

Pacotes Acessíveis

 

Pacotes Proibidos

É possível ocultar um pacote dos plug-ins de recebimento de dados todo o tempo excluindo-o da lista na seção Pacotes Exportados na página Tempo de Execução do editor de manifesto de plug-ins.

As referências aos tipos a partir de um pacote proibido resulta em erros de carregamento de classe em tempo de execução.

Para evitar situações desagradáveis:

  1. O compilador sinalizará referências a pacotes proibidos com um erro.
  2. Os tipos de pacotes proibidos NÃO estão disponíveis como sugestões no assistente de conteúdo.

Notas:

  1. Todos os plug-ins no SDK do Eclipse enumeram todos os seus pacotes na seção Pacotes Exportados. Dessa forma, nenhum dos pacotes no SDK têm acesso proibido.
  2. O nível de gravidade para referências proibidas é configurado na página de preferências página de preferências Abrir gravidades de problema Java > Compilador > Erros/Avisos > API descontinuada e restrita. :NONE.

    É altamente recomendável que a gravidade de uma referência proibida seja mantida na condição de erro.

Preferências proibidas

Pacotes Internos

Pacotes internos são pacotes que não são destinados ao uso por plug-ins de recebimento de dados. Esses pacotes são visíveis para plug-ins de recebimento de dados por padrão.

Pacotes internos são ocultados dos plug-ins de recebimento de dados apenas quando o Eclipse é ativado em modo exato (ou seja, quando você ativa com o argumento de VM -Dosgi.resolverMode=strict).

Pacotes internos devem ser listados na seção Pacotes Exportados na página Tempo de Execução do editor de manifesto de plug-ins com a opção oculto selecionada.

acesso desencorajado

Duas medidas são tomadas para desencorajar plug-ins de recebimento de dados de fazer referência a pacotes internos:

acesso desencorajado

assistente de conteúdo desencorajado

O nível de gravidade para referências desencorajadas pode ser definido na página de preferências página de preferências Abrir as gravidades de problema Java > Compilador > Erros/Avisos > API descontinuada e restrita.

Preferências desencorajadas

Pacotes Internos com Amigos

É importante para um plug-in poder conceder acesso integral a seus pacotes internos para plug-ins "amigos" designados. Por exemplo, o código do PDE é dividido entre diversos plug-ins, e o plug-in org.eclipse.pde.ui deve ter acesso integral aos pacotes internos do org.eclipse.pde.core.

No exemplo a seguir, o plug-in amigo org.eclipse.pde.ui tem acesso integral ao pacote org.eclipse.pde.internal.core.bundle a partir do plug-in org.eclipse.pde.core.

Amigos

Os amigos são livres para fazer referência a qualquer tipo do pacote org.eclipse.pde.internal.core.bundle com a bênção do compilador.

Por outro lado, se qualquer outro plug-in referenciar um tipo a partir do pacote org.eclipse.pde.internal.core.bundle, o compilador sinaliza a referência como uma referência desencorajada como descrito na seção anterior. :NONE.

Como Ativar Restrições de Acesso

Para aproveitar as vantagens do suporte de restrição de acesso do PDE, o único requisito é que os plug-ins em questão contenham um pacote configurável OSGi MANIFEST.MF. O PDE cuidará do restante, incluindo o gerenciamento do caminho de classe do plug-in.

Se o plug-in não contiver um arquivo MANIFEST.MF, esse arquivos podem ser criados da seguinte forma:

  1. Abra o plugin.xml no editor de manifesto de plug-ins.
  2. Na seção Conteúdo do Plug-in da página Visão Geral, clique no link 'criar um manifesto de pacote configurável do OSGi'.

converte para manifest.mf

Inspecionando Regras de Acesso

É possível inspecionar as regras de restrição de acesso impostas em cada caminho de classe pelo PDE na página de propriedade Caminho de Construção Java do projeto do plug-in.

Propriedades de Caminho de Construção Java

Referência relacionada

Editor de Plug-in
Página de visão geral
Página de dependências
Página de tempo de execução
Página de extensões
Página de pontos de extensão
Página de construção