Show Menu
TEMAS×

Usar los adaptadores de Sling

Sling oferta un patrón Adapter para traducir convenientemente objetos que implementan la interfaz Adaptable . Esta interfaz proporciona un método adaptableTo() genérico que traducirá el objeto al tipo de clase que se pasa como argumento.
Por ejemplo, para traducir un objeto Resource al objeto Node correspondiente, simplemente puede hacer lo siguiente:
Node node = resource.adaptTo(Node.class);

Use Cases

Existen los siguientes casos de uso:
  • Obtenga objetos específicos de la implementación.
    Por ejemplo, una implementación basada en JCR de la Resource interfaz genérica proporciona acceso al JCR subyacente Node .
  • Creación de accesos directos de objetos que requieren que se pasen objetos de contexto internos.
    Por ejemplo, la aplicación basada en JCR ResourceResolver contiene una referencia al JCR Session de la solicitud, que a su vez es necesaria para muchos objetos que funcionarán en función de esa sesión de solicitud, como el PageManager o UserManager .
  • Acceso directo a servicios.
    Un caso raro - sling.getService() también es simple.

Valor devuelto nulo

adaptTo() puede devolver null.
Esto se debe a varios motivos, entre ellos:
  • la implementación no admite el tipo de destinatario
  • no está activo un generador de adaptador que maneje este caso (p. ej. debido a que faltan referencias de servicio)
  • error en la condición interna
  • el servicio no está disponible
Es importante que gestione el caso nulo con gracia. En el caso de las representaciones jsp, puede ser aceptable que el jsp falle si el resultado es un fragmento de contenido vacío.

Caching

Para mejorar el rendimiento, las implementaciones pueden almacenar en caché el objeto devuelto por una obj.adaptTo() llamada. Si el obj valor es el mismo, el objeto devuelto es el mismo.
Este almacenamiento en caché se realiza en todos los casos AdapterFactory basados.
Sin embargo, no hay ninguna regla general: el objeto puede ser una instancia nueva o una existente. Esto significa que no se puede confiar en ninguno de los comportamientos. Por lo tanto, es importante, especialmente dentro AdapterFactory , que los objetos se reutilicen en este escenario.

Cómo funciona

Existen varias maneras de Adaptable.adaptTo() implementarlas:
  • Por el objeto mismo; implementar el propio método y asignar a determinados objetos.
  • Por un AdapterFactory , que puede asignar objetos arbitrarios.
    Los objetos deben seguir implementando la Adaptable interfaz y extenderse SlingAdaptable (lo que pasa la adaptTo llamada a un administrador central de adaptadores).
    Esto permite enganchar el adaptTo mecanismo de las clases existentes, como Resource .
  • Una combinación de ambos.
En el primer caso, los javadocs pueden indicar lo que adaptTo-targets es posible. Sin embargo, para subclases específicas como el recurso basado en JCR, a menudo esto no es posible. En este último caso, las implementaciones de AdapterFactory suelen formar parte de las clases privadas de un paquete y, por lo tanto, no están expuestas en una API de cliente ni están enumeradas en javadocs. En teoría, sería posible acceder a todas AdapterFactory las implementaciones desde el tiempo de ejecución del servicio OSGi y observar sus configuraciones "adaptables" (fuentes y destinatarios), pero no asignarlas entre sí. Al final, esto depende de la lógica interna, que debe ser documentada. De ahí esta referencia.

Referencia

Sling

El recurso se adapta a:
Nodo Si se trata de un recurso basado en nodos JCR o una propiedad JCR que hace referencia a un nodo.
Propiedad Si se trata de un recurso basado en propiedades JCR.
Elemento Si se trata de un recurso basado en JCR (nodo o propiedad).
Asignar Devuelve un mapa de las propiedades, si se trata de un recurso basado en nodos JCR (u otro recurso que admita mapas de valores).
ValueMap Devuelve un mapa práctico de las propiedades, si se trata de un recurso basado en nodos JCR (u otros mapas de valores de soporte de recursos). También se puede lograr (más simplemente) utilizando ResourceUtil.getValueMap(Resource) (maneja mayúsculas y minúsculas nulas, etc.).
HerenciaValueMap Extensión de ValueMap que permite tener en cuenta la jerarquía de recursos al buscar propiedades.
ModifiedValueMap Extensión de ValueMap , que permite modificar las propiedades de ese nodo.
InputStream Devuelve el contenido binario de un recurso de archivo (si se trata de un recurso basado en nodos JCR y el tipo de nodo es nt:file o nt:resource ; si se trata de un recurso de paquete; contenido del archivo si se trata de un recurso del sistema de archivos) o los datos de un recurso de propiedad JCR binario.
URL Devuelve una URL al recurso (URL del repositorio de este nodo si se trata de un recurso basado en nodos JCR; jar URL del paquete si se trata de un recurso del paquete; URL de archivo si se trata de un recurso del sistema de archivos).
Archivo Si se trata de un recurso del sistema de archivos.
SlingScript Si este recurso es una secuencia de comandos (por ejemplo, un archivo jsp) para la que se ha registrado un motor de secuencias de comandos con sling.
Servlet Si este recurso es una secuencia de comandos (por ejemplo, un archivo jsp) para la que se ha registrado un motor de secuencias de comandos con sling o si se trata de un recurso servlet.
Cadena Booleano Largo Doble Calendario Value.htmlString.htmlBoolean.htmlLong.htmlCalendar.htmlValorString[]Boolean[][]Long[]Calendario[]Valor[]Value[] Devuelve los valores si se trata de un recurso basado en la propiedad JCR (y el valor se ajusta).
LabledResource Si se trata de un recurso basado en nodos JCR.
Página Si se trata de un recurso basado en nodos JCR y el nodo es cq:Page (o cq:PseudoPage ).
Componente Si se trata de un recurso cq:Component de nodo.
Diseño Si es un nodo de diseño ( cq:Page ).
Plantilla Si se trata de un recurso cq:Template de nodo.
Modelo Si se trata de un recurso cq:Template de nodo.
Recurso Si se trata de un recurso de nodo dam:Asset.
Representación Si se trata de una representación dam:Asset (nt:file en la carpeta de representación de un dam:Assert)
Etiqueta Si se trata de un recurso cq:Tag de nodo.
UserManager En función de la sesión JCR, si se trata de un recurso basado en JCR y el usuario tiene permisos para acceder a UserManager.
Con autorización Autorizable es la interfaz de base común para usuarios y grupos.
Usuario El usuario es un usuario con autorización especial que se puede autenticar y suplantar.
SimpleSearch Busca debajo del recurso (o utilice setSearchIn()) si se trata de un recurso basado en JCR.
WorkflowStatus Estado del flujo de trabajo para el nodo de carga útil de página/flujo de trabajo determinado.
ReplicationStatus Estado de replicación para el recurso dado o su subnodo jcr:content (marcado primero).
ConnectorResource Devuelve un recurso de conector adaptado para determinados tipos, si se trata de un recurso basado en nodos JCR.
Configuración Si se trata de un recurso cq:ContentSyncConfig de nodo.
ConfigEntry Si está debajo de un recurso cq:ContentSyncConfig de nodo.
ResourceResolver se adapta a:
Sesión La sesión JCR de la solicitud, si es una resolución de recursos basada en JCR (predeterminada).
PageManager  
ComponentManager  
Diseñador  
AssetManager En función de la sesión de JCR, si se trata de una resolución de recursos basada en JCR.
TagManager En función de la sesión de JCR, si se trata de una resolución de recursos basada en JCR.
UserManager UserManager proporciona acceso a los objetos autorizados, es decir, usuarios y grupos, y los medios para mantenerlos. UserManager está enlazado a una sesión en particular.
Con autorización El usuario actual.
Usuario El usuario actual.
QueryBuilder
Externalizador Para externalizar direcciones URL absolutas, incluso sin el objeto de solicitud.
Aún no hay destinatarios, pero implementa Adaptable y se puede usar como fuente en un AdapterFactory personalizado.
ContentHandler (XML) Si esta es una respuesta de reescritor inteligente.

WCM

La página se adapta a:
Medio Recurso de la página.
LabledResource Recurso etiquetado (== this).
Nodo Nodo de la página.
... Todo a lo que se puede adaptar el recurso de la página.
El componente se adapta a:
Recurso del componente.
Recurso etiquetado (== this).
Nodo del componente.
...
Todo a lo que se puede adaptar el recurso del componente.
La plantilla se adapta a:
Recurso Node.htmlRecurso de la plantilla.
LabledResource Recurso etiquetado (== this).
Nodo Nodo de esta plantilla.
... Todo a lo que se puede adaptar el recurso de la plantilla.

Seguridad

Autorizable , Usuario y Grupo se adaptan a:
Devuelve el nodo principal del usuario o grupo.
Devuelve el estado de replicación del nodo principal del usuario o grupo.

DAM

El recurso se adapta a:
Recurso del recurso.
Nodo del recurso.
...
Todo a lo que se puede adaptar el recurso del recurso.

Etiquetado

La etiqueta se adapta a:
Recurso de la etiqueta.
Nodo de la etiqueta.
...
Todo a lo que se puede adaptar el recurso de la etiqueta.

Otras

Además, Sling / JCR / OCM también proporciona un [AdapterFactory](https://sling.apache.org/site/adapters.html#Adapters-AdapterFactory) para objetos OCM ( Object Content Mapping ) personalizados.