Mobiel met inhoudssynchronisatie mobile-with-content-sync

Gebruik Content Sync om inhoud te verpakken zodat deze kan worden gebruikt in systeemeigen mobiele toepassingen. Pagina's die in AEM zijn gemaakt, kunnen als toepassingsinhoud worden gebruikt, zelfs als het apparaat offline is. Omdat AEM pagina's zijn gebaseerd op webstandaarden, werken ze bovendien op verschillende platforms, zodat u ze in elke native wrapper kunt insluiten. Deze strategie beperkt de ontwikkelingsinspanningen en stelt u in staat om toepassingsinhoud eenvoudig bij te werken.

Met het raamwerk van Content Sync wordt een archiefbestand gemaakt dat de webinhoud bevat. De inhoud kan om het even wat van eenvoudige pagina's, beelden, en de dossiers van PDF, of volledige toepassingen van het Web zijn. De API voor het synchroniseren van inhoud biedt toegang tot het archiefbestand via mobiele apps of om processen te maken zodat de inhoud kan worden opgehaald en opgenomen in de app.

De volgende reeks stappen illustreert een typisch geval van gebruik voor de Synchronisatie van de Inhoud:

De handlers voor het synchroniseren van inhoud ontwikkelen developing-the-content-sync-handlers

Enkele richtlijnen voor het ontwikkelen van Inhoud synchroniseren-handlers zijn als volgt:

Inhoud voor inhoudssynchronisatie configureren configuring-the-content-sync-content

Maak een configuratie voor Content Sync om de inhoud op te geven van het ZIP-bestand dat aan de client wordt geleverd. U kunt een willekeurig aantal configuraties voor Content Sync maken. Elke configuratie heeft een naam voor identificatiedoeleinden.

Als u een configuratie voor inhoudssynchronisatie wilt maken, voegt u een cq:ContentSyncConfig noteren naar de gegevensopslagruimte, met de sling:resourceType eigenschap ingesteld op contentsync/config. De cq:ContentSyncConfig knooppunt kan zich overal in de gegevensopslagruimte bevinden, maar het knooppunt moet toegankelijk zijn voor gebruikers op de AEM-publicatie-instantie. Daarom moet u het onderstaande knooppunt toevoegen /content.

Voeg onderliggende knooppunten toe aan het knooppunt cq:ContentSyncConfig om de inhoud van het ZIP-bestand voor het synchroniseren van inhoud op te geven. De volgende eigenschappen van elk onderliggend knooppunt identificeren een inhoudsitem dat moet worden opgenomen en hoe dit wordt verwerkt wanneer het wordt toegevoegd:

Zie Configuratie voorbeeldinhoud synchroniseren voor meer informatie .

Nadat u de configuratie van de Synchronisatie van de Inhoud creeert, verschijnt het in de console van de Synchronisatie van de Inhoud.

Toegang tot downloads voor inhoudssynchronisatie configureren configuring-access-to-content-sync-downloads

Geef een gebruiker of groep op die kan worden gedownload van Content Sync. U kunt de standaardgebruiker of de groep vormen die van alle geheime voorgeheugens van de Synchronisatie van de Inhoud kan downloaden, en u kunt het gebrek met voeten treden en toegang voor een specifieke configuratie van de Synchronisatie van de Inhoud vormen.

Wanneer AEM is geïnstalleerd, kunnen leden van de beheerdersgroep standaard downloaden van Content Sync.

Standaardtoegang voor downloaden van inhoudssynchronisatie instellen setting-the-default-access-for-content-sync-downloads

Met de Day CQ Content Sync Manager-service hebt u toegang tot Content Sync. Configureer deze service om de gebruiker of groep op te geven die standaard kan downloaden van Content Sync.

Als u het vormen van de dienst gebruikend de Console van het Web, typt u de naam van de gebruiker of groep als de waarde van de eigenschap voor het toestaan van fallback-cache.

Als u configureren in de opslagplaatsen gebruikt u de volgende informatie over de service:

Download Access negeren voor cache van inhoudssynchronisatie overriding-download-access-for-a-content-sync-cache

Om downloadtoegang voor een specifieke configuratie van de Synchronisatie van de Inhoud te vormen, voeg het volgende bezit aan toe cq:ContentSyncConfig knooppunt:

