Tuesday, 18 April 2017

Deploy AEM bundles and packages using Maven

Setup Maven

You can use Maven to build an OSGi bundle that uses the QueryBuilder API and is deployed to Experiene Manager. Maven manages required JAR files that a Java project needs in its class path. Instead of searching the Internet trying to find and download third-party JAR files to include in your project’s class path, Maven manages these dependencies for you.
You can download Maven 3 from the following URL:
After you download and extract Maven, create an environment variable named M3_HOME. Assign the Maven install location to this environment variable. For example:
C:\Programs\Apache\apache-maven-3.0.4
Set up a system environment variable to reference Maven. To test whether you properly setup Maven, enter the following Maven command into a command prompt:
%M3_HOME%\bin\mvn -version
This command provides Maven and Java install details and resembles the following message:
OS name: "windows 7", version: "6.1", arch: "amd64", family: "windows"

Note:
For more information about setting up Maven and the Home variable, see: Maven in 5 Minutes.
Next, copy the Maven configuration file named settings.xml from [install location]\apache-maven-3.0.4\conf\ to your user profile. For example, C:\Users\scottm\.m2\.
You have to configure your settings.xml file to use Adobe’s public repository. For information, see Adobe Public Maven Repository at http://repo.adobe.com/.
The following XML code represents a settings.xml file that you can use.
<?xml version="1.0" encoding="UTF-8"?>
 
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
 
    http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->
 
<!--
 | This is the configuration file for Maven. It can be specified at two levels:
 |
 |  1. User Level. This settings.xml file provides configuration for a single user, 
 |                 and is normally provided in ${user.home}/.m2/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -s /path/to/user/settings.xml
 |
 |  2. Global Level. This settings.xml file provides configuration for all Maven
 |                 users on a machine (assuming they're all using the same Maven
 |                 installation). It's normally provided in 
 |                 ${maven.home}/conf/settings.xml.
 |
 |                 NOTE: This location can be overridden with the CLI option:
 |
 |                 -gs /path/to/global/settings.xml
 |
 | The sections in this sample file are intended to give you a running start at
 | getting the most out of your Maven installation. Where appropriate, the default
 | values (values used when the setting is not specified) are provided.
 |
 |-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
  <!-- localRepository
   | The path to the local repository maven will use to store artifacts.
   |
   | Default: ~/.m2/repository
  <localRepository>/path/to/local/repo</localRepository>
  -->
 
  <!-- interactiveMode
   | This will determine whether maven prompts you when it needs input. If set to false,
   | maven will use a sensible default value, perhaps based on some other setting, for
   | the parameter in question.
   |
   | Default: true
  <interactiveMode>true</interactiveMode>
  -->
 
  <!-- offline
   | Determines whether maven should attempt to connect to the network when executing a build.
   | This will have an effect on artifact downloads, artifact deployment, and others.
   |
   | Default: false
  <offline>false</offline>
  -->
 
  <!-- pluginGroups
   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
   |-->
  <pluginGroups>
    <!-- pluginGroup
     | Specifies a further group identifier to use for plugin lookup.
    <pluginGroup>com.your.plugins</pluginGroup>
    -->
  </pluginGroups>
 
  <!-- proxies
   | This is a list of proxies which can be used on this machine to connect to the network.
   | Unless otherwise specified (by system property or command-line switch), the first proxy
   | specification in this list marked as active will be used.
   |-->
  <proxies>
    <!-- proxy
     | Specification for one proxy, to be used in connecting to the network.
     |
    <proxy>
      <id>optional</id>
      <active>true</active>
      <protocol>http</protocol>
      <username>proxyuser</username>
      <password>proxypass</password>
      <host>proxy.host.net</host>
      <port>80</port>
      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
    </proxy>
    -->
  </proxies>
 
  <!-- servers
   | This is a list of authentication profiles, keyed by the server-id used within the system.
   | Authentication profiles can be used whenever maven must make a connection to a remote server.
   |-->
  <servers>
    <!-- server
     | Specifies the authentication information to use when connecting to a particular server, identified by
     | a unique name within the system (referred to by the 'id' attribute below).
     | 
     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are 
     |       used together.
     |
    <server>
      <id>deploymentRepo</id>
      <username>repouser</username>
      <password>repopwd</password>
    </server>
    -->
     
    <!-- Another sample, using keys to authenticate.
    <server>
      <id>siteServer</id>
      <privateKey>/path/to/private/key</privateKey>
      <passphrase>optional; leave empty if not used.</passphrase>
    </server>
    -->
  </servers>
 
  <!-- mirrors
   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
   | 
   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
   | However, this repository may have problems with heavy traffic at times, so people have mirrored
   | it to several places.
   |
   | That repository definition will have a unique id, so we can create a mirror reference for that
   | repository, to be used as an alternate download site. The mirror site will be the preferred 
   | server for that repository.
   |-->
  <mirrors>
    <!-- mirror
     | Specifies a repository mirror site to use instead of a given repository. The repository that
     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
     |
    <mirror>
      <id>mirrorId</id>
      <mirrorOf>repositoryId</mirrorOf>
      <name>Human Readable Name for this Mirror.</name>
      <url>http://my.repository.com/repo/path</url>
    </mirror>
     -->
  </mirrors>
   
  <!-- profiles
   | This is a list of profiles which can be activated in a variety of ways, and which can modify
   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
   | specific paths and repository locations which allow the build to work in the local environment.
   |
   | For example, if you have an integration testing plugin - like cactus - that needs to know where
   | your Tomcat instance is installed, you can provide a variable here such that the variable is 
   | dereferenced during the build process to configure the cactus plugin.
   |
   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
   | section of this document (settings.xml) - will be discussed later. Another way essentially
   | relies on the detection of a system property, either matching a particular value for the property,
   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a 
   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
   | Finally, the list of active profiles can be specified directly from the command line.
   |
   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
   |       repositories, plugin repositories, and free-form properties to be used as configuration
   |       variables for plugins in the POM.
   |
   |-->
  <profiles>
    <!-- profile
     | Specifies a set of introductions to the build process, to be activated using one or more of the
     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
     | or the command line, profiles have to have an ID that is unique.
     |
     | An encouraged best practice for profile identification is to use a consistent naming convention
     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
     | This will make it more intuitive to understand what the set of introduced profiles is attempting
     | to accomplish, particularly when you only have a list of profile id's for debug.
     |
     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
    <profile>
      <id>jdk-1.4</id>
 
      <activation>
        <jdk>1.4</jdk>
      </activation>
 
      <repositories>
        <repository>
          <id>jdk14</id>
          <name>Repository for JDK 1.4 builds</name>
          <url>http://www.myhost.com/maven/jdk14</url>
          <layout>default</layout>
          <snapshotPolicy>always</snapshotPolicy>
        </repository>
      </repositories>
    </profile>
    -->
 
    <!--
     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
     | might hypothetically look like:
     |
     | ...
     | <plugin>
     |   <groupId>org.myco.myplugins</groupId>
     |   <artifactId>myplugin</artifactId>
     |   
     |   <configuration>
     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
     |   </configuration>
     | </plugin>
     | ...
     |
     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
     |       anything, you could just leave off the <value/> inside the activation-property.
     |
    <profile>
      <id>env-dev</id>
 
      <activation>
        <property>
          <name>target-env</name>
          <value>dev</value>
        </property>
      </activation>
 
      <properties>
        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
      </properties>
    </profile>
    -->
   
 
<profile>
 
                <id>adobe-public</id>
 
                <activation>
 
                    <activeByDefault>true</activeByDefault>
 
                </activation>
 
                <repositories>
 
                  <repository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </repository>
 
                </repositories>
 
                <pluginRepositories>
 
                  <pluginRepository>
 
                    <id>adobe</id>
 
                    <name>Nexus Proxy Repository</name>
 
                    <url>http://repo.adobe.com/nexus/content/groups/public/</url>
 
                    <layout>default</layout>
 
                  </pluginRepository>
 
                </pluginRepositories>
 
            </profile>
 
</profiles>
 
  <!-- activeProfiles
   | List of profiles that are active for all builds.
   |
  <activeProfiles>
    <activeProfile>alwaysActiveProfile</activeProfile>
    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
  </activeProfiles>
  -->
</settings>

Create an Experience Manage archetype project 
To create an AEM bundle archetype project, perform these steps:
1. Open the command prompt and go to your working directory (for example, C:\AdobeCQ).
2. Run the following Maven command:
mvn archetype:generate 
-DarchetypeRepository=https://repo.adobe.com/nexus/content/groups/public/ 
-DarchetypeGroupId=com.day.jcr.vault -DarchetypeArtifactId=multimodule-content-package-archetype 
-DarchetypeVersion=1.0.2 -DgroupId=com.aem.kishore -DartifactId=aem-sample -Dversion=1.0-SNAPSHOT 
-Dpackage=com.aem.kishore -DappsFolderName=aem-sample -DartifactName="aem-sample" -DcqVersion="6.1" -DpackageGroup="aem-sample"
3. When prompted for additional information, specify Y.
4. Once done, you will see a message like:
[INFO] Finished at: Wed Mar 27 13:38:58 EDT 2013
[INFO] Final Memory: 10M/184M
5. Change the command prompt to the generated project. For example: C:\AdobeCQ\htl. Run the following Maven command:
mvn eclipse:eclipse


Goto parent pom.xml and add the modules, make sure aem-sample-all module is at bottom)

<modules>
        <module>aem-bundle-core</module>
        <module>aem-content-ui</module>
        <module>aem-sample-all</module>
    </modules>

Add the vault plugin in the parent pom.xml
 <plugin>
  <groupId>com.day.jcr.vault</groupId>
  <artifactId>maven-vault-plugin</artifactId>
  <version>0.0.10</version>
  <configuration>
    <verbose>true</verbose>
  </configuration>
 </plugin>

In each bundle module's(e.g. aem-sample/aem-bundle-core) pom.xml add the following configuration
<properties>
  <skip.install>false</skip.install>
</properties>

<profiles>
 <profile>
  <id>buildOnly</id>
  <properties>
   <skip.install>true</skip.install>
  </properties>
 </profile>
</profiles>

Modify the maven-sling-plugin in individual bundle modules pom.xml as shown below
<plugin>
 <groupId>org.apache.sling</groupId>
 <artifactId>maven-sling-plugin</artifactId>
 <executions>
  <execution>
   <id>install-bundle</id>
   <goals>
         <goal>install</goal>
   </goals>
  <configuration>
   <slingUrl>${cq.protocol}://${cq.host}:${cq.port}/system/console/bundles
   </slingUrl>
   <user>${cq.user}</user>
   <password>${cq.password}</password>
   <refreshPackages>true</refreshPackages>
   <failOnError>true</failOnError>
   <skip>${skip.install}</skip>
   </configuration>
    </execution>
   </executions>
 </plugin>

In each content modules (e.g. aem-sample/aem-content-ui) pom.xml add the following configuration
<properties>
 <skip.goal>install</skip.goal>
</properties>
 
Add as part of the profiles
<profile>
 <id>buildOnly</id>
 <properties>
  <skip.goal>build</skip.goal>
 </properties>
</profile>

Remove the profiles autoInstallPackage and autoInstallPackagePublish from content modules(e.g aem-sample/aem-content-ui/pom.xml - the deployment to the publisher is taken care from aem-sample-all/pom.xml).
Configure the content-package-maven-plugin as shown below
<plugin>
 <groupId>com.day.jcr.vault</groupId>
 <artifactId>content-package-maven-plugin</artifactId>
 <configuration>
  <name>cq-sample-content</name>
  <useProxy>false</useProxy>
  <failOnError>true</failOnError>
  <packageFile>${project.build.directory}/${project.build.finalName}.zip</packageFile>
  <targetURL>${cq.protocol}://${cq.host}:${cq.port}/crx/packmgr/service.jsp</targetURL>
  <userId>${cq.user}</userId>
  <password>${cq.password}</password>
 </configuration>
 <executions>
  <execution>
   <goals>
    <goal>${skip.goal}</goal>
   </goals>
  </execution>
 </executions>
</plugin>  

Add the below server configuration with admin username and password to Maven settings.xml(repeat the same for all the configured servers in aem-sample-all/pom.xml)
<server>
 <id>aem-dev-author</id>
 <username>admin</username>
 <password>admin</password>
</server>

Create cq-sample-all/pom.xml and configure the environment specific properties, module dependencies and different profiles - refer the sample below
Configure environment specific properties, module dependencies and different profiles in aem-sample-all/pom.xml.
<?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:schemaLotrion="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

 <modelVersion>4.0.0</modelVersion>
 <parent>
             <groupId>my-group-id</groupId> <!-- Change the groupid and artifactId of the paraent -->
             <artifactId>cq-sample</artifactId>
             <version>1.0-SNAPSHOT</version>
        </parent>

 <artifactId>cq-sample-all</artifactId> <!-- Change the artifcatId -->
 <packaging>content-package</packaging>
 <name>${project.groupId} - ${project.artifactId}</name>

 <properties>  
  <cq.dev.author.server>aem-dev-author</cq.dev.author.server>
  <cq.dev.author.host>localhost</cq.dev.author.host>
  <cq.dev.author.port>4502</cq.dev.author.port>
  <cq.dev.author.protocol>http</cq.dev.author.protocol>
  
  <cq.dev.publisher1.server>aem-dev-publisher</cq.dev.publisher1.server>
  <cq.dev.publisher1.host>localhost</cq.dev.publisher1.host>
  <cq.dev.publisher1.port>4503</cq.dev.publisher1.port>
  <cq.dev.publisher1.protocol>http</cq.dev.publisher1.protocol>
  
  <!-- Add the other server details-->
  
 </properties>
 
