Mobile con sincronizzazione dei contenuti mobile-with-content-sync

Utilizza Content Sync per creare un pacchetto di contenuti in modo che possa essere utilizzato nelle applicazioni mobili native. 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 il contenuto delle app.

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

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

Sviluppo dei gestori di sincronizzazione dei contenuti developing-the-content-sync-handlers

Alcune delle linee guida per lo sviluppo dei gestori di sincronizzazione dei contenuti sono le seguenti:

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

Crea una configurazione di sincronizzazione dei contenuti per specificare il contenuto del file ZIP che viene inviato 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 Content Sync, aggiungi una cq:ContentSyncConfig nodo del repository, con sling:resourceType proprietà impostata su contentsync/config. La cq:ContentSyncConfig Il nodo può trovarsi in qualsiasi punto dell'archivio, tuttavia il nodo deve essere accessibile agli utenti nell'istanza di pubblicazione AEM. Pertanto, devi aggiungere il nodo seguente /content.

Per specificare il contenuto del file ZIP di sincronizzazione del contenuto, aggiungi nodi figlio 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 per ulteriori informazioni.

Dopo aver creato la configurazione Content Sync, questa viene visualizzata nella console Content Sync.

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

Specifica un utente o un gruppo che può scaricare da Content Sync. È possibile configurare l’utente o il gruppo predefinito che può essere scaricato da tutte le cache di Sincronizzazione contenuto, nonché ignorare il valore predefinito e configurare l’accesso per una configurazione di Sincronizzazione contenuto specifica.

Quando AEM è installato, i membri del gruppo di amministratori possono scaricare da Content Sync per impostazione predefinita.

Impostazione dell’accesso predefinito per i download della 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 Content Sync per impostazione predefinita.

Se sei configurazione del servizio tramite la console Web, digita il nome dell’utente o del gruppo come valore della proprietà Fallback Cache Authorizable .

Se sei configurazione nell’archivio, utilizza le seguenti informazioni sul servizio:

Sovrascrittura dell’accesso al download per una cache di sincronizzazione dei contenuti overriding-download-access-for-a-content-sync-cache

Per configurare l'accesso per il download per una configurazione specifica di Content Sync, aggiungi la seguente proprietà alla cq:ContentSyncConfig nodo:

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

Se la cq:ContentSyncConfig Il nodo non dispone di proprietà autorizzabile. L'utente o il gruppo predefinito configurato per la proprietà Autorizzabile della 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 dei contenuti configuring-the-user-for-updating-a-content-sync-cache

Quando un utente esegue un aggiornamento della cache di sincronizzazione dei contenuti, un account utente specifico esegue l’azione per conto dell’utente. Per impostazione predefinita, l’utente anonimo aggiorna tutte le cache di sincronizzazione dei contenuti.

È possibile ignorare l’utente predefinito e specificare un utente o un gruppo che aggiorna una cache di sincronizzazione dei contenuti specifica.

Per ignorare l'utente predefinito, specifica un utente o un gruppo che esegue gli aggiornamenti per una configurazione specifica di Content Sync aggiungendo la seguente proprietà al nodo cq

Se la cq:ContentSyncConfig il nodo non ha updateuser proprietà, impostazione predefinita anonymous l'utente aggiorna la cache.

Tipi di configurazione configuration-types

L’elaborazione può variare dal rendering di 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 È sufficiente copiare file e cartelle.

content Rendering del contenuto utilizzando lo standard Elaborazione richiesta Sling.

clientlib Crea un pacchetto per una libreria client Javascript o CSS.

assets

Raccogliere rappresentazioni originali delle risorse.

immagine Raccogli un’immagine.

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

pagine Esegui il rendering AEM pagine e raccogli le risorse di riferimento.

riscrittura Il nodo di riscrittura definisce il modo in cui i collegamenti vengono riscritti nella pagina esportata. I collegamenti riscritti possono puntare ai file inclusi nel file zip o alle risorse sul server.

La rewrite il nodo deve essere posizionato sotto il page nodo.

La rewrite il nodo 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à della rewrite nodo: clientlibs, images e links.

Questa funzione è stata aggiunta nella AEM 5.5.

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

L’elenco seguente mostra una configurazione di esempio per Sincronizzazione contenuto.

+ 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 dovrebbero essere abbastanza ovvie. Poiché includeremo diverse pagine mobili, abbiamo bisogno dei relativi file di progettazione sotto /etc/designs. E poiché non è necessaria alcuna ulteriore elaborazione, la copia è sufficiente.