Met uw app kunnen gebruikers bijvoorbeeld updates rechtstreeks installeren via Content Sync. Als u wilt dat alle gebruikers de update kunnen downloaden, stelt u de waarde van de eigenschap Authorizable in op everyone.

Als de cq:ContentSyncConfig de knoop heeft geen toegelaten bezit, bepaalt de standaardgebruiker of de groep die voor het Vergunning bezit van het Geheime voorgeheugen van de Dienst van de Manager van de Synchronisatie van de Inhoud van de Dag CQ wordt gevormd wie kan downloaden.

De gebruiker configureren voor het bijwerken van een cache voor inhoudssynchronisatie configuring-the-user-for-updating-a-content-sync-cache

Wanneer een gebruiker een update uitvoert naar de cache van Content Sync, voert een specifieke gebruikersaccount de actie uit namens de gebruiker. De anonieme gebruiker werkt standaard alle cache voor Content Sync bij.

U kunt de standaardgebruiker overschrijven en een gebruiker of groep opgeven die een specifieke cache voor inhoudssynchronisatie bijwerkt.

Als u de standaardgebruiker wilt overschrijven, geeft u een gebruiker of groep op die updates uitvoert voor een specifieke configuratie van Content Sync door de volgende eigenschap toe te voegen aan de node cq

Als de cq:ContentSyncConfig node heeft geen updateuser eigenschap, de standaardwaarde anonymous de gebruiker werkt het geheime voorgeheugen bij.

Configuratietypen configuration-types

Verwerking kan variëren van het renderen van eenvoudige JSON tot volledige rendering van pagina's, inclusief de elementen waarnaar wordt verwezen. Deze sectie maakt een lijst van de beschikbare configuratietypen en hun specifieke parameters:

kopiëren Kopieer gewoon bestanden en mappen.

content Inhoud renderen met de standaard Verwerking van verkoopaanvraag.

clientlib Een JavaScript- of CSS-clientbibliotheek in een pakket plaatsen.

elementen

Oorspronkelijke uitvoeringen van elementen verzamelen.

image Verzamel een afbeelding.

Het afbeeldingstype wordt gebruikt om het We Retail-logo op te nemen in het ZIP-bestand.

pagina's Render AEM pagina's en verzamel elementen waarnaar wordt verwezen.

herschrijven Het knooppunt rewrite definieert hoe de koppelingen in de geëxporteerde pagina worden herschreven. De herschreven koppelingen kunnen verwijzen naar de bestanden in het ZIP-bestand of naar de bronnen op de server.

De rewrite knooppunt moet zich onder de page knooppunt.

De rewrite knooppunt kan een of meer van de volgende eigenschappen hebben:

Elke eigenschap kan een van de volgende waarden hebben:

De AEM-service PathRewriterTransformerFactory staat u toe om de specifieke html attributen te vormen die zullen worden herschreven. De dienst kan in de console van het Web worden gevormd en heeft een configuratie voor elk bezit van rewrite knooppunt: clientlibs, images en links.

Deze functie is toegevoegd in AEM 5.5.

Configuratie voorbeeldinhoud synchroniseren example-content-sync-configuration

Hieronder ziet u een voorbeeldconfiguratie voor Content Sync.

+ 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 en etc.designs.mobile De eerste twee ingangen van de configuratie zouden vrij duidelijk moeten zijn. Aangezien wij een aantal mobiele pagina's gaan omvatten, hebben wij de verwante ontwerpdossiers hieronder /etc/designs nodig. En omdat er geen extra verwerkingstijd nodig is, volstaat een kopie.

events.plist Deze vermelding is een beetje speciaal. Zoals vermeld in de inleiding, zou de toepassing een kaartweergave van tellers van de plaatsen van de gebeurtenissen moeten verstrekken. De benodigde locatie-informatie wordt als een afzonderlijk bestand in PLIST-indeling verstrekt. Dit werkt alleen wanneer de component met de gebeurtenislijst die op de indexpagina wordt gebruikt, een script heeft met de naam plist.jsp. Dit manuscript wordt uitgevoerd wanneer het middel van de component met de .plist uitbreiding wordt gevraagd. Zoals gewoonlijk wordt het pad naar componenten gegeven in de eigenschap path en wordt de tekst ingesteld op content, omdat we de functie willen gebruiken Verwerking van verkoopaanvraag.

