Plugin Documentation

Goals available for this plugin:

Goal Description
cics-bundle:build

This mojo builds a CICS bundle to the target directory, including any dependencies and resource definition artifacts.

Use this mojo by creating a new Maven module with packaging type cics-bundle to package an existing Java-based dependency as a bundle without modifying the existing dependency, or to create a bundle that only contains resource definitions artifacts.

cics-bundle:bundle-ear

This mojo packages the produced EAR project as a CICS bundle.

Use this mojo to add configuration to an existing EAR project so that it is packaged as a CICS bundle, without creating an additional Maven module.

cics-bundle:bundle-eba

This mojo packages the produced EBA project as a CICS bundle.

Use this mojo to add configuration to an existing EBA project so that it is packaged as a CICS bundle, without creating an additional Maven module.

cics-bundle:bundle-osgi

This mojo packages the produced OSGi project as a CICS bundle.

Use this mojo to add configuration to an existing OSGi project so that it is packaged as a CICS bundle, without creating an additional Maven module.

cics-bundle:bundle-war

This mojo packages the produced WAR project as a CICS bundle.

Use this mojo to add configuration to an existing WAR project so that it is packaged as a CICS bundle, without creating an additional Maven module.

cics-bundle:deploy

This mojo deploys a CICS bundle to the specified CICS region using the CICS bundle deployment API. A matching bundle definition must be provided in the CSD in advance.

The deploy goal is not bound by default, so will not run unless specifically configured. You might choose to configure the deploy goal to run inside a specific profile, so that a developer can choose whether to deploy their bundle with a command-line parameter to switch Maven profiles.

cics-bundle:package

This mojo packages a CICS bundle as an archive file. It will normally be run by default without specific configuration.

System Requirements

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

Maven 2.0
JDK 1.8
Memory No minimum requirement.
Disk Space No 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>com.ibm.cics</groupId>
          <artifactId>cics-bundle-maven-plugin</artifactId>
          <version>2.0.1-SNAPSHOT</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.ibm.cics</groupId>
        <artifactId>cics-bundle-maven-plugin</artifactId>
        <version>2.0.1-SNAPSHOT</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

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