Reglas de calidad de código personalizadas custom-code-quality-rules

Obtenga información sobre las reglas de calidad de código personalizadas de Cloud Manager, basadas en las prácticas recomendadas de ingeniería de Adobe Experience Manager, para garantizar un código de alta calidad mediante pruebas exhaustivas. Ver también pruebas de calidad del código.

Reglas de SonarQube sonarqube-rules

La siguiente sección detalla las reglas de SonarQube ejecutadas por Cloud Manager.

No utilizar funciones potencialmente peligrosas do-not-use-potentially-dangerous-functions

Los métodos Thread.stop() y Thread.interrupt() pueden ocasionar problemas difíciles de reproducir y, a veces, vulnerabilidades de seguridad. Su utilización debe ser objeto de un estricto seguimiento y validación. En general, transmitir mensajes es una manera más segura de lograr objetivos similares.

Código no conforme non-compliant-code

public class DontDoThis implements Runnable {
  private Thread thread;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    thread.stop();  // UNSAFE!
  }

  public void run() {
    while (true) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

Código conforme compliant-code

public class DoThis implements Runnable {
  private Thread thread;
  private boolean keepGoing = true;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    keepGoing = false;
  }

  public void run() {
    while (this.keepGoing) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

No usar cadenas de formato que puedan estar controladas externamente do-not-use-format-strings-which-may-be-externally-controlled

El uso de una cadena de formato de una fuente externa (como un parámetro de solicitud o contenido generado por el usuario) puede exponer una aplicación a ataques de denegación de servicio. Hay circunstancias en las que una cadena de formato puede estar controlada externamente, pero solo se permite desde fuentes de confianza.

Código no conforme non-compliant-code-1

protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) {
  String messageFormat = request.getParameter("messageFormat");
  request.getResource().getValueMap().put("some property", String.format(messageFormat, "some text"));
  response.sendStatus(HttpServletResponse.SC_OK);
}

Las solicitudes HTTP siempre deben tener tiempos de espera de conexión y socket http-requests-should-always-have-socket-and-connect-timeouts

Al realizar solicitudes HTTP dentro de una aplicación Experience Manager, es esencial configurar los tiempos de espera adecuados para evitar un consumo innecesario de subprocesos.
De forma predeterminada, tanto el cliente Java™ HTTP (java.net.HttpUrlConnection) como el cliente Apache HTTP Components, ampliamente utilizado, no imponen tiempos de espera, por lo que deben configurarse manualmente. Como práctica recomendada, los tiempos de espera deben establecerse en 60 segundos o menos.

Código no conforme non-compliant-code-2

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void dontDoThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  HttpClient httpClient = builder.build();

  // do something with the client
}

public void dontDoThisEither() {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

Código conforme compliant-code-1

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void doThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000)
    .setSocketTimeout(5000)
    .build();
  builder.setDefaultRequestConfig(requestConfig);

  HttpClient httpClient = builder.build();

  // do something with the client
}

public void orDoThis () {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();
  urlConnection.setConnectTimeout(5000);
  urlConnection.setReadTimeout(5000);

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

Cerrar siempre objetos ResourceResolver resourceresolver-objects-should-always-be-closed

Los objetos ResourceResolver obtenidos de ResourceResolverFactory consumen recursos del sistema. Aunque existen medidas para recuperar estos recursos cuando un objeto ResourceResolver ya no está en uso, es más eficaz cerrar explícitamente cualquier objeto ResourceResolver abierto invocando la función método close().

Una idea errónea común es que ResourceResolver objetos creados con una sesión de JCR existente no deben cerrarse explícitamente o que cerrarlos afecta a la sesión de JCR. Esta información es incorrecta. Un(a) ResourceResolver siempre se debe cerrar cuando ya no se necesita. Dado que ResourceResolver implementa la interfaz Closeable, también puede usar la sintaxis try-with-resources en lugar de llamar directamente a close().

Código no conforme non-compliant-code-4

public void dontDoThis(Session session) throws Exception {
  ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
  // do some stuff with the resolver
}

Código conforme compliant-code-2

public void doThis(Session session) throws Exception {
  ResourceResolver resolver = null;
  try {
    resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
    // do something with the resolver
  } finally {
    if (resolver != null) {
      resolver.close();
    }
  }
}

public void orDoThis(Session session) throws Exception {
  try (ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object) session))){
    // do something with the resolver
  }
}

