ootbee-beedk/beedk-acs-module-tile/README.md

BeeDK ACS Module Maven Tile

This is a component within the proposed BeeDK. It is considered to be part of the Private API of the BeeDK.

Purpose

This project creates a Maven Tile that provides the basis for any ACS module or extension.

Usage

To use this plugin, just reference it with the Maven Tiles plugin as shown in the following snippet. Do not forget the extensions element in the plugin configuration.

<project ...>
	...
	<build>
		...
		<plugins>
			<plugin>
				<groupId>io.repaint.maven</groupId>
				<artifactId>tiles-maven-plugin</artifactId>
				<version>[2.0,3.0)</version>
				<extensions>true</extensions>
				<configuration>
					<tiles>
						...
						<!-- Documentation: https://git.inteligr8.com/inteligr8/ootbee-beedk/src/branch/stable/beedk-acs-module-tile -->
						<tile>com.inteligr8.ootbee:beedk-acs-module-tile:[1.0.0,2.0.0)</tile>
						...
					</tiles>
				</configuration>
			</plugin>
			...
		</plugins>
		...
	</build>
	...
</project>

Configuration

In your Maven project, set the following properties to define the behavior of this Maven Tile. Unless otherwise stated, they can only be overridden in the project POM or other Maven Tiles loaded earlier than this Maven Tile.

Public API

The following properties are intended to be exposed by inheriting Public API Maven Tiles.

Maven Property	Required	Default	Description
project.build.packageDirectory		target/package	A variable specifying the folder name of consolidated resources for packaging.
alfresco.module.pathname		${project.groupId}.${project.artifactId}	A variable specifying the folder name of module resources. Use this property to help reference module resources. It should rarely ever be overridden.
alfresco.module.classifier		None	A Maven classifier for the artifact.
alfresco.module.noAmp		Automatic	Set to false to force AMP generation; true to force JAR. A value of true could produce a non-functional module.

Results

This Maven Tile will result in the definition of the following Maven properties during the respective Maven phase.

Property	Data Type	Phase	Description
alfresco.module.path	Text	At startup	The classpath to the module resources: alfresco/module/${alfresco.module.pathname}

Initialization

This tile comes with the ability to initialize your project with the required file(s) of an ACS module. You can do this by executing any Maven build with the scaffold property.

mvn -Dscaffold generate-sources