Come utilizzare lo strumento VLT

Lo strumento Jackrabbit FileVault (VLT) è uno strumento sviluppato da Apache Foundation che mappa il contenuto di un’istanza di Jackrabbit/AEM al file system. Lo strumento VLT ha funzioni simili a quelle del client di sistema di controllo del codice sorgente (come un client Subversion (SVN)), che fornisce le normali operazioni di check-in, check-out e gestione, nonché opzioni di configurazione per una rappresentazione flessibile del contenuto del progetto.

Esegui lo strumento VLT dalla riga di comando. Questo documento descrive come utilizzare lo strumento, tra cui come iniziare a ricevere aiuto, nonché un elenco di tutti comandi e disponibili options.

Concetti e architettura

Consulta la sezione Panoramica di Filevault e Vault FS pagina dal funzionario Documentazione di Apache Jackrabbit Filevault per una panoramica completa dei concetti e della struttura dello strumento Filevault.

Guida introduttiva a VLT

Per iniziare a utilizzare VLT, è necessario effettuare le seguenti operazioni:

  1. Installa VLT, aggiorna le variabili di ambiente e aggiorna i file di sottoversione globale ignorati.
  2. Imposta l’archivio AEM (se non lo hai già fatto).
  3. Consulta l’archivio AEM.
  4. Sincronizza con il repository.
  5. Verifica se la sincronizzazione ha funzionato.

Installazione dello strumento VLT

Per utilizzare lo strumento VLT, devi prima installarlo. Non è installato per impostazione predefinita in quanto è uno strumento aggiuntivo. Inoltre, devi impostare la variabile di ambiente del sistema.

  1. Scarica il file di archivio FileVault dal Archivio degli artefatti Maven.

    NOTA

    L'origine dello strumento VLT è disponibile su GitHub.

    1. Estrai l'archivio.
  2. Aggiungi <archive-dir>/vault-cli-<version>/bin all'ambiente PATH in modo che il comando file vlt o vlt.bat sono accessibili a seconda dei casi. Esempio:

    <aem-installation-dir>/crx-quickstart/opt/helpers/vault-cli-3.1.16/bin>

  3. Apri una shell a riga di comando ed esegui vlt --help. Assicurati che l'output sia simile alla seguente schermata di aiuto:

    vlt --help
    -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
    Jackrabbit FileVault [version 3.1.16] Copyright 2013 by Apache Software Foundation. See LICENSE.txt for more information.
    -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
    Usage:
      vlt [options] <command> [arg1 [arg2 [arg3] ..]]
    -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
    
    Global options:
    
      -Xjcrlog <arg>           Extended JcrLog options (omit argument for help)
      -Xdavex <arg>            Extended JCR remoting options (omit argument for help)
      --credentials <arg>      The default credentials to use
      --update-credentials     if present the credentials-to-host list is updated in the ~/.vault/auth.xml
      --config <arg>           The JcrFs config to use
      -v (--verbose)           verbose output
      -q (--quiet)             print as little as possible
      --version                print the version information and exit
      --log-level <level>      the log4j log level
      -h (--help) <command>    print this help
    

Dopo averlo installato è necessario aggiornare i file di sottoversione ignorati globali. Modifica le impostazioni svn e aggiungi quanto segue:

[miscellany]
### Set global-ignores to a set of whitespace-delimited globs
### which Subversion will ignore in its 'status' output, and
### while importing or adding files and directories.
global-ignores = .vlt

Configurazione del carattere di fine riga

VLT gestisce automaticamente End of Line (EOF) in base alle seguenti regole:

  • righe di file estratti su Windows con un CRLF
  • linee di file estratti su Linux/Unix con un LF
  • righe di file inviate alla fine dell’archivio con un LF

Per garantire la corrispondenza tra le configurazioni VLT e SVN, è necessario impostare svn:eol-style proprietà di native per l'estensione dei file memorizzati nel repository. Modifica le impostazioni svn e aggiungi quanto segue:

[auto-props]
*.css = svn:eol-style=native
*.cnd = svn:eol-style=native
*.java = svn:eol-style=native
*.js = svn:eol-style=native
*.json = svn:eol-style=native
*.xjson = svn:eol-style=native
*.jsp = svn:eol-style=native
*.txt = svn:eol-style=native
*.html = svn:eol-style=native
*.xml = svn:eol-style=native
*.properties = svn:eol-style=native

Estrazione del repository

