API Usage Scanner

A Java utility that scans Java bytecode to detect references to targeted APIs.

Date Posted: November 29, 2005

Overview Requirements Download FAQs Forum Reviews 1. On which platforms does AUS run? 2. How do I run AUS? 3. Does AUS come with documentation? 4. How do I define the rule file? 5. How do I get technical support for AUS? 5. I ran the scan and got the reports. What do I do with them? 1. On which platforms does AUS run? As a pure Java 2 implementation, AUS should be able to run on any platform that supports Java. Back to top 2. How do I run AUS? AUS can be invoked from the command line in three ways (paths are shown from the AUS installation directory): MS Windows batch file: bin/aus.bat Bash script file: bin/aus.sh Executing the lib/aus.jar file directly using the java -jar command All three invocation mechanisms take the same options in the same format. Back to top 3. Does AUS come with documentation? An InfoCenter is included in the AUS package. Extract the content of the AUS zip file into a local directory; then open the index.html file in the docs subdirectory. Back to top 4. How do I define the rule file? Refer to "Rule Construction Guide" in the API Usage Scanner InfoCenter for details and examples. Back to top 5. How do I get technical support for AUS? If you have a question regarding AUS usage or want to report a problem, please use the discussion forum, where you can obtain community support. Back to top 5. I ran the scan and got the reports. What do I do with them? Review the report using the "Usages by Target Class" section to identify whether the reported usages are expected (if not, modify the rule file by using the excludeTarget rule element to filter out the acceptable usages from being reported). Similarly, review the "Usage by Input Location" section to make sure that the components being scanned for usages are expected (if not, modify the rule file by using the excludeLocation rule element to filter out these components so they won't be included in the scan). Re-scan with the modified rule file and repeat the process. Back to top