No utilizar las rutas del servlet de Sling para registrar servlets do-not-use-sling-servlet-paths-to-register-servlets

Como se describe en la Documentación de Sling, se desaconseja enlazar los servlets por rutas. Los servlets enlazados a rutas no pueden utilizar controles de acceso JCR estándar y, como resultado, requieren un rigor de seguridad adicional. En lugar de utilizar servlets enlazados a rutas, se recomienda crear nodos en el repositorio y registrar servlets por tipo de recurso.

Código no conforme non-compliant-code-5

@Component(property = {
  "sling.servlet.paths=/apps/myco/endpoint"
})
public class DontDoThis extends SlingAllMethodsServlet {
 // implementation
}

Las excepciones capturadas deben registrarse o activarse, no ambas caught-exceptions-should-be-logged-or-thrown-but-not-both

En general, una excepción debe registrarse exactamente una vez. El registro de excepciones varias veces puede causar confusión. El motivo es que no está claro cuántas veces se produjo una excepción. El patrón más común que produce este efecto es registrar y producir una excepción capturada.

Código no conforme non-compliant-code-6

public void dontDoThis() throws Exception {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
    throw e;
  }
}

Código conforme compliant-code-3

public void doThis() {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
  }
}

public void orDoThis() throws MyCustomException {
  try {
    someOperation();
  } catch (Exception e) {
    throw new MyCustomException(e);
  }
}

Evitar las instrucciones de registro seguidas inmediatamente por las sentencias de lanzamiento avoid-having-a-log-statement-immediately-followed-by-a-throw-statement

Otro patrón común que se debe evitar es registrar un mensaje y luego iniciar inmediatamente una excepción. Esta práctica generalmente indica que el mensaje de excepción termina duplicado en los archivos de registro.

Código no conforme non-compliant-code-7

public void dontDoThis() throws Exception {
  logger.error("something went wrong");
  throw new RuntimeException("something went wrong");
}

Código conforme compliant-code-4

public void doThis() throws Exception {
  throw new RuntimeException("something went wrong");
}

Evitar iniciar sesión en la información al gestionar solicitudes GET o HEAD avoid-logging-at-info-when-handling-get-or-head-requests

En general, el nivel de registro INFO debe utilizarse para demarcar acciones importantes y, de forma predeterminada, Experience Manager está configurado para registrar a nivel INFO o superior. Los métodos GET y HEAD solo deben ser operaciones de solo lectura y, por lo tanto, no constituyen acciones importantes. Es probable que el registro en el nivel INFO como respuesta a solicitudes de GET o HEAD cree un ruido de registro significativo, lo que dificulta la identificación de información útil en los archivos de registro. Al administrar solicitudes de GET o HEAD, inicie sesión en los niveles WARN o ERROR si algo ha salido mal. Utilice los niveles DEBUG o TRACE si necesita información detallada sobre la solución de problemas.

Código no conforme non-compliant-code-8

public void doGet() throws Exception {
  logger.info("handling a request from the user");
}

Código conforme compliant-code-5

public void doGet() throws Exception {
  logger.debug("handling a request from the user.");
}

No usar Exception.getMessage() como primer parámetro de un enunciado de registro do-not-use-exception-getmessage-as-the-first-parameter-of-a-logging-statement

Como práctica recomendada, los mensajes de registro deben proporcionar información contextual sobre dónde se ha producido una excepción en la aplicación. Aunque el contexto también se puede determinar mediante el uso de trazos de pila, en general, el mensaje de registro será más fácil de leer y comprender. Como resultado, al registrar una excepción, es una mala práctica utilizar el mensaje de la excepción como mensaje de registro. El mensaje de excepción explica qué ha fallado, mientras que el mensaje de registro debe informar al lector sobre qué estaba haciendo la aplicación cuando se produjo la excepción. El mensaje de excepción se sigue registrando. Al especificar su propio mensaje, los registros son más fáciles de entender.

Código no conforme non-compliant-code-9

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error(e.getMessage(), e);
  }
}

Código conforme compliant-code-6

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

El registro en bloques de captura debe estar en el nivel WARN o ERROR logging-in-catch-blocks-should-be-at-the-warn-or-error-level

Como sugiere el nombre, las excepciones de Java™ siempre deben usarse en circunstancias excepcionales. Como resultado, cuando se captura una excepción, es importante asegurarse de que los mensajes de registro se registren en el nivel adecuado, WARN o ERROR. Este proceso garantiza que esos mensajes aparezcan correctamente en los registros.

Código no conforme non-compliant-code-10

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.debug(e.getMessage(), e);
  }
}

Código conforme compliant-code-7

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

No imprimir trazos de pila en la consola do-not-print-stack-traces-to-the-console

Como se ha mencionado, el contexto es fundamental para comprender los mensajes de registro. El uso de Exception.printStackTrace() hace que solo el trazo de pila se envíe al flujo de error estándar, lo que provoca que se pierda todo el contexto. Además, en una aplicación multiproceso como Experience Manager, si se imprimen varias excepciones mediante este método en paralelo, sus trazos de pila pueden superponerse, lo que produce una confusión significativa. Las excepciones solo deben registrarse en el marco de registro.

Código no conforme non-compliant-code-11

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    e.printStackTrace();
  }
}

Código conforme compliant-code-8

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

No enviar a salida estándar o error estándar do-not-output-to-standard-output-or-standard-error

El inicio de sesión de Experience Manager siempre se debe realizar mediante el marco de trabajo de registro (SLF4J). La salida directa a los flujos de error estándar o de salida estándar pierde la información estructural y contextual proporcionada por el marco de trabajo de registro. A veces, puede causar problemas de rendimiento.

Código no conforme non-compliant-code-12

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    System.err.println("Unable to do something");
  }
}

Código conforme compliant-code-9

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

Evite las rutas de aplicaciones y bibliotecas codificadas avoid-hardcoded-apps-and-libs-paths

Las rutas que comienzan por /libs y /apps generalmente no deberían estar codificadas. Estas rutas generalmente se almacenan en relación con la ruta de búsqueda de Sling, que tiene el valor predeterminado /libs,/apps. El uso de la ruta absoluta puede introducir defectos sutiles que solo aparecerían más adelante en el ciclo de vida del proyecto.

Código no conforme non-compliant-code-13

public boolean dontDoThis(Resource resource) {
  return resource.isResourceType("/libs/foundation/components/text");
}

Código conforme compliant-code-10

public void doThis(Resource resource) {
  return resource.isResourceType("foundation/components/text");
}

El planificador de Sling no debe utilizarse sonarqube-sling-scheduler

El planificador de Sling no debe utilizarse para tareas que requieren una ejecución garantizada. Los trabajos programados de Sling garantizan la ejecución y son más adecuados para los entornos agrupados y no agrupados.

Consulte la Documentación sobre eventos de Apache Sling y gestión de trabajos para obtener más información acerca de cómo se administran los trabajos de Sling en entornos agrupados.

Las API en desuso de Experience Manager no deben usarse sonarqube-aem-deprecated

La superficie de la API de Experience Manager está en constante revisión para identificar las API para las que se desaconseja el uso y que, por lo tanto, se consideran en desuso.

A menudo, estas API están en desuso al utilizar la anotación @Deprecated de Java™ estándar y, como tal, identificada por squid:CallToDeprecatedMethod.

Sin embargo, hay casos en los que una API está en desuso en el contexto de Experience Manager, pero puede que no en otros contextos. Esta regla identifica esta segunda clase.

No utilice anotaciones @Inject con @Optional en modelos Sling sonarqube-slingmodels-inject-optional

El proyecto de Apache Sling desaconseja el uso de la anotación @Inject en el contexto de los modelos Sling, ya que puede provocar un mal rendimiento cuando se combina con DefaultInjectionStrategy.OPTIONAL (ya sea en el nivel de campo o de clase). En su lugar, se deben utilizar inyecciones más específicas (como las anotaciones @ValueMapValue o @OsgiInjector).

Consulte la Documentación de Apache Sling para obtener más información acerca de las anotaciones recomendadas y por qué se hizo esta recomendación en primer lugar.

Reutilización de instancias de un HTTPClient sonarqube-reuse-httpclient

AEM Las aplicaciones de Apache suelen conectarse con otras aplicaciones mediante el protocolo HTTP y Apache HttpClient es una biblioteca que se utiliza a menudo para lograr este fin. Sin embargo, la creación de este tipo de objeto HttpClient conlleva cierta sobrecarga, por lo que estos objetos deben reutilizarse en la medida de lo posible.

Esta regla comprueba que un objeto HttpClient de este tipo no es privado dentro de un método, sino global en un nivel de clase, por lo que se puede reutilizar. En este caso, el campo HttpClient debe establecerse en el constructor de la clase o el método activate() (si esta clase es un componente o servicio OSGi).

Consulte la Guía de optimización de HttpClient para conocer algunas prácticas recomendadas sobre el uso de HttpClient.

Código no conforme non-compliant-code-14

public void doHttpCall() {
  HttpClient httpclient = HttpClients.createDefault();
  // do something with the httpclient
}

Código conforme compliant-code-11

public class myClass {

  HttpClient httpclient;

  public void doHttpCall() {
    // do something with the httpclient
  }

}

Reglas de contenido OakPAL oakpal-rules

La siguiente sección detalla las comprobaciones OakPAL ejecutadas por Cloud Manager.

Los clientes no deben implementar ni ampliar las API de producto anotadas con @ProviderType product-apis-annotated-with-providertype-should-not-be-implemented-or-extended-by-customers

La API de Experience Manager contiene interfaces y clases de Java™, que solo están pensadas para utilizarse, pero no para implementarse, mediante código personalizado. Por ejemplo, solo el Experience Manager debe implementar la interfaz com.day.cq.wcm.api.Page.

Cuando se agregan nuevos métodos a estas interfaces, esos métodos adicionales no afectan al código existente que utiliza estas interfaces. Como resultado, la adición de nuevos métodos a estas interfaces se considera compatible con versiones anteriores. Sin embargo, si el código personalizado implementa una de estas interfaces, dicho código personalizado ha introducido un riesgo de compatibilidad con versiones anteriores para el cliente.

Las interfaces y clases, implementadas por Experience Manager, están anotadas con org.osgi.annotation.versioning.ProviderType o, a veces, una anotación heredada similar aQute.bnd.annotation.ProviderType. Esta regla identifica los casos en los que el código personalizado implementa una interfaz de este tipo o amplía una clase.

Código no conforme non-compliant-code-3

import com.day.cq.wcm.api.Page;

public class DontDoThis implements Page {
// implementation here
}

Los índices personalizados de Lucene Oak deben tener una configuración de Tika oakpal-indextikanode

Múltiples índices de Oak de Experience Manager listos para usar incluyen una configuración de Tika y las personalizaciones de estos índices deben incluirla. Esta regla comprueba las personalizaciones de los índices damAssetLucene, lucene y graphqlConfig generan un problema si el nodo tika falta o el nodo tika no tiene un nodo secundario llamado config.xml.

Consulte la documentación de indexación para obtener más información sobre la personalización de definiciones de índice.

Código no conforme non-compliant-code-indextikanode

+ oak:index
    + damAssetLucene-1-custom
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene

Código conforme compliant-code-indextikanode

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Los índices personalizados de Lucene Oak no deben ser sincrónicos oakpal-indexasync

Los índices Oak del tipo lucene siempre deben estar indexado asincrónicamente. Si no lo hace, puede causar inestabilidad en el sistema. Encontrará más información sobre la estructura de los índices Lucene en la documentación de Oak.

Código no conforme non-compliant-code-indexasync

+ oak:index
    + damAssetLucene-1-custom
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      - tags: [visualSimilaritySearch]
      + tika
        + config.xml

Código conforme compliant-code-indexasync

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Los índices personalizados de recursos DAM de Lucene Oak están correctamente estructurados oakpal-damAssetLucene-sanity-check

Para que la búsqueda de recursos funcione correctamente en Experience Manager Assets, las personalizaciones del índice Oak damAssetLucene deben seguir un conjunto de directrices específicas de este índice. Esta regla comprueba que la definición de índice debe tener una propiedad de varios valores denominada tags, que contiene el valor visualSimilaritySearch.

Código no conforme non-compliant-code-damAssetLucene

+ oak:index
    + damAssetLucene-1-custom
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      + tika
        + config.xml

Código conforme compliant-code-damAssetLucene

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Los paquetes de clientes no deben crear ni modificar nodos en bibliotecas oakpal-customer-package

Una práctica recomendada clásica es que el árbol de contenido /libs en el repositorio de contenido de Experience Manager debe considerarse de solo lectura por los clientes. Modificar nodos y propiedades en /libs crea un riesgo significativo para las actualizaciones principales y secundarias. Use el Adobe, a través de los canales oficiales, para realizar modificaciones en /libs.

Los paquetes no deben contener configuraciones OSGi duplicadas oakpal-package-osgi

Un problema frecuente que ocurre en proyectos complejos es que el propio componente OSGi se configura varias veces. Este problema crea una ambigüedad sobre la configuración que se aplicará. Esta regla es “según el modo de ejecución”, ya que solo identifica problemas en los que el mismo componente se haya configurado varias veces en el mismo modo de ejecución o combinación de modos de ejecución.

Código no conforme non-compliant-code-osgi

+ apps
  + projectA
    + config
      + com.day.cq.commons.impl.ExternalizerImpl
  + projectB
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

Código conforme compliant-code-osgi

+ apps
  + shared-config
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

Las carpetas de configuración e instalación solo deben contener nodos OSGi oakpal-config-install

Por motivos de seguridad, las rutas que contienen /config/ y /install/ solo pueden leerlas los usuarios administrativos de Experience Manager y solo deben utilizarse para la configuración OSGi y los paquetes OSGi. Colocar otros tipos de contenido en rutas que contengan estos segmentos hace que el comportamiento de la aplicación difiera entre usuarios administrativos y no administrativos de forma involuntaria.

Un problema común es el uso de nodos llamados config en los cuadros de diálogo de componentes o al especificar la configuración del editor de texto enriquecido para la edición en línea. Para resolver este problema, se debe cambiar el nombre del nodo infractor por uno conforme. Para la configuración del editor de texto enriquecido, utilice la propiedad configPath en el nodo cq:inplaceEditing para especificar la nueva ubicación.

Código no conforme non-compliant-code-config-install

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    + config [nt:unstructured]
      + rtePlugins [nt:unstructured]

Código conforme compliant-code-config-install

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    ./configPath = inplaceEditingConfig (String)
    + inplaceEditingConfig [nt:unstructured]
      + rtePlugins [nt:unstructured]

Los paquetes no deben superponerse oakpal-no-overlap

Similar a la regla Los paquetes no deben contener configuraciones OSGi duplicadas, esta situación es un problema común en proyectos complejos en los que la misma ruta de acceso de nodo se escribe en varios paquetes de contenido independientes. Aunque el uso de dependencias de paquetes de contenido se puede utilizar para garantizar un resultado coherente, es mejor evitar las superposiciones por completo.

El modo de creación predeterminado no debe ser la IU clásica oakpal-default-authoring

La configuración OSGi com.day.cq.wcm.core.impl.AuthoringUIModeServiceImpl define el modo de creación predeterminado en Experience Manager. Dado que la IU clásica ha quedado en desuso desde Experience Manager 6.4, ahora se genera un problema cuando el modo de creación predeterminado esté configurado en la IU clásica.

Los componentes con cuadros de diálogo deben tener cuadros de diálogo de IU táctil oakpal-components-dialogs

Los componentes del Experience Manager que tengan un cuadro de diálogo de IU clásica siempre deben tener un cuadro de diálogo de IU táctil correspondiente. Ambos ofrecen una experiencia de creación óptima compatible con el modelo de implementación de Cloud Service, donde la IU clásica ya no es compatible. Esta regla verifica los siguientes escenarios:

La documentación de Herramientas de modernización de Experience Manager proporciona documentación y herramientas para convertir componentes de la IU clásica a la IU táctil. Consulte la documentación de Herramientas de modernización de Experience Manager para obtener más información.

Los paquetes no deben mezclar contenido mutable e inmutable oakpal-packages-immutable

Para que sean compatibles con el modelo de implementación de Cloud Service, los paquetes de contenido individuales deben incluir contenido para las áreas inmutables del repositorio (/apps y /libs) o el área modificable (todo lo que no está en /apps o /libs), pero no ambas. Por ejemplo, un paquete que incluye /apps/myco/components/text y /etc/clientlibs/myco no es compatible con el Cloud Service y causa que se informe de un problema.

Consulte Documentación de la estructura del proyecto de Experience Manager para obtener más información.

No utilizar agentes de replicación inversa oakpal-reverse-replication

El soporte para la replicación inversa no está disponible en las implementaciones de Cloud Service, tal como se describe como parte de las notas de la versión de Experience Manager as a Cloud Service.

Los clientes que utilizan la replicación inversa deben ponerse en contacto con Adobe para obtener soluciones alternativas.

Los recursos contenidos en las bibliotecas cliente habilitadas para proxy deben estar en una carpeta denominada Recursos oakpal-resources-proxy

Las bibliotecas de cliente de Experience Manager pueden contener recursos estáticos como imágenes y fuentes. Como se describe en el documento Uso de preprocesadores, cuando se usan bibliotecas cliente proxy, estos recursos estáticos deben estar contenidos en una carpeta secundaria denominada resources para que se haga referencia de forma efectiva en las instancias de publicación.

Código no conforme non-compliant-proxy-enabled

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + images
        + myimage.jpg

Código conforme compliant-proxy-enabled

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + resources
        + myimage.jpg

Uso de procesos de flujo de trabajo incompatibles con Cloud Service oakpal-usage-cloud-service

Con el cambio a los microservicios de recursos para el procesamiento de recursos en Adobe Experience Manager as a Cloud Service, ya no se admiten varios procesos de flujo de trabajo utilizados en versiones locales y de AMS. Muchos de estos flujos de trabajo también se han vuelto innecesarios.

La herramienta de migración en el Repositorio de GitHub de Experience Manager as a Cloud Service Assets se puede utilizar para actualizar modelos de flujo de trabajo durante la migración a Experience Manager as a Cloud Service.

No se recomienda el uso de plantillas estáticas en lugar de plantillas editables oakpal-static-template

Si bien el uso de plantillas estáticas siempre ha sido muy común en proyectos de Experience Manager, Adobe recomienda el uso de plantillas editables, ya que proporcionan la mayor flexibilidad y admiten funciones adicionales que no están presentes en las estáticas. Encontrará más información en el documento Plantillas de páginas.

La migración de plantillas estáticas a editables se puede automatizar en gran medida mediante Herramientas de modernización de Experience Manager.

Se desaconseja el uso de componentes de base heredados oakpal-usage-legacy

Los componentes de base heredados (es decir, los componentes de /libs/foundation) se han quedado obsoletos para varias versiones de Experience Manager en favor de los componentes principales. Se desaconseja el uso de los componentes de base como base para los componentes personalizados (ya sea por superposición o por herencia) y se debe convertir a los componentes principales correspondientes.

Herramientas de modernización de Experience Manager pueden facilitar esta conversión.

Usar solo nombres y órdenes de modo de ejecución admitidos oakpal-supported-runmodes

Experience Manager as a Cloud Service aplica una estricta directiva de nomenclatura para los nombres de los modos de ejecución y un orden estricto para ellos. La lista de modos de ejecución admitidos se encuentra en el documento Implementación en el as a Cloud Service Experience Manager y cualquier desviación de esta lista se identifica como un problema.

Los nodos de definición de índice de búsqueda personalizada deben ser tareas secundarias directas de /oak:index oakpal-custom-search

Experience Manager as a Cloud Service requiere que las definiciones de índice de búsqueda personalizadas (es decir, nodos de tipo oak:QueryIndexDefinition) sean nodos secundarios directos de /oak:index. Los índices de otras ubicaciones deben moverse para que sean compatibles con Experience Manager as a Cloud Service. Encontrará más información sobre los índices de búsqueda en el documento Búsqueda de contenido e indexación.

Los nodos de definición de índice de búsqueda personalizada deben tener una compatVersion de 2 oakpal-custom-search-compatVersion

Experience Manager as a Cloud Service requiere que las definiciones de índice de búsqueda personalizadas (como nodos de tipo oak:QueryIndexDefinition) tengan la propiedad compatVersion establecida en 2. Adobe Experience Manager as a Cloud Service no admite ningún otro valor. Consulte Búsqueda e indexación de contenido para obtener más información sobre los índices de búsqueda.

Los nodos descendientes de los nodos de definición de índice de búsqueda personalizada deben ser de tipo nt:unstructured

Pueden producirse problemas difíciles de solucionar cuando un nodo de definición de índice de búsqueda personalizada tiene nodos secundarios sin ordenar. Para evitar esta situación, se recomienda que todos los nodos descendientes de un nodo oak:QueryIndexDefinition sean de tipo nt:unstructured.

Los nodos de definición de índice de búsqueda personalizada deben contener un nodo secundario denominado indexRules que tenga tareas secundarias. oakpal-custom-search-index

Un nodo de definición de índice de búsqueda personalizada definido correctamente debe contener un nodo secundario denominado indexRules, que a su vez debe tener al menos un secundario. Puede encontrar más información en la documentación de Oak.

Los nodos de definición de índices de búsqueda personalizada deben seguir las convenciones de nombres oakpal-custom-search-definitions

Experience Manager as a Cloud Service requiere que las definiciones de índice de búsqueda personalizadas (es decir, nodos de tipo oak:QueryIndexDefinition) tengan un nombre que siga un patrón específico descrito en el documento Búsqueda e indexación de contenido.

Los nodos de definición de índice de búsqueda personalizada deben utilizar el tipo de índice Lucene oakpal-index-type-lucene

Experience Manager as a Cloud Service requiere que las definiciones de índice de búsqueda personalizadas (es decir, nodos de tipo oak:QueryIndexDefinition) tengan una propiedad type con el valor establecido en lucene. La indexación con tipos de índice heredados debe actualizarse antes de la migración a Experience Manager as a Cloud Service. Consulte la Documentación de búsqueda de contenido e indexación para obtener más información.

Los nodos de definición de índice de búsqueda personalizada no deben contener una propiedad denominada Semilla oakpal-property-name-seed

Experience Manager as a Cloud Service prohíbe que las definiciones de índice de búsqueda personalizadas (es decir, los nodos de tipo oak:QueryIndexDefinition) contengan una propiedad denominada seed. La indexación que utiliza esta propiedad debe actualizarse antes de la migración a Experience Manager as a Cloud Service. Consulte el documento Búsqueda de contenido e indexación para obtener más información.

Los nodos de definición de índice de búsqueda personalizada no deben contener una propiedad denominada “reindex” oakpal-reindex-property

Experience Manager as a Cloud Service prohíbe que las definiciones de índice de búsqueda personalizadas (es decir, los nodos de tipo oak:QueryIndexDefinition) contengan una propiedad denominada reindex. La indexación que utiliza esta propiedad debe actualizarse antes de migrar a Experience Manager como
Cloud Service. Consulte el documento Búsqueda de contenido e indexación para obtener más información.

Los nodos lucene del recurso DAM personalizado no deben especificar queryPaths oakpal-damAssetLucene-queryPaths

Código no conforme non-compliant-code-damAssetLucene-queryPaths

+ oak:index
    + damAssetLucene-1-custom-1
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - queryPaths: [/content/dam]
      - type: lucene
      + tika
        + config.xml

Código conforme compliant-code-damAssetLucene-queryPaths

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Si la definición del índice de búsqueda personalizada contiene compatVersion, debe establecerse en 2 oakpal-compatVersion

El nodo de índice que especifica includedPaths también debe especificar queryPaths con los mismos valores oakpal-included-paths-without-query-paths

Para los índices personalizados, configure includedPaths y queryPaths con valores idénticos. Si se especifica uno, el otro debe coincidir con él. Sin embargo, hay un caso especial para los índices de damAssetLucene, incluidas sus versiones personalizadas. Para estos casos, proporcione solamente includedPaths.

El nodo de índice que especifica nodeScopeIndex en el tipo de nodo genérico también debe especificar includedPaths y queryPaths oakpal-full-text-on-generic-node-type

Al establecer la propiedad nodeScopeIndex en un tipo de nodo "genérico" como nt:unstructured o nt:base, también debe especificar las propiedades includedPaths y queryPaths.
El tipo de nodo nt:base puede considerarse "genérico", ya que todos los tipos de nodo heredan de él. Por lo tanto, al establecer un nodeScopeIndex en nt:base, se indexan todos los nodos del repositorio. Del mismo modo, nt:unstructured también se considera "genérico", ya que hay muchos nodos en repositorios de este tipo.

Código no conforme non-compliant-code-full-text-on-generic-node-type

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

Código conforme compliant-code-full-text-on-generic-node-type

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
  - includedPaths: ["/content/dam/"]
  - queryPaths: ["/content/dam/"]
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

La propiedad queryLimitReads del motor de consulta no se debe anular oakpal-query-limit-reads

Anular el valor predeterminado puede llevar a lecturas de página lentas, especialmente cuando se agrega más contenido.

Varias versiones activas del mismo índice oakpal-multiple-active-versions

Código no conforme non-compliant-code-multiple-active-versions

+ oak:index
  + damAssetLucene-1-custom-1
    ...
  + damAssetLucene-1-custom-2
    ...
  + damAssetLucene-1-custom-3
    ...

Código conforme compliant-code-multiple-active-versions

+ damAssetLucene-1-custom-3
    ...

El nombre de las definiciones de índice totalmente personalizadas debe ajustarse a las directrices oficiales oakpal-fully-custom-index-name

El patrón esperado para los nombres de índice totalmente personalizados es: [prefix].[indexName]-custom-[version]. Encontrará más información en el documento Búsqueda de contenido e indexación.

La misma propiedad con diferentes valores analizados en la misma definición de índice oakpal-same-property-different-analyzed-values

Código no conforme non-compliant-code-same-property-different-analyzed-values

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status

Código conforme compliant-code-same-property-different-analyzed-values

Ejemplo:

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

Ejemplo:

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

Si la propiedad analizada no se establece explícitamente, su valor predeterminado es false.

Propiedad Tags tags-property

Para índices específicos, asegúrese de conservar la propiedad de etiquetas y sus valores actuales. Aunque se pueden agregar nuevos valores a la propiedad de etiquetas, la eliminación de los existentes (o de la propiedad por completo) puede producir resultados inesperados.

Los nodos de definición de índice no deben implementarse en el paquete de contenido de la IU oakpal-ui-content-package

AEM Cloud Service prohíbe que las definiciones de índice de búsqueda personalizadas (nodos de tipo oak:QueryIndexDefinition) se implementen en el paquete de contenido de la interfaz de usuario.

La definición del índice de texto completo personalizado del tipo damAssetLucene debe tener el prefijo "damAssetLucene" correctamente oakpal-dam-asset-lucene

AEM Cloud Service prohíbe que las definiciones de índice de texto completo personalizadas de tipo damAssetLucene lleven un prefijo distinto de damAssetLucene.

Los nodos de definición de índice no deben contener propiedades con el mismo nombre oakpal-index-property-name

AEM Cloud Service prohíbe que las definiciones de índice de búsqueda personalizadas (es decir, los nodos de tipo oak:QueryIndexDefinition) contengan propiedades con el mismo nombre

Está prohibido personalizar ciertas definiciones de índice predefinido oakpal-customizing-ootb-index

AEM Cloud Service prohíbe las modificaciones no autorizadas de los siguientes índices OOTB:

La configuración de los tokenizers en los analizadores debe crearse con el nombre "tokenizer" oakpal-tokenizer

AEM Cloud Service prohíbe la creación de tokenizers con nombres incorrectos en los analizadores. Los tokenizadores siempre se deben definir como tokenizer.

La configuración de las definiciones de indexación no debe contener espacios oakpal-indexing-definitions-spaces

AEM Cloud Service prohíbe la creación de definiciones de indexación que contengan propiedades con espacios.