VLT ツールの使用方法 how-to-use-the-vlt-tool

Jackrabbit FileVault ツール（VLT）は、Jackrabbit/AEM インスタンスのコンテンツをファイルシステムにマップするためのツールで、Apache Foundation によって開発されました。VLT ツールの機能は、Subversion（SVN）クライアントなどのソース管理システムクライアントに似ており、通常のチェックイン、チェックアウト、管理操作を行うことができるほか、プロジェクトのコンテンツを柔軟に表現する設定オプションも用意されています。

VLT ツールはコマンドラインから実行します。このドキュメントでは、ツールの使い方（導入方法、ヘルプの表示方法、すべてのコマンドと使用可能なオプションのリストを含む）について説明します。

概念およびアーキテクチャ concepts-and-architecture

Filevault ツールの概念と構造の完全な概要については、公式の Apache Jackrabbit Filevault ドキュメントの Filevault の概要および Vault FS ページを参照してください。

VLT の導入 getting-started-with-vlt

VLT の使用を開始するには、次の手順を実行する必要があります。

VLT ツールのインストール installing-the-vlt-tool

VLT ツールを使用するには、まず VLT ツールをインストールする必要があります。追加のツールなので、デフォルトではインストールされません。また、システムの環境変数を設定する必要があります。

インストールが完了したら、グローバルに無視されている subversion ファイルを更新する必要があります。svn 設定を編集して次の情報を追加します。