events.touch.html Vervolgens worden de feitelijke pagina's weergegeven die in de app worden weergegeven. De eigenschap path wordt ingesteld op de hoofdpagina van de gebeurtenis. Alle gebeurtenispagina's onder die pagina worden ook opgenomen, omdat de eigenschap deep standaard op true wordt ingesteld. Pagina's worden gebruikt als configuratietype, zodat alle afbeeldingen of andere bestanden waarnaar kan worden verwezen vanuit een afbeelding of downloadcomponent op een pagina, worden opgenomen. Bovendien geeft het instellen van de aanraakkiezer ons een mobiele versie van de pagina's. De configuratie in het eigenschappak bevat meer ingangen van dit type, maar zij worden verlaten hier voor eenvoud.

logo Het type van logoconfiguratie is tot dusverre niet vermeld en het is geen van de bouwstijltypes. Het raamwerk voor het synchroniseren van inhoud kan echter tot op zekere hoogte worden uitgebreid. Dit is een voorbeeld hiervan, dat in de volgende sectie zal worden behandeld.

manifest Het is vaak wenselijk om metagegevens in het ZIP-bestand op te nemen, zoals bijvoorbeeld de startpagina van de inhoud. Door dergelijke gegevens te coderen voorkomt u echter dat u deze later gemakkelijk kunt wijzigen. Het kader van de Synchronisatie van de Inhoud steunt dit gebruiksgeval door een duidelijke knoop in de configuratie te zoeken, die eenvoudig door naam wordt geïdentificeerd en geen configuratietype vereist. Elke eigenschap die op dat knooppunt is gedefinieerd, wordt toegevoegd aan een bestand dat ook wel manifest wordt genoemd en dat zich in de hoofdmap van het ZIP-bestand bevindt.

In het voorbeeld moet de pagina met gebeurtenislijsten de startpagina zijn. Deze informatie wordt verstrekt in het indexPage en kan dus op elk moment gemakkelijk worden gewijzigd. Een tweede eigenschap definieert het pad van het events.plist bestand. Aangezien wij later zullen zien, kan de cliënttoepassing manifest nu lezen en volgens het handelen.

Zodra de configuratie is ingesteld, kan de inhoud worden gedownload met een browser of een andere HTTP-client, of als u zich ontwikkelt voor iOS, kunt u de toegewezen WAppKitSync-clientbibliotheek gebruiken. De downloadlocatie bestaat uit het pad van de configuratie en de .zip extensie, bijvoorbeeld wanneer u werkt met een lokale AEM-instantie: http://localhost:4502/content/weretail_go.zip

De console voor het synchroniseren van inhoud the-content-sync-console

In de console Content Sync worden alle configuraties van Content Sync in de opslagplaats vermeld (alle knooppunten van het type cq:ContentSyncConfig) en voor elke configuratie kunt u het volgende doen:

Het kan nuttig zijn voor ontwikkeling en het oplossen van problemen.

De console is toegankelijk op:

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

Het ziet er als volgt uit:

Uitbreiding van het raamwerk voor contentsynchronisatie extending-the-content-sync-framework

Hoewel het aantal configuratieopties reeds vrij uitgebreid is, kan het niet alle vereisten van uw specifiek gebruiksgeval behandelen. In deze sectie worden de extensiepunten van het Content Sync-framework beschreven en hoe u aangepaste configuratietypen kunt maken.

Voor elk configuratietype is er een Handler voor bijwerken van inhoud, een OSGi-componentfabriek die voor dat specifieke type is geregistreerd. Deze handlers verzamelen inhoud, verwerken deze en voegen deze toe aan een cache die door het Content Sync-framework wordt onderhouden. Implementeer de volgende interface of abstracte basisklasse:

Registreer uw klasse als OSGi componentenfabriek en stel het in de container OSGi in een bundel op. Dit kan worden gedaan gebruikend Maven SCR plug-in gebruiken met JavaDoc-tags of annotaties. In het volgende voorbeeld wordt de JavaDoc-versie getoond:

