Class AbstractProtocMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
AbstractProtocCompileMojo
,AbstractProtocTestCompileMojo
abstract class AbstractProtocMojo
extends org.apache.maven.plugin.AbstractMojo
Abstract Mojo implementation.
This class is extended by ProtocCompileMojo
and
ProtocTestCompileMojo
in order to override the specific configuration for
compiling the main or test classes respectively.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate File[]
Additional source paths for.proto
definitions.private org.apache.maven.artifact.factory.ArtifactFactory
A factory for Maven artifact definitions.private org.apache.maven.artifact.resolver.ArtifactResolver
A component that implements resolution of Maven artifacts from repositories.protected boolean
If set totrue
, the generated descriptor set will be attached to the build.protected boolean
If set totrue
, then the specified protobuf source files from this project will be attached as resources to the build, for subsequent inclusion into the final artifact.protected org.sonatype.plexus.build.incremental.BuildContext
Build context that tracks changes to the source and target files.private boolean
Normallyprotoc
is invoked on every execution of the plugin.private boolean
Whentrue
, the output directory will be cleared out prior to code generation.private static final String
protected String
The descriptor set file name.private String[]
A list of <exclude> elements specifying the protobuf definition files (by pattern) that should be excluded from compilation.private boolean
Usually most of protobuf mojos will not get executed on parent poms (i.e.private boolean
Set this tofalse
to disable hashing of dependent jar paths.private static final char[]
protected boolean
Iftrue
andwriteDescriptorSet
has been set, the compiler will include all dependencies in the descriptor set making it "self-contained".private String[]
A list of <include> elements specifying the protobuf definition files (by pattern) that should be included in compilation.protected boolean
Iftrue
andwriteDescriptorSet
has been set, do not strip SourceCodeInfo from the FileDescriptorProto.private org.apache.maven.artifact.repository.ArtifactRepository
This is the path to the local mavenrepository
.protected org.apache.maven.project.MavenProject
The current Maven project.protected org.apache.maven.project.MavenProjectHelper
A helper used to add resources to the project.private static final String
private String
Protobuf compiler artifact specification, ingroupId:artifactId:version[:type[:classifier]]
format.private String
This is the path to theprotoc
executable.private File
A directory where native launchers for java protoc plugins will be generated.private List
<ProtocPlugin> Specifies one of more custom protoc plugins, written in Java and available as Maven artifacts.private List
<org.apache.maven.artifact.repository.ArtifactRepository> Remote repositories for artifact resolution.private org.apache.maven.repository.RepositorySystem
A component that handles resolution of Maven artifacts.private org.apache.maven.artifact.resolver.ResolutionErrorHandler
A component that handles resolution errors.protected org.apache.maven.execution.MavenSession
The current Maven Session Object.private boolean
Whentrue
, skip the execution.private long
Sets the granularity in milliseconds of the last modification date for testing whether source protobuf definitions need recompilation.private File
A directory where temporary files will be generated.private File
Sinceprotoc
cannot access jars, proto files in dependencies are extracted to this location and deleted on exit.protected org.apache.maven.toolchain.ToolchainManager
An optional tool chain manager.protected boolean
If set totrue
, all command line arguments to protoc will be written to a file, and only a path to that file will be passed to protoc on the command line.protected boolean
If set totrue
, the compiler will generate a binary descriptor set file for the specified.proto
files.Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addProtocBuilderParameters
(Protoc.Builder protocBuilder) Adds mojo-specific parameters to the protoc builder.protected boolean
checkFilesUpToDate
(Iterable<File> sourceFiles, Iterable<File> targetFiles) Checks that the source files don't have modification time that is later than the target files.protected void
protected org.apache.maven.artifact.Artifact
createDependencyArtifact
(String artifactSpec) Creates a dependency artifact from a specification ingroupId:artifactId:version[:type[:classifier]]
format.protected org.apache.maven.artifact.Artifact
createDependencyArtifact
(String groupId, String artifactId, String version, String type, String classifier) protected void
Generates native launchers for java protoc plugins.protected String
Attempts to detect java home directory, usingjdk
toolchain if available, with a fallback tojava.home
system property.protected void
protected abstract void
protected abstract void
void
execute()
Executes the mojo.findGeneratedFilesInDirectory
(File directory) findProtoFilesInDirectories
(Iterable<File> directories) findProtoFilesInDirectory
(File directory) Gets theFile
for each dependency artifact.protected abstract List
<org.apache.maven.artifact.Artifact> protected abstract File
Returns output directory for descriptor set file.protected String[]
protected String[]
protected abstract File
Returns the output directory for generated sources.protected abstract File
protected boolean
Checks if the injected build context has changes in any of the specified files.protected static long
lastModified
(Iterable<File> files) Returns timestamp for the most recently modified file in the given set.makeProtoPathFromJars
(File temporaryProtoFileDirectory, Iterable<File> classpathElementFiles) Unpacks proto descriptors that are bundled inside dependent artifacts into a temporary directory.private static String
protected File
resolveBinaryArtifact
(org.apache.maven.artifact.Artifact artifact) protected boolean
skipMojo()
Determine if the mojo execution should get skipped.protected static String
toHexString
(byte[] byteArray) protected String
truncatePath
(String jarPath) Truncates the path of jar files so that they are relative to the local repository.Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
PROTO_FILE_SUFFIX
- See Also:
-
DEFAULT_INCLUDES
- See Also:
-
project
@Parameter(defaultValue="${project}", readonly=true) protected org.apache.maven.project.MavenProject projectThe current Maven project. -
session
@Parameter(defaultValue="${session}", readonly=true) protected org.apache.maven.execution.MavenSession sessionThe current Maven Session Object.- Since:
- 0.2.0
-
buildContext
@Component protected org.sonatype.plexus.build.incremental.BuildContext buildContextBuild context that tracks changes to the source and target files.- Since:
- 0.3.0
-
toolchainManager
@Component protected org.apache.maven.toolchain.ToolchainManager toolchainManagerAn optional tool chain manager.- Since:
- 0.2.0
-
projectHelper
@Component protected org.apache.maven.project.MavenProjectHelper projectHelperA helper used to add resources to the project. -
artifactFactory
@Component private org.apache.maven.artifact.factory.ArtifactFactory artifactFactoryA factory for Maven artifact definitions.- Since:
- 0.3.1
-
artifactResolver
@Component private org.apache.maven.artifact.resolver.ArtifactResolver artifactResolverA component that implements resolution of Maven artifacts from repositories.- Since:
- 0.3.1
-
repositorySystem
@Component private org.apache.maven.repository.RepositorySystem repositorySystemA component that handles resolution of Maven artifacts.- Since:
- 0.4.0
-
resolutionErrorHandler
@Component private org.apache.maven.artifact.resolver.ResolutionErrorHandler resolutionErrorHandlerA component that handles resolution errors.- Since:
- 0.4.0
-
localRepository
@Parameter(required=true, readonly=true, property="localRepository") private org.apache.maven.artifact.repository.ArtifactRepository localRepositoryThis is the path to the local mavenrepository
. -
remoteRepositories
@Parameter(required=true, readonly=true, defaultValue="${project.remoteArtifactRepositories}") private List<org.apache.maven.artifact.repository.ArtifactRepository> remoteRepositoriesRemote repositories for artifact resolution.- Since:
- 0.3.0
-
tempDirectory
@Parameter(required=true, readonly=true, defaultValue="${project.build.directory}") private File tempDirectoryA directory where temporary files will be generated.- Since:
- 0.6.0
-
protocPluginDirectory
@Parameter(required=false, defaultValue="${project.build.directory}/protoc-plugins") private File protocPluginDirectoryA directory where native launchers for java protoc plugins will be generated.- Since:
- 0.3.0
-
protocExecutable
This is the path to theprotoc
executable. When this parameter is not set, the plugin attempts to load aprotobuf
toolchain and use it locateprotoc
executable. If noprotobuf
toolchain is defined in the project, theprotoc
executable in thePATH
is used. -
protocArtifact
Protobuf compiler artifact specification, ingroupId:artifactId:version[:type[:classifier]]
format. When this parameter is set, the plugin attempts to resolve the specified artifact asprotoc
executable.- Since:
- 0.4.1
-
additionalProtoPathElements
Additional source paths for.proto
definitions. -
temporaryProtoFileDirectory
@Parameter(required=true, defaultValue="${project.build.directory}/protoc-dependencies") private File temporaryProtoFileDirectorySinceprotoc
cannot access jars, proto files in dependencies are extracted to this location and deleted on exit. This directory is always cleaned during execution. -
hashDependentPaths
@Parameter(required=true, defaultValue="true") private boolean hashDependentPathsSet this tofalse
to disable hashing of dependent jar paths. This plugin expands jars on the classpath looking for embedded.proto
files. Normally these paths are hashed (MD5) to avoid issues with long file names on windows. However if this property is set tofalse
longer paths will be used. -
includes
A list of <include> elements specifying the protobuf definition files (by pattern) that should be included in compilation. When not specified, the default includes will be:
<includes>
<include>**/*.proto</include>
</includes>
-
excludes
A list of <exclude> elements specifying the protobuf definition files (by pattern) that should be excluded from compilation. When not specified, the default excludes will be empty:
<excludes>
</excludes>
-
attachProtoSources
@Parameter(required=true, defaultValue="true") protected boolean attachProtoSourcesIf set totrue
, then the specified protobuf source files from this project will be attached as resources to the build, for subsequent inclusion into the final artifact. This is the default behaviour, as it allows downstream projects to import protobuf definitions from the upstream projects, and those imports are automatically resolved at build time.If distribution of
.proto
source files is undesirable for security reasons or because of other considerations, then this parameter should be set tofalse
.- Since:
- 0.4.1
-
descriptorSetFileName
@Parameter(required=true, defaultValue="${project.build.finalName}.protobin") protected String descriptorSetFileNameThe descriptor set file name. Only used ifwriteDescriptorSet
is set totrue
.- Since:
- 0.3.0
-
writeDescriptorSet
@Parameter(required=true, defaultValue="false") protected boolean writeDescriptorSetIf set totrue
, the compiler will generate a binary descriptor set file for the specified.proto
files.- Since:
- 0.3.0
-
attachDescriptorSet
@Parameter(required=true, defaultValue="false") protected boolean attachDescriptorSetIf set totrue
, the generated descriptor set will be attached to the build.- Since:
- 0.4.1
-
includeDependenciesInDescriptorSet
@Parameter(required=false, defaultValue="false") protected boolean includeDependenciesInDescriptorSetIftrue
andwriteDescriptorSet
has been set, the compiler will include all dependencies in the descriptor set making it "self-contained".- Since:
- 0.3.0
-
includeSourceInfoInDescriptorSet
@Parameter(required=false, defaultValue="false") protected boolean includeSourceInfoInDescriptorSetIftrue
andwriteDescriptorSet
has been set, do not strip SourceCodeInfo from the FileDescriptorProto. This results in vastly larger descriptors that include information about the original location of each decl in the source file as well as surrounding comments.- Since:
- 0.4.4
-
useArgumentFile
@Parameter(required=false, defaultValue="false") protected boolean useArgumentFileIf set totrue
, all command line arguments to protoc will be written to a file, and only a path to that file will be passed to protoc on the command line. This helps prevent Command line is too long errors when the number of.proto
files is large.NOTE: This is only supported for protoc 3.5.0 and higher.
- Since:
- 0.6.0
-
protocPlugins
Specifies one of more custom protoc plugins, written in Java and available as Maven artifacts. An executable plugin will be created at execution time. On UNIX the executable is a shell script and on Windows it is a WinRun4J .exe and .ini. -
staleMillis
@Parameter(required=false, defaultValue="0") private long staleMillisSets the granularity in milliseconds of the last modification date for testing whether source protobuf definitions need recompilation.This parameter is only used when
checkStaleness
parameter is set totrue
.If the project is built on NFS it's recommended to set this parameter to
10000
. -
checkStaleness
@Parameter(required=false, defaultValue="false") private boolean checkStalenessNormallyprotoc
is invoked on every execution of the plugin. Setting this parameter totrue
will enable checking timestamps of source protobuf definitions vs. generated sources.- See Also:
-
skip
@Parameter(required=false, property="protoc.skip", defaultValue="false") private boolean skipWhentrue
, skip the execution.- Since:
- 0.2.0
-
forceMojoExecution
@Parameter(required=false, property="protoc.force", defaultValue="false") private boolean forceMojoExecutionUsually most of protobuf mojos will not get executed on parent poms (i.e. projects with packaging type 'pom'). Setting this parameter totrue
will force the execution of this mojo, even if it would usually get skipped in this case.- Since:
- 0.2.0
-
clearOutputDirectory
@Parameter(required=false, defaultValue="true") private boolean clearOutputDirectoryWhentrue
, the output directory will be cleared out prior to code generation. With the latest versions of protoc (2.5.0 or later) this is generally not required, although some earlier versions reportedly had issues with running two code generations in a row without clearing out the output directory in between.- Since:
- 0.4.0
-
HEX_CHARS
private static final char[] HEX_CHARS
-
-
Constructor Details
-
AbstractProtocMojo
AbstractProtocMojo()
-
-
Method Details
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureExceptionExecutes the mojo.- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
-
createProtocPlugins
protected void createProtocPlugins()Generates native launchers for java protoc plugins. These launchers will later be added as parameters for protoc compiler.- Since:
- 0.3.0
-
detectJavaHome
Attempts to detect java home directory, usingjdk
toolchain if available, with a fallback tojava.home
system property.- Returns:
- path to java home directory.
- Since:
- 0.3.0
-
addProtocBuilderParameters
Adds mojo-specific parameters to the protoc builder.- Parameters:
protocBuilder
- the builder to be modified.
-
skipMojo
protected boolean skipMojo()Determine if the mojo execution should get skipped.
This is the case if:skip
istrue
- if the mojo gets executed on a project with packaging type 'pom' and
forceMojoExecution
isfalse
- Returns:
true
if the mojo execution should be skipped.- Since:
- 0.2.0
-
findGeneratedFilesInDirectory
-
lastModified
Returns timestamp for the most recently modified file in the given set.- Parameters:
files
- a collection of file descriptors.- Returns:
- timestamp of the most recently modified file.
-
checkFilesUpToDate
Checks that the source files don't have modification time that is later than the target files.- Parameters:
sourceFiles
- a collection of source files.targetFiles
- a collection of target files.- Returns:
true
, if source files are not later than the target files;false
, otherwise.
-
hasDelta
Checks if the injected build context has changes in any of the specified files.- Parameters:
files
- files to be checked for changes.- Returns:
true
, if at least one file has changes;false
, if no files have changes.- Since:
- 0.3.0
-
checkParameters
protected void checkParameters() -
getProtoSourceRoot
-
getIncludes
-
getExcludes
-
getDependencyArtifacts
-
getOutputDirectory
Returns the output directory for generated sources. Depends on build phase so must be defined in concrete implementation.- Returns:
- output directory for generated sources.
-
getDescriptorSetOutputDirectory
Returns output directory for descriptor set file. Depends on build phase so must be defined in concrete implementation.- Returns:
- output directory for generated descriptor set.
- Since:
- 0.3.0
-
doAttachFiles
protected void doAttachFiles() -
doAttachProtoSources
protected abstract void doAttachProtoSources() -
doAttachGeneratedFiles
protected abstract void doAttachGeneratedFiles() -
getDependencyArtifactFiles
Gets theFile
for each dependency artifact.- Returns:
- A list of all dependency artifacts.
-
makeProtoPathFromJars
protected List<File> makeProtoPathFromJars(File temporaryProtoFileDirectory, Iterable<File> classpathElementFiles) Unpacks proto descriptors that are bundled inside dependent artifacts into a temporary directory. This is needed because protobuf compiler cannot handle imported descriptors that are packed inside jar files.- Parameters:
temporaryProtoFileDirectory
- temporary directory to serve as root for unpacked structure.classpathElementFiles
- classpath elements, can be either jar files or directories.- Returns:
- a list of import roots for protobuf compiler (these will all be subdirectories of the temporary directory).
-
findProtoFilesInDirectory
-
findProtoFilesInDirectories
-
truncatePath
Truncates the path of jar files so that they are relative to the local repository.- Parameters:
jarPath
- the full path of a jar file.- Returns:
- the truncated path relative to the local repository or root of the drive.
-
md5Hash
-
toHexString
-
resolveBinaryArtifact
-
createDependencyArtifact
Creates a dependency artifact from a specification ingroupId:artifactId:version[:type[:classifier]]
format.- Parameters:
artifactSpec
- artifact specification.- Returns:
- artifact object instance.
-
createDependencyArtifact
-