DocumentationAEM 6.4Developing Guide

AEM Developer Tools for Eclipse aem-developer-tools-for-eclipse

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Overview overview

The AEM Developer Tools for Eclipse is a Eclipse plugin based on the Eclipse plugin for Apache Sling released under the Apache License 2.

It offers several features that make AEM development easier:

  • Seamless integration with AEM instances through Eclipse Server Connector.
  • Synchronization for both content and OSGI bundles.
  • Debugging support with code hot-swaping capability.
  • Simple bootstrap of AEM projects via a specific Project Creation Wizard.
  • Easy editing of JCR properties.

Requirements requirements

Before using the AEM Developer Tools, you need to:

  • Download and install Eclipse IDE for Java EE Developers. AEM Developer Tools currently support Eclipse Kepler or newer

  • Can be used with AEM version 5.6.1 or newer

  • Configure your eclipse installation to ensure that you have at least 1 gigabyte of heap memory by editing your eclipse.ini configuration file as described in the Eclipse FAQ.

NOTE
On macOS, you need to right-click on Eclipse.app and then select Show Package Contents in order to find your eclipse.ini.

How to install the AEM Developer Tools for Eclipse how-to-install-the-aem-developer-tools-for-eclipse

Once you have fulfilled the requirements above, you can install the plugin as follows:

  1. Browse the AEM Developer Tools Web Site.

  2. Copy the Installation Link.

    Note that alternatively you can download an archive instead of using the installation link. This allows offline installation but you will miss automatic update notifications this way.

  3. In Eclipse, open the Help menu.

  4. Click Install New Software.

  5. Click Add….

  6. In Name type AEM Developer Tools.

  7. In Location copy the installation URL.

  8. Click Ok.

  9. Check both AEM and Sling plugins.

  10. Click Next.

  11. Click Next.

  12. Accept the lincese agreements and click Finish.

  13. Click Yes in order to restart Eclipse.

How To Import Existing Projects how-to-import-existing-projects

NOTE
See How to work with a bundle in Eclipse when it was downloaded from AEM.

The AEM Perspective the-aem-perspective

The AEM Development Tools for Eclipse ships with a Perspective that offers you full control over your AEM projects and instances.

chlimage_1-2

Sample Multi-Module Project sample-multi-module-project

The AEM Developer Tools for Eclipse comes with a sample, multi-module project that helps you quickly get up to speed with a project setup in Eclipse, as well as serving as a best-practice guide to several AEM features. Learn more about the Project Archetype.

Follow these steps to create the sample project:

  1. In the File > New > Project menu, browse to the AEM section and select AEM Sample Multi-Module Project.

    chlimage_1-69

  2. Click Next.

    note note
    NOTE
    This step might take a while since m2eclipse needs to scan the archetype catalogs.

    chlimage_1-70

  3. Choose com.adobe.granite.archetypes : sample-project-archetype : (highest number) from the menu, then click Next.

    chlimage_1-71

  4. Fill in a Name, Group id and an Artifact id for the sample project. You can also opt to set some advanced properties.

    chlimage_1-72

  5. You should then configure an AEM server to which Eclipse will connect.

    In order to use the debugger featue, you need to have started AEM in debug mode - which can be achieved eg by adding the following to the command line:

    code language-none 
        -nofork -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10123

    chlimage_1-73

  6. Click Finish. The project structure is created.

    note note
    NOTE
    On a fresh installation (more specifically: when maven dependencies have never been downloaded) you might get the project created with errors. In this case please follow the procedure describe in Resolving Invalid Project Definition.

Troubleshooting troubleshooting

Resolving Invalid Project Definition resolving-invalid-project-definition

To resolve invalid dependencies and project definition proceed as follows:

  1. Select all created projects.
  2. Right-click. In menu Maven select Update Projects.
  3. Check Force Updates of Snapshot/Releases.
  4. Click OK. Eclipse tries to download the required dependencies.

Enabling tag library autocompletion in JSP files enabling-tag-library-autocompletion-in-jsp-files

Tag library autocompletion works out of the box, given that the proper dependencies are added to the project. There is one known issue when using the AEM Uber Jar, which does not include the needed tld and TagExtraInfo files.

To work around it, ensure that the org.apache.sling.scripting.jsp.taglib artifact is located in the classpath before the AEM Uber Jar. For Maven projects, place the following dependency in the pom.xml before the Uber Jar.

<dependency>
  <groupId>org.apache.sling</groupId>
  <artifactId>org.apache.sling.scripting.jsp.taglib</artifactId>
  <scope>provided</scope>
</dependency>

Make sure to add the proper version for your deployment of AEM.

More information more-information

The official Apache Sling IDE tooling for Eclipse website provides you with useful information:

The following official Eclipse documentation can help to set up your environment:

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e