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 capabiliby.
- Simple bootstrap of AEM projects via a specific Project Creation Wizard.
- Easy JCR properties edition.
Before using the AEM Developper Tools, you need to:
- Download and install Eclipse IDE for Java EE Developers. We currently support Eclipse Kepler or newer
- We support AEM version 5.6.1 or newer
- Configure your eclipse installation to ensure that you have at least 1 Giga bytes of Heap memory by editing your eclipse.ini configuration file as described in the Eclipse FAQ.
On Mac OS X, you need to right click on Eclipse.app and then select Show Package Contents in order to find your eclipse.ini.
Once you have fulfilled the requirements above, you can install the plugin as follows:
The AEM Development Tools for Eclipse ships with a Perspective that offers you full control over your AEM projects and instances.
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:
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.
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>
The official Apache Sling IDE tooling for Eclipse website provides you with useful information: