Class AnalysisScopeReader

java.lang.Object

com.ibm.wala.core.util.config.AnalysisScopeReader

Direct Known Subclasses:

DexAnalysisScopeReader, EclipseAnalysisScopeReader, Java9AnalysisScopeReader

public class AnalysisScopeReader
extends Object

Reads AnalysisScope from a text file.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	BASIC_FILE
static AnalysisScopeReader	instance
protected final ClassLoader	MY_CLASSLOADER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnalysisScopeReader()
protected	AnalysisScopeReader(ClassLoader myLoader, String basicFile)

Method Summary

Modifier and Type	Method	Description
void	addClassPathToScope(String classPath, AnalysisScope scope, ClassLoaderReference loader)
protected boolean	handleInSubclass(AnalysisScope scope, ClassLoaderReference walaLoader, String language, String entryType, String entryPathname)
AnalysisScope	makeBasePrimordialScope(File exclusionsFile)	Creates an AnalysisScope containing only the JDK standard libraries.
AnalysisScope	makeJavaBinaryAnalysisScope(String classPath, File exclusionsFile)
AnalysisScope	makePrimordialScope(File exclusionsFile)	Creates an AnalysisScope containing only the JDK standard libraries.
void	processScopeDefLine(AnalysisScope scope, ClassLoader javaLoader, String line)
AnalysisScope	read(AnalysisScope scope, String scopeFileName, @Nullable File exclusionsFile, ClassLoader javaLoader)
protected AnalysisScope	read(AnalysisScope scope, URI scopeFileURI, File exclusionsFile, ClassLoader javaLoader)
AnalysisScope	readJavaScope(String scopeFileName, @Nullable File exclusionsFile, ClassLoader javaLoader)	read in an analysis scope for a Java application from a text file
protected static void	setScopeReader(AnalysisScopeReader reader)

Methods inherited from class Object

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

Field Details

instance

public static AnalysisScopeReader instance

MY_CLASSLOADER

protected final ClassLoader MY_CLASSLOADER

BASIC_FILE

protected final String BASIC_FILE

Constructor Details

AnalysisScopeReader

protected AnalysisScopeReader()

AnalysisScopeReader

protected AnalysisScopeReader(ClassLoader myLoader,
 String basicFile)

Method Details

setScopeReader

protected static void setScopeReader(AnalysisScopeReader reader)

readJavaScope

public AnalysisScope readJavaScope(String scopeFileName,
 @Nullable File exclusionsFile,
 ClassLoader javaLoader)
                            throws IOException

read in an analysis scope for a Java application from a text file

Parameters:

scopeFileName - the text file specifying the scope

exclusionsFile - a file specifying code to be excluded from the scope; can be null

javaLoader - the class loader used to read in files referenced in the scope file, via ClassLoader.getResource(String)

Returns:

the analysis scope

Throws:

IOException

read

public AnalysisScope read(AnalysisScope scope,
 String scopeFileName,
 @Nullable File exclusionsFile,
 ClassLoader javaLoader)
                   throws IOException

Throws:

IOException

read

protected AnalysisScope read(AnalysisScope scope,
 URI scopeFileURI,
 File exclusionsFile,
 ClassLoader javaLoader)
                      throws IOException

Throws:

IOException

processScopeDefLine

public void processScopeDefLine(AnalysisScope scope,
 ClassLoader javaLoader,
 String line)
                         throws IOException

Throws:

IOException

handleInSubclass

protected boolean handleInSubclass(AnalysisScope scope,
 ClassLoaderReference walaLoader,
 String language,
 String entryType,
 String entryPathname)

makePrimordialScope

public AnalysisScope makePrimordialScope(File exclusionsFile)
                                  throws IOException

Creates an AnalysisScope containing only the JDK standard libraries. If no explicit JDK library paths are given in the WALA properties file, the scope contains all library modules for the running JVM.

Parameters:

exclusionsFile - file holding class hierarchy exclusions. may be null

Throws:

IllegalStateException - if there are problems reading wala properties

IOException

makeBasePrimordialScope

public AnalysisScope makeBasePrimordialScope(File exclusionsFile)
                                      throws IOException

Creates an AnalysisScope containing only the JDK standard libraries. If no explicit JDK library paths are given in the WALA properties file, the scope contains only the java.base module for the running JVM.

Parameters:

exclusionsFile - file holding class hierarchy exclusions. may be null

Throws:

IllegalStateException - if there are problems reading wala properties

IOException

makeJavaBinaryAnalysisScope

public AnalysisScope makeJavaBinaryAnalysisScope(String classPath,
 File exclusionsFile)
                                          throws IOException

Parameters:

classPath - class path to analyze, delimited by File.pathSeparator

exclusionsFile - file holding class hierarchy exclusions. may be null

Throws:

IllegalStateException - if there are problems reading wala properties

IOException

addClassPathToScope

public void addClassPathToScope(String classPath,
 AnalysisScope scope,
 ClassLoaderReference loader)