85 lines
5.2 KiB
Markdown
85 lines
5.2 KiB
Markdown
# BeeDK ACS Share RAD Maven Tile for Share Projects
|
|
|
|
This is a component within the proposed [BeeDK](/inteligr8/ootbee-beedk). It is considered to be part of the **Public API** of the BeeDK.
|
|
|
|
## Purpose
|
|
|
|
This project creates a [Maven Tile](https://github.com/repaint-io/maven-tiles) that provides the basis for rapid application development of any ACS Share module, extension, service, or web application.
|
|
|
|
## 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.
|
|
|
|
```xml
|
|
<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://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-self-rad-tile -->
|
|
<tile>com.inteligr8.ootbee:beedk-acs-share-self-rad-tile:[1.0.0,2.0.0)</tile>
|
|
</tiles>
|
|
</configuration>
|
|
</plugin>
|
|
...
|
|
</plugins>
|
|
...
|
|
</build>
|
|
...
|
|
</project>
|
|
```
|
|
|
|
There are 2 other alternative tiles that serve a similar purpose, but are for other use cases. Make sure you are using the right one. Follow the logic below.
|
|
|
|
Is your Maven project an ACS Share module or ACS Share web application?
|
|
: You will be declaring the `beedk-acs-share-module-tile` or `beedk-acs-share-webapp-tile` Maven Tile. You will need to explicitly declare and configure the `beedk-acs-share-self-rad-tile` Maven Tile.
|
|
|
|
Is your Maven project just one within a set of other Maven projects AND one of those other Maven projects is an ACS Share web application (not a module)?
|
|
: You will need to explicitly declare and configure the [`beedk-acs-share-sibling-rad-tile` Maven Tile](../beedk-acs-share-sibling-rad-tile).
|
|
|
|
Otherwise
|
|
: You will need to explicitly declare and configure the [`beedk-acs-share-artifact-rad-tile` Maven Tile](../beedk-acs-share-artifact-rad-tile).
|
|
|
|
See the [BeeDK documentation](/inteligr8/ootbee-beedk) on instructions for how to start and stop RAD capabilities.
|
|
|
|
## 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](https://github.com/Alfresco/alfresco-sdk).<br/>*Inherited from [`beedk-acs-webapp-artifact-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-rad-tile)* |
|
|
| `alfresco.share.version` | *Maybe* | | The Alfresco Share version to use for RAD. See below for more details. |
|
|
| `alfresco.war.artifactId` | | `share` | The Maven `artifactId` of a Maven `war` Type Project defined in a Maven Repository.<br/>*Inherited from [`beedk-acs-webapp-artifact-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-tile)* |
|
|
| `alfresco.war.version` | *Maybe* | *See Below* | The Maven `version` of a Maven `war` Type Project defined in a Maven Repository.<br/>*Inherited from [`beedk-acs-webapp-artifact-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-tile)* |
|
|
| `acs-platform.url` | | *See Below* | The URL of the backend ACS Platform to be used. |
|
|
| `acs-share.port` | | 8180 | The port to expose on `localhost` for the developer; not for other applications or users. |
|
|
| `acs-share.debugger.port` | | 8100 | The port to expose on `localhost` for the developer; not for other applications or users. |
|
|
| `acs-share.tomcat.opts` | | | Additional `CATALINA_OPTS` to add to the Apache Tomcat startup.<br/>*May be overridden by any POM parent or Maven Tile.*<br/>*Inherited from [`beedk-acs-share-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-rad-tile)* |
|
|
|
|
* The `alfresco.share.version` is used to default the `alfresco.war.version`. It is expected to be used by other Maven Tiles, so it is here for convenience. You must specify either property for this tile to function.
|
|
* The `acs-platform.url` will default to the appropriate value when using the `beedk-acs-platform-*-rad-tile` tiles. This should be overridden if you are not using those tiles and are instead using some other ACS Platform instance.
|
|
|
|
### Other APIs
|
|
|
|
Additional less important configurations are inherited from the following Maven Tiles.
|
|
|
|
* [`beedk-acs-share-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-share-rad-tile)
|
|
* [`beedk-acs-webapp-artifact-rad-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-webapp-artifact-rad-tile)
|
|
|
|
## Results
|
|
|
|
ACS Share will be started during the `process-classes` Maven phase.
|