events.plist Questa voce è un po' speciale. Come indicato nell’introduzione, l’applicazione deve fornire una vista mappa con i marcatori delle posizioni degli eventi. Forniremo le informazioni sulla posizione necessarie come file separato in formato PLIST. Affinché ciò funzioni, il componente elenco eventi utilizzato nella pagina indice ha uno script chiamato plist.jsp. Questo script viene eseguito quando la risorsa del componente viene richiesta con estensione .plist . Come al solito, il percorso dei componenti viene indicato nella proprietà path e il tipo è impostato su content, perché vogliamo sfruttare Elaborazione richiesta Sling.

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

logo Il tipo di configurazione del logo non è stato menzionato finora e non è uno dei tipi incorporati. Tuttavia, il framework Content Sync è estensibile in un certo senso e questo è un esempio di ciò, che sarà trattato nella sezione successiva.

manifest Spesso è auspicabile che nel file zip sia incluso un qualche tipo di metadati, ad esempio la pagina iniziale del contenuto. Tuttavia, la codifica fissa di tali informazioni impedisce di modificarle facilmente in un secondo momento. Il framework Content Sync supporta questo caso d’uso cercando un nodo manifest nella configurazione, che è semplicemente identificato dal nome e non richiede un tipo di configurazione. Ogni proprietà definita su quel particolare nodo viene aggiunta a un file, che è anche chiamato manifest e risiede nella radice del file zip.

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

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

Console Content Sync the-content-sync-console

Nella console Content Sync sono elencate tutte le configurazioni di Content Sync nella directory 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.

Puoi accedere alla console da:

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

Si presenta come segue:

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

Anche se il numero di opzioni di configurazione è già abbastanza ampio, potrebbe non coprire tutti i requisiti del tuo caso d'uso specifico. Questa sezione descrive i punti di estensione del framework Content Sync e come creare tipi di configurazione personalizzati.

Per ogni tipo di configurazione, è disponibile un Gestore dell’aggiornamento dei contenuti, che è una fabbrica di componenti OSGi registrata per quel tipo specifico. Questi gestori raccolgono il contenuto, lo elaborano e lo aggiungono a una cache gestita dal framework Content Sync. Implementa la seguente interfaccia o classe base astratta:

Registra la classe come componente factory OSGi e distribuiscila nel contenitore OSGi in un bundle. Questa operazione può essere eseguita utilizzando 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
}

Tieni presente che fabbrica La definizione contiene l'interfaccia comune e il tipo personalizzato separati da barra. Questa strategia consente al framework Content Sync di trovare e creare un'istanza della classe personalizzata in quanto riconosce il tipo personalizzato in una voce di configurazione. Nella sezione successiva viene illustrato 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 nell’angolo in alto a sinistra un logo che vorremmo includere nel file zip, ovviamente. Tuttavia, per l’ottimizzazione della cache, AEM non fa riferimento alla posizione reale del file immagine nell’archivio, il che ci impedisce di utilizzare semplicemente il copia tipo di configurazione. Quello che dobbiamo fare invece è fornire il nostro logo tipo di configurazione che rende l'immagine disponibile nella posizione richiesta da AEM. Il seguente elenco di codici mostra la piena implementazione del gestore di aggiornamenti 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 LogoUpdateHandler la classe implementa ContentUpdateHandler dell'interfaccia updateCacheEntry(ConfigEntry, Long, String, Session, Session) metodo , che accetta diversi argomenti:

Per implementare il gestore personalizzato, crea prima un’istanza della classe Image basata sulla risorsa specificata nella voce di configurazione. Questa è sostanzialmente la stessa procedura del componente logo effettivo sulle nostre pagine. Assicurati 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 dopo l’ultimo aggiornamento. Le implementazioni personalizzate devono evitare inutili aggiornamenti della cache e restituire false se non cambia nulla. Se la risorsa è stata modificata, copia l’immagine nella posizione di destinazione prevista relativa alla directory principale della cache. Infine, true viene restituito 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 Content Sync, è necessario 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. Si noti che il contenuto non si riferisce solo ai dati ma anche alla logica, vale a dire alle applicazioni web complete; consentendo così all’utente mobile di eseguire le applicazioni web recuperate e i dati corrispondenti anche senza connettività di rete.

La sincronizzazione dei contenuti offre contenuti in modo intelligente: Vengono distribuite solo le modifiche apportate ai dati dall’ultima sincronizzazione dei dati riuscita, riducendo così il tempo necessario per il trasferimento dei dati. Al primo avvio di un'applicazione le modifiche ai dati sono richieste a partire dal 1° gennaio 1970, mentre successivamente vengono richiesti solo i dati modificati dall'ultima sincronizzazione riuscita. AEM utilizza un framework di comunicazione client per iOS per semplificare la comunicazione e il trasferimento dei dati in modo che sia necessaria 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. Nel caso di 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 è stato possibile stabilire una connessione, verranno visualizzati i dati scaricati in precedenza.

Risorse aggiuntive additional-resources

Per scoprire i ruoli e le responsabilità di un amministratore e di un autore, consulta le risorse seguenti: