Documenting the use of EJB3 annotations in a code base

Question

We have a large code base, and I want to generate specific reports about the use of EJB3 annotations in the code base. The simplest use case is to create an HTML / PDF report with detailed information about all classes / methods that use EJB3 security annotations. The purpose of this document is to enable non-developers to simply reconsider which interfaces in the product have some roles, so gaps can be connected. I would see similar reports for using persistent and session annotations. And an uber report of all annotations.

@RolesAllowed({"Administrator", "UserAlarmsRO", "NetworkAlarmsRO", "DeviceAlarmsRO","ServiceAlarmsRO","UserAlarmsRW", "NetworkAlarmsRW", 
"DeviceAlarmsRW", "ServiceAlarmsRW","UserGraphsRO","NetworkGraphsRO","DeviceGraphsRO","ServiceGraphsRO","SLMRO","SLMRW","SLMTemplatesRW"})
public class VisualisationMgrBean 

Is it better to use the existing javadoc tool or is there a set of third-party doclets that I could reuse.

Answer 1

Google for “Annotation Processing” will find a lot of material on how to analyze annotations in Java code. For example, this link is Annotations . You should not try to find any code that you can modify to generate the reports you want (I made html and Excel myself, and it is very simple).