Custom audit rules in Jdeveloper extension
3 likes3,042 views
This document discusses creating custom audit rules in Oracle JDeveloper 12c. It covers setting up an extension development environment, creating an extension project, adding a custom audit rule analyzer class, configuring the extension manifest, running and testing the custom rule extension. The goal of custom rules is to analyze code for adherence to programming standards and identify defects to improve code quality and maintainability.
![TEST_AUTOMATION_CASE_STUDY_(2)2[1]](https://cdn.slidesharecdn.com/ss_thumbnails/a9c158f4-db61-4cf3-afa9-b0123ffabf86-160903185545-thumbnail.jpg?width=560&fit=bounds)
Ad
More Related Content
What's hot (19)
Similar to Custom audit rules in Jdeveloper extension (20)
Ad
More from Vinay Kumar (20)
Ad
Recently uploaded (20)
Custom audit rules in Jdeveloper extension
- 1. Presented by Vinay Kumar SILBURY IT SOLUTION GMBH 10/04/2014 Custom Audit Rules in Jdeveloper 12c
- 2. โข Audit in JDeveloper โข Extension in Jdeveloper 12c โข Set up extension environment โข Creation Extension project โข Create Audit Rule โข Suppress Warning โข Run Extension โข Test Extension Agenda
- 3. โข Audit is a planned and documented activity performed by qualified personnel to determine by investigation, examination, or evaluation of objective evidence, the adequacy and compliance with established procedures, or applicable documents, and the effectiveness of implementation โข Analysis of code with set of metrics and guidelines . โข Auditing in Jdeveloper- Auditing is the static analysis of code for adherence to rules and metrics that define programming standards. Auditing finds defects that make code difficult to improve and maintain. The JDeveloper auditing tools help you find and fix such defects. Code can be audited even when it is not compilable or executable. What is Audit
- 4. โข JDeveloper has a built in Audit framework with lots of rules that you can turn on or off. โข Also can create new custom audit rules . โข Based on Visitor design pattern. โข Able to create new Audit rules. โข Rules can be configurable โข Generate warning or error compile time. โข Help in improving code quality. โข Auditing finds defects that make code difficult to improve and maintain โข JDeveloper auditing feature to analyze Java code for conformance to programming standards. Audit Framework in jdeveloper
- 5. .
- 6. .
- 7. โข Install Extension SDK (Help- Check for updates) โข Search for Extension SDK โข Add this update in your Jdeveloper Setting up Extension workspace
- 8. Create New Extension project File -> New- Applications -> Extension Application extension.xml & Manifest.MF Bundled as .zip Distributed through Jdeveloper update center Or Drive
- 9. โข ` New Extension Application
- 11. Add Dependencies
- 12. Create new custom rule
- 13. .
- 14. Extension.xml Java Analyzer class mapping with rule Audit Hook display name Rule Id mapping Severity element can be set to one from these options. -Error -Warning -Incomplete -Advisory -Assist
- 15. Properties file Label definition file
- 16. . Rule Id mapped in extension.xml โข. Class should extend analyzer
- 17. . Report violated rule to AuditContenxt
- 18. โข A visitor over the Audit object models which verifies rules and/or computes metrics. โข Analyzer subclass implements visitor methods which are invoked by the Audit framework as it traverses the Audit object models i.e. enter & exit โข Visitor methods (enter & exit) report violations and measurements using the reporting methods of a context object passed to them. โข getRules & getMetrics provide rules& metric of analyzer to framework . โข Analyzers (classes) are registered with the AuditManager at startup by IDE extensions. oracle.jdeveloper.audit.analyzer.Analyzer
- 19. โข Audit framework traverses the constructs of the object models corresponding to the nodes being audited and at each construct invokes the applicable enter and exit methods of each registered analyzer. โข enter and exit methods accept two parameters, a context and a construct. โข Visitor method called each workspace, source class, document, element, attribute, method. โข Violations and measurements, suppression are reported by the visitor methods using the report method. โข Setting attributes for child & parent construct. interface AuditContext Context, construct
- 20. โข public void enter(AuditContext context, Workspace workspace) This methods contains the workspace (application) validation code. In our case we do not use it. โข public void enter(AuditContext context, Project project) This methods contains the project validation code. In our case we do not use it. โข public void enter(AuditContext context, Document document) This method contains the code to analyze and validate documents. โข public void enter(AuditContext context, Element element) This method contains the code to analyze and validate individual element. .
- 21. Analyzers registered with Audit Manager on start up by IDE Each analyzer create instance and fetch rules using getRules method each construct invokes methods of registered analyzer Enter & exit method invoked as per match the construct Check/analyze information in visitor methods and report to context Audit framework flow
- 22. SuppressWarning Annotation โข Indicate to suppress this warning in workspace for all elements.
- 23. โข Suppressed warning in jdeveloper by annotation. SuppressWarning Annotation
- 24. โข Make Extension.jpr โข Deploy to Target Platform โข Run Extension โข New Jdevloper instance open โข Tools -> Preferences -> Audit -> Profiles and find rule โข Test rule. Run & Test Audit Rule Extension
- 25. Run & Test Audit Rule Extension
- 26. โข Create bundle.xml in project โข Create an extension package which consists of a JAR that is packaged in an extension bundle archive โข Change extension JAR files into a .zip file for distribution Packaging Extension
- 27. .
- 28. โข Analyzer Class-Oracle Documentation โข Developing Extensions for Oracle Jdeveloper โข blog on extension โข blog by Richard References
- 30. .
- 31. Happy Auditing With Jdeveloper Thanks
Editor's Notes
- #4: How presentation will benefit audience: Adult learners are more interested in a subject if they know how or why it is important to them.Presenterโs level of expertise in the subject: Briefly state your credentials in this area, or explain why participants should listen to you.
- #5: Example objectivesAt the end of this lesson, you will be able to:Save files to the team Web server.Move files to different locations on the team Web server.Share files on the team Web server.