[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

行末の文字の設定 configuring-the-end-of-line-character

VLT は、次のルールに従って行末（EOF）を自動的に処理します。

VLT と SVN の設定を一致させるには、リポジトリに格納されたファイルの拡張子に対して svn:eol-style プロパティを native に設定する必要があります。svn 設定を編集して次の情報を追加します。

[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

リポジトリのチェックアウト checking-out-the-repository

ソース管理システムを使用してリポジトリをチェックアウトします。例えば svn では、次のように入力します（URI とパスはお使いのリポジトリのものに置き換えてください）。

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

リポジトリとの同期 synchronizing-with-the-repository

filevault とリポジトリを同期する必要があります。次の手順を実行します。

同期が正常に実行されたかどうかのテスト testing-whether-the-synchronization-worked

リポジトリのチェックアウトと同期が完了したら、すべてが適切に機能しているかどうかをテストする必要があります。このテスト行う簡単な方法は、.jsp ファイルを編集して、変更のコミット後にその変更が反映されているかどうかを確認することです。

同期をテストするには：

VLT ツールのヘルプの表示 getting-help-with-the-vlt-tool

VLT ツールのインストールが完了したら、コマンドラインからヘルプファイルにアクセスできます。

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

特定のコマンドに関するヘルプを表示するには、help コマンドの後にそのコマンドの名前を入力します。次は例です。

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

VLT で実行される一般的なタスク common-tasks-performed-in-vlt

VLT で実行される一般的なタスクの一部を次に示します。各コマンドについて詳しくは、個々のコマンドを参照してください。

サブツリーのチェックアウト checking-out-a-subtree

リポジトリのサブツリー（例：/apps/geometrixx）のチェックアウトのみを行う場合は、次のように入力します。

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

これにより、エクスポート用の新しいルート geo が META-INF と jcr_root ディレクトリで作成され、/apps/geometrixx の下のすべてのファイルが geo/jcr_root に配置されます。

フィルターが適用されたチェックアウトの実行 performing-a-filtered-checkout

既存のワークスペースフィルターがあり、チェックアウトにそのフィルターを使用する場合は、最初に META-INF/vault ディレクトリを作成してそこにフィルターを配置するか、またはコマンドラインで次のようにフィルターを指定します。

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

フィルターの例は次のとおりです。

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

.vlt コントロールの代わりとしてのインポート／エクスポートの使用 using-import-export-instead-of-vlt-control

コントロールファイルを使用せずに、JCR リポジトリとローカルファイルシステムとの間でコンテンツのインポートとエクスポートを行うことができます。

.vlt コントロールを使用せずにコンテンツのインポートとエクスポートを行うには：

VLT の使用 using-vlt

VLT でコマンドを実行するには、コマンドラインで次のように入力します。

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

以降の節で、オプションとコマンドについて詳しく説明します。

VLT のグローバルオプション vlt-global-options

すべてのコマンドで使用できる VLT のオプションのリストを次に示します。使用できるその他のオプションについては、個々のコマンドを参照してください。

VLT のコマンド vlt-commands

次の表は、使用可能なすべての VLT コマンドを示しています。構文、使用可能なオプションおよび例について詳しくは、個々のコマンドを参照してください。

エクスポート export

<uri> にマウントされた Vault ファイルシステムを <local-path> のローカルファイルシステムに書き出します。サブツリーのみを書き出すには、オプションの <jcr-path> を指定できます。

構文 syntax

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

オプション options

例 examples

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

import import

<local-path> で始まるローカルファイルシステムを vault ファイルシステム（<uri>）に読み込みます。<jcr-path> をインポートのルートとして指定できます。--sync が指定されている場合は、読み込むファイルは自動的に vault 管理下に置かれます。

構文 syntax-1

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

オプション options-1

例 examples-1

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

checkout（co） checkout-co

JCR リポジトリから、<uri> で始まるローカルファイルシステム、および <local-path> で始まるローカルファイルシステムへの最初のチェックアウトを順に実行します。<jcrPath> 引数を追加して、リモートツリーのサブディレクトリをチェックアウトすることもできます。META-INF ディレクトリにコピーするワークスペースフィルターを指定できます。

構文 syntax-2

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

オプション options-2

例 examples-2

JCR のリモート処理を使用する場合：

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

デフォルトのワークスペースを使用する場合：

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

URI が不完全な場合は、展開されます。

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

分析 analyze

パッケージを分析します。

構文 syntax-3

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

オプション options-3

ステータス status

作業用コピーファイルとディレクトリのステータスを出力します。

--show-update が指定されている場合は、各ファイルがリモートのバージョンと照合されます。2 番目の文字は、更新操作によって実行されるアクションを指定します。

構文 syntax-4

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

オプション options-4

アップデート update

リポジトリから作業用コピーに変更をコピーします。

構文 syntax-5

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

オプション options-5

情報 info

ローカルファイルに関する情報を表示します。

構文 syntax-6

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

オプション options-6

commit commit

作業用コピーからリポジトリに変更を送信します。

構文 syntax-7

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

オプション options-7

元に戻す revert

作業用コピーファイルを元の状態に復元して、大部分のローカルの編集を元に戻します。

構文 syntax-8

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

オプション options-8

Resolved resolved

作業用コピーファイルまたはディレクトリの​ 競合 ​状態を削除します。

構文 syntax-9

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

オプション options-9

propget propget

ファイルまたはディレクトリのプロパティの値を出力します。

構文 syntax-10

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

オプション options-10

proplist proplist

ファイルまたはディレクトリのプロパティを出力します。

構文 syntax-11

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

オプション options-11

propset propset

ファイルまたはディレクトリのプロパティの値を設定します。

構文 syntax-12

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

オプション options-12

add add

ファイルとディレクトリのバージョンを管理し、それらをリポジトリに追加するスケジュールを設定します。これらは次回のコミット時に追加されます。

構文 syntax-13

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

オプション options-13

削除 delete

ファイルとディレクトリのバージョン管理を削除します。

構文 syntax-14

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

オプション options-14

diff diff

2 つのパスの差分を表示します。

構文 syntax-15

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

オプション options-15

コンソール console

インタラクティブコンソールを実行します。

構文 syntax-16

console -F <file>

オプション options-16

rcp rcp

ノードツリーをリモートリポジトリ間でコピーします。<src>はコピー元のノードを指し、<dst>でコピー先のパスを指定します。親ノードが存在するパスである必要があります。rcp は、データをストリーミングすることでノードを処理します。

構文 syntax-17

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

オプション options-17

例 examples-3

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

sync sync

vault 同期サービスを制御できるようにします。引数を指定しない場合、このコマンドは現在の作業ディレクトリの同期の管理を試行します。vlt チェックアウト内で実行される場合は、それぞれのフィルターとホストを使用して同期を設定します。vlt チェックアウト外で実行される場合は、現在のフォルダーを同期用に登録します（ディレクトリが空の場合のみ）。

構文 syntax-18

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

オプション options-18

ステータスコード status-codes

VLT で使用するステータスコードは次のとおりです。

FileVault 同期のセットアップ setting-up-filevault-sync

vault 同期サービスは、リポジトリのコンテンツをローカルファイルシステム表現と同期する（またはその逆の同期を行う）場合に使用します。そのためには、リポジトリの変更をリッスンし、ファイルシステムのコンテンツを定期的にスキャンする OSGi サービスをインストールします。リポジトリのコンテンツをディスクにマッピングするために、Vault と同じシリアル化形式を使用します。

vlt を使用したサービスのインストール installing-the-service-using-vlt

vlt sync install コマンドを使用すると、Vault 同期サービスのバンドルおよび設定を自動的にインストールできます。

このバンドルは /libs/crx/vault/install の下にインストールされ、設定ノードは /libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl に作成されます。最初はサービスが有効になっていますが、同期のルートは設定されていません。

次の例では、特定の uri によってアクセス可能な CRX インスタンスに同期サービスをインストールします。

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

サービスのステータスの表示 displaying-the-service-status

status コマンドを使用すると、実行中の同期サービスに関する情報を表示できます。

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

同期フォルダーの追加 adding-a-sync-folder

register コマンドは、同期するフォルダーを設定に追加するために使用します。

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

同期フォルダーの削除 removing-a-sync-folder

unregister コマンドは、同期するフォルダーを設定から削除するために使用します。

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

同期の設定 configuring-synchronization

サービス設定 service-configuration

実行中のサービスは以下のパラメーターを使用して設定できます。

同期フォルダーの設定 sync-folder-configuration

各同期フォルダーにある次の 3 つのファイルに、設定とステータスが格納されます。

.vlt-sync-config.properties ファイルを使用すると、次のプロパティを設定できます。

無効 同期のオンとオフを切り替えます。デフォルトでは、このパラメーターは false に設定されており、同期が行われます。

sync-once 空でない場合は、次にスキャンするとき、指定した方向にフォルダーを同期し、パラメーターがクリアされます。次の 2 つの値をサポートしています。

sync-log ログのファイル名を定義します。デフォルト値は .vlt-sync.log です。

開発のための VLT 同期の使用 using-vlt-sync-for-development

同期フォルダーに基づいて開発環境をセットアップするには、次の手順を実行します。

これで、ローカルフォルダーがリポジトリと同期されます。この同期は双方向なので、リポジトリからの変更はローカルの同期フォルダーに適用されます。逆の場合も同様です。