Come utilizzare lo strumento VLT how-to-use-the-vlt-tool

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

Lo strumento VLT viene eseguito dalla riga di comando. In questo documento viene descritto come utilizzare lo strumento, incluso come iniziare e ottenere assistenza, e un elenco di tutti i comandi e delle opzioni disponibili.

Concetti e architettura concepts-and-architecture

Per una panoramica completa dei concetti e della struttura dello strumento Filevault, vedere la pagina Panoramica di Filevault e Vault FS nella documentazione ufficiale di Apache Jackrabbit Filevault.

Guida introduttiva a VLT getting-started-with-vlt

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

Installazione dello strumento VLT installing-the-vlt-tool

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

Dopo averlo installato, è necessario aggiornare i file di sovversione 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 configuring-the-end-of-line-character

VLT gestisce automaticamente la fine della linea (EOF) in base alle seguenti regole:

Per garantire che la configurazione VLT e SVN corrisponda, è necessario impostare la proprietà svn:eol-style su native per l'estensione dei file archiviati nell'archivio. 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 dell'archivio checking-out-the-repository

Estrarre l'archivio utilizzando il sistema di controllo del codice sorgente. In svn, ad esempio, digita quanto segue (sostituendo l’URI e il percorso con l’archivio):

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

Sincronizzazione con l’archivio synchronizing-with-the-repository

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

Verifica del funzionamento della sincronizzazione testing-whether-the-synchronization-worked

Dopo aver estratto il repository e averlo sincronizzato, è necessario eseguire un test per verificare che tutto funzioni correttamente. Un modo semplice per eseguire questa operazione è modificare un file .jsp e verificare se le modifiche vengono applicate dopo il commit delle modifiche.

Per verificare la sincronizzazione:

Come trovare assistenza con lo strumento VLT getting-help-with-the-vlt-tool

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 della Guida su un comando specifico, digitare il comando help seguito dal nome del comando. Ad 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 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 common-tasks-performed-in-vlt

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

Estrazione di una sottostruttura checking-out-a-subtree

Se si desidera estrarre solo una sottostruttura del repository, ad esempio /apps/geometrixx, è possibile digitare quanto segue:

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

In questo modo viene creata una nuova radice di esportazione geo con una directory META-INF e jcr_root e tutti i file al di sotto di /apps/geometrixx vengono inseriti in geo/jcr_root.

Esecuzione di un Check-Out filtrato performing-a-filtered-checkout

Se si dispone di un filtro dell'area di lavoro esistente e si desidera utilizzarlo per l'estrazione, è possibile creare innanzitutto la directory META-INF/vault e posizionare il filtro in tale directory oppure specificarlo nella riga di comando come indicato di seguito:

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

Esempio di filtro:

<?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 al posto del controllo .vlt using-import-export-instead-of-vlt-control

Puoi importare ed esportare contenuti tra un archivio JCR e il file system locale senza utilizzare i control file.

Per importare ed esportare contenuto senza utilizzare il controllo .vlt:

Utilizzo di VLT using-vlt

Per eseguire 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 vlt-global-options

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

Comandi VLT vlt-commands

Nella tabella seguente vengono descritti tutti i comandi VLT disponibili. Per informazioni dettagliate sulla sintassi, sulle opzioni disponibili e sugli esempi, vedere i singoli comandi.

Esporta export

Esporta il file system Vault installato in <uri> nel file system locale in <local-path>. È possibile specificare un <jcr-path> facoltativo per esportare solo una sottostruttura.

Sintassi syntax

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

Opzioni options

Esempi examples

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

Importa import

Importa il file system locale (a partire da <local-path>) nel file system di Vault in <uri>. È possibile specificare <jcr-path> come radice di importazione. Se si specifica --sync, i file importati verranno automaticamente posti sotto controllo di Vault.

Sintassi syntax-1

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

Opzioni options-1

Esempi examples-1

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

Pagamento (co) checkout-co

Esegue un check-out iniziale da un archivio JCR al file system locale a partire da <uri> fino al file system locale in <local-path>. È inoltre possibile aggiungere un argomento <jcrPath> per estrarre una sottodirectory della struttura remota. È possibile specificare filtri Workspace da copiare nella directory META-INF.

Sintassi syntax-2

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

Opzioni options-2

Esempi examples-2

Utilizzo di JCR Remoting:

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 analyze

Analizza i pacchetti.

Sintassi syntax-3

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

Opzioni options-3

Stato status

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

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

Sintassi syntax-4

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

Opzioni options-4

Aggiornare update

Copia le modifiche dal repository nella copia di lavoro.

Sintassi syntax-5

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

Opzioni options-5

Info info

Visualizza informazioni su un file locale.

Sintassi syntax-6

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

Opzioni options-6

Conferma commit

Invia le modifiche dalla copia di lavoro all'archivio.

Sintassi syntax-7

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

Opzioni options-7

Ripristina revert

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

Sintassi syntax-8

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

Opzioni options-8

Risolto resolved

Rimuove lo stato in conflitto nei file o nelle directory di copia di lavoro.

Sintassi syntax-9

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

Opzioni options-9

Propget propget

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

Sintassi syntax-10

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

Opzioni options-10

Proplist proplist

Stampa le proprietà su file o directory.

Sintassi syntax-11

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

Opzioni options-11

Propset propset

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

Sintassi syntax-12

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

Opzioni options-12

Aggiungi add

Inserisce i file e le directory sotto il controllo della versione, pianificandoli per l'aggiunta all'archivio. Verranno aggiunti al prossimo commit.

Sintassi syntax-13

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

Opzioni options-13

Elimina delete

Rimuove file e directory dal controllo delle versioni.

Sintassi syntax-14

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

Opzioni options-14

Diff. diff

Visualizza le differenze tra due percorsi.

Sintassi syntax-15

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

Opzioni options-15

Console console

Esegue una console interattiva.

Sintassi syntax-16

console -F <file>

Opzioni options-16

Rcp rcp

Copia una struttura di nodi da un repository remoto a un altro. <src> punta al nodo di origine e <dst> specifica il percorso di destinazione, in cui deve esistere il nodo padre. Rcp elabora i nodi trasmettendo i dati in streaming.

Sintassi syntax-17

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

Opzioni options-17

Esempi examples-3

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

Sincronizza sync

Consente di controllare il servizio di sincronizzazione di Vault. Senza argomenti, questo comando tenta di porre la directory di lavoro corrente sotto il controllo di sincronizzazione. Se viene eseguito all'interno di un'estrazione VLT, utilizza il rispettivo filtro e host per configurare la sincronizzazione. Se viene eseguita all'esterno di un'estrazione VLT, la cartella corrente viene registrata per la sincronizzazione solo se la directory è vuota.

Sintassi syntax-18

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

Opzioni options-18

Codici di stato status-codes

I codici di stato utilizzati da VLT sono:

Impostazione della sincronizzazione di FileVault setting-up-filevault-sync

Il servizio di sincronizzazione Vault viene utilizzato per sincronizzare il contenuto dell’archivio con una rappresentazione del file system locale e viceversa. Ciò si ottiene installando un servizio OSGi che ascolta le modifiche dell’archivio e analizza periodicamente il contenuto del file system. Utilizza lo stesso formato di serializzazione dell’insieme di credenziali per la mappatura del contenuto dell’archivio su disco.

Installazione del servizio tramite vlt installing-the-service-using-vlt

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

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

Nell'esempio seguente il servizio di sincronizzazione viene installato nell'istanza di CRX accessibile dall'URI specificato.

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

Visualizzazione dello stato del servizio displaying-the-service-status

Il comando 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.

Aggiunta di una cartella di sincronizzazione adding-a-sync-folder

Il comando 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

Rimozione di una cartella di sincronizzazione removing-a-sync-folder

Il comando 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

Configurazione della sincronizzazione configuring-synchronization

Configurazione del servizio service-configuration

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

Sincronizza configurazione cartelle sync-folder-configuration

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

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

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

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

sync-log Definisce il nome del file di log. Il valore predefinito è .vlt-sync.log

Utilizzo della sincronizzazione VLT per lo sviluppo using-vlt-sync-for-development

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

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