oakpal:webster

Full name:

net.adamcin.oakpal:oakpal-maven-plugin:2.2.2:webster

Description:

Execute Webster targets that read from an external Oak JCR repository to update nodetypes, privileges, and checklist files managed in a maven project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes by direct invocation only.

Optional Parameters

Name Type Since Description
<baseDir> File - (no description)
Default value is: ${project.basedir}.
<revealOakLogging> boolean - The Oak repository spin up and query process can be quite verbose. By default, Webster sets "org.apache.jackrabbit.oak" loggers to ERROR to avoid flooding the execution log with minutiae. Set this parameter to true to avoid suppressing these logging statements.
User property is: webster.revealOakLogging.
<websterArchiveRoot> File - Directory containing resources for a FileVault archive. This is required for "nodetypes" and "privileges" targets. It is also possible to reference the built content-package artifact, as in "${project.build.directory}/${project.build.finalName}.zip", if this goal is executed after completion of the "package" phase.
Default value is: ${basedir}/src/main/content.
<websterOakRunArgs> String - If the Oak repository NodeStore requires more complex configurations.
User property is: webster.oakRunArgs.
<websterRepositoryHome> File - The path to a folder containing a segmentstore directory, that also contains a journal.log file and the rest of an Oak SegmentTar NodeStore. If a datastore child folder also exists, it will be treated as a FileBlobStore. Otherwise, inline blobs will be assumed.

If this folder does not exist, is null, or is the current directory, the mojo will gracefully opt out of definition export.

This can be overridden using the webster.oakRunArgsString property.


User property is: webster.repositoryHome.
<websterTargets> JsonObject - Specify the list of targets to update.
<websterTempDirectory> File - Specify a particular director for creation of temporary segment stores.
Default value is: ${project.build.directory}/oakpal-plugin/webster-tmpdir.
User property is: webster.tmpdir.

Parameter Details

<baseDir>

(no description)
  • Type: java.io.File
  • Required: No
  • Default: ${project.basedir}

<revealOakLogging>

The Oak repository spin up and query process can be quite verbose. By default, Webster sets "org.apache.jackrabbit.oak" loggers to ERROR to avoid flooding the execution log with minutiae. Set this parameter to true to avoid suppressing these logging statements.
  • Type: boolean
  • Required: No
  • User Property: webster.revealOakLogging

<websterArchiveRoot>

Directory containing resources for a FileVault archive. This is required for "nodetypes" and "privileges" targets. It is also possible to reference the built content-package artifact, as in "${project.build.directory}/${project.build.finalName}.zip", if this goal is executed after completion of the "package" phase.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/content

<websterOakRunArgs>

If the Oak repository NodeStore requires more complex configurations.
  • Type: java.lang.String
  • Required: No
  • User Property: webster.oakRunArgs

<websterRepositoryHome>

The path to a folder containing a segmentstore directory, that also contains a journal.log file and the rest of an Oak SegmentTar NodeStore. If a datastore child folder also exists, it will be treated as a FileBlobStore. Otherwise, inline blobs will be assumed.

If this folder does not exist, is null, or is the current directory, the mojo will gracefully opt out of definition export.

This can be overridden using the webster.oakRunArgsString property.

  • Type: java.io.File
  • Required: No
  • User Property: webster.repositoryHome

<websterTargets>

Specify the list of targets to update.
  • Type: javax.json.JsonObject
  • Required: No

<websterTempDirectory>

Specify a particular director for creation of temporary segment stores.
  • Type: java.io.File
  • Required: No
  • User Property: webster.tmpdir
  • Default: ${project.build.directory}/oakpal-plugin/webster-tmpdir