inteligr8/ootbee-beedk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial checkin

Browse Source
This commit is contained in:
Brian Long
2021-04-22 15:58:20 -04:00
commit a7fef4641b
278 changed files with 14028 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
beedk-acs-share-module-tile/.gitignore vendored Normal file
View File

@@ -0,0 +1,9 @@
# Eclipse
.project
.classpath
.settings
# Maven
pom.xml.versionsBackup
target

77
beedk-acs-share-module-tile/README.md Normal file
View File

@@ -0,0 +1,77 @@
# BeeDK ACS Share Module Maven Tile
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 any ACS Share 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.
```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-module-tile -->
<tile>com.inteligr8.ootbee:beedk-acs-share-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. |
### Other APIs
Additional less important configurations are inherited from the following Maven Tile.
* [`beedk-acs-module-tile`](/inteligr8/ootbee-beedk/src/stable/beedk-acs-module-tile)
## Results
The project will build as a deployable ACS Share module.
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}` |
| `alfresco.ext.path` | | *At startup* | The classpath to the extension resources: `alfresco/web-extension` |
| `alfresco.ext.package` | Text | *At startup* | The package reference to the extension resources: `alfresco.web-extension` |
## Initialization
This tile comes with the ability to initialize your project with the required file(s) of an ACS Share module. You can do this by executing any Maven build with the `scaffold` property.
```sh
mvn -Dscaffold generate-sources
```

47
beedk-acs-share-module-tile/pom.xml Normal file
View File

@@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.inteligr8.ootbee</groupId>
<artifactId>beedk-acs-share-module-tile</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>tile</packaging>
<name>Order of the Bee Development Kit: ACS Share Module</name>
<scm>
<url>https://bitbucket.org/inteligr8/ootbee-beedk</url>
</scm>
<organization>
<name>Order of the Bee</name>
<url>https://orderofthebee.net</url>
</organization>
<developers>
<developer>
<name>Brian Long</name>
<email>brian@inteligr8.com</email>
<organization>Inteligr8</organization>
<organizationUrl>https://www.inteligr8.com</organizationUrl>
<url>https://twitter.com/brianmlong</url>
</developer>
</developers>
<build>
<plugins>
<plugin>
<groupId>io.repaint.maven</groupId>
<artifactId>tiles-maven-plugin</artifactId>
<version>2.20</version>
<extensions>true</extensions>
<configuration>
<tiles>
<tile>com.inteligr8:maven-public-deploy-tile:[1.0.0,2.0.0)</tile>
</tiles>
</configuration>
</plugin>
</plugins>
</build>
</project>

96
beedk-acs-share-module-tile/tile.xml Normal file
View File

@@ -0,0 +1,96 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://tiles.bluetrainsoftware.com/maven/tiles/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://tiles.bluetrainsoftware.com/maven/tiles/1.1.0 https://bitbucket.org/inteligr8/maven-tiles/raw/xsd/src/main/resources/maven-tiles.xsd">
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.2.0</version>
<executions>
<execution>
<id>add-acs-share-module-resources</id>
<goals><goal>add-resource</goal></goals>
<configuration>
<resources>
<!-- copy & filter the contents of a convenient extension folder -->
<resource>
<directory>src/main/extension</directory>
<filtering>true</filtering>
<excludes>
<exclude>**/README*</exclude>
<exclude>share-config*.xml</exclude>
</excludes>
<targetPath>${project.build.directory}/extension-classes/${alfresco.ext.path}</targetPath>
</resource>
<!-- copy & filter the share-config-custom from a possible other folder -->
<resource>
<directory>src/main/module</directory>
<filtering>true</filtering>
<includes>
<include>share-config*.xml</include>
</includes>
<targetPath>${project.build.directory}/web-resources/META-INF</targetPath>
</resource>
<!-- copy & filter the share-config-custom from a possible other folder -->
<resource>
<directory>src/main/extension</directory>
<filtering>true</filtering>
<includes>
<include>share-config*.xml</include>
</includes>
<targetPath>${project.build.directory}/web-resources/META-INF</targetPath>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.2.0</version>
<executions>
<!-- This plugin execution consolidates the compiled/generated/filtered resources into one directory for packaging -->
<execution>
<id>consolidate-extension</id>
<phase>process-resources</phase>
<goals><goal>copy-resources</goal></goals>
<configuration>
<outputDirectory>${project.build.packageDirectory}</outputDirectory>
<resources>
<resource>
<directory>${project.build.directory}/extension-classes</directory>
<filtering>false</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>default-props</id>
<activation>
<property>
<name>!some-prop-that-never-exists</name>
</property>
</activation>
<properties>
<!-- output -->
<alfresco.ext.path>alfresco/web-extension</alfresco.ext.path>
<alfresco.ext.package>alfresco.web-extension</alfresco.ext.package>
</properties>
</profile>
</profiles>
<tiles>
<!-- Documentation: https://bitbucket.org/inteligr8/ootbee-beedk/src/stable/beedk-acs-module-tile -->
<tile>com.inteligr8.ootbee:beedk-acs-module-tile:1.0-SNAPSHOT</tile>
</tiles>
</project>