mirror of
https://github.com/Alfresco/alfresco-sdk.git
synced 2025-09-17 14:21:45 +00:00
updated documentation to refer to version 4.2
This commit is contained in:
gfertuso
@@ -26,7 +26,7 @@ If you are an Enterprise customer check the [Support](#alfresco-enterprise-custo
|
||||
## User Getting Started
|
||||
|
||||
### Latest Documentation
|
||||
To get started with **Alfresco SDK 4.1.x** (latest) visit the [Alfresco Documentation](docs/README.md).
|
||||
To get started with **Alfresco SDK 4.2.x** (latest) visit the [Alfresco Documentation](docs/README.md).
|
||||
|
||||
#### Documentation about Previous Versions
|
||||
| SDK Version | Alfresco Enterprise Version | Alfresco Community Version | Documentation |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Alfresco AIO Project - SDK 4.0
|
||||
# Alfresco AIO Project - SDK 4.2
|
||||
|
||||
This is an All-In-One (AIO) project for Alfresco SDK 4.0.
|
||||
This is an All-In-One (AIO) project for Alfresco SDK 4.2.
|
||||
|
||||
Run with `./run.sh build_start` or `./run.bat build_start` and verify that it
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>${artifactId}</artifactId>
|
||||
<name>Integration Tests Module</name>
|
||||
<description>Integration Tests module for in-container integration testing - part of AIO - SDK 4.0</description>
|
||||
<description>Integration Tests module for in-container integration testing - part of AIO - SDK 4.2</description>
|
||||
<packaging>jar</packaging> <!-- Note. this just runs Integration Tests, but it needs to be a JAR otherwise
|
||||
nothing is compiled (i.e. you cannot set it to pom) -->
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<artifactId>${artifactId}</artifactId>
|
||||
<name>Alfresco Platform/Repository JAR Module</name>
|
||||
<description>Platform/Repo JAR Module (to be included in the alfresco.war) - part of AIO - SDK 4.0
|
||||
<description>Platform/Repo JAR Module (to be included in the alfresco.war) - part of AIO - SDK 4.2
|
||||
</description>
|
||||
<packaging>jar</packaging>
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
<artifactId>${artifactId}</artifactId>
|
||||
<name>Alfresco Share JAR Module</name>
|
||||
<packaging>jar</packaging>
|
||||
<description>Sample Share JAR Module (to be included in the share.war) - part of AIO - SDK 4.0</description>
|
||||
<description>Sample Share JAR Module (to be included in the share.war) - part of AIO - SDK 4.2</description>
|
||||
|
||||
<parent>
|
||||
<groupId>${groupId}</groupId>
|
||||
|
||||
@@ -5,8 +5,8 @@
|
||||
<groupId>${groupId}</groupId>
|
||||
<artifactId>${artifactId}</artifactId>
|
||||
<version>${version}</version>
|
||||
<name>AIO - SDK 4.0</name>
|
||||
<description>All-In-One (AIO) project for SDK 4.0</description>
|
||||
<name>AIO - SDK 4.2</name>
|
||||
<description>All-In-One (AIO) project for SDK 4.2</description>
|
||||
<packaging>pom</packaging>
|
||||
|
||||
<prerequisites>
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Alfresco ACS JAR Module - SDK 4.0
|
||||
# Alfresco ACS JAR Module - SDK 4.2
|
||||
|
||||
This is an ACS project for Alfresco SDK 4.0.
|
||||
This is an ACS project for Alfresco SDK 4.2.
|
||||
|
||||
Run with `./run.sh build_start` or `./run.bat build_start` and verify that it
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Alfresco Share JAR Module - SDK 4.0
|
||||
# Alfresco Share JAR Module - SDK 4.2
|
||||
|
||||
This is a Share project for Alfresco SDK 4.0.
|
||||
This is a Share project for Alfresco SDK 4.2.
|
||||
|
||||
Run with `./run.sh build_start` or `./run.bat build_start` and verify that it
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
Title: Alfresco SDK 4.1
|
||||
Title: Alfresco SDK 4.2
|
||||
Added: v3.0.0
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Alfresco SDK 4.1
|
||||
# Alfresco SDK 4.2
|
||||
|
||||
Alfresco SDK 4.1 is a Maven based development kit that provides an easy to use approach to developing applications and extensions for Alfresco. With this
|
||||
Alfresco SDK 4.2 is a Maven based development kit that provides an easy to use approach to developing applications and extensions for Alfresco. With this
|
||||
SDK you can develop, package, test, run, document and release your Alfresco extension project.
|
||||
|
||||
For earlier releases of the Alfresco SDK, see the Previous versions of [http://docs.alfresco.com](http://docs.alfresco.com).
|
||||
@@ -14,22 +14,22 @@ The Alfresco Software Development Kit (Alfresco SDK) is a fundamental tool provi
|
||||
the Alfresco Digital Business Platform. It is based on [Apache Maven](http://maven.apache.org/) and [Docker](https://www.docker.com/) and is compatible with
|
||||
major IDEs. This enables Rapid Application Development (RAD) and Test Driven Development (TDD).
|
||||
|
||||
Alfresco SDK 4.1 is released under [Apache License version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) and supports Alfresco Content Services both
|
||||
Alfresco SDK 4.2 is released under [Apache License version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) and supports Alfresco Content Services both
|
||||
in Community Edition and Enterprise Edition. If you're an Enterprise customer, please check the [Alfresco SDK Support status](https://www.alfresco.com/alfresco-product-support-status)
|
||||
for the version you're using. If your version is in Limited or Full Support and you need help, contact our Support team [http://support.alfresco.com](http://support.alfresco.com/).
|
||||
|
||||
Alfresco SDK 4.1 is a minor update to the SDK and provides support for Alfresco 6.2.x.
|
||||
Alfresco SDK 4.2 is a minor update to the SDK and provides support for Alfresco 7.0.x.
|
||||
|
||||
The 4.0 release takes advantage of Semantic Versioning ([SEMVER](http://semver.org/)), which means that this new release is not directly compatible with the
|
||||
previous releases of the SDK.
|
||||
|
||||
If you have existing projects that you wish to upgrade to SDK 4.1.x, the recommended approach is to generate a new project from our archetypes and move your
|
||||
If you have existing projects that you wish to upgrade to SDK 4.2.x, the recommended approach is to generate a new project from our archetypes and move your
|
||||
code into place.
|
||||
|
||||
## Documentation Content
|
||||
|
||||
* [What's new?](whats-new.md)
|
||||
* [Getting started with Alfresco SDK 4.1](getting-started.md)
|
||||
* [Getting started with Alfresco SDK 4.2](getting-started.md)
|
||||
* [Alfresco SDK Maven archetypes](mvn-archetypes.md)
|
||||
* [Working with generated projects](working-with-generated-projects/README.md)
|
||||
* [All-In-One project structure](working-with-generated-projects/structure-aio.md)
|
||||
|
||||
@@ -5,7 +5,7 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# Working with AMPs
|
||||
|
||||
Since the early days of the Alfresco SDK, the Alfresco Module Packages (AMP) have been the way customizations were packaged. In Alfresco SDK 4.1 everything
|
||||
Since the early days of the Alfresco SDK, the Alfresco Module Packages (AMP) have been the way customizations were packaged. In Alfresco SDK 4.2 everything
|
||||
is packaged as a JAR by default, while the AMPs are still available as an optional assembly. This gives you much more control over packaging, and simple
|
||||
modules can easily be deployed as JARs.
|
||||
|
||||
@@ -55,7 +55,7 @@ to your needs.
|
||||
|
||||
## Installing AMPs with the SDK
|
||||
|
||||
The projects created from the Alfresco SDK 4.1 archetypes are configured to deploy either JARs or AMPs to the ACS / Share docker container. The only thing to
|
||||
The projects created from the Alfresco SDK 4.2 archetypes are configured to deploy either JARs or AMPs to the ACS / Share docker container. The only thing to
|
||||
do is modify the `pom.xml` file of the corresponding docker module / project in order to properly configure the dependencies and the Maven dependency plugin.
|
||||
|
||||
### All-In-One project
|
||||
@@ -237,7 +237,7 @@ include *.amp in the copy-and-filter-docker-resources-non-filtered
|
||||
## Controlling the order AMPs are applied
|
||||
|
||||
Under some specific circumstances it is necessary to apply different AMPs in a development project in a precise order. The default configuration of the
|
||||
projects generated using the Alfresco SDK 4.1 archetypes doesn't specify any concrete order applying the AMPs to the ACS/Share installation.
|
||||
projects generated using the Alfresco SDK 4.2 archetypes doesn't specify any concrete order applying the AMPs to the ACS/Share installation.
|
||||
|
||||
Anyway, that order can be controlled modifying slightly the configuration of the custom Docker images in the project. For instance, let's say we have three
|
||||
third party AMPs that we want to apply in the next order `third-party-amp-01.amp -> third-party-amp-02.amp -> third-party-amp-03.amp`. In this example, we're
|
||||
|
||||
@@ -10,4 +10,4 @@ application server. This section outlines the steps needed to configure Alfresco
|
||||
and to troubleshoot issues by stepping through the code line by line.
|
||||
|
||||
Here we assume you have already generated an Alfresco project using the Alfresco SDK. If you don't have a project already, follow the steps in
|
||||
[Getting started with Alfresco SDK 4.1](../../getting-started.md) to learn how to generate it in a few easy steps.
|
||||
[Getting started with Alfresco SDK 4.2](../../getting-started.md) to learn how to generate it in a few easy steps.
|
||||
|
||||
@@ -5,7 +5,7 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# Remote debugging using Eclipse
|
||||
|
||||
All the projects generated using the Alfresco SDK 4.1 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
All the projects generated using the Alfresco SDK 4.2 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
have a port for remotely debugging ACS, share or both of them.
|
||||
|
||||
By default, the remote debug port for ACS is **8888** and for share is **9898**. This configuration can be changed through the maven properties `acs.debug.port`
|
||||
@@ -79,7 +79,7 @@ application. In our case, we are going to test the behaviour of debugging by run
|
||||
|
||||
8. Open your browser and type `http://localhost:8080/alfresco/s/sample/helloworld`.
|
||||
|
||||
This is a sample webscript generated in every project created using SDK 4.1 and the platform artifact.
|
||||
This is a sample webscript generated in every project created using SDK 4.2 and the platform artifact.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# Remote debugging using IntelliJ
|
||||
|
||||
All the projects generated using the Alfresco SDK 4.1 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
All the projects generated using the Alfresco SDK 4.2 are pre-configured to listen for remote debug connections. Depending on the selected archetypes you'll
|
||||
have a port for remotely debugging ACS, share or both of them.
|
||||
|
||||
By default, the remote debug port for ACS is **8888** and for share is **9898**. This configuration can be changed through the maven properties `acs.debug.port`
|
||||
@@ -77,7 +77,7 @@ application. In our case, we are going to test the behaviour of debugging by run
|
||||
|
||||
7. Open your browser and type `http://localhost:8080/alfresco/s/sample/helloworld`.
|
||||
|
||||
This is a sample webscript generated in every project created using SDK 4.1 and the platform artifact.
|
||||
This is a sample webscript generated in every project created using SDK 4.2 and the platform artifact.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Last reviewed: 2019-10-18
|
||||
[HotSwapAgent](http://hotswapagent.org/index.html) is the agent that enables you to do hot reloading. This allows you to modify the application code, and
|
||||
view the changes without having to restart Alfresco Tomcat (or the ACS Docker container).
|
||||
|
||||
A prerequisite for this tutorial is to have a project created with the Alfresco SDK 4.1, using the All-In-One archetype or the Platform JAR archetype. It's
|
||||
A prerequisite for this tutorial is to have a project created with the Alfresco SDK 4.2, using the All-In-One archetype or the Platform JAR archetype. It's
|
||||
worth noting that hot reloading is only supported on the platform, and not in Alfresco Share.
|
||||
|
||||
As an alternative to the HotSwapAgent you can also try out JRebel. It has more features but isn't free.
|
||||
@@ -112,7 +112,7 @@ For more information about HotSwapAgent configuration for Java 8, please check t
|
||||
Using Java 11 and HotSwapAgent, it isn't necessary to configure the java agent and the alternative JVM as in previous versions. Instead, it is required
|
||||
to use an alternative pre-built JDK distribution. That JDK is based on OpenJDK and includes all the required modifications to run the HotSwapAgent properly.
|
||||
|
||||
In the context of the Alfresco SDK 4.1, this change is an issue because the JDK installation is inherited from the [Alfresco java docker image](https://github.com/Alfresco/alfresco-docker-base-java).
|
||||
In the context of the Alfresco SDK 4.2, this change is an issue because the JDK installation is inherited from the [Alfresco java docker image](https://github.com/Alfresco/alfresco-docker-base-java).
|
||||
It is necessary to modify the project ACS docker image to change the default java installation of the container's OS to the one provided by HotSwapAgent.
|
||||
|
||||
A way to implement the required modifications would be:
|
||||
@@ -250,7 +250,7 @@ You'll recognize HotSwapAgent is working when you see similar log messages:
|
||||
|
||||
2. Before making any changes, let's run the sample webscript by opening your browser and typing `http://localhost:8080/alfresco/s/sample/helloworld`.
|
||||
|
||||
This is a sample webscript generated in every project created using SDK 4.1 and the platform artifact.
|
||||
This is a sample webscript generated in every project created using SDK 4.2 and the platform artifact.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Last reviewed: 2019-10-18
|
||||
[JRebel](https://zeroturnaround.com/software/jrebel/) is the agent that enables you to do hot reloading. This allows you to modify the application code,
|
||||
and view the changes without having to restart Alfresco Tomcat (or the ACS Docker container).
|
||||
|
||||
A prerequisite to this tutorial is having an Alfresco project created with Alfresco SDK 4.1, using the All-In-One archetype, or the Platform JAR archetype.
|
||||
A prerequisite to this tutorial is having an Alfresco project created with Alfresco SDK 4.2, using the All-In-One archetype, or the Platform JAR archetype.
|
||||
It's worth noting that hot reloading is only supported on the platform, and not in Alfresco Share.
|
||||
|
||||
An open source and free of charge alternative to JRebel is HotSwapAgent. For more details, see the [HotSwapAgent website](http://hotswapagent.org/index.html).
|
||||
|
||||
@@ -11,11 +11,11 @@ in an integration test plan to those aggregates, and delivers as its output the
|
||||
|
||||
Even if the definition of integration testing is a general description, the concept is also valid for Alfresco projects.
|
||||
|
||||
The Alfresco SDK 4.1 keeps the same general idea of integration testing provided by SDK 3.0, but this new version reshapes it slightly to leverage on a
|
||||
The Alfresco SDK 4.2 keeps the same general idea of integration testing provided by SDK 3.0, but this new version reshapes it slightly to leverage on a
|
||||
Docker-oriented environment.
|
||||
|
||||
Here are the basics to understanding and using integration testing in the context of projects created with the SDK, from a technical perspective:
|
||||
* SDK 4.1 develops integration tests for the platform only. Currently, the integration tests that the SDK is able to manage by default is related to
|
||||
* SDK 4.2 develops integration tests for the platform only. Currently, the integration tests that the SDK is able to manage by default is related to
|
||||
Alfresco Content Services (ACS) only.
|
||||
* Integration tests require an ACS instance to be up and running. You will see that all the scripts and commands are designed to easily manage this
|
||||
requirement, but the prerequisite for the SDK is that an ACS instance is available.
|
||||
|
||||
@@ -5,7 +5,7 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# How to run SDK's integration tests
|
||||
|
||||
Running the integration tests of a project generated from the Alfresco SDK 4.1 archetypes is pretty easy. Let's distinguish different cases of executing the
|
||||
Running the integration tests of a project generated from the Alfresco SDK 4.2 archetypes is pretty easy. Let's distinguish different cases of executing the
|
||||
integration tests.
|
||||
|
||||
## Command line
|
||||
|
||||
@@ -36,7 +36,7 @@ or set the Java system property `acs.endpoint.path`.
|
||||
|
||||
## Integration tests configuration in the All-In-One project
|
||||
|
||||
So, taking into account the previous section, let's see how the integration tests are configured in a project generated from the SDK 4.1 All-In-One archetype.
|
||||
So, taking into account the previous section, let's see how the integration tests are configured in a project generated from the SDK 4.2 All-In-One archetype.
|
||||
|
||||
* The maven dependencies required to execute the integration tests are deployed to the ACS Docker image in the `PROJECT_ARTEFACTID-platform-docker` maven
|
||||
module using the `maven-dependency-plugin`. The configuration is done in the file `PROJECT_ARTEFACTID-platform-docker/pom.xml`:
|
||||
|
||||
@@ -28,7 +28,7 @@ The supported versions are explained in the next sections of this article.
|
||||
|
||||
## Switch to Alfresco version 6.0.x
|
||||
|
||||
Starting from a newly created Alfresco SDK 4.1 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
Starting from a newly created Alfresco SDK 4.2 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
|
||||
1. Open the pom.xml in your generated project.
|
||||
|
||||
@@ -60,7 +60,7 @@ about wrong JDK versions.
|
||||
|
||||
## Switch to Alfresco version 6.1.x
|
||||
|
||||
Starting from a newly created Alfresco SDK 4.1 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
Starting from a newly created Alfresco SDK 4.2 project (All-In-One, Platform JAR, or Share JAR), let’s replace the two properties with the following ones.
|
||||
|
||||
1. Open the pom.xml in your generated project.
|
||||
|
||||
|
||||
@@ -3,13 +3,13 @@ Title: Upgrading
|
||||
Added: v4.0.0
|
||||
Last reviewed: 2019-01-29
|
||||
---
|
||||
# Upgrading an SDK 3.0 project to SDK 4.1
|
||||
# Upgrading an SDK 3.0 project to SDK 4.2
|
||||
|
||||
In these instructions, "base" refers to a freshly instantiated SDK 4.1 and "target" refers to the SDK 3.0.1 project that is being upgraded.
|
||||
In these instructions, "base" refers to a freshly instantiated SDK 4.2 and "target" refers to the SDK 3.0.1 project that is being upgraded.
|
||||
|
||||
## Download a base
|
||||
|
||||
Download or instantiate an SDK 4.1 project to use as a base for copying files.
|
||||
Download or instantiate an SDK 4.2 project to use as a base for copying files.
|
||||
|
||||
For example, you might create a new project called `test-aio-400` to use as a base from which to copy files into the target project that is to be upgraded.
|
||||
|
||||
@@ -65,7 +65,7 @@ Similar to previous step, the directory should follow the same pattern as the ex
|
||||
|
||||
Need to smartly do this merge so that target project maintains its dependencies, name, version, description, etc.
|
||||
|
||||
1. Copy the entire `<properties>` element from the base 4.1 pom.xml into the target 3.0 pom.xml, replacing the existing one completely.
|
||||
1. Copy the entire `<properties>` element from the base 4.2 pom.xml into the target 3.0 pom.xml, replacing the existing one completely.
|
||||
|
||||
2. Change the `acs.host` property to match the target project name.
|
||||
|
||||
@@ -220,7 +220,7 @@ Then that would need to be moved into the share docker module's pom.xml file in
|
||||
|
||||
## Changes to the integration-tests module
|
||||
|
||||
1. Completely replace the pom.xml file with the pom.xml file from the 4.1 pom.xml file under integration-tests.
|
||||
1. Completely replace the pom.xml file with the pom.xml file from the 4.2 pom.xml file under integration-tests.
|
||||
|
||||
2. Edit the integration-tests pom.xml to replace references to the base project name with references to the target project name.
|
||||
|
||||
@@ -230,7 +230,7 @@ Then that would need to be moved into the share docker module's pom.xml file in
|
||||
|
||||
## Changes to the platform-jar module
|
||||
|
||||
Smartly merge the pom.xml file from the 4.1 platform-jar module into the existing platform-jar module pom.xml file.
|
||||
Smartly merge the pom.xml file from the 4.2 platform-jar module into the existing platform-jar module pom.xml file.
|
||||
|
||||
Maintain the dependencies from the 3.0 platform-jar module pom.xml.
|
||||
|
||||
@@ -238,13 +238,13 @@ Any old "platformModule" dependencies, which are typically AMPs or JARs that nee
|
||||
|
||||
## Changes to the share-jar module
|
||||
|
||||
Smartly merge the pom.xml file from the 4.1 share-jar module into the existing share-jar module pom.xml file.
|
||||
Smartly merge the pom.xml file from the 4.2 share-jar module into the existing share-jar module pom.xml file.
|
||||
|
||||
Maintain the dependencies from the 3.0 share-jar module pom.xml.
|
||||
|
||||
Any old "shareModule" dependencies, which are typically AMPs or JARs that need to be installed in the Share tier need to be copied into this pom.xml's depdencies.
|
||||
|
||||
Remove the spring-surf-api dependency from the 4.1 share-jar module. Remove:
|
||||
Remove the spring-surf-api dependency from the 4.2 share-jar module. Remove:
|
||||
|
||||
```
|
||||
<dependency>
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
Title: Getting started with Alfresco SDK 4.1
|
||||
Title: Getting started with Alfresco SDK 4.2
|
||||
Added: v2.1.1
|
||||
Last reviewed: 2019-10-18
|
||||
---
|
||||
# Getting started with Alfresco SDK 4.1
|
||||
# Getting started with Alfresco SDK 4.2
|
||||
|
||||
Use these instructions to get started with using Alfresco SDK 4.1.
|
||||
Use these instructions to get started with using Alfresco SDK 4.2.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
There are a number of software requirements for using Alfresco SDK 4.1.
|
||||
There are a number of software requirements for using Alfresco SDK 4.2.
|
||||
* Java Development Kit (JDK) - Version 11
|
||||
* Maven - Version 3.3
|
||||
* Docker - Latest stable version
|
||||
@@ -46,7 +46,7 @@ JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-11.0.1.jdk/Contents/Home
|
||||
Alfresco recommends that you keep up-to-date with all the Maven releases. Linux distributions and package managers tend to bundle older releases and this is
|
||||
the most common pitfall.
|
||||
|
||||
Alfresco SDK 4.1 requires Maven 3.3.0+, but you are recommended to download the latest version.
|
||||
Alfresco SDK 4.2 requires Maven 3.3.0+, but you are recommended to download the latest version.
|
||||
|
||||
1. Download and install [Apache Maven](https://maven.apache.org/download.cgi) and make sure it is configured correctly on your path.
|
||||
|
||||
@@ -95,7 +95,7 @@ mvn archetype:generate -Dfilter=org.alfresco:
|
||||
```
|
||||
|
||||
You'll be prompted to select the archetype you want. The previously available archetypes, alfresco-amp-archetype and share-amp-archetype will still show up
|
||||
as an option, however these archetypes are not part of Alfresco SDK 4.1.
|
||||
as an option, however these archetypes are not part of Alfresco SDK 4.2.
|
||||
|
||||
Attention: You'll need double quotes around the filter part if you are using Windows Powershell: mvn archetype:generate "-Dfilter=org.alfresco:".
|
||||
|
||||
@@ -132,9 +132,11 @@ Choose org.alfresco.maven.archetype:alfresco-allinone-archetype version:
|
||||
8: 2.2.0
|
||||
9: 3.0.0
|
||||
10: 3.0.1
|
||||
11: 4.0.0
|
||||
12: 4.1.0
|
||||
13: 4.2.0
|
||||
11: 3.1.0
|
||||
12: 4.0.0-beta-1
|
||||
13: 4.0.0
|
||||
14: 4.1.0
|
||||
15: 4.2.0
|
||||
```
|
||||
|
||||
4. Next you will be prompted for additional values, like groupId, artifactId, and package, as shown below:
|
||||
@@ -190,7 +192,7 @@ If everything has been configured correctly, you should see something similar to
|
||||
[INFO] ------------------------------------------------------------------------
|
||||
```
|
||||
|
||||
7. You have successfully generated your first SDK 4.1 project.
|
||||
7. You have successfully generated your first SDK 4.2 project.
|
||||
|
||||
Inside the project, you will find the `run.bat` and `run.sh` scripts. These are convenience scripts for you to quickly compile / test / run your project.
|
||||
|
||||
|
||||
@@ -5,17 +5,17 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# Alfresco SDK Maven archetypes
|
||||
|
||||
The Alfresco SDK 4.1 comes with a number of Maven archetypes that can be used to generate Alfresco extension projects.
|
||||
The Alfresco SDK 4.2 comes with a number of Maven archetypes that can be used to generate Alfresco extension projects.
|
||||
|
||||
For more details, see [Getting started with Alfresco SDK 4.1](getting-started.md).
|
||||
For more details, see [Getting started with Alfresco SDK 4.2](getting-started.md).
|
||||
|
||||
These archetypes are available during the creation of a brand new project. In short, a [Maven archetype](https://maven.apache.org/guides/introduction/introduction-to-archetypes.html)
|
||||
is a project templating toolkit. It's defined as an original pattern or model from which all other things of the same kind are made. Using archetypes
|
||||
provides a great way to enable developers to quickly follow best practice in a consistent way. This is valid for every project built with Apache Maven and
|
||||
it's valid in particular when using Alfresco SDK 4.1.
|
||||
it's valid in particular when using Alfresco SDK 4.2.
|
||||
|
||||
In this section we are going to introduce all the available archetypes in Alfresco SDK 4.1, with a brief description of their purpose and main use.
|
||||
After reading this information, you should be able to understand the various possibilities that Alfresco SDK 4.1 can offer to developers, in terms of
|
||||
In this section we are going to introduce all the available archetypes in Alfresco SDK 4.2, with a brief description of their purpose and main use.
|
||||
After reading this information, you should be able to understand the various possibilities that Alfresco SDK 4.2 can offer to developers, in terms of
|
||||
projects.
|
||||
|
||||
When generating your project, you'll be prompted to select the Maven archetype you want to use through an interactive menu, similar to what you can see below.
|
||||
@@ -55,7 +55,7 @@ Please note that the numbering is not sequential and some numbers may be skipped
|
||||
### org.alfresco.maven.archetype:alfresco-allinone-archetype
|
||||
|
||||
This archetype allows a developer to implement the All-In-One project on Alfresco Content Services. The All-In-One project (also called AIO) is provided in
|
||||
this and previous versions of Alfresco SDK, but in SDK 4.1 it has been reshaped to leverage on Docker.
|
||||
this and previous versions of Alfresco SDK, but in SDK 4.2 it has been reshaped to leverage on Docker.
|
||||
|
||||
The All-In-One archetype allows a developer to create a multi-module project on Alfresco Content Services. The All-In-One project mainly includes a module for
|
||||
the core repository in ACS and a module for the Share client. This includes:
|
||||
|
||||
@@ -9,7 +9,7 @@ The Maven Alfresco SDK is designed to work well with Eclipse. This support inclu
|
||||
Alfresco SDK.
|
||||
|
||||
Here we assume you already have an Eclipse installation up and running, together with an available Alfresco project created using the Alfresco SDK. If you
|
||||
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.1](../getting-started.md) to learn how to quickly generate it in a few
|
||||
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.2](../getting-started.md) to learn how to quickly generate it in a few
|
||||
easy steps.
|
||||
|
||||
## Importing the Alfresco project into Eclipse
|
||||
|
||||
@@ -9,7 +9,7 @@ The Maven Alfresco SDK is designed to work well with Eclipse. This support inclu
|
||||
Alfresco SDK.
|
||||
|
||||
Here we assume you already have an Eclipse installation up and running, together with an available Alfresco project created using the Alfresco SDK. If you
|
||||
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.1](../getting-started.md) to learn how to quickly generate it in a few
|
||||
don't have a project already, follow the steps in [Getting started with Alfresco SDK 4.2](../getting-started.md) to learn how to quickly generate it in a few
|
||||
easy steps.
|
||||
|
||||
## Importing the Alfresco project into Intellij IDEA
|
||||
|
||||
@@ -5,7 +5,7 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# Troubleshooting
|
||||
|
||||
This article describes a list of common issues with the projects generated from the Alfresco SDK 4.1 archetypes and the way to troubleshoot them.
|
||||
This article describes a list of common issues with the projects generated from the Alfresco SDK 4.2 archetypes and the way to troubleshoot them.
|
||||
|
||||
* [Incorrect JDK version](#incorrect-jdk-version)
|
||||
* [Containers synchronization](#containers-synchronization)
|
||||
|
||||
@@ -5,10 +5,10 @@ Last reviewed: 2019-10-18
|
||||
---
|
||||
# Working with generated projects
|
||||
|
||||
After generating a project using one of the Alfresco SDK 4.1 Maven archetypes, it is important to know how to build / run / test these projects.
|
||||
After generating a project using one of the Alfresco SDK 4.2 Maven archetypes, it is important to know how to build / run / test these projects.
|
||||
|
||||
The Alfresco Platform 6 deployment architecture is highly based on container technologies, specifically in [Docker](http://docs.alfresco.com/6.0/concepts/master-deploy.html).
|
||||
Due to that, the projects generated using the Alfresco SDK 4.1 archetypes set up their local environment making an intensive use of Docker and Docker compose
|
||||
Due to that, the projects generated using the Alfresco SDK 4.2 archetypes set up their local environment making an intensive use of Docker and Docker compose
|
||||
technologies.
|
||||
|
||||
If you're not familiar with these technologies, it is highly recommended visiting the [Docker documentation website](https://docs.docker.com). This site offers
|
||||
@@ -21,7 +21,7 @@ a great quantity of training resources about [Docker](https://docs.docker.com/ge
|
||||
## Project structures
|
||||
|
||||
After generating your project, using one of the Maven archetypes, review the project structure. The directory structure and content of each folder and file
|
||||
can help you to understand how to start developing with the Alfresco SDK 4.1. Before continuing, make sure that you have read and completed the tasks in the
|
||||
can help you to understand how to start developing with the Alfresco SDK 4.2. Before continuing, make sure that you have read and completed the tasks in the
|
||||
[Getting started](../getting-started.md) tutorial.
|
||||
|
||||
The structure of the project and the purpose of the files it contains vary according to the [Maven archetype](../mvn-archetypes.md) used to generate the project
|
||||
@@ -33,7 +33,7 @@ itself. The following links provide detailed descriptions of the different proje
|
||||
|
||||
## Run script
|
||||
|
||||
All the projects generated using the Alfresco SDK 4.1 archetypes provide a utility script to work with the project. This script is `run.sh` for Unix systems
|
||||
All the projects generated using the Alfresco SDK 4.2 archetypes provide a utility script to work with the project. This script is `run.sh` for Unix systems
|
||||
and `run.bat` for Windows systems.
|
||||
|
||||
The execution of this script must be followed by a parameter that dictates the task to be executed in the project. The list of available tasks is:
|
||||
|
||||
@@ -78,7 +78,7 @@ my-all-in-one-project mbergljung$ ./run.sh build_start
|
||||
[INFO] ------------------------------------------------------------------------
|
||||
[INFO] Reactor Build Order:
|
||||
[INFO]
|
||||
[INFO] AIO - SDK 4.1
|
||||
[INFO] AIO - SDK 4.2
|
||||
[INFO] Alfresco Platform/Repository JAR Module
|
||||
[INFO] Alfresco Share JAR Module
|
||||
[INFO] Integration Tests Module
|
||||
@@ -88,7 +88,7 @@ my-all-in-one-project mbergljung$ ./run.sh build_start
|
||||
[INFO] ------------------------------------------------------------------------
|
||||
[INFO] Reactor Summary:
|
||||
[INFO]
|
||||
[INFO] AIO - SDK 4.1 ...................................... SUCCESS [ 0.680 s]
|
||||
[INFO] AIO - SDK 4.2 ...................................... SUCCESS [ 0.680 s]
|
||||
[INFO] Alfresco Platform/Repository JAR Module ............ SUCCESS [ 5.461 s]
|
||||
[INFO] Alfresco Share JAR Module .......................... SUCCESS [ 0.557 s]
|
||||
[INFO] Integration Tests Module ........................... SUCCESS [ 0.900 s]
|
||||
|
||||
Reference in New Issue
Block a user