Policeman's Forbidden API Checker (3.3)

Allows to parse Java byte code to find invocations of method/class/field signatures and fail build (Apache Ant, Apache Maven, Gradle, or CLI)

Full name: de.thetaphi:forbiddenapis:3.3

Apache Ant

Task Documentation

Apache Maven: Mojo Goals

• forbiddenapis:check
  Mojo to check if no project generated class files (compile scope) contain calls to forbidden APIs from the project classpath and a list of API signatures (either inline or as pointer to files or bundled signatures). At least one signature must be given, using any of the corresponding optional parameters. This Mojo exists since version 1.2, replacing the old forbiddenapis:forbiddenapis goal. In most cases its enough to rename the goal on update, the older v1.0 properties are still available. Since version 2.0 this Mojo defaults to run in the 'verify' lifecycle phase, before it was done in 'process-classes' phase, which caused problems for some users (especially debugging tests).
• forbiddenapis:help
  Display help information on forbiddenapis. Call mvn forbiddenapis:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
• forbiddenapis:testCheck
  Mojo to check if no project generated class files (test scope) contain calls to forbidden APIs from the project classpath and a list of API signatures (either inline or as pointer to files or bundled signatures). At least one signature must be given, using any of the corresponding optional parameters. Since version 2.0 this Mojo defaults to run in the 'verify' lifecycle phase, before it was done in 'process-test-classes' phase, which caused problems for some users (especially debugging tests).

Gradle

Task Documentation (Javadocs)

Command Line Interface

The JAR file can be called as command line tool using java -jar. This is the documentation of the CLI executable as printed by itsself:

$ java -jar forbiddenapis-3.3.jar --help
usage: java -jar forbiddenapis-3.3.jar [options]
Scans a set of class files for forbidden API usage.
    --allowmissingclasses                don't fail if a referenced class
                                         is missing on classpath
    --allowunresolvablesignatures        DEPRECATED: don't fail if a
                                         signature is not resolving
 -b,--bundledsignatures <name>           name of a bundled signatures
                                         definition (separated by commas
                                         or option can be given multiple
                                         times)
 -c,--classpath <path>                   class search path of directories
                                         and zip/jar files
 -d,--dir <directory>                    directory with class files to
                                         check for forbidden api usage;
                                         this directory is also added to
                                         classpath
 -e,--excludes <pattern>                 ANT-style pattern to exclude some
                                         files from checks (separated by
                                         commas or option can be given
                                         multiple times)
 -f,--signaturesfile <file>              path to a file containing
                                         signatures (option can be given
                                         multiple times)
 -h,--help                               print this help
 -i,--includes <pattern>                 ANT-style pattern to select class
                                         files (separated by commas or
                                         option can be given multiple
                                         times, defaults to '**/*.class')
    --ignoresignaturesofmissingclasses   if a class is missing while
                                         parsing signatures files, all
                                         methods and fields from this
                                         class are silently ignored
    --suppressannotation <classname>     class name or glob pattern of
                                         annotation that suppresses error
                                         reporting in
                                         classes/methods/fields (separated
                                         by commas or option can be given
                                         multiple times)
 -V,--version                            print product version and exit
Exit codes: 0 = SUCCESS, 1 = forbidden API detected, 2 = invalid command
line, 3 = unsupported JDK version, 4 = other error (I/O,...)

Additional documentation

• Bundled Signatures
• Syntax of Custom Signatures Files