Fork me on GitHub

sling:generate-adapter-metadata

Full name:

org.apache.sling:sling-maven-plugin:3.0.2:generate-adapter-metadata

Description:

Build adapter metadata (JSON) for the Web Console Plugin at /system/console/status-adapters and /system/console/adapters from classes annotated with adapter annotations.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
<buildOutputDirectory> File - The directory which to check for classes with adapter metadata annotations.
Default value is: ${project.build.outputDirectory}.
User property is: adapter.build.output.directory.
<fileName> String - Name of the generated descriptor file (relative to outputDirectory).
Default value is: SLING-INF/adapters.json.
User property is: adapter.descriptor.name.
<outputDirectory> File - The output directory in which to emit the descriptor file with name fileName.
Default value is: ${project.build.outputDirectory}.
User property is: adapter.output.directory.

Parameter Details

<buildOutputDirectory>

The directory which to check for classes with adapter metadata annotations.
  • Type: java.io.File
  • Required: No
  • User Property: adapter.build.output.directory
  • Default: ${project.build.outputDirectory}

<fileName>

Name of the generated descriptor file (relative to outputDirectory).
  • Type: java.lang.String
  • Required: No
  • User Property: adapter.descriptor.name
  • Default: SLING-INF/adapters.json

<outputDirectory>

The output directory in which to emit the descriptor file with name fileName.
  • Type: java.io.File
  • Required: No
  • User Property: adapter.output.directory
  • Default: ${project.build.outputDirectory}