de.thetaphi.forbiddenapis

Class Checker

java.lang.Object

de.thetaphi.forbiddenapis.Checker

public abstract class Checker
extends Object

Task to check if a set of class files contains calls to forbidden APIs from a given classpath and list of API signatures (either inline or as pointer to files). In contrast to other ANT tasks, this tool does only visit the given classpath and the system classloader. It uses the local classpath in preference to the system classpath (which violates the spec).

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isSupportedJDK

Constructor Summary

Constructors

Constructor and Description
Checker(ClassLoader loader, boolean internalRuntimeForbidden, boolean failOnMissingClasses, boolean defaultFailOnUnresolvableSignatures)

Method Summary

Modifier and Type	Method and Description
void	addClassToCheck(InputStream in) Parses and adds a class from the given stream to the list of classes to check.
boolean	hasNoSignatures()
protected abstract void	logError(String msg)
protected abstract void	logInfo(String msg)
protected abstract void	logWarn(String msg)
void	parseBundledSignatures(String name, String jdkTargetVersion) Reads a list of bundled API signatures from classpath.
void	parseSignaturesFile(InputStream in) Reads a list of API signatures.
void	parseSignaturesString(String signatures) Reads a list of API signatures from a String.
void	run()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isSupportedJDK

public final boolean isSupportedJDK

Constructor Detail

Checker

public Checker(ClassLoader loader,
               boolean internalRuntimeForbidden,
               boolean failOnMissingClasses,
               boolean defaultFailOnUnresolvableSignatures)

Method Detail

logError

protected abstract void logError(String msg)

logWarn

protected abstract void logWarn(String msg)

logInfo

protected abstract void logInfo(String msg)

parseBundledSignatures

public final void parseBundledSignatures(String name,
                                         String jdkTargetVersion)
                                  throws IOException,
                                         ParseException

Reads a list of bundled API signatures from classpath.

Throws:

IOException

ParseException

parseSignaturesFile

public final void parseSignaturesFile(InputStream in)
                               throws IOException,
                                      ParseException

Reads a list of API signatures. Closes the Reader when done (on Exception, too)!

Throws:

IOException

ParseException

parseSignaturesString

public final void parseSignaturesString(String signatures)
                                 throws IOException,
                                        ParseException

Reads a list of API signatures from a String.

Throws:

IOException

ParseException

addClassToCheck

public final void addClassToCheck(InputStream in)
                           throws IOException

Parses and adds a class from the given stream to the list of classes to check. Closes the stream when parsed (on Exception, too)!

Throws:

IOException

hasNoSignatures

public final boolean hasNoSignatures()

run

public final void run()
               throws ForbiddenApiException

Throws:

ForbiddenApiException