While working on one of a complex requirements in our Adobe CQ5 / AEM project , we felt the need to continuously observe the flow. Though, logs are of good help but we wanted to analyze the complete flow . In this scenario, debugging feature in IDE becomes very handy. Software Stack being used :
- CQ Server : AEM 5.6.1
- IDE : IntelliJIdea 12.0
First We need to start our CQ instance in debug mode. We can do so by starting the AEM in debug mode by running the following command :
java -jar cq5-author-4502.jar -fork -forkargs -- -Xdebug -Xrunjdwp:transport=dt_socket,address=59865,suspend=n,server=y -Xmx1520m -XX:MaxPermSize=512m -XX:-UseSplitVerifier
We need to first open the socket from where all the JVM communication will happen. We need to specify the port number while starting the instance. Socket specifies the entry point for all the communication that happens in JVM. Every communication will happen via Socket. In above command,
address=59865 is creating the socket for us. In IDE, we need to setup a remote connection for CQ and specify the same port no as mentioned while starting CQ. Follow the below steps to setup a remote connection in IntelliJIdea.
- Go to Run panel (top of the window) and select Edit configuration.
- Select Defaults and click on “+” to add new configuration. List of all the options will appear. Select “Remote” from that list.
- Enter the details in the window as per your need. Specify the same port number which was used while starting the CQ instance in debug mode.
- Click on “OK” to save the configuration.
Below is the screenshot for the reference.
Add breakpoints in the java files which you want to debug by double clicking on the line and start newly created configuration in Debug mode.
1. While starting the AEM instance, make sure JVM has enough heap size for running CQ server, otherwise it will fork the JVM and parameters will not be passed to the forked jvm. Use -fork -forkargs – option to ensure that the command line parameters gets passed to the jvm.
2. If you are using java 7 , make sure to specify the -XX:-UseSplitVerifier parameter to avoid the unwanted strict verification errors while debugging the bundle.