Så här använder du VLT-verktyget how-to-use-the-vlt-tool

Jackrabbit FileVault-verktyget (VLT) är ett verktyg som utvecklats av Apache Foundation och som mappar innehållet i en Jackrabbit/AEM-instans till filsystemet. VLT-verktyget har liknande funktioner som en VLT-klient (till exempel en Subversion-klient), med normala in-, utchecknings- och hanteringsåtgärder samt konfigurationsalternativ för flexibel representation av projektinnehållet.

Du kör VLT-verktyget från kommandoraden. I det här dokumentet beskrivs hur du använder verktyget, inklusive hur du kommer igång och får hjälp, och en lista över alla kommandon och tillgängliga alternativ.

Koncept och arkitektur concepts-and-architecture

Se sidan Fillevaöversikt och Vault FS från den officiella dokumentationen för Apache Jackrabbit Filevault för en grundlig översikt över koncept och struktur för verktyget Filevault.

Komma igång med VLT getting-started-with-vlt

Om du vill börja använda VLT måste du göra följande:

Installera VLT-verktyget installing-the-vlt-tool

Om du vill använda VLT-verktyget måste du först installera det. Det installeras inte som standard eftersom det är ett extra verktyg. Dessutom måste du ange systemmiljövariabeln.

När du har installerat den måste du uppdatera globala ignorerade underversionsfiler. Redigera SVN-inställningarna och lägg till följande:

