Como usar a ferramenta VLT how-to-use-the-vlt-tool

A ferramenta Jackrabbit FileVault (VLT) é uma ferramenta desenvolvida pela The Apache Foundation, que mapeia o conteúdo de uma instância Jackrabbit/AEM para o seu sistema de arquivos. A ferramenta VLT tem funções semelhantes às do cliente do sistema de controle de origem (como um cliente SVN), fornecendo operações normais de check-in, check-out e gerenciamento, além de opções de configuração para representação flexível do conteúdo do projeto.

Execute a ferramenta VLT a partir da linha de comando. Este documento descreve como usar a ferramenta, incluindo como começar e obter ajuda, e uma lista de todos os comandos e as opções disponíveis.

Conceitos e arquitetura concepts-and-architecture

Consulte a página Visão geral do Filevault e Vault FS da documentação oficial do Apache Jackrabbit Filevault para obter uma visão geral completa dos conceitos e da estrutura da ferramenta Filevault.

Introdução ao VLT getting-started-with-vlt

Para começar a usar o VLT, é necessário fazer o seguinte:

Instalação da ferramenta VLT installing-the-vlt-tool

Para usar a ferramenta VLT, primeiro é necessário instalá-la. Ele não é instalado por padrão, pois é uma ferramenta adicional. Além disso, é necessário definir a variável de ambiente do sistema.

Depois de instalá-lo, você precisa atualizar os arquivos de subversão ignorados globais. Edite suas configurações de svn e adicione o seguinte:

[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

Configurando o caractere de fim de linha configuring-the-end-of-line-character

O VLT processa automaticamente o Final da Linha (EOF) de acordo com as seguintes regras:

Para garantir que a configuração de VLT e SVN corresponda, você deve configurar a propriedade svn:eol-style como native para a extensão dos arquivos armazenados no repositório. Edite suas configurações de svn e adicione o seguinte:

[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

Fazendo check-out do repositório checking-out-the-repository

Fazer check-out do repositório usando o sistema de controle de origem. No svn, por exemplo, digite o seguinte (substituindo o URI e o caminho pelo repositório):

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

Sincronização com o repositório synchronizing-with-the-repository

Você precisa sincronizar o cofre com o repositório. Para fazer isso:

Testar se a sincronização funcionou testing-whether-the-synchronization-worked

Depois de fazer check-out do repositório e sincronizá-lo, você deve testar para garantir que tudo funcione corretamente. Uma maneira fácil de fazer isso é editar um arquivo .jsp e ver se suas alterações são refletidas após confirmar as alterações.

Para testar a sincronização:

Obtendo ajuda com a ferramenta VLT getting-help-with-the-vlt-tool

Depois de instalar a ferramenta VLT, você pode acessar o arquivo Ajuda na linha de 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
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Para obter ajuda sobre um comando específico, digite o comando help seguido do nome do comando. Por exemplo:

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

Tarefas Comuns Executadas no VLT common-tasks-performed-in-vlt

A seguir estão algumas tarefas comuns executadas no VLT. Para obter informações detalhadas sobre cada comando, consulte os comandos individuais.

Fazendo Check-out de uma Subárvore checking-out-a-subtree

Se você quiser fazer check-out apenas de uma subárvore do repositório, por exemplo, /apps/geometrixx, digite o seguinte:

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

Isso cria uma nova raiz de exportação geo com um diretório META-INF e jcr_root e coloca todos os arquivos abaixo de /apps/geometrixx em geo/jcr_root.

Executando uma Finalização Filtrada performing-a-filtered-checkout

Se você tiver um filtro de espaço de trabalho existente e quiser usá-lo para check-out, poderá primeiro criar o diretório META-INF/vault e colocar o filtro nele ou especificá-lo na linha de comando da seguinte maneira:

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

Um exemplo de filtro:

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

Uso de Importação/Exportação em Vez de Controle .vlt using-import-export-instead-of-vlt-control

Você pode importar e exportar conteúdo entre um repositório JCR e o sistema de arquivos local sem usar arquivos de controle.

Para importar e exportar conteúdo sem usar o controle .vlt:

Uso do VLT using-vlt

Para emitir comandos no VLT, digite o seguinte na linha de comando:

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

As opções e os comandos são descritos em detalhes nas seções a seguir.

Opções Globais de VLT vlt-global-options

Veja a seguir uma lista de opções de VLT, que estão disponíveis para todos os comandos. Consulte os comandos individuais para obter informações sobre opções adicionais disponíveis.

Comandos VLT vlt-commands

A tabela a seguir descreve todos os comandos VLT disponíveis. Consulte os comandos individuais para obter informações detalhadas sobre sintaxe, opções disponíveis e exemplos.

Exportar export

Exporta o sistema de arquivos do Vault montado em <uri> para o sistema de arquivos local em <local-path>. Um <jcr-path> opcional pode ser especificado para exportar apenas uma subárvore.

Sintaxe syntax

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

Opções options

Exemplos examples

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

Importar import

Importa o sistema de arquivos local (iniciando em <local-path> para o sistema de arquivos do cofre em <uri>. Você pode especificar um <jcr-path> como raiz de importação. Se --sync for especificado, os arquivos importados serão automaticamente colocados sob controle do cofre.

Sintaxe syntax-1

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

Opções options-1

Exemplos examples-1

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

Check-out (co) checkout-co

Executa uma verificação inicial de um repositório JCR no sistema de arquivos local, iniciando em <uri> para o sistema de arquivos local em <local-path>. Você também pode adicionar um argumento <jcrPath> para verificar um subdiretório da árvore remota. É possível especificar filtros Workspace que são copiados para o diretório META-INF.

Sintaxe syntax-2

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

Opções options-2

Exemplos examples-2

Usando comunicação remota JCR:

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

Com o espaço de trabalho padrão:

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

Se o URI estiver incompleto, ele será expandido:

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

Analisar analyze

Analisa pacotes.

Sintaxe syntax-3

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

Opções options-3

Status status

Imprime o status dos arquivos e diretórios da cópia de trabalho.

Se --show-update for especificado, cada arquivo será verificado em relação à versão remota. A segunda letra especifica que ação será executada por uma operação de atualização.

Sintaxe syntax-4

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

Opções options-4

Atualizar o update

Copia as alterações do repositório para a cópia de trabalho.

Sintaxe syntax-5

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

Opções options-5

Informações info

Exibe informações sobre um arquivo local.

Sintaxe syntax-6

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

Opções options-6

Confirmar commit

Envia as alterações da sua cópia de trabalho para o repositório.

Sintaxe syntax-7

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

Opções options-7

Reverter revert

Restaura o arquivo de cópia de trabalho ao estado original e desfaz a maioria das edições locais.

Sintaxe syntax-8

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

Opções options-8

Resolvido resolved

Remove o estado conflitante nos arquivos ou diretórios da cópia de trabalho.

Sintaxe syntax-9

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

Opções options-9

Propget propget

Imprime o valor de uma propriedade em arquivos ou diretórios.

Sintaxe syntax-10

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

Opções options-10

Proplist proplist

Imprime as propriedades nos arquivos ou diretórios.

Sintaxe syntax-11

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

Opções options-11

Propset propset

Define o valor de uma propriedade em arquivos ou diretórios.

Sintaxe syntax-12

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

Opções options-12

Adicionar add

Coloca arquivos e diretórios sob controle de versão, agendando-os para adição ao repositório. Eles serão adicionados na próxima confirmação.

Sintaxe syntax-13

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

Opções options-13

Excluir delete

Remove arquivos e diretórios do controle de versão.

Sintaxe syntax-14

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

Opções options-14

Diff diff

Exibe as diferenças entre dois caminhos.

Sintaxe syntax-15

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

Opções options-15

Console console

Executa um console interativo.

Sintaxe syntax-16

console -F <file>

Opções options-16

Rcp rcp

Copia uma árvore de nós de um repositório remoto para outro. <src> aponta para o nó de origem e <dst> especifica o caminho de destino, onde o nó pai deve existir. O Rcp processa os nós transmitindo os dados.

Sintaxe syntax-17

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

Opções options-17

Exemplos examples-3

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

Sincronizar sync

Permite controlar o serviço de sincronização do Vault. Sem nenhum argumento, este comando tenta colocar o diretório de trabalho atual sob controle de sincronização. Se executado em uma finalização de compra do vlt, ele usa o respectivo filtro e host para configurar a sincronização. Se for executado fora de um check-out vlt, ele registrará a pasta atual para sincronização somente se o diretório estiver vazio.

Sintaxe syntax-18

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

Opções options-18

Códigos de status status-codes

Os códigos de status usados pelo VLT são:

Configurando a sincronização do FileVault setting-up-filevault-sync

O serviço de sincronização do Vault é usado para sincronizar o conteúdo do repositório com uma representação de sistema de arquivos local e vice-versa. Isso é feito instalando um serviço OSGi que detectará as alterações no repositório e verificará o conteúdo do sistema de arquivos periodicamente. Ele usa o mesmo formato de serialização que o Vault para mapear o conteúdo do repositório para o disco.

Instalando o serviço usando vlt installing-the-service-using-vlt

O comando vlt sync install pode ser usado para instalar o pacote de serviços de sincronização do Vault e a configuração automaticamente.

O pacote está instalado abaixo de /libs/crx/vault/install e o nó de configuração é criado em /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl. Inicialmente, o serviço está habilitado, mas nenhuma raiz de sincronização está configurada.

O exemplo a seguir instala o serviço de sincronização na instância do CRX acessível pelo uri fornecido.

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

Exibição do status do serviço displaying-the-service-status

O comando status pode ser usado para exibir informações sobre o serviço de sincronização em execução. "

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

Adição de uma pasta de sincronização adding-a-sync-folder

O comando register é usado para adicionar uma pasta para sincronizar com a configuração.

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

Remoção de uma pasta de sincronização removing-a-sync-folder

O comando unregister é usado para remover uma pasta para sincronização da configuração.

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

Configuração da sincronização configuring-synchronization

Configuração do serviço service-configuration

Quando o serviço estiver em execução, ele poderá ser configurado com os seguintes parâmetros:

Sincronizar configuração da pasta sync-folder-configuration

Cada pasta de sincronização armazena a configuração e o status em três arquivos:

O arquivo .vlt-sync-config.properties permite configurar as seguintes propriedades:

desabilitado Ativa ou desativa a sincronização. Por padrão, esse parâmetro é definido como false para permitir a sincronização.

sincronizar uma vez Se não estiver vazio, a próxima verificação sincronizará a pasta na direção especificada e o parâmetro será limpo. Dois valores são suportados:

sync-log Define o nome do arquivo de log. O valor padrão é .vlt-sync.log

Uso da sincronização VLT para desenvolvimento using-vlt-sync-for-development

Para configurar um ambiente de desenvolvimento com base em uma pasta de sincronização, proceda da seguinte maneira:

A pasta local agora está sincronizada com o repositório. A sincronização é bidirecional, portanto, a modificação do repositório será aplicada à pasta de sincronização local e vice-versa.