Package org.eclipse.steady.java

Class JarAnalyzer

java.lang.Object

org.eclipse.steady.java.JarAnalyzer

All Implemented Interfaces:

Callable<FileAnalyzer>, FileAnalyzer, JarEntryWriter

Direct Known Subclasses:

AarAnalyzer, WarAnalyzer

@NotThreadSafe
public class JarAnalyzer
extends Object
implements Callable<FileAnalyzer>, JarEntryWriter, FileAnalyzer

Analyzes a single Java archives as to identify (and potentially instrument) all its constructs.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	classCount
protected Set<ConstructId>	constructs
protected int	enumCount
protected InstrumentationControl	instrControl
protected boolean	instrument
protected int	interfaceCount
protected JarFile	jar
protected JarWriter	jarWriter
protected boolean	rename
protected String	url
protected Path	workDir

Constructor Summary

Constructors

Constructor	Description
JarAnalyzer()

Method Summary

Modifier and Type	Method	Description
void	analyze(File _file)
FileAnalyzer	call()	This method is called by ArchiveAnalysisManager.
boolean	canAnalyze(File _file)
boolean	containsConstruct(ConstructId _id)
protected void	createInstrumentedArchive()	See here: http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html
boolean	equals(Object obj)
static org.eclipse.steady.shared.json.model.Application	getAppContext()	getAppContext.
Set<FileAnalyzer>	getChilds(boolean _recursive)
Set<String>	getClassNames()	Returns the class names for all class files found in the given archive.
protected static javassist.ClassPool	getClassPool()	getClassPool.
Construct	getConstruct(ConstructId _id)
Set<ConstructId>	getConstructIds()	Identifies all ConstructIds of all methods and constructors.
Map<ConstructId,Construct>	getConstructs()
String	getFileName()	getFileName.
long	getFileSize()	Returns the size of the original JAR file (before instrumentation).
static String	getFqClassname(String _jar_entry_name)	Returns the fully-qualified Java class identifier for a given JAR entry.
InputStream	getInputStream(String _regex, JarEntry _entry)	Callback used for rewriting particular JAR entries.
InstrumentationControl	getInstrumentationControl()	getInstrumentationControl.
File	getInstrumentedArchive()	getInstrumentedArchive.
long	getInstrumentedFileSize()	Returns the size of the instrumented JAR file (or -1 if no instrumentation took place).
org.eclipse.steady.shared.json.model.Library	getLibrary()	Returns a Library representing the analyzed Java archive.
JarAnalyzer	getParent()	Getter for the field parent.
Path	getPath()	getPath.
String	getSHA1()	Returns the SHA1 digest of the JAR.
List<org.eclipse.steady.shared.json.model.ConstructId>	getSharedConstructs()	getSharedConstructs.
String[]	getSupportedFileExtensions()
boolean	hasChilds()
int	hashCode()
boolean	hasJARConstructs()	hasJARConstructs.
static void	insertClasspath(String _url)	Adds a given URL to the classpath of the class pool.
static boolean	isJavaIdentifier(String _name)	isJavaIdentifier.
static void	setAppContext(org.eclipse.steady.shared.json.model.Application _ctx)	setAppContext.
void	setInstrument(boolean _instrument)	Setter for the field instrument.
void	setLibraryId(org.eclipse.steady.shared.json.model.LibraryId _id)	Sets the Maven Id for the JAR to be analyzed.
void	setParent(JarAnalyzer ja)	Setter for the field parent.
void	setRename(boolean _b)	Determines whether the instrumented JAR is renamed or not.
void	setWorkDir(Path _p)	Specifies the work directory into which instrumented JARs are written.
String	toString()	toString.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

constructs

protected Set<ConstructId> constructs

url

protected String url

jar

protected JarFile jar

instrument

protected boolean instrument

rename

protected boolean rename

classCount

protected int classCount

enumCount

protected int enumCount

interfaceCount

protected int interfaceCount

workDir

protected Path workDir

jarWriter

protected JarWriter jarWriter

instrControl

protected InstrumentationControl instrControl

Constructor Detail

JarAnalyzer

public JarAnalyzer()

Method Detail

getSupportedFileExtensions

public String[] getSupportedFileExtensions()

Specified by:

getSupportedFileExtensions in interface FileAnalyzer

canAnalyze

public final boolean canAnalyze(File _file)

Specified by:

canAnalyze in interface FileAnalyzer

analyze

public void analyze(File _file)
             throws FileAnalysisException

Specified by:

analyze in interface FileAnalyzer

Throws:

FileAnalysisException

setInstrument

public void setInstrument(boolean _instrument)

Setter for the field instrument.

Parameters:

_instrument - a boolean.

getPath

public Path getPath()

getPath.

Returns:

a Path object.

setParent

public void setParent(JarAnalyzer ja)

Setter for the field parent.

Parameters:

ja - a JarAnalyzer object.

getParent

public JarAnalyzer getParent()

Getter for the field parent.

Returns:

a JarAnalyzer object.

getFileSize

public long getFileSize()

Returns the size of the original JAR file (before instrumentation).

Returns:

a long.

See Also:

getInstrumentedFileSize()

getInstrumentedFileSize

public long getInstrumentedFileSize()

Returns the size of the instrumented JAR file (or -1 if no instrumentation took place).

Returns:

a long.

See Also:

getFileSize()

setWorkDir

public void setWorkDir(Path _p)

Specifies the work directory into which instrumented JARs are written. If null, a temporary directory will be created.

Parameters:

_p - a Path object.

setRename

public void setRename(boolean _b)

Determines whether the instrumented JAR is renamed or not. If yes, the new file name follows the following format: - If app context is provided: [originalJarName]-vulas-[appGroupId]-[appArtifactId]-[appVersion].jar - Otherwise: [originalJarName]-vulas-instr.jar

Parameters:

_b - a boolean.

setLibraryId

public void setLibraryId(org.eclipse.steady.shared.json.model.LibraryId _id)

Sets the Maven Id for the JAR to be analyzed. The Maven ID is already known in some contexts (e.g., during Maven plugin execution).

Parameters:

_id - a LibraryId object.

getLibrary

public org.eclipse.steady.shared.json.model.Library getLibrary()
                                                        throws FileAnalysisException

Returns a Library representing the analyzed Java archive.

Returns:

a Library object.

Throws:

FileAnalysisException

getSHA1

public String getSHA1()

Returns the SHA1 digest of the JAR. Either taken from the manifest (entry VULAS-originalSHA1, in case the original JAR has been instrumented offline), or by computing it on the fly.

Returns:

the SHA1 digest of the JAR

getFileName

public String getFileName()

getFileName.

Returns:

a String object.

call

public FileAnalyzer call()

This method is called by ArchiveAnalysisManager.

Specified by:

call in interface Callable<FileAnalyzer>

Returns:

a FileAnalyzer object.

createInstrumentedArchive

protected void createInstrumentedArchive()
                                  throws JarAnalysisException

See here: http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html

Throws:

JarAnalysisException

getInstrumentedArchive

public final File getInstrumentedArchive()

getInstrumentedArchive.

Returns:

a File object.

getClassNames

public Set<String> getClassNames()

Returns the class names for all class files found in the given archive.

Returns:

a Set object.

hasJARConstructs

public boolean hasJARConstructs()

hasJARConstructs.

Returns:

a boolean.

hasChilds

public boolean hasChilds()

Specified by:

hasChilds in interface FileAnalyzer

getChilds

public Set<FileAnalyzer> getChilds(boolean _recursive)

Specified by:

getChilds in interface FileAnalyzer

getConstructIds

public Set<ConstructId> getConstructIds()

Identifies all ConstructIds of all methods and constructors.

Returns:

a Set object.

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object.

getInstrumentationControl

public InstrumentationControl getInstrumentationControl()

getInstrumentationControl.

Returns:

a InstrumentationControl object.

getInputStream

public InputStream getInputStream(String _regex,
                                  JarEntry _entry)

Callback used for rewriting particular JAR entries. Return null to rewrite the original JAR entry. In case the archive is rewritten, this method is used to rewrite certain JarEntrys (rather than taking the file from the original archive). The callback registration takes place in createInstrumentedArchive().

Specified by:

getInputStream in interface JarEntryWriter

Parameters:

_regex - a String object.

_entry - a JarEntry object.

Returns:

a InputStream object.

getConstructs

public Map<ConstructId,Construct> getConstructs()
                                               throws FileAnalysisException

Specified by:

getConstructs in interface FileAnalyzer

Throws:

FileAnalysisException

getSharedConstructs

public List<org.eclipse.steady.shared.json.model.ConstructId> getSharedConstructs()
                                                                           throws FileAnalysisException

getSharedConstructs.

Returns:

a List object.

Throws:

FileAnalysisException - if any.

containsConstruct

public boolean containsConstruct(ConstructId _id)
                          throws FileAnalysisException

Specified by:

containsConstruct in interface FileAnalyzer

Throws:

FileAnalysisException

getConstruct

public Construct getConstruct(ConstructId _id)
                       throws FileAnalysisException

Specified by:

getConstruct in interface FileAnalyzer

Throws:

FileAnalysisException

equals

public boolean equals(Object obj)

Specified by:

equals in interface FileAnalyzer

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface FileAnalyzer

Overrides:

hashCode in class Object

isJavaIdentifier

public static boolean isJavaIdentifier(String _name)

isJavaIdentifier.

Parameters:

_name - a String object.

Returns:

a boolean.

getFqClassname

public static String getFqClassname(String _jar_entry_name)

Returns the fully-qualified Java class identifier for a given JAR entry. This is done by removing the file extension and by interpreting folders as packages. If anything goes wrong, null is returned.

Parameters:

_jar_entry_name - a String object.

Returns:

a String object.

setAppContext

public static void setAppContext(org.eclipse.steady.shared.json.model.Application _ctx)

setAppContext.

Parameters:

_ctx - a Application object.

getAppContext

public static org.eclipse.steady.shared.json.model.Application getAppContext()

getAppContext.

Returns:

a Application object.

insertClasspath

public static void insertClasspath(String _url)
                            throws javassist.NotFoundException

Adds a given URL to the classpath of the class pool. This allows maintaining dependencies needed for the compilation of instrumented classes.

Parameters:

_url - a String object.

Throws:

javassist.NotFoundException

getClassPool

protected static javassist.ClassPool getClassPool()

getClassPool.

Returns:

a ClassPool object.