Show Menu
TÓPICOS×

Uso de adaptadores Sling

O Sling oferece um padrão de adaptador para converter convenientemente objetos que implementam a interface adaptável . Essa interface fornece um método genérico adaptTo() que traduzirá o objeto para o tipo de classe que está sendo passado como argumento.
Por exemplo, para traduzir um objeto de Recurso para o objeto Nó correspondente, basta fazer o seguinte:
Node node = resource.adaptTo(Node.class);

Use Cases

Há os seguintes casos de uso:
  • Obtenha objetos específicos da implementação.
    Por exemplo, uma implementação baseada em JCR da interface genérica fornece acesso ao JCR subjacente Resource Node ."
  • Criação de atalhos de objetos que exigem a transmissão de objetos de contexto internos.
    Por exemplo, o JCR ResourceResolver contém uma referência ao JCR Session da solicitação, que por sua vez é necessária para muitos objetos que funcionarão com base na sessão da solicitação, como o PageManager ou UserManager .
  • Atalho para serviços.
    Um caso raro - sling.getService() também é simples.

Valor de retorno nulo

adaptTo() pode retornar nulo.
Há várias razões para isso, incluindo:
  • a implementação não suporta o tipo de alvo
  • um adaptador de fábrica que manuseia este caso não está ativo (por exemplo, devido a referências de serviço ausentes)
  • falha na condição interna
  • serviço não está disponível
É importante que você manipule a caixa nula com cuidado. Para renderizações jsp, pode ser aceitável que o jsp falhe se isso resultar em um conteúdo vazio.

Cache

Para melhorar o desempenho, as implementações podem armazenar em cache o objeto retornado de uma obj.adaptTo() chamada. Se o objeto obj for o mesmo, o objeto retornado será o mesmo.
Esse cache é executado para todos os casos AdapterFactory baseados.
No entanto, não há regra geral - o objeto pode ser uma nova instância ou uma existente. Isso significa que você não pode confiar em nenhum dos comportamentos. Assim, é importante, principalmente dentro AdapterFactory , que os objetos sejam reutilizáveis nesse cenário.

Como funciona

Há várias maneiras de Adaptable.adaptTo() implementar:
  • Pelo próprio objeto; implementação do próprio método e mapeamento para certos objetos.
  • Por um AdapterFactory ", que pode mapear objetos arbitrários.
    Os objetos ainda devem implementar a Adaptable interface e ser estendidos SlingAdaptable (o que passa a adaptTo chamada para um gerenciador central do adaptador).
    Isso permite que os ganchos entrem no adaptTo mecanismo para classes existentes, como Resource .
  • Uma combinação de ambos.
No primeiro caso, os javadocs podem dizer o que adaptTo-targets é possível. No entanto, para subclasses específicas, como o recurso baseado no JCR, isso geralmente não é possível. No último caso, as implementações de AdapterFactory são normalmente parte das classes privadas de um pacote e, portanto, não são expostas em uma API de cliente, nem listadas em javadocs. Teoricamente, seria possível acessar todas as AdapterFactory implementações a partir do tempo de execução do serviço OSGi e observar suas configurações "adaptáveis" (fontes e destinos), mas não mapeá-las umas às outras. Afinal, isso depende da lógica interna, que deve ser documentada. Daí essa referência.

Referência

Sling

O recurso se adapta a:
Se for um recurso baseado em nó JCR ou uma propriedade JCR que faça referência a um nó.
Propriedade Se este for um recurso baseado em propriedade JCR.
Item Se for um recurso baseado em JCR (nó ou propriedade).
Mapa Retorna um mapa das propriedades, se este for um recurso baseado em nós JCR (ou outros mapas de valor de suporte de recursos).
ValueMap Retorna um mapa conveniente das propriedades, se for um recurso baseado em nós JCR (ou outros mapas de valor de suporte de recursos). Também pode ser obtido (mais simples) usando ResourceUtil.getValueMap(Resource) (manipula letras maiúsculas e minúsculas, etc.).
InheritanceValueMap Extensão do ValueMap que permite que a hierarquia de recursos seja considerada ao procurar propriedades.
PersistableValueMap Se este for um recurso baseado em nó JCR e o usuário tiver permissões para modificar as propriedades nesse nó. Observação: vários mapas persistentes não compartilham seus valores.
InputStream Retorna o conteúdo binário de um "arquivo" nt:resource
AuthorizableResourceProvider org.apache.sling.jackrabbit.usermanager /system/userManager
cq:Page cq:PseudoPage
cq:Component
cq:Page
cq:Template
cq:Page
cq:Tag
cq:Preferences
cq:ContentSyncConfig
cq:ContentSyncConfig
O ResourceResolver adapta-se a:
Sessão A sessão JCR da solicitação, se for um resolvedor de recursos baseado em JCR (padrão).
PageManager
ComponentManager
Designer
AssetManager Com base na sessão JCR, se for um resolvedor de recursos baseado em JCR.
TagManager Com base na sessão JCR, se for um resolvedor de recursos baseado em JCR.
UserManager Com base na sessão JCR, se este for um resolvedor de recursos baseado em JCR e se o usuário tiver permissões para acessar o UserManager.
Autorizável O usuário atual.
Usuário O usuário atual.
PrivilegeManager
Preferências Preferências do usuário atual (com base na sessão JCR se for um resolvedor de recursos baseado em JCR).
PreferencesService
PinManager
QueryBuilder
Externalizador Para externalizar URLs absolutos, mesmo sem o objeto de solicitação.
Nenhum destino ainda, mas implementa Adaptável e pode ser usado como fonte em um AdapterFactory personalizado.
ContentHandler (XML) Se isso for uma resposta de um sling rewriter.

WCM

A página se adapta a:
Recurso Recurso da página.
LabelResource Recurso rotulado (== this).
Nó da página.
... Tudo ao qual o recurso da página pode ser adaptado.
O componente adapta-se a:
Recurso do componente.
Recurso rotulado (== this).
Nó do componente.
...
Tudo ao qual o recurso do componente pode ser adaptado.
O modelo adapta-se a:
Recurso Node.htmlRecurso do modelo.
LabelResource Recurso rotulado (== this).
Nó deste modelo.
... Tudo ao qual o recurso do modelo pode ser adaptado.

Segurança

Retorna o nó inicial do usuário/grupo.
Retorna o status de replicação do nó inicial do usuário/grupo.

DAM

O ativo se adapta a:
Recurso do ativo.
Nó do ativo.
...
Tudo ao qual o recurso do ativo pode ser adaptado.

Marcação com tags

A tag se adapta a:
Recurso da tag .
Nó da tag .
...
Tudo ao qual o recurso da tag pode ser adaptado.

Outro

Além disso, Sling / JCR / COM também fornece um [AdapterFactory](https://sling.apache.org/site/adapters.html#Adapters-AdapterFactory) para objetos MAC personalizados ( Object Content Mapping ).