existdb:sync

Full name:

net.middell:existdb-maven-plugin:1.0:sync

Description:

Synchronizes the local filesystem with a set of collections and/or resources in an eXist-db instance.

Sample configuration:

<configuration>
<serverId>exist</serverId>
<syncMappings>
<syncMapping>
<source>xmldb:exist://localhost.de:8080/exist/xmlrpc/db/apps/sample/</source>
<target>src/main/xml/</target>
</syncMapping>
</syncMappings>
</configuration>

Corresponding server settings in $HOME/.m2/settings.xml:

<server>
<id>exist</id>
<username>admin</username>
<password>secret</password>
</server>

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
serverId String - The id of the <server/> entry in the Maven settings which provides username and password credentials for accessing the eXist-db instance.

Should this identifier not have been configured, this goal emits a warning and exits.
syncBase String - An optional base URI of all collections/resources to be synchronized.

All mapped URIs are resolved against this base in case it has been provided.
syncExclusion String - An optional regular expression which is matched against eXist-db URIs and allows for the exclusion of resources otherwise synced.

Per default, descriptor files are excluded.


Default value is: .*?(repo)|(expath\-pkg)\.xml$.
syncMappings List - A list of mappings between eXist-db collection/resources, specified via URIs, and local filesystem paths.

Relative filesystem paths are interpreted relative to a project's base directory.

Parameter Details

serverId:

The id of the <server/> entry in the Maven settings which provides username and password credentials for accessing the eXist-db instance.

Should this identifier not have been configured, this goal emits a warning and exits.

  • Type: java.lang.String
  • Required: No

syncBase:

An optional base URI of all collections/resources to be synchronized.

All mapped URIs are resolved against this base in case it has been provided.

  • Type: java.lang.String
  • Required: No

syncExclusion:

An optional regular expression which is matched against eXist-db URIs and allows for the exclusion of resources otherwise synced.

Per default, descriptor files are excluded.

  • Type: java.lang.String
  • Required: No
  • Default: .*?(repo)|(expath\-pkg)\.xml$

syncMappings:

A list of mappings between eXist-db collection/resources, specified via URIs, and local filesystem paths.

Relative filesystem paths are interpreted relative to a project's base directory.

  • Type: java.util.List
  • Required: No