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

A ferramenta Jackrabbit FileVault (VLT) é uma ferramenta desenvolvida por A Fundação Apache que mapeia o conteúdo de uma instância Jackrabbit/AEM para seu sistema de arquivos. A ferramenta VLT tem funções semelhantes às do cliente do sistema de controle de origem (como um cliente SVN (Subversion)), fornecendo operações normais de check-in, check-out e gerenciamento, bem como 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, bem como uma lista de todos os comandos e disponíveis opções.

Conceitos e arquitetura concepts-and-architecture

Consulte a Visão geral do Filevault e Cofre FS página do funcionário Documentação 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, você precisa 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.

Após instalá-lo, é necessário atualizar os arquivos de subversão globais ignorados. Edite as configurações 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

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

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

Para garantir que a configuração de VLT e SVN seja correspondente, você deve configurar a variável svn:eol-style propriedade para native para a extensão dos arquivos armazenados no repositório. Edite as configurações 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

Confira o repositório usando o sistema de controle de origem. Em svn, por exemplo, digite o seguinte (substituindo o URI e o caminho pelo seu repositório):

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

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

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

Testando 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 uma .jsp e veja se as alterações são refletidas após confirmar as alterações.

Para testar a sincronização:

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

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

Tarefas comuns executadas em VLT common-tasks-performed-in-vlt

Veja a seguir algumas tarefas comuns executadas no VLT. Para obter informações detalhadas sobre cada comando, consulte o comandos.

Fazendo check-out de uma subárvore checking-out-a-subtree

Por exemplo, se você quiser verificar apenas uma subárvore do repositório, /apps/geometrixx, você pode fazer isso digitando o seguinte:

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

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

Execução de um Check-out Filtrado performing-a-filtered-checkout

Se você tiver um filtro de espaço de trabalho existente e deseja usá-lo para check-out, é possível primeiro criar o META-INF/vault e coloque o filtro lá, ou especifique-o 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 Importar/Exportar em vez do 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 .vlt Controlo:

Uso de 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 detalhadamente 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 Vault montado em <uri> para o sistema de arquivos local em <local-path>. Uma <jcr-path> 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 (começando em <local-path> ao sistema de arquivos do cofre em <uri>. Você pode especificar uma <jcr-path> como raiz de importação. If --sync for especificado, os arquivos importados serão automaticamente colocados sob controle de 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 um check-out 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 uma <jcrpath> para fazer check-out de um subdiretório da árvore remota. É possível especificar filtros de espaço de trabalho 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 a Remoção do 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 de arquivos e diretórios de cópia de trabalho.

If --show-update for especificado, cada arquivo será verificado em relação à versão remota. A segunda letra especifica então qual ação seria 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 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 alterações da 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 conflitante estado em arquivos ou diretórios de 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 em 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ó 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 fazendo o streaming dos 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 de cofre. Sem nenhum argumento, esse comando tenta colocar o diretório de trabalho atual sob controle sincronizado. Se executado em um check-out de vlt, ele usará o respectivo filtro e host para configurar a sincronização. Se executado fora de um check-out de 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 de cofre é usado para sincronizar o conteúdo do repositório com uma representação do sistema de arquivos local e vice-versa. Isso é feito instalando um serviço OSGi que acompanha as alterações do repositório e verificará o conteúdo do sistema de arquivos periodicamente. Ele usa o mesmo formato de serialização do cofre para mapear o conteúdo do repositório para o disco.

Instalação do serviço usando vlt installing-the-service-using-vlt

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

O pacote está instalado abaixo /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 é ativado, mas nenhuma raiz de sincronização é 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

Exibir o status do serviço displaying-the-service-status

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

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

O 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

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

O unregister é usado para remover uma pasta para sincronizar 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

Depois que 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 .vlt-sync-config.properties permite configurar as seguintes propriedades:

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

sync-once Se não estiver vazio, a próxima verificação sincronizará a pasta na direção determinada, então o parâmetro será limpo. Dois valores são suportados:

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

Usar a 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 é sincronizada com o repositório. A sincronização é bidirecional, portanto, a modificação do repositório será aplicada à sua pasta de sincronização local e vice-versa.