/*
 * @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
}

Let erop dat de fabriek De definitie bevat de gemeenschappelijke interface en het douanetype dat door schuine streep wordt gescheiden. Deze strategie laat het kader van de Synchronisatie van de Inhoud toe om een geval van uw douaneklasse te vinden en tot stand te brengen aangezien het het douanetype in een configuratieingang erkent. In de volgende sectie ziet u een concreet voorbeeld van een aangepaste update-handler.

Een aangepaste updatehandler implementeren implementing-a-custom-update-handler

Elke pagina Web.Retail Mobile bevat een logo in de linkerbovenhoek dat we natuurlijk in het ZIP-bestand willen opnemen. Voor het optimaliseren van de cache verwijst AEM echter niet naar de werkelijke locatie van het afbeeldingsbestand in de opslagplaats, wat ons belet om de kopiëren configuratietype. Wat we in plaats daarvan moeten doen, is onze eigen middelen ter beschikking stellen logo configuratietype dat de afbeelding beschikbaar maakt op de locatie die door AEM wordt gevraagd. In het volgende codevoorbeeld wordt de volledige implementatie van de logo-updatehandler getoond:

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;
    }
}

De LogoUpdateHandler de klasse implementeert de ContentUpdateHandler interface updateCacheEntry(ConfigEntry, Long, String, Session, Session) methode, die een aantal argumenten gebruikt:

Om de douanemanager uit te voeren, creeer eerst een geval van de klasse van het Beeld die op het middel wordt gebaseerd dat in de configuratieingang wordt gegeven. Dit is eigenlijk dezelfde procedure als de eigenlijke logocomponent op onze pagina's. Het zorgt ervoor dat het doelpad van de afbeelding hetzelfde is als het pad waarnaar op een pagina wordt verwezen.

Controleer vervolgens of de bron is gewijzigd sinds de laatste update. De implementaties van de douane zouden onnodige updates van het geheime voorgeheugen moeten vermijden en zouden vals terugkeren als niets verandert. Als de bron is gewijzigd, kopieert u de afbeelding naar de verwachte doellocatie ten opzichte van de cachroot. Tot slot: true wordt geretourneerd om aan het framework aan te geven dat de cache is bijgewerkt.

De inhoud op de client gebruiken using-the-content-on-the-client

Als u inhoud wilt gebruiken in een mobiele toepassing die wordt geleverd door Content Sync, moet u inhoud aanvragen via een HTTP- of HTTPS-verbinding. Hierdoor kan opgehaalde inhoud (verpakt in een ZIP-bestand) lokaal worden uitgepakt en opgeslagen op het mobiele apparaat. De inhoud heeft niet alleen betrekking op gegevens, maar ook op logica, d.w.z. volledige webtoepassingen; en de mobiele gebruiker in staat te stellen opgehaalde webtoepassingen en de bijbehorende gegevens uit te voeren, zelfs zonder netwerkconnectiviteit.

Content Sync levert inhoud op intelligente wijze: Alleen gegevenswijzigingen sinds de laatste geslaagde gegevenssynchronisatie worden geleverd, waardoor de vereiste tijd voor gegevensoverdracht afneemt. Bij de eerste uitvoering van een toepassing worden gegevenswijzigingen aangevraagd sinds 1 januari 1970, en daarna worden alleen gegevens gevraagd die zijn gewijzigd sinds de laatste succesvolle synchronisatie. AEM gebruikt een communicatiekader voor de client voor iOS om de gegevenscommunicatie en -overdracht te vereenvoudigen, zodat een minimale hoeveelheid native code vereist is om een op iOS gebaseerde webtoepassing in te schakelen.

Alle overgedragen gegevens kunnen in dezelfde mappenstructuur worden geëxtraheerd, er zijn geen extra stappen (bijvoorbeeld afhankelijkheidscontroles) vereist voor het ophalen van gegevens. In het geval van iOS worden alle gegevens opgeslagen in een submap in de map Documents van de iOS App.

Typisch uitvoeringspad van een op iOS gebaseerde AEM Mobile-app:

Als er geen verbinding kon worden gemaakt, worden eerder gedownloade gegevens weergegeven.

Aanvullende bronnen additional-resources

Zie de volgende bronnen voor meer informatie over de rollen en verantwoordelijkheden van een beheerder en een auteur: