Plugin Documentation

Goals available for this plugin:

GoalDescription
kscontractdoc:kscontractdocThe plugin entrypoint which is used to generate the html wiki doc of the service interface.
kscontractdoc:kscreateadminuiNo description.
kscontractdoc:kscreateconftestThis class associates a mojo to create the conformance tests.
kscontractdoc:kscreatejpaimplNo description.
kscontractdoc:kscreatemockNo description.
kscontractdoc:kscreateremoteimplNo description.
kscontractdoc:kscreatevdecNo description.
kscontractdoc:ksdictionarycreatorThe plugin entrypoint which is used to generate dictionary files based on the contract
kscontractdoc:ksdictionarydoc
kscontractdoc:kseachmethodservicegeneratorThe plugin entrypoint which is used to generate a java interface file for each service method in the source files based on the contract definition

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven2.0
JDK1.6
MemoryNo minimum requirement.
Disk SpaceNo minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.kuali.maven.plugins</groupId>
          <artifactId>kscontractdoc-maven-plugin</artifactId>
          <version>1.0.10-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.kuali.maven.plugins</groupId>
        <artifactId>kscontractdoc-maven-plugin</artifactId>
        <version>1.0.10-SNAPSHOT</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"