Jackrabbit FileVault ツール(VLT)は、Jackrabbit/AEM インスタンスのコンテンツをファイルシステムにマップするためのツールで、The Apache Foundation によって開発されました。VLT ツールの機能はソース管理システムクライアント(Subversion(SVN)クライアントなど)に似ており、通常のチェックイン、チェックアウト、管理操作をおこなうことができるほか、プロジェクトのコンテンツを柔軟に表現するための設定オプションも用意されています。
VLT ツールはコマンドラインから実行します。このドキュメントでは、ツールの使い方(導入方法、ヘルプの表示方法、すべてのコマンドと使用可能なオプションのリストを含む)について説明します。
Filevaultツールの概念と構造の詳細については、Apache Jackrabbit FilevaultドキュメントのFilevaultの概要とVault FSのページを参照してください。
VLT の使用を開始するには、次の手順を実行する必要があります。
VLT ツールを使用するには、まず VLT ツールをインストールする必要があります。このツールは追加のツールなので、デフォルトではインストールされません。 また、システムの環境変数を設定する必要があります。
MavenアーティファクトリポジトリからFileVaultアーカイブファイルをダウンロードします。
VLTツールのソースはGitHubで利用できます。
アーカイブを解凍します。
<a追加0/>を環境PATH
に送信し、必要に応じてvlt
またはvlt.bat
にアクセスできるようにします。 <archive-dir>/vault-cli-<version>/bin
次に例を示します。
<aem-installation-dir>/crx-quickstart/opt/helpers/vault-cli-3.1.16/bin>
コマンドラインシェルを開き、vlt --help
を実行します。 出力が次のヘルプ画面のようになっていることを確認します。
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
インストールが完了したら、グローバルに無視されている 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
VLT は、次のルールに従って行末(EOF)を自動的に処理します。
CRLF
で終わる。LF
で終わるLF
で終わる。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
ソース管理システムを使用してリポジトリをチェックアウトします。例えば svn では、次のように入力します(URI とパスはお使いのリポジトリのものに置き換えてください)。
svn co https://svn.server.com/repos/myproject
filevault とリポジトリを同期する必要があります。次の手順を実行します。
コマンドラインでcontent/jcr_root
に移動します。
次のように入力してリポジトリをチェックアウトします(4502 をお使いのポート番号に置き換えて、お使いの admin パスワードを使用してください)。
vlt --credentials admin:admin co --force http://localhost:4502/crx
資格情報は、初回のチェックアウト時に1回だけ指定する必要があります。その後、.vault/auth.xml
内のホームディレクトリに保存されます。
リポジトリのチェックアウトと同期が完了したら、すべてが適切に機能しているかどうかをテストする必要があります。このテストを簡単におこなうには、.jsp ファイルを編集して、変更のコミット後にその変更が反映されているかどうかを確認します。
同期をテストするには:
.../jcr_content/libs/foundation/components/text
に移動します。text.jsp
で何かを編集します。vlt st
と入力して、変更されたファイルを確認します。vlt diff text.jsp
と入力して変更を確認してくださいvlt ci test.jsp
.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 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
VLT で実行される一般的なタスクの一部を以下に示します。各コマンドについて詳しくは、個々のコマンドを参照してください。
リポジトリのサブツリー(例:/apps/geometrixx
)だけをチェックアウトする場合は、次のように入力します。
vlt co http://localhost:4502/crx/-/jcr:root/apps/geometrixx geo
これを行うと、META-INF
とjcr_root
ディレクトリを持つ新しい書き出しルートgeo
が作成され、すべてのファイルがgeo/jcr_root
の/apps/geometrixx
の下に配置されます。
既存のワークスペースフィルターがあり、チェックアウトにそのフィルターを使用する場合は、最初に 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>
コントロールファイルを使用せずに、JCR リポジトリとローカルファイルシステムとの間でコンテンツの読み込みと書き出しをおこなうことができます。
.vlt
コントロールを使用せずにコンテンツを読み込んで書き出すには:
最初にリポジトリをセットアップします。
$ cd /projects
$ svn mkdir https://svn.server.com/repos/myproject
$ svn co https://svn.server.com/repos/myproject
$ vlt export -v http://localhost:4502/crx /apps/geometrixx geometrixx
$ cd geometrixx/
$ svn add META-INF/ jcr_root/
$ svn ci
リモートコピーを変更して JCR を更新します。
$ cd /projects/geometrixx
$ vlt -v import http://localhost:4502/crx . /
リモートコピーを変更してファイルサーバーを更新します。
$ cd /projects/geometrixx
$ vlt export -v http://localhost:4502/crx /apps/geometrixx .
$ svn st
M META-INF/vault/properties.xml
M jcr_root/apps/geometrixx/components/contentpage/.content.xml
$ svn ci
VLT でコマンドを実行するには、コマンドラインで次のように入力します。
vlt [options] <command> [arg1 [arg2 [arg3] ..]]
以降の節で、オプションとコマンドについて詳しく説明します。
すべてのコマンドで使用可能な VLT のオプションのリストを次に示します。使用可能なその他のオプションについては、個々のコマンドを参照してください。
オプション | 説明 |
-Xjcrlog <arg> |
拡張された JcrLog オプション |
-Xdavex <arg> |
拡張された JCR のリモート処理のオプション |
--credentials <arg> |
使用するデフォルトの資格情報 |
--config <arg> |
使用する JcrFs 設定 |
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
--version |
バージョン情報を出力して VLT を終了します |
--log-level <level> |
ログレベル(例:log4j)を示します |
-h (--help) <command> |
特定のコマンドのヘルプを出力します |
次の表は、使用可能な VLT のすべてのコマンドを示しています。構文、使用可能なオプションおよび例について詳しくは、個々のコマンドを参照してください。
コマンド | コマンドの略称 | 説明 |
export |
コントロールファイルを使用せずに JCR リポジトリ(vault ファイルシステム)からローカルファイルシステムに書き出します。 | |
import |
ローカルファイルシステムを JCR リポジトリ(vault ファイルシステム)に読み込みます。 | |
checkout |
co |
Vault ファイルシステムをチェックアウトします。最初の JCR リポジトリをローカルファイルシステムにチェックアウトする場合にこのコマンドを使用します(注意:最初に subversion でリポジトリをチェックアウトする必要があります)。 |
analyze |
パッケージを分析します。 | |
status |
st |
作業用コピーファイルとディレクトリのステータスを出力します。 |
update |
up |
リポジトリから作業用コピーに変更を読み込みます。 |
info |
ローカルファイルに関する情報を表示します。 | |
commit |
ci |
作業用コピーからリポジトリに変更を送信します。 |
revert |
rev |
作業用コピーファイルを元の状態に復元して、大部分のローカルの編集を元に戻します。 |
resolved |
res |
作業用コピーファイルまたはディレクトリの競合状態を削除します。 |
propget |
pg |
ファイルまたはディレクトリのプロパティの値を出力します。 |
proplist |
pl |
ファイルまたはディレクトリのプロパティを出力します。 |
propset |
ps |
ファイルまたはディレクトリのプロパティの値を設定します。 |
add |
ファイルとディレクトリのバージョンを管理します。 | |
delete |
del か rm のどちらかにする必要があります。 |
ファイルとディレクトリのバージョン管理を削除します。 |
diff |
di |
2 つのパスの差分を表示します。 |
console |
インタラクティブコンソールを実行します。 | |
rcp |
ノードツリーをリモートリポジトリ間でコピーします。 | |
sync |
vault 同期サービスを制御できるようにします。 |
<uri> でマウントされた Vault ファイルシステムをローカルファイルシステム(<local-path>)に書き出します。サブツリーのみを書き出すには、オプションの <jcr-path> を指定できます。
export -v|-t <arg>|-p <uri> <jcr-path> <local-path>
-v (--verbose) |
詳細出力 |
-t (--type) <arg> |
書き出しのタイプ(platform または jar)を指定します。 |
-p (--prune-missing) |
見つからないローカルファイルを削除する必要がある場合に指定します。 |
<uri> |
マウントポイントの URI |
<jcrPath> |
JCR パス |
<localPath> |
ローカルパス |
vlt export http://localhost:4502/crx /apps/geometrixx myproject
ローカルファイルシステム(<local-path>
から始まる)を<uri>
のボールトファイルシステムに読み込みます。 <jcr-path>
をインポートルートとして指定できます。 --sync
を指定した場合、インポートされたファイルは自動的にVault管理下に置かれます。
import -v|-s <uri> <local-path> <jcr-path>
-v (--verbose) |
詳細出力 |
-s (-- sync) |
ローカルファイルの vault を管理します。 |
<uri> |
マウントポイントの URI |
<jcrPath> |
JCR パス |
<localPath> |
ローカルパス |
vlt import http://localhost:4502/crx . /
JCR リポジトリから <uri> で始まるローカルファイルシステムおよび <local-path> で始まるローカルファイルシステムへの最初のチェックアウトを順に実行します。<jcrPath> 引数を追加して、リモートツリーのサブディレクトリをチェックアウトすることもできます。META-INF ディレクトリにコピーするワークスペースフィルターを指定できます。
checkout --force|-v|-q|-f <file> <uri> <jcrPath> <localPath>
--force |
ローカルファイルが既に存在する場合は、チェックアウトを実行してそのファイルを強制的に上書きします |
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
-f (--filter) <file> |
自動フィルターを指定します(定義されていない場合) |
<uri> |
マウントポイントの URI |
<jcrPath> |
(オプション)リモートパス |
<localPath> |
(オプション)ローカルパス |
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 -l <format>|-v|-q <localPaths1> [<localPaths2> ...]
-l (--linkFormat) <format> |
修正プログラムリンク(名前、ID)のprintf形式(例:[CQ520_HF_%s|%s] ) |
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
<localPaths> [<localPaths> ...] |
ローカルパス |
作業用コピーファイルとディレクトリのステータスを出力します。
--show-update
を指定した場合は、各ファイルをリモートバージョンと比較してチェックします。 2 番目の文字は、更新操作によって実行されるアクションを指定します。
status -v|-q|-u|-N <file1> [<file2> ...]
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
-u (--show-update) |
更新情報を表示します |
-N (--non-recursive) |
単一のディレクトリで処理が実行されます |
<file> [<file> ...] |
ステータスを表示するファイルまたはディレクトリ |
リポジトリから作業用コピーに変更をコピーします。
update -v|-q|--force|-N <file1> [<file2> ...]
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
--force |
ローカルファイルを強制的に上書きします |
-N (--non-recursive) |
単一のディレクトリで処理が実行されます |
<file> [<file> ...] |
更新するファイルまたはディレクトリ |
ローカルファイルに関する情報を表示します。
info -v|-q|-R <file1> [<file2> ...]
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
-R (--recursive) |
処理を再帰的に実行します |
<file> [<file> ...] |
情報を表示するファイルまたはディレクトリ |
作業用コピーからリポジトリに変更を送信します。
commit -v|-q|--force|-N <file1> [<file2> ...]
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
--force |
リモートコピーが変更される場合でも、強制的にコミットします |
-N (--non-recursive) |
単一のディレクトリで処理が実行されます |
<file> [<file> ...] |
コミットするファイルまたはディレクトリ |
作業用コピーファイルを元の状態に復元して、大部分のローカルの編集を元に戻します。
revert -q|-R <file1> [<file2> ...]
-q (--quiet) |
出力を最小限に抑えます |
-R (--recursive) |
処理を再帰的に実行します |
<file> [<file> ...] |
コミットするファイルまたはディレクトリ |
作業用コピーファイルまたはディレクトリの競合状態を削除します。
このコマンドは意味的に競合を解決したり、競合のマーカーを削除したりするのではなく、単に競合に関連するアーティファクトファイルを削除して、PATH を再びコミットできるようにします。
resolved -q|-R|--force <file1> [<file2> ...]
-q (--quiet) |
出力を最小限に抑えます |
-R (--recursive) |
処理を再帰的に実行します |
--force |
競合のマーカーがある場合でも解決を実行します |
<file> [<file> ...] |
解決するファイルまたはディレクトリ |
ファイルまたはディレクトリのプロパティの値を出力します。
propget -q|-R <propname> <file1> [<file2> ...]
-q (--quiet) |
出力を最小限に抑えます |
-R (--recursive) |
処理を再帰的に実行します |
<propname> |
プロパティ名 |
<file> [<file> ...] |
プロパティの取得元のファイルまたはディレクトリ |
ファイルまたはディレクトリのプロパティを出力します。
proplist -q|-R <file1> [<file2> ...]
-q (--quiet) |
出力を最小限に抑えます |
-R (--recursive) |
処理を再帰的に実行します |
<file> [<file> ...] |
プロパティの出力元のファイルまたはディレクトリ |
ファイルまたはディレクトリのプロパティの値を設定します。
VLTは、次の特別なバージョン付きプロパティを認識します。
vlt:mime-type
ファイルの MIME タイプ。ファイルを結合するかどうかを判断するために使用します。「text/」で始まる MIME タイプ(または MIME タイプが存在しない場合)はテキストとして扱われます。それ以外の MIME タイプはバイナリとして扱われます。
propset -q|-R <propname> <propval> <file1> [<file2> ...]
-q (--quiet) |
出力を最小限に抑えます |
-R (--recursive) |
処理を再帰的に実行します |
<propname> |
プロパティ名 |
<propval> |
プロパティ値 |
<file> [<file> ...] |
プロパティを設定するファイルまたはディレクトリ |
ファイルとディレクトリのバージョンを管理し、それらをリポジトリに追加するスケジュールを設定します。ファイルとディレクトリは次回のコミット時に追加されます。
add -v|-q|-N|--force <file1> [<file2> ...]
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
-N (--non-recursive) |
単一のディレクトリで処理が実行されます |
--force |
操作を強制的に実行します |
<file> [<file> ...] |
追加するローカルファイルまたはディレクトリ |
ファイルとディレクトリのバージョン管理を削除します。
delete -v|-q|--force <file1> [<file2> ...]
-v (--verbose) |
詳細出力 |
-q (--quiet) |
出力を最小限に抑えます |
--force |
操作を強制的に実行します |
<file> [<file> ...] |
削除するローカルファイルまたはディレクトリ |
2 つのパスの差分を表示します。
diff -N <file1> [<file2> ...]
-N (--non-recursive) |
単一のディレクトリで処理が実行されます |
<file> [<file> ...] |
差分を表示するファイルまたはディレクトリ |
インタラクティブコンソールを実行します。
console -F <file>
-F (--console-settings) <file> |
コンソール設定ファイルを指定します。デフォルトのファイルは console.properties です。 |
ノードツリーをリモートリポジトリ間でコピーします。<src>
はソースノードを指し、親ノードが存在する必要がある宛先パスを <dst>
指定します。rcp は、データをストリーミングすることでノードを処理します。
rcp -q|-r|-b <size>|-t <seconds>|-u|-n|-e <arg1> [<arg2> ...] <src> <dst>
-q (--quiet) |
出力を最小限に抑えます。 |
-r (--recursive) |
処理を再帰的に実行します。 |
-b (--batchSize) <size> |
中間保存前に処理されるノード数。 |
-t (--throttle) <seconds> |
中間保存の後に待機する秒数。 |
-u (--update) |
既存のノードを上書き/削除します。 |
-n (--newer) |
lastModified プロパティを更新に適用します。 |
-e (--exclude) <arg> [<arg> ...] |
除外するコピー元のパスの正規表現。 |
<src> |
コピー元のツリーのリポジトリのアドレス。 |
<dst> |
コピー先のノードのリポジトリのアドレス。 |
vlt rcp http://localhost:4502/crx/-/jcr:root/content https://admin:admin@localhost:4503/crx/-/jcr:root/content_copy
--exclude
オプションの後に、<src>
引数と<dst>
引数の前に別のオプションを指定する必要があります。 次に例を示します。
vlt rcp -e ".*\.txt" -r
vault 同期サービスを制御できるようにします。引数を指定しない場合、このコマンドは現在の作業ディレクトリの同期の管理を試行します。vlt チェックアウト内で実行される場合は、それぞれのフィルターとホストを使用して同期を設定します。vlt チェックアウト外で実行される場合は、現在のフォルダーを同期用に登録します(ディレクトリが空の場合のみ)。
sync -v|--force|-u <uri> <command> <localPath>
-v (--verbose) |
詳細出力。 |
--force |
特定のコマンドを強制的に実行します。 |
-u (--uri) <uri> |
同期ホストの URI を指定します。 |
<command> |
実行する sync コマンド。 |
<localPath> |
同期するローカルフォルダー。 |
VLT で使用するステータスコードは次のとおりです。
vault 同期サービスは、リポジトリのコンテンツをローカルファイルシステム表現と同期する(またはその逆の同期をおこなう)場合に使用します。そのためには、リポジトリの変更をリッスンし、ファイルシステムのコンテンツを定期的にスキャンする OSGi サービスをインストールします。このサービスでは、vault と同じシリアル化形式を使用して、リポジトリのコンテンツをディスクにマップします。
vault 同期サービスは開発ツールであり、本番システムでの使用は推奨されません。また、このサービスはローカルファイルシステムとの同期のみ可能であり、リモート開発には使用できません。
vlt sync install
コマンドを使用すると、vault 同期サービスのバンドルおよび設定を自動的にインストールできます。
バンドルは/libs/crx/vault/install
の下にインストールされ、configノードは/libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl
に作成されます。 最初はサービスが有効になっていますが、同期のルートは設定されていません。
次の例では、特定の uri によってアクセス可能な CRX インスタンスに同期サービスをインストールします。
$ vlt --credentials admin:admin sync --uri http://localhost:4502/crx install
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.
status
コマンドは、サービスからライブデータを取得せず、/libs/crx/vault/com.day.jcr.sync.impl.VaultSyncServiceImpl
の設定を読み取ります。
register
コマンドは、同期するフォルダーを設定に追加するために使用します。
$ vlt sync register
Connecting via JCR remoting to http://localhost:4502/crx/server
Added new sync directory: /tmp/workspace/vltsync/jcr_root
register
コマンドは、sync-once
を設定するまで同期をトリガーしません。
unregister
コマンドは、同期するフォルダーを設定から削除するために使用します。
$ vlt sync unregister
Connecting via JCR remoting to http://localhost:4502/crx/server
Removed sync directory: /tmp/workspace/vltsync/jcr_root
同期フォルダー自体を削除する前に、そのフォルダーの登録を解除する必要があります。
実行中のサービスは以下のパラメーターを使用して設定できます。
vault.sync.syncroots
:同期のルートを定義する 1 つまたは複数のローカルファイルシステムのパス。
vault.sync.fscheckinterval
:ファイル・システムで変更をスキャンする頻度(秒)。デフォルト値は 5 秒です。
vault.sync.enabled
:サービスを有効または無効にする一般的なフラグ。
このサービスは、Web コンソールまたはリポジトリ内の sling:OsgiConfig
ノード(名前:com.day.jcr.sync.impl.VaultSyncServiceImpl
)で設定できます。
AEM と連携する場合は、いくつかの方法でこのようなサービスの設定を管理できます。詳しくは、OSGi の設定を参照してください。
各同期フォルダー内の次の 3 つのファイルに設定とステータスが格納されます。
.vlt-sync-config.properties
:設定ファイル。
.vlt-sync.log
:同期中に実行された操作に関する情報を含むログファイルです。
.vlt-sync-filter.xml
:リポジトリのどの部分が同期されるかを定義するフィルター。このファイルの形式は、フィルターを適用したチェックアウトの実行セクションで定義されています。
.vlt-sync-config.properties
ファイルでは、次のプロパティを設定できます。
disabled同期のオン/オフを切り替えます。デフォルトでは、このパラメーターは false に設定されており、同期が許可されます。
sync- once空でない場合、次のスキャンで指定された方向のフォルダーが同期され、パラメーターがクリアされます。次の 2 つの値がサポートされています。
JCR2FS
:JCR リポジトリ内のコンテンツをすべて書き出して、ローカルディスクに書き込みます。FS2JCR
:ディスクから JCR リポジトリにすべてのコンテンツを読み込みます。sync- logログファイル名を定義します。デフォルト値は .vlt-sync.log です。
同期フォルダーに基づいて開発環境をセットアップするには、次の手順を実行します。
vlt コマンドラインを使用してリポジトリをチェックアウトします。
$ vlt --credentials admin:admin co --force http://localhost:4502/crx dev
フィルターを使用して、適切なパスだけをチェックアウトできます。詳しくは、フィルターが適用されたチェックアウトの実行を参照してください。
作業用コピーのルートフォルダーに移動します。
$ cd dev/jcr_root/
同期サービスをリポジトリにインストールします。
$ vlt sync install
Connecting via JCR remoting to http://localhost:4502/crx/server
Preparing to install vault-sync-2.4.24.jar...
Updated bundle: vault-sync-2.4.24.jar
Created new config at /libs/crx/vault/config/com.day.jcr.sync.impl.VaultSyncServiceImpl
同期サービスを初期化します。
$ vlt sync
Connecting via JCR remoting to http://localhost:4502/crx/server
Starting initialization of sync service in existing vlt checkout /Users/colligno/Applications/cq5/vltsync/sandbox/dev/jcr_root for http://localhost:4502/crx/server/-/jcr:root
Added new sync directory: /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root
The directory /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root is now enabled for syncing.
You might perform a 'sync-once' by setting the
appropriate flag in the /Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/.vlt-sync-config.properties file.
.vlt-sync-config.properties
隠しファイルを編集し、リポジトリのコンテンツを同期する同期を設定します。
sync-once=JCR2FS
この手順では、フィルター条件に従ってリポジトリ全体をダウンロードします。
ログファイル.vlt-sync.log
を確認して進行状況を確認します。
***
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/product/
30.04.2017 14:39:10 A file:///Users/trushton/Applications/aem/vltsync/sandbox/dev/jcr_root/apps/geometrixx-outdoors/src/core/src/main/java/info/geometrixx/outdoors/core/product/GeoProduct.java
***
これで、ローカルフォルダーがリポジトリと同期されます。この同期は双方向なので、リポジトリからの変更はローカルの同期フォルダーに適用されます。逆の場合も同様です。
VLT 同期機能でサポートされるのはシンプルなファイルとフォルダーのみです。vault でシリアル化された特殊なファイル(.content.xml、dialog.xml など)は検出されても無視されます。そのため、デフォルトの vlt チェックアウトで vault 同期を使用できます。