[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

Konfigurera tecknet för radslut configuring-the-end-of-line-character

VLT hanterar automatiskt End Of Line (EOF) enligt följande regler:

För att garantera att konfigurationen för VLT och SVN matchar bör du ställa in egenskapen svn:eol-style på native för filtillägget som lagras i databasen. Redigera SVN-inställningarna och lägg till följande:

[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

Checka ut databasen checking-out-the-repository

Checka ut databasen med hjälp av källkontrollssystemet. I svn skriver du till exempel följande (ersätter URI och sökväg med din databas):

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

Synkronisera med databasen synchronizing-with-the-repository

Du måste synkronisera filnivå med databasen. Så här gör du:

Testar om synkroniseringen fungerade testing-whether-the-synchronization-worked

När du har checkat ut databasen och synkroniserat den bör du testa att se till att allt fungerar som det ska. Ett enkelt sätt att göra detta är att redigera en .jsp-fil och se om ändringarna återspeglas när ändringarna har verkställts.

Så här testar du synkroniseringen:

Få hjälp med VLT-verktyget getting-help-with-the-vlt-tool

När du har installerat VLT-verktyget kommer du åt dess hjälpfil från kommandoraden:

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

Om du vill ha hjälp med ett visst kommando skriver du hjälpkommandot följt av namnet på kommandot. Till exempel:

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

Vanliga uppgifter utförda i VLT common-tasks-performed-in-vlt

Nedan följer några vanliga uppgifter som utförs i VLT. Mer information om varje kommando finns i de enskilda kommandona.

Checka ut ett underträd checking-out-a-subtree

Om du bara vill checka ut ett underträd i databasen, till exempel /apps/geometrixx, kan du göra det genom att skriva följande:

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

Om du gör det skapas en ny exportrot geo med katalogen META-INF och jcr_root och alla filer placeras under /apps/geometrixx i geo/jcr_root.

Utföra en filtrerad utcheckning performing-a-filtered-checkout

Om du har ett befintligt arbetsytefilter och vill använda det för utcheckning kan du antingen skapa katalogen META-INF/vault och placera filtret där, eller ange det på kommandoraden enligt följande:

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

Ett exempelfilter:

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

Använda Importera/exportera i stället för VLT-kontroll using-import-export-instead-of-vlt-control

Du kan importera och exportera innehåll mellan en JCR-databas och det lokala filsystemet utan att använda kontrollfiler.

Så här importerar och exporterar du innehåll utan att använda kontrollen .vlt:

Använda VLT using-vlt

Om du vill skicka kommandon i VLT skriver du följande på kommandoraden:

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

Alternativ och kommandon beskrivs i detalj i följande avsnitt.

Globala VLT-alternativ vlt-global-options

Nedan följer en lista över VLT-alternativ som är tillgängliga för alla kommandon. Mer information om ytterligare tillgängliga alternativ finns i de enskilda kommandona.

VLT-kommandon vlt-commands

I följande tabell beskrivs alla tillgängliga VLT-kommandon. I de enskilda kommandona finns detaljerad information om syntax, tillgängliga alternativ och exempel.

Exportera export

Exporterar Vaultfilsystemet som är monterat på <uri> till det lokala filsystemet på <local-path>. Du kan ange ett valfritt <jcr-path> om du bara vill exportera ett underträd.

Syntax syntax

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

Alternativ options

Exempel examples

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

Importera import

Importerar det lokala filsystemet (med början vid <local-path> till valvfilsystemet vid <uri>. Du kan ange en <jcr-path> som importrot. Om --sync anges hamnar de importerade filerna automatiskt under vaultkontroll.

Syntax syntax-1

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

Alternativ options-1

Exempel examples-1

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

Utcheckning (co) checkout-co

Utför en första utcheckning från en JCR-databas till det lokala filsystemet från <uri> till det lokala filsystemet på <local-path>. Du kan också lägga till ett <jcrPath>-argument för att checka ut en underkatalog till fjärrträdet. Workspace-filter kan anges som kopieras till META-INF-katalogen.

Syntax syntax-2

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

Alternativ options-2

Exempel examples-2

Använda JCR Remoting:

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

Med standardarbetsytan:

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

Om URI:n är ofullständig utökas den:

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

Analysera analyze

Analyserar paket.

Syntax syntax-3

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

Alternativ options-3

Status status

Skriver ut status för arbetskopia av filer och kataloger.

Om --show-update anges kontrolleras varje fil mot fjärrversionen. Den andra bokstaven anger sedan vilken åtgärd som ska utföras av en uppdateringsåtgärd.

Syntax syntax-4

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

Alternativ options-4

Uppdatera update

Kopierar ändringar från databasen till arbetskopian.

Syntax syntax-5

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

Alternativ options-5

Info info

Visar information om en lokal fil.

Syntax syntax-6

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

Alternativ options-6

Verkställ commit

Skickar ändringar från din arbetskopia till databasen.

Syntax syntax-7

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

Alternativ options-7

Återställ revert

Återställer arbetskopiefilen till ursprungligt läge och ångrar de flesta lokala redigeringarna.

Syntax syntax-8

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

Alternativ options-8

Löst resolved

Tar bort konfliktläge för arbetskopiefiler eller kataloger.

Syntax syntax-9

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

Alternativ options-9

Propget propget

Skriver ut värdet för en egenskap på filer eller kataloger.

Syntax syntax-10

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

Alternativ options-10

Proplist proplist

Skriver ut egenskaperna för filer eller kataloger.

Syntax syntax-11

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

Alternativ options-11

Propset propset

Anger värdet för en egenskap i filer eller kataloger.

Syntax syntax-12

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

Alternativ options-12

Lägg till add

Placerar filer och kataloger under versionskontroll och schemalägger dem så att de kan läggas till i databasen. De kommer att läggas till vid nästa implementering.

Syntax syntax-13

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

Alternativ options-13

Ta bort delete

Tar bort filer och kataloger från versionskontrollen.

Syntax syntax-14

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

Alternativ options-14

Diff diff

Visar skillnaderna mellan två banor.

Syntax syntax-15

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

Alternativ options-15

Konsol console

Kör en interaktiv konsol.

Syntax syntax-16

console -F <file>

Alternativ options-16

Rcp rcp

Kopierar ett nodträd från en fjärrdatabas till en annan. <src> pekar på källnoden och <dst> anger målsökvägen, där den överordnade noden måste finnas. Rcp bearbetar noderna genom att direktuppspela data.

Syntax syntax-17

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

Alternativ options-17

Exempel examples-3

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

Synkronisera sync

Låter dig styra tjänsten för valvsynkronisering. Utan argument försöker det här kommandot synkronisera den aktuella arbetskatalogen. Om den körs inom en giltig utcheckning används respektive filter och värd för att konfigurera synkroniseringen. Om den körs utanför en giltig utcheckning registreras den aktuella mappen endast för synkronisering om katalogen är tom.

Syntax syntax-18

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

Alternativ options-18

Statuskoder status-codes

Statuskoderna som används av VLT är:

Konfigurera FileVault-synkronisering setting-up-filevault-sync

Tjänsten vault sync används för att synkronisera databasinnehåll med en lokal filsystemrepresentation och omvänt. Detta uppnås genom att installera en OSGi-tjänst som avlyssnar databasändringar och regelbundet söker igenom filsystemets innehåll. Det använder samma serialiseringsformat som vault för att mappa databasinnehållet till disken.

Installera tjänsten med VLT installing-the-service-using-vlt

Kommandot vlt sync install kan användas för att installera tjänstpaketet för vaultsynkronisering och konfigurationen automatiskt.

Paketet installeras under /libs/crx/vault/install och konfigurationsnoden skapas på /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl. Tjänsten är till att börja med aktiverad, men inga synkroniseringsrötter har konfigurerats.

I följande exempel installeras synkroniseringstjänsten på den CRX-instans som är tillgänglig för den angivna uri.

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

Visa tjänstens status displaying-the-service-status

Kommandot status kan användas för att visa information om den synkroniseringstjänst som körs. "

$ 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.

Lägga till en synkroniseringsmapp adding-a-sync-folder

Kommandot register används för att lägga till en mapp som ska synkroniseras med konfigurationen.

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

Ta bort en synkroniseringsmapp removing-a-sync-folder

Kommandot unregister används för att ta bort en mapp som ska synkroniseras från konfigurationen.

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

Konfigurerar synkronisering configuring-synchronization

Tjänstkonfiguration service-configuration

När tjänsten körs kan den konfigureras med följande parametrar:

Synkronisera mappkonfiguration sync-folder-configuration

I varje synkroniseringsmapp lagras konfiguration och status i tre filer:

Med filen .vlt-sync-config.properties kan du konfigurera följande egenskaper:

inaktiverad Aktiverar eller inaktiverar synkroniseringen. Som standard är den här parametern inställd på false för att tillåta synkronisering.

sync-once Om nästa sökning inte är tom kommer att synkronisera mappen i den angivna riktningen, kommer parametern att rensas. Två värden stöds:

sync-log definierar loggfilens namn. Som standard är värdet .vlt-sync.log

Använda VLT-synkronisering för utveckling using-vlt-sync-for-development

Så här konfigurerar du en utvecklingsmiljö baserad på en synkroniseringsmapp:

Din lokala mapp är nu synkroniserad med databasen. Synkroniseringen är dubbelriktad, så ändringar från databasen tillämpas på din lokala synkroniseringsmapp och omvänt.