Debugging an extension—ArcObjects 10.4 Help for Java

How to enable debugging

Log into ArcGIS Server Manager.
Ensure that the extension you wish to debug into is deployed to ArcGIS Server.
Publish a map or image service and enable the extension you wish to debug.
Navigate to Site > Extensions. Click the Debug Settings button.
Click Enable debugging of extensions to enable debugging.
Check the Suspend service startup checkbox and provide a time window in milliseconds if you wish to debug into the lifecycle methods of your extension. Examples of lifecycle methods are init() and shutdown(). These methods are invoked by the parent map service during the startup and shutdown phases. When the map service starts, Server freezes initialization of the map service for the duration specified by this time window, thus allowing you to set a breaking point in init() or other lifecycle methods and connect the IDE debug session to the ArcGIS Server process hosting the extension.
Specify a port range. ArcGIS Server will select a port from this range, bind your map service and extension’s process to the next available port from this range, and listen to the incoming connection request on this port.
Click Save. Debugging is now enabled on ArcGIS Server.
Restart the map service that your extension is enabled on, for above changes to take effect.

How to debug into Java extensions using Eclipse IDE

Access the server logs in ArcGIS Server Manager.
Set the Log Filter to Verbose level.
Set the Age to Last 15 Minutes.
Set the Source to All.
Set the Machine to All Machines.
Click Update.
Pick up the port number from the log entry that mentions the name of the map service your extension is enabled on and the name of your extension. For example, you may see the port number selected by ArcGIS Server is 9000.

Switch to Eclipse.
Right click your extension class.
Select Debug As… and click Remote Java Application from list of types of applications.
Select your extension. If your extension does not show up as an item in the Remote Java Application list, create a new launch configuration within this type.
In the Port text box, type in the port number copied from ArcGIS Server Manager.
Click Debug.
Set breakpoints in your extension code, if not already set.
Consume the extension via its client application. The extension execution on ArcGIS Server will stop at the breakpoint you set in Eclipse.

How to disable debugging

Log into ArcGIS Server Manager.
Navigate to Site > Extensions. Click the Debug Settings button.
Uncheck the Enable debugging of extensions check-box to disable debugging.
Click Save. Debugging is now disabled on ArcGIS Server.
Restart the map service that your extension is enabled on, for above changes to take effect.

Tips

Before turning debugging on, open the Logs page in Manager and verify that the log level in the Settings section is set to Verbose. Setting the log level to Verbose will ensure that logs will be generated at this level.

After debugging is turned on in Manager, ArcGIS Server allocates a port number to all instances of services that are newly created or re-started. If you have numerous services running, then you must provide a wider port range in the Site > Extensions > Debug Settings dialog in Manager to accommodate all those instances, including those of your extension’s parent map or image service. Alternatively, just for duration of your debugging session, you could stop non-required services and reduce the number of instances of your extension’s parent map or image service to one. This will allow for a shorter port range, and will generate less number of logs for you to sift through to determine the port number. Please remember to restart those other services once debugging session is over.

Remember to turn debugging off in the Site > Extensions > Debug Settings dialog in Manager, after your debugging session is over.

The extension you debug into must be deployed to a server that is installed locally on the machine you are debugging the extension on.