Dispositivi mobili con sincronizzazione contenuti mobile-with-content-sync

Utilizza Sincronizzazione contenuti per creare pacchetti di contenuti in modo che possano essere utilizzati nelle applicazioni native per dispositivi mobili. Le pagine create in AEM possono essere utilizzate come contenuto dell’app, anche quando il dispositivo è offline. Inoltre, poiché le pagine AEM sono basate su standard web, funzionano su più piattaforme e consentono di incorporarle in qualsiasi wrapper nativo. Questa strategia riduce lo sforzo di sviluppo e consente di aggiornare facilmente i contenuti dell’app.

Il framework di sincronizzazione dei contenuti crea un file di archivio contenente il contenuto web. Il contenuto può essere qualsiasi cosa, da semplici pagine, immagini e file PDF o intere applicazioni Web. L’API di sincronizzazione dei contenuti consente di accedere al file di archivio dalle app per dispositivi mobili o dai processi di generazione, in modo che il contenuto possa essere recuperato e incluso nell’app.

La sequenza di passaggi seguente illustra un caso d’uso tipico della sincronizzazione dei contenuti:

Configurazione del contenuto di sincronizzazione contenuti configuring-the-content-sync-content

Crea una configurazione di sincronizzazione contenuti per specificare il contenuto del file ZIP che viene distribuito al client. Puoi creare un numero qualsiasi di configurazioni di sincronizzazione dei contenuti. Ogni configurazione ha un nome a scopo di identificazione.

Per creare una configurazione di sincronizzazione dei contenuti, aggiungere un nodo cq:ContentSyncConfig all'archivio con la proprietà sling:resourceType impostata su contentsync/config. Il nodo cq:ContentSyncConfig può trovarsi in qualsiasi punto del repository, tuttavia il nodo deve essere accessibile agli utenti nell'istanza di pubblicazione AEM. Pertanto, aggiungere il nodo sotto /content.

Per specificare il contenuto del file ZIP di sincronizzazione contenuti, aggiungi nodi secondari al nodo cq:ContentSyncConfig. Le seguenti proprietà di ciascun nodo figlio identificano un elemento di contenuto da includere e come viene elaborato quando lo si aggiunge:

Vedi Esempio di configurazione della sincronizzazione dei contenuti.

Dopo aver creato la configurazione di Sincronizzazione contenuti, questa viene visualizzata nella console Sincronizzazione contenuti.

Configurazione dell’accesso ai download di sincronizzazione dei contenuti configuring-access-to-content-sync-downloads

Specifica un utente o un gruppo che può scaricare da Sincronizzazione contenuti. Puoi configurare l’utente o il gruppo predefinito che può essere scaricato da tutte le cache di Sincronizzazione contenuto, nonché ignorare l’impostazione predefinita e configurare l’accesso per una specifica configurazione di Sincronizzazione contenuto.

Quando AEM è installato, i membri del gruppo dell'amministratore possono scaricare da Sincronizzazione contenuti per impostazione predefinita.

Impostazione dell’accesso predefinito per i download di sincronizzazione dei contenuti setting-the-default-access-for-content-sync-downloads

Il servizio Day CQ Content Sync Manager controlla l’accesso a Content Sync. Configura questo servizio per specificare l'utente o il gruppo che può scaricare da Sincronizzazione contenuti per impostazione predefinita.

Se si sta configurando il servizio utilizzando la console Web, digitare il nome dell'utente o del gruppo come valore della proprietà Autorizzabile della cache di fallback.

Se si sta configurando nel repository, utilizzare le seguenti informazioni sul servizio:

Ignorare l’accesso ai download per una cache di sincronizzazione dei contenuti overriding-download-access-for-a-content-sync-cache

Per configurare l'accesso al download per una configurazione specifica di Sincronizzazione contenuto, aggiungere la seguente proprietà al nodo cq:ContentSyncConfig:

Ad esempio, la tua app consente agli utenti di installare gli aggiornamenti direttamente da Sincronizzazione contenuti. Per consentire a tutti gli utenti di scaricare l'aggiornamento, impostare il valore della proprietà autorizzabile su everyone.

Se il nodo cq:ContentSyncConfig non dispone di una proprietà autorizzabile, l'utente o il gruppo predefinito configurato per la proprietà Autorizzabile cache di fallback del servizio Day CQ Content Sync Manager determina chi può scaricare.

Configurazione dell’utente per l’aggiornamento di una cache di sincronizzazione contenuti configuring-the-user-for-updating-a-content-sync-cache

Quando un utente esegue un aggiornamento alla cache di sincronizzazione contenuti, l’azione viene eseguita da un account utente specifico per conto dell’utente. Per impostazione predefinita, l’utente anonimo aggiorna tutte le cache di Sincronizzazione contenuto.