<!-- Add all the  bundle/content modules as part of dependency. Change the artifactId of the modules-->

 <dependencies>
  <dependency>
   <groupId>${project.groupId}</groupId>
   <artifactId>cq-sample-content</artifactId>
   <version>${project.version}</version>
   <type>content-package</type>
  </dependency>
  <dependency>
   <groupId>${project.groupId}</groupId>
   <artifactId>cq-sample-bundle</artifactId>
   <version>${project.version}</version>
  </dependency>
 </dependencies>

 <build>
  <plugins>
   <plugin>
    <groupId>com.day.jcr.vault</groupId>
    <artifactId>maven-vault-plugin</artifactId>
    <extensions>true</extensions>
    <executions>
     <execution>
      <goals>
       <goal>package</goal>
      </goals>
      <configuration>
       <embeddedTarget>/apps/cq-sample/install</embeddedTarget> <!-- change the folder name(cq-sample) accordingly -->
       <embeddeds>
        <embedded>
         <groupId>${project.groupId}</groupId>
         <artifactId>cq-sample-bundle</artifactId>
         <filter>true</filter>
        </embedded>
        <!-- Add additional bundle modules here as embedded -->
       </embeddeds>
       <subPackages>
        <subPackage>
         <groupId>${project.groupId}</groupId>
         <artifactId>cq-sample-content</artifactId>
         <filter>true</filter>
        </subPackage>
        
        <!-- Add additional content modules here as subPackage -->
       </subPackages>
      </configuration>
     </execution>
    </executions>
   </plugin>
  </plugins>
 </build>

 <profiles>
  <!-- Profile for Development deployments -->
  <!--Create the profile for different environments -->
  <profile>
   <id>Development</id>
   <build>
    <plugins>
     <plugin>
      <groupId>com.day.jcr.vault</groupId>
      <artifactId>content-package-maven-plugin</artifactId>
      <executions>
       <execution>
        <id>install-content-package-author</id>
        <phase>install</phase>
        <goals>
         <goal>install</goal>
        </goals>
        <configuration>
         <failOnError>true</failOnError>
         <useProxy>false</useProxy>
         <packageFile>${project.build.directory}/${project.build.finalName}.zip</packageFile>
         <targetURL>${cq.dev.author.protocol}://${cq.dev.author.host}:${cq.dev.author.port}/crx/packmgr/service.jsp</targetURL>
         <serverId>${cq.dev.author.server}</serverId>
        </configuration>
       </execution>
       <execution>
        <id>install-content-package-publisher1</id>
        <phase>install</phase>
        <goals>
         <goal>install</goal>
        </goals>
        <configuration>
         <failOnError>true</failOnError>
         <useProxy>false</useProxy>
         <packageFile>${project.build.directory}/${project.build.finalName}.zip</packageFile>
         <targetURL>${cq.dev.publisher1.protocol}://${cq.dev.publisher1.host}:${cq.dev.publisher1.port}/crx/packmgr/service.jsp</targetURL>
         <serverId>${cq.dev.publisher1.server}</serverId>
        </configuration>
       </execution>
       
       <!-- Add execution for additional publisher with different id(increment the last digit)-->
       
      </executions>
     </plugin>
    </plugins>
   </build>
  </profile>  
 </profiles>
</project>

Run the build by providing the following command (parent pom.xml)
mvn clean package install -PbuildOnly,Development 

Development is the profile name configured in aem-sample-all/pom.xml.

To deploy the individual modules to author or publisher Replace the default server properties from the parent pom.xml 

Development is the profile name configured in aem-sample-all/pom.xml.
To deploy the individual modules to author or publisher replace the default server properties from the parent pom.xml 

<crx.host>localhost</crx.host>
 <crx.port>4502</crx.port>
 <crx.username>admin</crx.username>
 <crx.password>admin</crx.password> 
<publish.crx.host>localhost</publish.crx.host> 
<publish.crx.port>4503</publish.crx.port> 
<publish.crx.username>admin</publish.crx.username> <publish.crx.password>admin</publish.crx.password> 

 with
<cq.protocol>http</cq.protocol>
<cq.host>localhost</cq.host> 
<cq.port>4502</cq.port> 
<cq.username>admin</cq.username>
<cq.password>admin</cq.password>

Change the server details in the properties in the parent pom.xml with author or publisher- aem-sample/pom.xml and run the individual module pom.xml (mvn clean install) to deploy the individual modules.

No comments :

Post a Comment