-
Notifications
You must be signed in to change notification settings - Fork 56
Maven Plugin Architecture
IMPORTANT: Zanata's wiki has moved to https://github.com/zanata/zanata-platform/wiki
New link: https://github.com/zanata/zanata-platform/wiki/Maven-Plugin-Architecture
The Zanata Maven Plugin uses the Maven Plugin API to implement a plugin that can be incorporated into Maven workflows or used as a standalone command-line application (but still requiring a working Maven installation). The plugin is essentially a wrapper that handles invocation and argument handling, then passes control to classes in the zanata-client-commands project.
An introduction to Maven Plugins can be found at Apache Maven Project - Guide to Developing Java Plugins.
It is recommended to understand the concept of a Command and an Options object in Zanata before continuing. See Client Command Architecture.
Maven Plugin commands are implemented as Mojos. There is a Mojo for each available command in the Zanata Maven Plugin, e.g. PutProjectMojo. The Mojo acts as an Options object that is passed to an appropriate type of Command object.
The Zanata Maven Plugin is made up of several classes found in repository zanata-client project zanata-maven-plugin, in package org.zanata.maven. These classes use Command classes found in project zanata-client-commands in package org.zanata.client.commands, which generally also use code in project zanata-rest-client and zanata-common-api (in repository zanata-api).
The Maven Plugin framework handles processing of parameters from pom.xml or the command line, and calls execute(). In execute(), a Command object is instantiated, given the Mojo as its Options implementation, and the command is run.
Parameters are defined with annotations as described in Maven: The Complete Reference 11.5. Mojo Parameters.