Personalización del lado del servidor server-side-customization

API de Java™ java-apis

Interfaz de SocialComponent socialcomponent-interface

Los componentes sociales son POJO que representan un recurso para una función de AEM Communities. Lo ideal es que cada SocialComponent represente un resourceType específico con GETters expuestos que proporcionen datos al cliente para que el recurso se represente con precisión. Toda la lógica empresarial y de vista se encapsula en el componente social, incluida la información de sesión del visitante del sitio, si es necesario.

La interfaz define un conjunto básico de GETters necesarios para representar un recurso. Es importante destacar que la interfaz estipula los métodos Map<String, Object> getAsMap() y String toJSONString() necesarios para procesar plantillas Handlebars y exponer los extremos JSON de GET para los recursos.

Todas las clases SocialComponent deben implementar la interfaz com.adobe.cq.social.scf.SocialComponent

Interfaz de SocialCollectionComponent socialcollectioncomponent-interface

La interfaz SocialCollectionComponent amplía la interfaz SocialComponent para representar mejor los recursos que son colecciones de otros recursos.

Todas las clases SocialCollectionComponent deben implementar la interfaz com.adobe.cq.social.scf.SocialCollectionComponent

Interfaz de SocialComponentFactory socialcomponentfactory-interface

Un SocialComponentFactory (generador) registra un SocialComponent con el marco de trabajo. La fábrica proporciona un medio para hacer saber al marco qué componentes sociales están disponibles para un resourceType determinado y su clasificación de prioridad cuando se identifican varios componentes sociales.

Un SocialComponentFactory es responsable de crear una instancia del SocialComponent seleccionado, lo que permite inyectar todas las dependencias que necesita el SocialComponent desde la fábrica mediante prácticas de ID.

Un SocialComponentFactory es un servicio OSGi y tiene acceso a otros servicios OSGi que se pueden pasar al SocialComponent a través de un constructor.

Todas las clases SocialComponentFactory deben implementar la interfaz com.adobe.cq.social.scf.SocialComponentFactory

Una implementación del método SocialComponentFactory.getPriority() debe devolver el valor más alto para el generador que se utilizará para el resourceType dado tal como lo devuelve getResourceType().

Interfaz de SocialComponentFactoryManager socialcomponentfactorymanager-interface

SocialComponentFactoryManager (administrador) administra todos los SocialComponents registrados con el marco de trabajo y es responsable de seleccionar SocialComponentFactory para utilizar en un recurso determinado (resourceType). Si no hay fábricas registradas para un resourceType específico, el administrador devuelve una fábrica con el supertipo más cercano para el recurso determinado.

Un SocialComponentFactoryManager es un servicio OSGi y tiene acceso a otros servicios OSGi que se pueden pasar al SocialComponent a través de un constructor.

Se obtuvo un identificador para el servicio OSGi invocando com.adobe.cq.social.scf.SocialComponentFactoryManager

API HTTP: solicitudes del POST http-api-post-requests

Clase PostOperation postoperation-class

Los extremos del POST de la API HTTP son clases PostOperation definidas al implementar la interfaz SlingPostOperation (paquete org.apache.sling.servlets.post).

La implementación del extremo PostOperation establece sling.post.operation en un valor al que responde la operación. Todas las solicitudes de POST con un parámetro:operation establecido en ese valor se delegan a esta clase de implementación.

PostOperation invoca a SocialOperation, que realiza las acciones necesarias para la operación.

PostOperation recibe el resultado de SocialOperation y devuelve la respuesta adecuada al cliente.

Clase SocialOperation socialoperation-class

Cada extremo SocialOperation extiende la clase AbstractSocialOperation y reemplaza el método performOperation(). Este método realiza todas las acciones necesarias para completar la operación y devolver un SocialOperationResult o de lo contrario generar un OperationException. En este caso, se devuelve un estado de error HTTP con un mensaje, si está disponible, en lugar del código de estado HTTP de éxito o de respuesta JSON normal.

Ampliar AbstractSocialOperation hace posible la reutilización de SocialComponents para enviar respuestas JSON.

Clase SocialOperationResult socialoperationresult-class

La clase SocialOperationResult se devuelve como resultado de SocialOperation y se compone de SocialComponent, código de estado HTTP y mensaje de estado HTTP.

SocialComponent representa el recurso afectado por la operación.

Para una operación Create, el SocialComponent incluido en el SocialOperationResult representa el recurso creado y, para una operación Update, representa el recurso modificado por la operación. No se devolvió ningún SocialComponent para una operación de eliminación.

Los códigos de estado HTTP de éxito utilizados son:

Clase OperationException operationexception-class

Se produce un OperationExcepton al realizar una operación si la solicitud no es válida o si se produce algún otro error. Por ejemplo, errores internos, valores de parámetros incorrectos o permisos incorrectos. Un(a) OperationException se compone de un código de estado HTTP y un mensaje de error, que se devuelven al cliente como respuesta al(la) PostOperatoin.

Clase OperationService operationservice-class

El marco del componente social recomienda que la lógica empresarial responsable de realizar la operación no se implemente dentro de la clase SocialOperation, sino que se delegue a un servicio OSGi. El uso de un servicio OSGi para lógica empresarial permite que un elemento SocialComponent, sobre el que actúa un extremo SocialOperation, se integre con otro código y se aplique una lógica empresarial diferente.

Todas las clases OperationService amplían AbstractOperationService, lo que permite extensiones adicionales que se pueden conectar a la operación que se está realizando. Cada operación del servicio está representada por una clase SocialOperation. La clase OperationExtensions se puede invocar durante la ejecución de la operación llamando a los métodos

Clase OperationExtension operationextension-class

Las clases OperationExtension son fragmentos de código personalizados que se pueden insertar en una operación que permite personalizar las operaciones para satisfacer las necesidades comerciales. Los consumidores del componente pueden agregar funcionalidad de forma dinámica e incremental al componente. El patrón de extensión/vínculo permite a los desarrolladores centrarse exclusivamente en las propias extensiones y elimina la necesidad de copiar y anular operaciones y componentes completos.

Código de ejemplo sample-code

Hay código de muestra disponible en el repositorio Adobe Experience Cloud GitHub. Busque proyectos con el prefijo aem-communities o aem-scf.

Prácticas recomendadas best-practices

Vea la sección Directrices de codificación para conocer varias directrices de codificación y prácticas recomendadas para desarrolladores de AEM Communities.

Consulte también Proveedor de recursos de almacenamiento (SRP) para UGC para obtener más información sobre el acceso al contenido generado por el usuario.