BeeDK ACS Web Application Builder 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 building Alfresco web applications. It is intended to be used by other BeeDK components and not directly by any development project.

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-webapp-artifact-build-tile -->
						<tile>com.inteligr8.ootbee:beedk-acs-webapp-artifact-build-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
`alfresco.sdk.version`	YES		For a list of versions and more details, see the Alfresco SDK. This is used for AMP packaging functionality.
`alfresco.war.groupId`		`org.alfresco`	The Maven `groupId` of a Maven `war` Type Project defined in a Maven Repository. Inherited from `beedk-acs-webapp-artifact-tile`
`alfresco.war.artifactId`	YES		The Maven `artifactId` of a Maven `war` Type Project defined in a Maven Repository. Inherited from `beedk-acs-webapp-artifact-tile`
`alfresco.war.version`	YES		The Maven `version` of a Maven `war` Type Project defined in a Maven Repository. Inherited from `beedk-acs-webapp-artifact-tile`
`project.build.ampDirectory`		`${project.build.directory}/amp`	This is where AMPs are temporarily copied during the build process.

Other APIs

Additional less important configurations are inherited from the following Maven Tiles.

beedk-acs-webapp-artifact-tile

Results

The configured WAR will downloaded to your local Maven Repository and copied into the configured directory during the configured Maven phase. The project's AMP compile and runtime dependencies will be downloaded to your local Maven Repository and copied into the configured directory during the pre-package Maven phase. The AMPs will be installed into the WAR during the package Maven phase. The downloaded and copied AMPs will remain in place.

3.5 KiB Raw Permalink Blame History