com.sap.psr.vulas.cg

Class ReachabilityAnalyzer

java.lang.Object

com.sap.psr.vulas.cg.ReachabilityAnalyzer

All Implemented Interfaces:

Runnable

public class ReachabilityAnalyzer
extends Object
implements Runnable

Reachability Analyzer

Constructor Summary

Constructors

Constructor and Description
ReachabilityAnalyzer(com.sap.psr.vulas.goals.GoalContext _ctx) Constructor for ReachabilityAnalyzer.

Method Summary

Modifier and Type	Method and Description
String	getAppClasspath() getAppClasspath.
Callgraph	getCallgraph() Getter for the field callgraph.
org.apache.commons.configuration.Configuration	getConfiguration() Returns a human-readable description of the constructor's specific configuration.
long	getConstructionTime() Returns the time required for building the call graph (in nanoseconds), or -1 if the construction did not finish.
String	getDependencyClasspath() getDependencyClasspath.
int	getEdgeCount() Returns the number of edges in constructed call graph (or -1 if the call graph has not been constructed).
int	getNodeCount() Returns the number of nodes in the constructed call graph (or -1 if the call graph has not been constructed).
Map<String,Long>	getStatistics() getStatistics.
void	run() Given the bugid and callgraph constructor framework, do the reachability analysis from callgraph construction to callgraph computation
void	setAppClasspaths(Set<Path> _paths) Sets the directories where to find compiled application classes.
void	setAppConstructs(Set<com.sap.psr.vulas.shared.json.model.ConstructId> _constructs) Sets the application constructs.
void	setCallgraphConstructor(String analysisFramework, boolean _is_cli) setCallgraphConstructor.
void	setDependencyClasspaths(Set<Path> _paths) Sets the directories where to find the classes of application dependencies.
void	setEntryPoints(Set<com.sap.psr.vulas.shared.json.model.ConstructId> _constructs, com.sap.psr.vulas.shared.enums.PathSource _source, boolean _throw_exception) Sets the entry points that will be used as a starting point for the call graph construction.
void	setExcludePackages(String _packages) setExcludePackages.
void	setTargetConstructs(Map<String,Set<com.sap.psr.vulas.shared.json.model.ConstructId>> _target_constructs) Setter for the field targetConstructs.
void	setTargetConstructs(String _filter) Sets the change list elements of the given bug(s) as target constructs.
static boolean	startAnalysis(ReachabilityAnalyzer _ra, long _timeout_ms) startAnalysis.
void	upload() Uploads reachable constructs and touch points to the backend.
void	uploadBug(String _bugid, List<List<com.sap.psr.vulas.shared.json.model.ConstructId>> _paths) Uploads paths for the given bug to the backend.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReachabilityAnalyzer

public ReachabilityAnalyzer(com.sap.psr.vulas.goals.GoalContext _ctx)

Constructor for ReachabilityAnalyzer.

Parameters:

_ctx - a GoalContext object.

Method Detail

getCallgraph

public Callgraph getCallgraph()

Getter for the field callgraph.

Returns:

a Callgraph object.

setAppClasspaths

public void setAppClasspaths(Set<Path> _paths)

Sets the directories where to find compiled application classes. Each path is typically a directory, e.g., 'WEB-INF/classes' in case of uncompressed WARs or 'target/classes' in case of Maven projects.

Parameters:

_paths - a Set object.

getAppClasspath

public String getAppClasspath()

getAppClasspath.

Returns:

a String object.

setDependencyClasspaths

public void setDependencyClasspaths(Set<Path> _paths)

Sets the directories where to find the classes of application dependencies. Each path is typically a JAR file, e.g., 'WEB-INF/lib' in case of uncompressed WARs or 'target/dependencies' in case of Maven projects.

Parameters:

_paths - a Set object.

getDependencyClasspath

public String getDependencyClasspath()

getDependencyClasspath.

Returns:

a String object.

setAppConstructs

public void setAppConstructs(Set<com.sap.psr.vulas.shared.json.model.ConstructId> _constructs)

Sets the application constructs.

Parameters:

_constructs - a Set object.

setEntryPoints

public void setEntryPoints(Set<com.sap.psr.vulas.shared.json.model.ConstructId> _constructs,
                           com.sap.psr.vulas.shared.enums.PathSource _source,
                           boolean _throw_exception)

Sets the entry points that will be used as a starting point for the call graph construction. The entry points used depend on the GoalType.

Parameters:

_constructs - a Set object.

_source - a PathSource object.

_throw_exception - a boolean.

setExcludePackages

public void setExcludePackages(String _packages)

setExcludePackages.

Parameters:

_packages - a String object.

setTargetConstructs

public void setTargetConstructs(String _filter)

Sets the change list elements of the given bug(s) as target constructs. If no bugs are passed, all bugs relevant for the application will be considered (cf. BackendConnector.getAppBugs(GoalContext, Application)).

Parameters:

_filter - Comma-separated list of bug identifiers

setTargetConstructs

public void setTargetConstructs(Map<String,Set<com.sap.psr.vulas.shared.json.model.ConstructId>> _target_constructs)

Setter for the field targetConstructs.

Parameters:

_target_constructs - a Map object.

setCallgraphConstructor

public void setCallgraphConstructor(String analysisFramework,
                                    boolean _is_cli)

setCallgraphConstructor.

Parameters:

analysisFramework - a String object.

_is_cli - a boolean.

run

public void run()

Given the bugid and callgraph constructor framework, do the reachability analysis from callgraph construction to callgraph computation

Specified by:

run in interface Runnable

getStatistics

public Map<String,Long> getStatistics()

getStatistics.

Returns:

a Map object.

getConstructionTime

public long getConstructionTime()

Returns the time required for building the call graph (in nanoseconds), or -1 if the construction did not finish.

Returns:

the time required for building the call graph (in nanoseconds)

getConfiguration

public org.apache.commons.configuration.Configuration getConfiguration()

Returns a human-readable description of the constructor's specific configuration.

Returns:

a Configuration object.

getNodeCount

public int getNodeCount()

Returns the number of nodes in the constructed call graph (or -1 if the call graph has not been constructed).

Returns:

the number of nodes in this graph

See Also:

getEdgeCount()

getEdgeCount

public int getEdgeCount()

Returns the number of edges in constructed call graph (or -1 if the call graph has not been constructed).

Returns:

the number of edges in this graph

See Also:

getNodeCount()

startAnalysis

public static boolean startAnalysis(ReachabilityAnalyzer _ra,
                                    long _timeout_ms)
                             throws InterruptedException

startAnalysis.

Parameters:

_ra - a ReachabilityAnalyzer object.

_timeout_ms - timeout in milliseconds (no timeout if negative or 0)

Returns:

true if the analysis terminated, false otherwise

Throws:

InterruptedException

uploadBug

public void uploadBug(String _bugid,
                      List<List<com.sap.psr.vulas.shared.json.model.ConstructId>> _paths)

Uploads paths for the given bug to the backend. If there is no such path, an empty array will be uploaded to indicate that the analysis ran but did not yield a result.

Parameters:

_bugid - a String object.

_paths - a List object.

upload

public void upload()

Uploads reachable constructs and touch points to the backend.