Regras de acesso

O tempo de execução do Eclipse 3.1 faculta ao programador a opção de controlar, pacote a pacote, a visibilidade do código do plug-in perante plug-ins em sentido descendente.

Um pacote poderá estar classificado da seguinte forma:

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

O PDE converte estas regras de visibilidade de tempo de execução em regras de restrição de acessos de compilador, no momento da compilação. Como consequência, a violação de uma regra de visibilidade é sinalizada pelo compilador sob a forma de aviso ou de erro - dependendo da gravidade da violação.

Utilizando este tipo de suporte em tempo de compilação, nunca será surpreendido por erros de carregamento de classes em tempo de execução e estará sempre alerta ao referenciar tipos internos.

Pacotes Acessíveis

Os pacotes acessíveis estão visíveis perante plug-ins em sentido descendente incondicionalmente.  Embora todos os pacotes de API devam recair claramente nesta categoria, compete ao programador decidir que outros pacotes exportados pelo plug-in devem receber este nível de visibilidade.

Para declarar um pacote como acessível, tem de listá-lo na secção Pacotes exportados no Tempo de execução do editor de ficheiros manifest de plug-ins e deixe a predefinição de visibilidade tal como está.

Pacotes acessíveis

 

Pacotes Proibidos

Pode ocultar um pacote dos plug-ins em sentido descendente sempre excluindo-o da lista na secção Pacotes exportados na página Tempo de execução do editor de ficheiros manifest de plug-ins.

Faz referências a tipos de um resultado de pacote proibido em erros de carregamento de classes no tempo de execução.

Para evitar tais situações inconvenientes:

  1. O compilador irá sinalizar referências a pacotes proibidos com um erro.
  2. Os tipos oriundos de pacotes proibidos NÃO estão disponíveis na assistência a conteúdos.

Notas:

  1. Todos os plug-ins no Eclipse SDK enumeram todos os pacotes na secção Pacotes exportados; por conseguinte, nenhum dos pacotes no SDK tem acesso proibido.
  2. O nível de gravidade para referências proibidas é definido na página de preferências Open problem severities preference page Java > Compilador > Erros/Avisos > API obsoleta e restrita.

    Recomenda-se vivamente que a gravidade de uma referência proibida seja mantida no erro.

Preferências proibidas

Pacotes Internos

Os pacotes internos são aqueles que não se destinam a utilização por parte de plug-ins em sentido descendente. Estes pacotes estão visíveis para plug-ins em sentido descendente porpredefinição.

Os pacotes internos são ocultos dos plug-ins em sentido descendente apenas quando o Eclipse é iniciado no modo restrito (isto é, quando inicia com o argumento da VM -Dosgi.resolverMode=strict).

Os pacotes internos têm de ser listados na secção Pacotes exportados na página Tempo de execução do editor de ficheiros manifest de plug-ins com a opção oculto seleccionada.

acesso desencorajado

Foram tomadas duas medidas para desencorajar plug-ins em sentido descendente de referenciarem pacotes internos:

acesso desencorajado

assistência a conteúdo desencorajada

O nível de gravidade para referências desaconselhadas pode ser definido na página de preferências Abrir página de preferências da gravidade dos problemas Java > Compilador > Erros/Avisos> API obsoleta e restrita.

Preferências desencorajadas

Pacotes internos com amigos

É importante para um plug-in conseguir conceder acesso integral aos pacotes internos para plug-ins designados como "amigos". Por exemplo, o código PDE é dividido entre vários plug-ins e o plug-in org.eclipse.pde.ui deve ter acesso integral a pacotes internos de org.eclipse.pde.core.

No exemplo em baixo, o plug-in org.eclipse.pde.ui amigo 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 de referenciar qualquer tipo oriundo do pacote org.eclipse.pde.internal.core.bundle com a aprovação do compilador.

Por outro lado, se qualquer outro plug-in fizer referência a um tipo a partir do pacote org.eclipse.pde.internal.core.bundle, o compilador sinalizar a referência como referência desencorajada, conforme descrito na secção anterior.

Como activar restrições de acesso

Para tirar partido do suporte de restrição de acesso de PDE, o único requisito é que os plug-ins em questão contenham um agrupamento OSGi MANIFEST.MF. O PDE irá encarregar-se dos restantes procedimentos, incluindo a gestão do caminho da classe do plug-in.

Se o plug-in não contém um ficheiro MANIFEST.MF, esse ficheiro pode ser criado como se segue:

  1. Abra o plugin.xml no editor de ficheiros manifest de plug-ins.
  2. Na secção Conteúdo de plug-in da página Descrição geral, faça clique na ligação 'criar um ficheiro manifest de lote OSGi'.

converter para manifest.mf

Inspeccionar regras de acesso

Poderá inspeccionar as regras de restrição de acesso impostas a cada entrada de caminho de classes pelo PDE na página de propriedades Caminho de Construção Java do projecto de plug-in.

Propriedades de caminho de construção Java

Referência relacionada

Editor de Plug-in
Página Descrição geral
Página Dependências
Página Tempo de execução
Página Extensões
Página Pontos de Extensão
Página Construir