Estrai il repository utilizzando il sistema di controllo del codice sorgente. In svn, ad esempio, digitare quanto segue (sostituendo l’URI e il percorso con il repository):

svn co https://svn.server.com/repos/myproject

Sincronizzazione con il repository

È necessario sincronizzare filevault con l’archivio. Per effettuare questo collegamento:

  1. Nella riga di comando, passa a content/jcr_root.

  2. Estrai il repository digitando quanto segue (sostituendo il numero di porta per 4502 e password dell'amministratore):

    vlt --credentials admin:admin co --force http://localhost:4502/crx
    
    NOTA

    Le credenziali devono essere specificate una sola volta al momento del pagamento iniziale. Vengono quindi memorizzati nella directory home all'interno della .vault/auth.xml.

Verifica del funzionamento della sincronizzazione

Dopo aver estratto l'archivio e sincronizzato l'archivio, è necessario verificare che tutto funzioni correttamente. Un modo semplice per farlo è modificare un .jsp e controlla se le modifiche vengono applicate dopo il commit delle modifiche.

Per verificare la sincronizzazione:

  1. Accedi a .../jcr_content/libs/foundation/components/text.
  2. Modifica qualcosa in text.jsp.
  3. Visualizza i file modificati digitando vlt st
  4. Visualizza le modifiche digitando vlt diff text.jsp
  5. Conferma le modifiche: vlt ci test.jsp.
  6. Ricarica una pagina contenente un componente di testo e verifica se le modifiche sono presenti.

Guida in linea con lo strumento VLT

Dopo aver installato lo strumento VLT, è possibile accedere al relativo file della Guida dalla riga di comando:

vlt --help
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Jackrabbit FileVault [version 3.1.16] Copyright 2013 by Apache Software Foundation. See LICENSE.txt for more information.
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Usage:
  vlt [options] <command> [arg1 [arg2 [arg3] ..]]
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Global options:
  -Xjcrlog <arg>           Extended JcrLog options (omit argument for help)
  -Xdavex <arg>            Extended JCR remoting options (omit argument for help)
  --credentials <arg>      The default credentials to use
  --update-credentials     if present the credentials-to-host list is updated in the ~/.vault/auth.xml
  --config <arg>           The JcrFs config to use
  -v (--verbose)           verbose output
  -q (--quiet)             print as little as possible
  --version                print the version information and exit
  --log-level <level>      the log4j log level
  -h (--help) <command>    print this help
Commands:
  export                   Export the Vault filesystem
  import                   Import a Vault filesystem
  checkout (co)            Checkout a Vault file system
  status (st)              Print the status of working copy files and directories.
  update (up)              Bring changes from the repository into the working copy.
  info                     Displays information about a local file.
  commit (ci)              Send changes from your working copy to the repository.
  revert (rev)             Restore pristine working copy file (undo most local edits).
  resolved (res)           Remove 'conflicted' state on working copy files or directories.
  propget (pg)             Print the value of a property on files or directories.
  proplist (pl)            Print the properties on files or directories.
  propset (ps)             Set the value of a property on files or directories.
  add                      Put files and directories under version control.
  delete (del,rm)          Remove files and directories from version control.
  diff (di)                Display the differences between two paths.
  rcp                      Remote copy of repository content.
  sync                     Control vault sync service
  console                  Run an interactive console
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Per informazioni su un determinato comando, digitare il comando help seguito dal nome del comando. Esempio:

vlt --help export
Usage:
 export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

Description:
  Export the Vault filesystem mounted at <uri> to the local filesystem at <local-path>. An optional <jcr-path> can be specified in order to export just a sub tree.
  Example:
    vlt export http://localhost:4502/crx /apps/geometrixx myproject

Options:
  -v (--verbose)          verbose output
  -t (--type) <arg>       specifies the export type. either 'platform' or 'jar'.
  -p (--prune-missing)    specifies if missing local files should be deleted.
  <uri>                   mountpoint uri
  <jcr-path>              the jcr path
  <local-path>            the local path

Attività comuni eseguite in VLT

Di seguito sono riportate alcune attività comuni eseguite in VLT. Per informazioni dettagliate su ciascun comando, vedere l'utente comandi.

Estrazione di una sottostruttura

Se, ad esempio, desideri estrarre solo una sottostruttura dell’archivio, /apps/geometrixx, per farlo, digita quanto segue:

vlt co http://localhost:4502/crx/-/jcr:root/apps/geometrixx geo

In questo modo si crea una nuova radice di esportazione geo con META-INF e jcr_root directory e inserisce tutti i file sotto /apps/geometrixx in geo/jcr_root.

Esecuzione di un checkout filtrato

Se disponi di un filtro area di lavoro esistente e lo desideri utilizzare per il pagamento, puoi prima creare il META-INF/vault e posizionare il filtro in tale posizione, oppure specificarlo sulla riga di comando come segue:

$ vlt co --filter filter.xml http://localhost:4502/crx/-/jcr:root geo

Un filtro di esempio:

<?xml version="1.0" encoding="UTF-8"?>
<workspaceFilter version="1.0">
    <filter root="/etc/designs/geometrixx" />
    <filter root="/apps/geometrixx"/>
</workspaceFilter>

Utilizzo di Import/Export invece del controllo .vlt

È possibile importare ed esportare il contenuto tra un archivio JCR e il file system locale senza utilizzare i file di controllo.

Importazione ed esportazione di contenuti senza utilizzare .vlt controllo:

  1. Impostare inizialmente l'archivio:

    $ cd /projects
    $ svn mkdir https://svn.server.com/repos/myproject
    $ svn co https://svn.server.com/repos/myproject
    $ vlt export -v http://localhost:4502/crx /apps/geometrixx geometrixx
    $ cd geometrixx/
    $ svn add META-INF/ jcr_root/
    $ svn ci
    
  2. Modifica la copia remota e aggiorna JCR:

    $ cd /projects/geometrixx
    $ vlt -v import http://localhost:4502/crx . /
    
  3. Modificare la copia remota e aggiornare il file server:

    $ cd /projects/geometrixx
    $ vlt export -v http://localhost:4502/crx /apps/geometrixx .
    $ svn st
    M      META-INF/vault/properties.xml
    M      jcr_root/apps/geometrixx/components/contentpage/.content.xml
    $ svn ci
    

Utilizzo di VLT

Per eseguire i comandi in VLT, digitare quanto segue nella riga di comando:

vlt [options] <command> [arg1 [arg2 [arg3] ..]]

Le opzioni e i comandi sono descritti in dettaglio nelle sezioni seguenti.

Opzioni globali VLT

Di seguito è riportato un elenco di opzioni VLT, disponibili per tutti i comandi. Per informazioni sulle opzioni disponibili aggiuntive, vedere i singoli comandi.

Opzione Descrizione
-Xjcrlog <arg> Opzioni JcrLog estese
-Xdavex <arg> Opzioni estese di comunicazione remota JCR
--credentials <arg> Credenziali predefinite da utilizzare
--config <arg> Configurazione JcrFs da utilizzare
-v (--verbose) uscita dettagliata
-q (--quiet) stampare il meno possibile
--version Stampa le informazioni sulla versione ed esce da VLT
--log-level <level> Indica il livello del registro, ad esempio il livello del registro log4j.
-h (--help) <command> Stampa la guida per quel particolare comando

Comandi VLT

Nella tabella seguente sono descritti tutti i comandi VLT disponibili. Per informazioni dettagliate sulla sintassi, le opzioni disponibili e gli esempi, vedere i singoli comandi.

Comando Comando abbreviato Descrizione
export Esporta da un archivio JCR (file system vault) al file system locale senza file di controllo.
import Importa un file system locale in un archivio JCR (vault file system).
checkout co Esegue il Check-Out di un file system Vault. Utilizzalo per un archivio JCR iniziale nel file system locale. (Nota: È innanzitutto necessario estrarre il repository in subversione.)
analyze Analizza i pacchetti.
status st Stampa lo stato dei file e delle directory della copia di lavoro.
update up Importa le modifiche dall'archivio nella copia di lavoro.
info Visualizza informazioni su un file locale.
commit ci Invia le modifiche dalla copia di lavoro all’archivio.
revert rev Ripristina lo stato originale del file di copia di lavoro e annulla la maggior parte delle modifiche locali.
resolved res Rimuove lo stato in conflitto nei file o nelle directory della copia di lavoro.
propget pg Stampa il valore di una proprietà su file o directory.
proplist pl Stampa le proprietà su file o directory.
propset ps Imposta il valore di una proprietà su file o directory.
add Posiziona i file e le directory sotto il controllo della versione.
delete del oppure rm Rimuove file e directory dal controllo della versione.
diff di Visualizza le differenze tra due percorsi.
console Esegue una console interattiva.
rcp Copia una struttura dei nodi da un archivio remoto a un altro.
sync Consente di controllare il servizio di sincronizzazione degli archivi.

Esporta

Esporta il filesystem Vault montato su <uri> al filesystem locale in <local-path>. Facoltativo <jcr-path> può essere specificato per esportare solo un sottoalbero.

Sintassi

export -v|-t <arg>|-p <uri> <jcr-path> <local-path>

Opzioni

-v (--verbose) uscita dettagliata
-t (--type) <arg> specifica il tipo di esportazione, piattaforma o jar.
-p (--prune-missing) specifica se i file locali mancanti devono essere eliminati
<uri> uri di montagna
<jcrPath> Percorso JCR
<localPath> percorso locale

Esempi

vlt export http://localhost:4502/crx /apps/geometrixx myproject

Importa

Importa il file system locale (a partire da <local-path> al file system vault in <uri>. Puoi specificare un <jcr-path> come radice di importazione. Se --sync viene specificato, i file importati vengono automaticamente messi sotto controllo vault.

Sintassi

import -v|-s <uri> <local-path> <jcr-path>

Opzioni

-v (--verbose) uscita dettagliata
-s (-- sync) mette i file locali sotto controllo vault
<uri> uri di montagna
<jcrPath> Percorso JCR
<localPath> percorso locale

Esempi

vlt import http://localhost:4502/crx . /

Pagamento (co)

Esegue un check-out iniziale da un archivio JCR al file system locale a partire da <uri> al filesystem locale in <local-path>. Puoi anche aggiungere una <jcrpath> argomento per estrarre una sottodirectory dell'albero remoto. È possibile specificare i filtri Workspace che vengono copiati nella directory META-INF.

Sintassi

checkout --force|-v|-q|-f <file> <uri> <jcrPath> <localPath>

Opzioni

--force forza il checkout per sovrascrivere i file locali se esistono già
-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
-f (--filter) <file> specifica i filtri automatici se non ne sono definiti nessuno
<uri> uri di montagna
<jcrPath> (facoltativo) percorso remoto
<localPath> (facoltativo) percorso locale

Esempi

Utilizzando la Remoting JCR:

vlt --credentials admin:admin co http://localhost:8080/crx/server/crx.default/jcr_root/

Con l’area di lavoro predefinita:

vlt --credentials admin:admin co http://localhost:8080/crx/server/-/jcr_root/

Se l’URI è incompleto, verrà espanso:

vlt --credentials admin:admin co http://localhost:8080/crx

Analizza

Analizza i pacchetti.

Sintassi

analyze -l <format>|-v|-q <localPaths1> [<localPaths2> ...]

Opzioni

-l (--linkFormat) <format> formato printf per i collegamenti hotfix (nome, id), ad esempio `[CQ520_HF_%s
-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
<localPaths> [<localPaths> ...] percorso locale

Stato

Stampa lo stato dei file e delle directory della copia di lavoro.

Se --show-update viene specificato, ogni file viene verificato rispetto alla versione remota. La seconda lettera specifica quindi quale azione verrà eseguita da un'operazione di aggiornamento.

Sintassi

status -v|-q|-u|-N <file1> [<file2> ...]

Opzioni

-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
-u (--show-update) visualizza informazioni sull'aggiornamento
-N (--non-recursive) funziona su un'unica directory
<file> [<file> ...] file o directory per visualizzare lo stato

Aggiorna

Copia le modifiche dall'archivio nella copia di lavoro.

Sintassi

update -v|-q|--force|-N <file1> [<file2> ...]

Opzioni

-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
--force forza la sovrascrittura dei file locali
-N (--non-recursive) funziona su un'unica directory
<file> [<file> ...] file o directory da aggiornare

Info

Visualizza informazioni su un file locale.

Sintassi

info -v|-q|-R <file1> [<file2> ...]

Opzioni

-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
-R (--recursive) opera in modo ricorsivo
<file> [<file> ...] file o directory per visualizzare le informazioni

Conferma

Invia le modifiche dalla copia di lavoro all’archivio.

Sintassi

commit -v|-q|--force|-N <file1> [<file2> ...]

Opzioni

-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
--force forza l'esecuzione anche se la copia remota viene modificata
-N (--non-recursive) funziona su un'unica directory
<file> [<file> ...] file o directory da commit

Versione precedente

Ripristina lo stato originale del file della copia di lavoro e annulla la maggior parte delle modifiche locali.

Sintassi

revert -q|-R <file1> [<file2> ...]

Opzioni

-q (--quiet) stampa il più possibile
-R (--recursive) discendenza ricorsiva
<file> [<file> ...] file o directory da commit

Risolto

Rimozioni in conflitto stato su file o directory di copia di lavoro.

NOTA

Questo comando non risolve semanticamente i conflitti o rimuove i contrassegni di conflitto; rimuove semplicemente i file di artefatto relativi al conflitto e consente di eseguire nuovamente il PATH.

Sintassi

resolved -q|-R|--force <file1> [<file2> ...]

Opzioni

-q (--quiet) stampa il più possibile
-R (--recursive) discendenza ricorsiva
--force risolve, anche in presenza di indicatori di conflitto
<file> [<file> ...] file o directory da risolvere

Propget

Stampa il valore di una proprietà su file o directory.

Sintassi

propget -q|-R <propname> <file1> [<file2> ...]

Opzioni

-q (--quiet) stampa il più possibile
-R (--recursive) discendenza ricorsiva
<propname> nome della proprietà
<file> [<file> ...] file o directory da cui ottenere la proprietà

Proplist

Stampa le proprietà su file o directory.

Sintassi

proplist -q|-R <file1> [<file2> ...]

Opzioni

-q (--quiet) stampa il più possibile
-R (--recursive) discendenza ricorsiva
<file> [<file> ...] file o directory da cui elencare le proprietà

Protesta

Imposta il valore di una proprietà su file o directory.

NOTA

VLT riconosce le seguenti proprietà speciali con versione:

vlt:mime-type

Il tipo mimetico del file. Utilizzato per determinare se unire il file. Un mimetype che inizia con 'text/' (o un mimetype assente) viene trattato come testo. Qualsiasi altra cosa viene trattata come binaria.

Sintassi

propset -q|-R <propname> <propval> <file1> [<file2> ...]

Opzioni

-q (--quiet) stampa il più possibile
-R (--recursive) discendenza ricorsiva
<propname> nome della proprietà
<propval> il valore della proprietà
<file> [<file> ...] file o directory su cui impostare la proprietà

Aggiungi

Posiziona i file e le directory sotto il controllo della versione, pianificandoli per l’aggiunta all’archivio. Saranno aggiunti al prossimo commit.

Sintassi

add -v|-q|-N|--force <file1> [<file2> ...]

Opzioni

-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
-N (--non-recursive) funziona su un'unica directory
--force forza l'esecuzione dell'operazione
<file> [<file> ...] file o directory locale da aggiungere

Elimina

Rimuove file e directory dal controllo della versione.

Sintassi

delete -v|-q|--force <file1> [<file2> ...]

Opzioni

-v (--verbose) uscita dettagliata
-q (--quiet) stampa il più possibile
--force forza l'esecuzione dell'operazione
<file> [<file> ...] file o directory locale da eliminare

Diff.

Visualizza le differenze tra due percorsi.

Sintassi

diff -N <file1> [<file2> ...]

Opzioni

-N (--non-recursive) funziona su un'unica directory
<file> [<file> ...] file o directory per visualizzare le differenze

Console

Esegue una console interattiva.

Sintassi

console -F <file>

Opzioni

-F (--console-settings) <file> specifica il file delle impostazioni della console. Il file predefinito è console.properties.

Rcp

Copia una struttura dei nodi da un archivio remoto a un altro. <src> punta al nodo di origine e <dst> specifica il percorso di destinazione in cui deve esistere il nodo principale. Rcp elabora i nodi effettuando lo streaming dei dati.

Sintassi

rcp -q|-r|-b <size>|-t <seconds>|-u|-n|-e <arg1> [<arg2> ...] <src> <dst>

Opzioni

-q (--quiet) Stampa il meno possibile.
-r (--recursive) Discende in modo ricorsivo.
-b (--batchSize) <size> Numero di nodi da elaborare prima di un salvataggio intermedio.
-t (--throttle) <seconds> Numero di secondi da attendere dopo un salvataggio intermedio.
-u (--update) Sovrascrivi/elimina i nodi esistenti.
-n (--newer) Rispetta le proprietà lastModified per l'aggiornamento.
-e (--exclude) <arg> [<arg> ...] Regexp dei percorsi sorgente esclusi.
<src> Indirizzo del repository della struttura di origine.
<dst> L'indirizzo del repository del nodo di destinazione.

Esempi

vlt rcp http://localhost:4502/crx/-/jcr:root/content  https://admin:admin@localhost:4503/crx/-/jcr:root/content_copy
NOTA

La --exclude le opzioni devono essere seguite da un’altra opzione prima della <src> e <dst> argomenti. Esempio:

vlt rcp -e ".*\.txt" -r

Sincronizza

Consente di controllare il servizio di sincronizzazione degli archivi. Senza argomenti questo comando cerca di mettere la directory di lavoro corrente sotto controllo di sincronizzazione. Se eseguito all’interno di un checkout vlt, utilizza il rispettivo filtro e host per configurare la sincronizzazione. Se eseguito al di fuori di un checkout vlt, registra la cartella corrente per la sincronizzazione solo se la directory è vuota.

Sintassi

sync -v|--force|-u <uri> <command> <localPath>

Opzioni

-v (--verbose) output dettagliato.
--force forzare l'esecuzione di determinati comandi.
-u (--uri) <uri> specifica l'URI dell'host di sincronizzazione.
<command> comando di sincronizzazione da eseguire.
<localPath> cartella locale da sincronizzare.

Codici di stato

I codici di stato utilizzati da VLT sono:

  • ' nessuna modifica
  • Aggiunta di "A"
  • "C" in conflitto
  • "D" soppresso
  • 'I' ignorato
  • Modificato 'M'
  • 'R' sostituito
  • "?" elemento non sotto controllo versione
  • '!' elemento mancante (rimosso dal comando non svn) o incompleto
  • Elemento con versione '~' ostruito da un elemento di un tipo diverso

Configurazione della sincronizzazione FileVault

Il servizio di sincronizzazione degli archivi viene utilizzato per sincronizzare il contenuto dell'archivio con una rappresentazione del file system locale e viceversa. Questo si ottiene installando un servizio OSGi che ascolterà le modifiche del repository e analizzerà periodicamente il contenuto del filesystem. Utilizza lo stesso formato di serializzazione dell'archivio per mappare il contenuto dell'archivio su disco.

NOTA

Il servizio di sincronizzazione vault è uno strumento di sviluppo ed è altamente scoraggiato ad usarlo su un sistema produttivo. Inoltre, il servizio può sincronizzarsi solo con il filesystem locale e non può essere utilizzato per lo sviluppo remoto.

Installazione del servizio tramite vlt

La vlt sync install può essere utilizzato per installare automaticamente il bundle e la configurazione del servizio di sincronizzazione archivi.

Il bundle è installato qui sotto /libs/crx/vault/install e il nodo di configurazione viene creato in /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl. Inizialmente il servizio è abilitato ma non sono configurate radici di sincronizzazione.

L'esempio seguente installa il servizio di sincronizzazione nell'istanza CRX accessibile dall'URI specificato.

$ vlt --credentials admin:admin sync --uri http://localhost:4502/crx install

Visualizzazione dello stato del servizio

La status può essere utilizzato per visualizzare informazioni sul servizio di sincronizzazione in esecuzione. "

$ vlt sync status --uri http://localhost:4502/crx
Connecting via JCR remoting to http://localhost:4502/crx/server
Listing sync status for http://localhost:4502/crx/server/-/jcr:root
- Sync service is enabled.
- No sync directories configured.
NOTA

La status il comando non recupera dati live dal servizio, ma legge la configurazione in /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl.

Aggiunta di una cartella di sincronizzazione

La register viene utilizzato per aggiungere una cartella da sincronizzare alla configurazione.

$ vlt sync register
Connecting via JCR remoting to http://localhost:4502/crx/server
Added new sync directory: /tmp/workspace/vltsync/jcr_root
NOTA

La register non attiva una sincronizzazione finché non configuri sync-once configurazione.

Rimozione di una cartella di sincronizzazione

La unregister viene utilizzato per rimuovere una cartella da sincronizzare dalla configurazione.

$  vlt sync unregister
Connecting via JCR remoting to http://localhost:4502/crx/server
Removed sync directory: /tmp/workspace/vltsync/jcr_root
NOTA

È necessario annullare la registrazione di una cartella di sincronizzazione prima di eliminare la cartella stessa.

Configurazione della sincronizzazione

Configurazione del servizio

Una volta che il servizio è in esecuzione, può essere configurato con i seguenti parametri:

  • vault.sync.syncroots: Uno o più percorsi di file system locali che definiscono le radici di sincronizzazione.

  • vault.sync.fscheckinterval: Frequenza (in secondi) della quale il file system deve essere analizzato per verificare la presenza di modifiche. Il valore predefinito è 5 secondi.

  • vault.sync.enabled: Flag generale che abilita/disabilita il servizio.

NOTA

Il servizio può essere configurato con la console Web o con un sling:OsgiConfig nodo (con il nome com.day.jcr.sync.impl.VaultSyncServiceImpl) nella directory archivio.

Quando si lavora con AEM esistono diversi metodi per gestire le impostazioni di configurazione di tali servizi; vedere Configurazione di OSGi per informazioni complete.

Sincronizza la configurazione della cartella

Ciascuna cartella di sincronizzazione memorizza la configurazione e lo stato in tre file:

  • .vlt-sync-config.properties: file di configurazione.

  • .vlt-sync.log: file di registro contenente informazioni sulle operazioni eseguite durante la sincronizzazione.

  • .vlt-sync-filter.xml: filtri che definiscono quali parti dell’archivio vengono sincronizzate. Il formato di questo file è descritto dal Esecuzione di un checkout filtrato sezione .

La .vlt-sync-config.properties file ti consente di configurare le seguenti proprietà:

disattivato Attiva o disattiva la sincronizzazione. Per impostazione predefinita, questo parametro è impostato su false per consentire la sincronizzazione.

sync-once Se non è vuoto, la scansione successiva sincronizzerà la cartella nella direzione specificata, il parametro verrà cancellato. Sono supportati due valori:

  • JCR2FS: esporta tutti i contenuti nell’archivio JCR e scrive sul disco locale.
  • FS2JCR: importa tutto il contenuto dal disco nell’archivio JCR.

sync-log Definisce il nome del file di registro. Per impostazione predefinita, il valore è .vlt-sync.log

Utilizzo della sincronizzazione VLT per lo sviluppo

Per impostare un ambiente di sviluppo basato su una cartella di sincronizzazione, procedi come segue:

  1. Effettua il checkout del tuo archivio con la riga di comando vlt:

    $ vlt --credentials admin:admin co --force http://localhost:4502/crx dev
    
    NOTA

    Puoi utilizzare i filtri solo per estrarre i percorsi appropriati. Consulta la sezione Esecuzione di un checkout filtrato per informazioni.

  2. Passa alla cartella principale della copia di lavoro:

    $ cd dev/jcr_root/
    
  3. Installa il servizio di sincronizzazione nel tuo archivio:

    $ vlt sync install
    Connecting via JCR remoting to http://localhost:4502/crx/server
    Preparing to install vault-sync-2.4.24.jar...
    Updated bundle: vault-sync-2.4.24.jar
    Created new config at /libs/crx/vault/config/com.day.jcr.sync.impl.VaultSyncServiceImpl
    
  4. Inizializza il servizio di sincronizzazione:

    $ vlt sync
    Connecting via JCR remoting to http://localhost:4502/crx/server
    Starting initialization of sync service in existing vlt checkout /Users/colligno/Applications/cq5/vltsync/sandbox/dev/jcr_root for http://localhost:4502/crx/server/-/jcr:root
    Added new sync directory: /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root
    
    The directory /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root is now enabled for syncing.
    You might perform a 'sync-once' by setting the
    appropriate flag in the /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/.vlt-sync-config.properties file.
    
  5. Modifica le .vlt-sync-config.properties file nascosto e configura la sincronizzazione per sincronizzare il contenuto del tuo archivio:

    sync-once=JCR2FS
    
    NOTA

    Questo passaggio scarica l’intero archivio in base alla configurazione del filtro.

  6. Controlla il file di registro .vlt-sync.log per vedere lo stato di avanzamento:

    ***
    30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/
    30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/
    30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/product/
    30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/product/GeoProduct.java
    ***
    

La cartella locale è ora sincronizzata con l'archivio. La sincronizzazione è bidirezionale, quindi la modifica dall'archivio verrà applicata alla cartella di sincronizzazione locale e viceversa.

NOTA

La funzione di sincronizzazione VLT supporta solo file e cartelle semplici ma rileva i file serializzati con archivi speciali (.content.xml, dialog.xml, ecc.) e li ignora silenziosamente. Così è possibile utilizzare la sincronizzazione degli archivi su un checkout vlt predefinito.

In questa pagina