Puoi sovrascrivere l’utente predefinito e specificare un utente o un gruppo che aggiorna una cache di sincronizzazione contenuti specifica.

Per ignorare l'utente predefinito, specificare un utente o un gruppo che esegua aggiornamenti per una configurazione di Sincronizzazione contenuto specifica aggiungendo la seguente proprietà al nodo cq

Se il nodo cq:ContentSyncConfig non dispone di una proprietà updateuser, l'utente anonimo predefinito aggiorna la cache.

Tipi di configurazione configuration-types

L’elaborazione può variare dal rendering di un JSON semplice al rendering completo delle pagine, incluse le relative risorse di riferimento. In questa sezione sono elencati i tipi di configurazione disponibili e i relativi parametri specifici:

copia Copia semplicemente file e cartelle.

content - Esegui il rendering del contenuto utilizzando l'elaborazione della richiesta Sling standard.

clientlib - Crea un pacchetto con una libreria client JavaScript o CSS.

risorse - Raccogli le rappresentazioni originali delle risorse.

immagine - Raccogli un'immagine.

Il tipo di immagine viene utilizzato per includere il logo We.Retail nel file zip.

pagine - Eseguire il rendering delle pagine AEM e raccogliere le risorse di riferimento.

riscrittura - Il nodo di riscrittura definisce la modalità di riscrittura dei collegamenti nella pagina esportata. I collegamenti riscritti possono puntare ai file inclusi nel file zip o alle risorse sul server.

Il nodo rewrite deve trovarsi sotto il nodo page.

Il nodo rewrite può avere una o più delle seguenti proprietà:

Ogni proprietà può avere uno dei seguenti valori:

Il servizio AEM denominato PathRewriterTransformerFactory consente di configurare gli attributi html specifici che verranno riscritti. Il servizio può essere configurato nella console Web e dispone di una configurazione per ogni proprietà del nodo rewrite: clientlibs, images e links.

Questa funzione è stata aggiunta all’AEM 5.5.

Esempio di configurazione della sincronizzazione dei contenuti example-content-sync-configuration

L’elenco seguente mostra un esempio di configurazione per Sincronizzazione contenuti.

+ weretail_go [cq:ContentSyncConfig]
  - sling:resourceType = "contentsync/config"

  + etc.designs.default [nt:unstructured]
    - path = "/etc/designs/default"
    - type = "copy"

  + etc.designs.mobile [nt:unstructured]
    - path = "/etc/designs/mobile"
    - type = "copy"

  + events.plist [nt:unstructured]
    - path = "/content/weretail_mobile/en/events/jcr:content/par/events"
    - type = "content"
    - extension = "plist"

  + events.touch.html [nt:unstructured]
    - path = "/content/weretail_mobile/en/events"
    - type = "pages"
    - extension = "html"
    - selector = "touch"

  + logo [nt:unstructured]
    - path = "/etc/designs/mobile/jcr:content/mobilecontentpage/logo"
    - type = "logo"

  + manifest [nt:unstructured]
    - indexPage = "/content/weretail_mobile/en/events.touch.html"
    - metadataPlist = "/content/weretail_mobile/en/events/_jcr_content/par/events.plist"

  + ...

etc.designs.default e etc.designs.mobile - Le prime due voci della configurazione sono ovvie. Poiché includeremo diverse pagine mobili, abbiamo bisogno dei relativi file di progettazione sotto /etc/designs. E poiché non è richiesta alcuna elaborazione aggiuntiva, la copia è sufficiente.

events.plist - Questa voce è un po' speciale. Come accennato nell’introduzione, l’applicazione deve fornire una vista a mappa con i marcatori della posizione degli eventi. Le informazioni necessarie sulla posizione verranno fornite come file separato in formato PLIST. Affinché ciò funzioni, il componente elenco eventi utilizzato nella pagina indice dispone di uno script denominato plist.jsp. Questo script viene eseguito quando la risorsa del componente viene richiesta con l'estensione .plist. Come sempre, il percorso dei componenti è indicato nella proprietà percorso e il tipo è impostato sul contenuto, perché vogliamo utilizzare l’elaborazione delle richieste Sling.

events.touch.html - Successivamente vengono visualizzate le pagine effettive visualizzate nell'app. La proprietà path viene impostata sulla pagina principale degli eventi. Sono incluse anche tutte le pagine evento al di sotto di quella pagina, perché la proprietà deep (deep) è impostata per impostazione predefinita su true. Utilizziamo le pagine come tipo di configurazione, in modo da includere tutte le immagini o altri file a cui si può fare riferimento da un componente immagine o download in una pagina. Inoltre, l’impostazione del selettore touch fornisce una versione mobile delle pagine. La configurazione nel feature pack contiene più voci di questo tipo, ma qui sono escluse per semplicità.

