net.adamcin.oakpal.maven.mojo

Interface MojoWithRepositoryParams

All Superinterfaces:

org.apache.maven.plugin.Mojo, MojoWithCommonParams

All Known Implementing Classes:

OpearPackageMojo, OpearPlanMojo, ScanArtifactMojo, ScanManyArtifactsMojo, VerifyMojo

public interface MojoWithRepositoryParams
extends MojoWithCommonParams

Mojo Interface providing default methods for resolution of artifacts and creation of maven classloaders.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Method Summary

Modifier and Type	Method and Description
default ClassLoader	createContainerClassLoader() Creates a classloader for execution of oakpal logic.
default Set<org.apache.maven.artifact.Artifact>	depToArtifact(@NotNull org.apache.maven.model.Dependency dependency, @NotNull org.apache.maven.artifact.repository.RepositoryRequest baseRequest, boolean transitive)
org.apache.maven.repository.RepositorySystem	getRepositorySystem()
default boolean	isTestScopeContainer() There are basically two use cases for the oakpal-maven-plugin: 1) Adhoc testing of a content-package project artifact, in which case all oakpal classpath resources will be found in test scope, or 2) Creation and testing of an oakpal module with checklists, and/or creation and testing of an opear archive, in which case all oakpal classpath resources will be found in a non-test scope classpath.
default List<org.apache.maven.artifact.Artifact>	resolveArtifacts(@NotNull List<org.apache.maven.model.Dependency> dependencies, boolean transitive)
default List<File>	resolveDependencies(@NotNull List<org.apache.maven.model.Dependency> dependencies, boolean transitive)

Methods inherited from interface net.adamcin.oakpal.maven.mojo.MojoWithCommonParams

getExecution, getProject, getSession, getSettings

Methods inherited from interface org.apache.maven.plugin.Mojo

execute, getLog, setLog

Method Detail

getRepositorySystem

org.apache.maven.repository.RepositorySystem getRepositorySystem()

isTestScopeContainer

default boolean isTestScopeContainer()

There are basically two use cases for the oakpal-maven-plugin: 1) Adhoc testing of a content-package project artifact, in which case all oakpal classpath resources will be found in test scope, or 2) Creation and testing of an oakpal module with checklists, and/or creation and testing of an opear archive, in which case all oakpal classpath resources will be found in a non-test scope classpath. Mojos should override this method to return true, to specify that a test-scope classloader is desired, as in the first case.

Returns:

true if a test-scope classloader is desired, or false if a non-test-scope classloader is desired.

createContainerClassLoader

default ClassLoader createContainerClassLoader()
                                        throws org.apache.maven.plugin.MojoFailureException

Creates a classloader for execution of oakpal logic.

Returns:

a container classLoader

Throws:

org.apache.maven.plugin.MojoFailureException - if an error occurs

depToArtifact

default Set<org.apache.maven.artifact.Artifact> depToArtifact(@NotNull
                                                              @NotNull org.apache.maven.model.Dependency dependency,
                                                              @NotNull
                                                              @NotNull org.apache.maven.artifact.repository.RepositoryRequest baseRequest,
                                                              boolean transitive)

resolveArtifacts

default List<org.apache.maven.artifact.Artifact> resolveArtifacts(@NotNull
                                                                  @NotNull List<org.apache.maven.model.Dependency> dependencies,
                                                                  boolean transitive)

resolveDependencies

default List<File> resolveDependencies(@NotNull
                                       @NotNull List<org.apache.maven.model.Dependency> dependencies,
                                       boolean transitive)
                                throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException