com.sap.psr.vulas.cg.spi

Interface ICallgraphConstructor

public interface ICallgraphConstructor

A call graph constructor builds a call graph starting from a given set of entry points. Entry points can be, for instance, all Constructs of an application, or all Constructs that have been traced during tests.

Method Summary

Modifier and Type	Method and Description
void	buildCallgraph(boolean _policy) Builds the call graph.
com.ibm.wala.util.graph.Graph<com.sap.psr.vulas.shared.json.model.ConstructId>	getCallgraph() Returns the call graph.
long	getConstructionTime() Returns the time required for building the call graph (in nanoseconds), or -1 if the construction did not finish.
org.apache.commons.configuration.Configuration	getConstructorConfiguration() Returns the constructor's specific configuration settings.
Set<com.sap.psr.vulas.shared.json.model.ConstructId>	getEntrypoints() Returns the effectively used entry points.
String	getFramework() The name of the analysis framework, used to register this callgraph constructor
void	setAppClasspath(String _cp) Sets the class path with directories and/or JAR files for the application.
void	setAppContext(com.sap.psr.vulas.shared.json.model.Application _ctx) Sets the application for call graph construction.
void	setDepClasspath(String _dependencyClasspath) Sets the class path with directories and/or JAR files for the dependencies.
void	setEntrypoints(Set<com.sap.psr.vulas.shared.json.model.ConstructId> _constructs) Sets the entry points for call graph construction.
void	setExcludePackages(String _packages) Excludes certain packages from the analysis, i.e., potential invocations happening in Constructs of those packages will be ignored.
void	setVulasConfiguration(com.sap.psr.vulas.shared.util.VulasConfiguration _cfg) setVulasConfiguration.

Method Detail

getFramework

String getFramework()

The name of the analysis framework, used to register this callgraph constructor

Returns:

the framework's name

setAppContext

void setAppContext(com.sap.psr.vulas.shared.json.model.Application _ctx)

Sets the application for call graph construction.

Parameters:

_ctx - a Application object.

setVulasConfiguration

void setVulasConfiguration(com.sap.psr.vulas.shared.util.VulasConfiguration _cfg)

setVulasConfiguration.

Parameters:

_cfg - a VulasConfiguration object.

setAppClasspath

void setAppClasspath(String _cp)

Sets the class path with directories and/or JAR files for the application. Individual entries must be separated by the system-specific path separator.

Parameters:

_cp - a String object.

setDepClasspath

void setDepClasspath(String _dependencyClasspath)

Sets the class path with directories and/or JAR files for the dependencies. Individual entries must be separated by the system-specific path separator.

Parameters:

_dependencyClasspath - a String object.

setEntrypoints

void setEntrypoints(Set<com.sap.psr.vulas.shared.json.model.ConstructId> _constructs)
             throws CallgraphConstructException

Sets the entry points for call graph construction. These are the starting point of the call graph construction.

Parameters:

_constructs - a Set object.

Throws:

CallgraphConstructException

setExcludePackages

void setExcludePackages(String _packages)

Excludes certain packages from the analysis, i.e., potential invocations happening in Constructs of those packages will be ignored.

Parameters:

_packages - a String object.

getEntrypoints

Set<com.sap.psr.vulas.shared.json.model.ConstructId> getEntrypoints()

Returns the effectively used entry points. Constructs of type class or package, for instance, will be filtered. Also, it may happen that some of the specified entry points cannot be found, e.g., due to an incomplete class path.

Returns:

a Set object.

buildCallgraph

void buildCallgraph(boolean _policy)
             throws CallgraphConstructException

Builds the call graph. If the argument is set to true, the construction will be aborted if not all of the specified entry points could be used.

Parameters:

_policy - a boolean.

Throws:

CallgraphConstructException

getConstructionTime

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)

getConstructorConfiguration

org.apache.commons.configuration.Configuration getConstructorConfiguration()

Returns the constructor's specific configuration settings.

Returns:

a Configuration object.

getCallgraph

com.ibm.wala.util.graph.Graph<com.sap.psr.vulas.shared.json.model.ConstructId> getCallgraph()

Returns the call graph.

Returns:

a Graph object.