logo - Il tipo di configurazione del logo non è stato menzionato finora e non è nessuno dei tipi incorporati. Tuttavia, il framework di sincronizzazione dei contenuti è in certa misura estensibile, come illustrato nella sezione successiva.

manifest - È spesso consigliabile includere nel file zip alcuni tipi di metadati, ad esempio la pagina iniziale del contenuto. Tuttavia, la codifica fissa di tali informazioni impedisce di modificarle in un secondo momento. Il framework di sincronizzazione dei contenuti supporta questo caso d’uso cercando un nodo manifesto nella configurazione, identificato per nome e che non richiede un tipo di configurazione. Ogni proprietà definita in quel particolare nodo viene aggiunta a un file, che è anche chiamato manifesto e risiede nella radice del file zip.

Nell’esempio, la pagina di elenco degli eventi deve essere la pagina iniziale. Queste informazioni sono fornite nella proprietà indexPage e possono quindi essere facilmente modificate in qualsiasi momento. Una seconda proprietà definisce il percorso del file events.plist. Come vedremo più avanti, l’applicazione client ora può leggere il manifesto e agire in base ad esso.

Una volta configurata la configurazione, il contenuto può essere scaricato con un browser o con qualsiasi altro client HTTP oppure, se stai sviluppando per iOS, puoi utilizzare la libreria client WAppKitSync dedicata. Il percorso di download è costituito dal percorso della configurazione e dall'estensione .zip, ad esempio, quando si lavora con un'istanza AEM locale: https://localhost:4502/content/weretail_go.zip

Console di sincronizzazione contenuti the-content-sync-console

La console Sincronizzazione contenuti elenca tutte le configurazioni di Sincronizzazione contenuti nell'archivio (tutti i nodi di tipo cq:ContentSyncConfig) e per ogni configurazione consente di effettuare le seguenti operazioni:

Può essere utile per lo sviluppo e la risoluzione dei problemi.

La console è accessibile al seguente indirizzo:

https://localhost:4502/libs/cq/contentsync/content/console.html

Si presenta come segue:

Estensione del framework Content Sync extending-the-content-sync-framework

Anche se il numero di opzioni di configurazione è già ampio, potrebbe non coprire tutti i requisiti del caso d’uso specifico. Questa sezione descrive i punti di estensione del framework di sincronizzazione dei contenuti e come creare tipi di configurazione personalizzati.

Per ogni tipo di configurazione esiste un Gestore aggiornamento contenuto, ovvero una factory del componente OSGi registrata per il tipo specifico. Questi gestori raccolgono il contenuto, lo elaborano e lo aggiungono a una cache gestita dal framework Content Sync. Implementa la seguente classe di interfaccia o di base astratta:

Registra la classe come fabbrica di componenti OSGi e implementala nel contenitore OSGi in un bundle. Questa operazione può essere eseguita utilizzando il plug-in Maven SCR utilizzando tag JavaDoc o annotazioni. L’esempio seguente mostra la versione di JavaDoc:

/*
 * @scr.component metatype="no"
 * factory="com.day.cq.contentsync.handler.ContentUpdateHandler/customtype"
 */
public class CustomTypeUpdateHandler implements ContentUpdateHandler {
    // add your code here
}

/*
 * @scr.component metatype="no" inherit="true"
 * factory="com.day.cq.contentsync.handler.ContentUpdateHandler/othertype"
 */
public class OtherTypeUpdateHandler extends AbstractSlingResourceUpdateHandler {
    // add your code here
}

La definizione di factory contiene l'interfaccia comune e il tipo personalizzato separati da una barra. Questa strategia consente al framework Content Sync di trovare e creare un'istanza della classe personalizzata che riconosce il tipo personalizzato in una voce di configurazione. Nella sezione successiva viene fornito un esempio concreto di un gestore di aggiornamento personalizzato.

Implementazione di un gestore di aggiornamento personalizzato implementing-a-custom-update-handler

Ogni pagina mobile We.Retail contiene un logo nell'angolo in alto a sinistra che vorremmo includere nel file zip. Tuttavia, per l'ottimizzazione della cache, AEM non fa riferimento alla posizione reale del file di immagine nell'archivio, il che impedisce di utilizzare semplicemente il tipo di configurazione copy. In alternativa, è necessario fornire il tipo di configurazione logo che rende l'immagine disponibile nel percorso richiesto dall'AEM. Il seguente elenco di codici mostra la completa implementazione del gestore di aggiornamento del logo:

LogoUpdateHandler.java logoupdatehandler-java

package com.day.cq.wcm.apps.weretail.impl;

import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.jcr.resource.JcrResourceResolverFactory;

import com.day.cq.commons.jcr.JcrUtil;
import com.day.cq.contentsync.config.ConfigEntry;
import com.day.cq.contentsync.handler.ContentUpdateHandler;
import com.day.cq.wcm.foundation.Image;
import com.day.text.Text;

/**
 * The <code>LogoUpdateHandler</code> is used to update the content sync cache
 * with a page logo added using a logo component.
 *
 * @scr.component metatype="no"
 * factory="com.day.cq.contentsync.handler.ContentUpdateHandler/logo"
 */
public class LogoUpdateHandler implements ContentUpdateHandler {

    private static final Logger log = LoggerFactory.getLogger(LogoUpdateHandler.class);

    /** @scr.reference policy="static" */
    protected JcrResourceResolverFactory resolverFactory;

    public boolean updateCacheEntry(ConfigEntry configEntry, Long lastUpdated, String configCacheRoot, Session admin, Session session) {
        ResourceResolver resolver = resolverFactory.getResourceResolver(admin);
        Resource resource = resolver.getResource(configEntry.getContentPath());

        Image img = new Image(resource);
        img.setItemName(Image.NN_FILE, "image");
        img.setItemName(Image.PN_REFERENCE, "imageReference");
        img.setSelector("img");

        try {
            if(img.getLastModified() == null || lastUpdated < img.getLastModified().getTime().getTime()) {
                String src = img.getSrc();
                String parentPath = configCacheRoot + Text.getRelativeParent(src, 1);

                Node parent = JcrUtil.createPath(parentPath, "sling:Folder", admin);
                Node image = resolver.getResource(resource.getPath() + "/image").adaptTo(Node.class);
                JcrUtil.copy(image, parent, Text.getName(src));

                admin.save();

                return true;
            }
        } catch (RepositoryException e) {
            log.error("Unexpected error while updating logo: ", e);
        }

        return false;
    }
}

La classe LogoUpdateHandler implementa il metodo updateCacheEntry(ConfigEntry, Long, String, Session, Session) dell'interfaccia ContentUpdateHandler, che accetta diversi argomenti:

Per implementare il gestore personalizzato, crea innanzitutto un’istanza della classe Image in base alla risorsa specificata nella voce di configurazione. Questa è sostanzialmente la stessa procedura del componente effettivo del logo sulle nostre pagine. Verifica che il percorso di destinazione dell’immagine sia lo stesso di quello a cui si fa riferimento da una pagina.

Quindi, controlla se la risorsa è stata modificata dall’ultimo aggiornamento. Le implementazioni personalizzate devono evitare aggiornamenti non necessari della cache e restituire false in caso di modifiche. Se la risorsa è stata modificata, copia l’immagine nella posizione di destinazione prevista relativa alla directory principale della cache. Infine, viene restituito true per indicare al framework che la cache è stata aggiornata.

Utilizzo del contenuto sul client using-the-content-on-the-client

Per utilizzare il contenuto in un’app mobile fornita da Sincronizzazione contenuti, devi richiedere il contenuto tramite una connessione HTTP o HTTPS. Di conseguenza, il contenuto recuperato (compresso in un file ZIP) può essere estratto e memorizzato localmente sul dispositivo mobile. Il contenuto non si riferisce solo ai dati ma anche alla logica, ovvero alle applicazioni web complete; pertanto, l’utente mobile può eseguire le applicazioni web recuperate e i dati corrispondenti anche senza connettività di rete.

La sincronizzazione dei contenuti offre i contenuti in modo intelligente: vengono trasmesse solo le modifiche apportate ai dati dall’ultima sincronizzazione dei dati eseguita correttamente, riducendo così il tempo necessario per il trasferimento dei dati. Alla prima esecuzione di un'applicazione dati, le modifiche sono richieste a partire dal 01 gennaio 1970, mentre successivamente sono richiesti solo i dati che sono cambiati dopo l'ultima sincronizzazione riuscita. AEM utilizza un framework di comunicazione client per iOS per semplificare la comunicazione e il trasferimento dei dati in modo da richiedere una quantità minima di codice nativo per abilitare un’applicazione web basata su iOS.

Tutti i dati trasferiti possono essere estratti nella stessa struttura di directory; non sono necessari passaggi aggiuntivi (ad esempio, controlli di dipendenza) durante l’estrazione dei dati. Se è presente iOS, tutti i dati vengono memorizzati in una sottocartella all’interno della cartella Documenti dell’app iOS.

Percorso di esecuzione tipico di un’app AEM Mobile basata su iOS:

Se non è possibile stabilire una connessione, vengono visualizzati i dati scaricati in precedenza.

Come procedere getting-ahead

Per informazioni sui ruoli e sulle responsabilità di un amministratore e di uno sviluppatore, consulta le risorse seguenti: