Package gov.nist.secauto.metaschema.maven.plugin

Class AbstractMetaschemaMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
gov.nist.secauto.metaschema.maven.plugin.AbstractMetaschemaMojo
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
Direct Known Subclasses:
GenerateSchemaMojo, GenerateSourcesMojo
public abstract class AbstractMetaschemaMojo extends org.apache.maven.plugin.AbstractMojo

  • Field Details

    • staleFileDirectory

      @Parameter(defaultValue="${project.build.directory}/metaschema", readonly=true, required=true) protected File staleFileDirectory

      The directory where the staleFile is found. The staleFile is used to determine if re-generation of generated Java classes is needed, by recording when the last build occurred.

      This directory is expected to be located within the ${project.build.directory}, to ensure that code (re)generation occurs after cleaning the project.

    • includes

      @Parameter protected String[] includes
      A set of inclusion patterns used to select which Metaschema modules are to be processed. By default, all files are processed.

    • excludes

      @Parameter protected String[] excludes
      A set of exclusion patterns used to prevent certain files from being processed. By default, this set is empty such that no files are excluded.

  • Constructor Details

  • Method Details

    • getBuildContext

      protected final org.sonatype.plexus.build.incremental.BuildContext getBuildContext()
      The BuildContext is used to identify which files or directories were modified since last build. This is used to determine if Module-based generation must be performed again.
      Returns:
      the active Plexus BuildContext.

    • getMavenProject

      protected final org.apache.maven.project.MavenProject getMavenProject()
      Retrieve the Maven project context.
      Returns:
      The active MavenProject.

    • getPluginArtifacts

      protected final List<org.apache.maven.artifact.Artifact> getPluginArtifacts()

    • getMojoExecution

      public org.apache.maven.plugin.MojoExecution getMojoExecution()
      Retrieve the mojo execution context.
      Returns:
      The active MojoExecution.

    • getOutputDirectory

      protected File getOutputDirectory()
      Retrieve the directory where generated classes will be stored.
      Returns:
      the directory

    • setOutputDirectory

      protected void setOutputDirectory(File outputDirectory)
      Set the directory where generated classes will be stored.
      Parameters:
      outputDirectory - the directory to use

    • getEncoding

      protected final String getEncoding()
      Gets the file encoding to use for generated classes.

      The algorithm for finding the encoding to use is as follows (where the first non-null value found is used for encoding):

      1. If the configuration property is explicitly given within the plugin's configuration, use that value.
      2. If the Maven property project.build.sourceEncoding is defined, use its value.
      3. Otherwise use the value from the system property file.encoding.
      Returns:
      The encoding to be used by this AbstractJaxbMojo and its tools.

    • getModuleSources

      protected Stream<File> getModuleSources()
      Retrieve a stream of Module file sources.
      Returns:
      the stream

    • newBindingContext

      @NonNull protected IBindingContext newBindingContext(@NonNull IModuleLoader.IModulePostProcessor modulePostProcessor) throws IOException, MetaschemaException
      Throws:
      IOException
      MetaschemaException

    • getConstraints

      @NonNull protected List<IConstraintSet> getConstraints() throws org.apache.maven.plugin.MojoExecutionException
      Get the configured collection of constraints.
      Returns:
      the loaded constraints
      Throws:
      org.apache.maven.plugin.MojoExecutionException - if an error occurred while loading the constraints

    • shouldExecutionBeSkipped

      protected boolean shouldExecutionBeSkipped()
      Determine if the execution of this mojo should be skipped.
      Returns:
      true if the mojo execution should be skipped, or false otherwise

    • getStaleFileName

      protected abstract String getStaleFileName()
      Get the name of the file that is used to detect staleness.
      Returns:
      the name

    • getStaleFile

      protected final File getStaleFile()
      Gets the staleFile for this execution.
      Returns:
      the staleFile

    • isGenerationRequired

      protected boolean isGenerationRequired()
      Determine if code generation is required. This is done by comparing the last modified time of each Module source file against the stale file managed by this plugin.
      Returns:
      true if the code generation is needed, or false otherwise

    • getClassPath

      protected Set<String> getClassPath() throws org.apache.maven.artifact.DependencyResolutionRequiredException
      Throws:
      org.apache.maven.artifact.DependencyResolutionRequiredException

    • getModulesToGenerateFor

      @NonNull protected Set<IModule> getModulesToGenerateFor(@NonNull IBindingContext bindingContext, @NonNull IModuleLoader.IModulePostProcessor modulePostProcessor) throws MetaschemaException, IOException
      Throws:
      MetaschemaException
      IOException

    • createStaleFile

      protected void createStaleFile(@NonNull File staleFile) throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • execute

      public void execute() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • generate

      @NonNull protected abstract List<File> generate(@NonNull Set<IModule> modules) throws org.apache.maven.plugin.MojoExecutionException
      Perform the generation operation.
      Parameters:
      modules - the modules to generate resources/sources for
      Returns:
      the files generated during the operation
      Throws:
      org.apache.maven.plugin.MojoExecutionException - if an error occurred while performing the generation operation