Package org.eclipse.steady.java

Class WarAnalyzer

java.lang.Object

org.eclipse.steady.java.JarAnalyzer

org.eclipse.steady.java.WarAnalyzer

All Implemented Interfaces:

Callable<FileAnalyzer>, FileAnalyzer, JarEntryWriter

@NotThreadSafe
public class WarAnalyzer
extends JarAnalyzer

Analyzes a single Web app archive (WAR) as to identify (and potentially instrument) all its classes (in directory WEB-INF/classes), as well as its JARs (in directory WEB-INF/lib).

Field Summary

Fields inherited from class org.eclipse.steady.java.JarAnalyzer

classCount, constructs, enumCount, instrControl, instrument, interfaceCount, jar, jarWriter, rename, url, workDir

Constructor Summary

Constructors

Constructor	Description
WarAnalyzer()

Method Summary

Modifier and Type	Method	Description
void	analyze(File _file)
protected void	createInstrumentedArchive()	See here: http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html
Set<FileAnalyzer>	getChilds(boolean _recursive)
Set<ConstructId>	getConstructIds()	Identifies all ConstructIds of all methods and constructors.
InputStream	getInputStream(String _regex, JarEntry _entry)	Callback used for rewriting particular JAR entries.
String[]	getSupportedFileExtensions()
boolean	hasChilds()
void	setIncludeDir(Path _p)	Sets the directory containing JARs to be included in the rewritten WAR.
void	setRename(boolean _b)	Determines whether the instrumented JAR is renamed or not.

Methods inherited from class org.eclipse.steady.java.JarAnalyzer

call, canAnalyze, containsConstruct, equals, getAppContext, getClassNames, getClassPool, getConstruct, getConstructs, getFileName, getFileSize, getFqClassname, getInstrumentationControl, getInstrumentedArchive, getInstrumentedFileSize, getLibrary, getParent, getPath, getSHA1, getSharedConstructs, hashCode, hasJARConstructs, insertClasspath, isJavaIdentifier, setAppContext, setInstrument, setLibraryId, setParent, setWorkDir, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WarAnalyzer

public WarAnalyzer()

Method Detail

getSupportedFileExtensions

public String[] getSupportedFileExtensions()

Specified by:

getSupportedFileExtensions in interface FileAnalyzer

Overrides:

getSupportedFileExtensions in class JarAnalyzer

analyze

public void analyze(File _file)
             throws FileAnalysisException

Specified by:

analyze in interface FileAnalyzer

Overrides:

analyze in class JarAnalyzer

Throws:

FileAnalysisException

setIncludeDir

public void setIncludeDir(Path _p)

Sets the directory containing JARs to be included in the rewritten WAR. All JARs contained therein will be modified as well in order to set the application scope in the Vulas configuration file.

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 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.jar

Overrides:

setRename in class JarAnalyzer

Parameters:

_b - a boolean.

createInstrumentedArchive

protected void createInstrumentedArchive()
                                  throws JarAnalysisException

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

Overrides:

createInstrumentedArchive in class JarAnalyzer

Throws:

JarAnalysisException

hasChilds

public boolean hasChilds()

Specified by:

hasChilds in interface FileAnalyzer

Overrides:

hasChilds in class JarAnalyzer

getChilds

public Set<FileAnalyzer> getChilds(boolean _recursive)

Specified by:

getChilds in interface FileAnalyzer

Overrides:

getChilds in class JarAnalyzer

getConstructIds

public Set<ConstructId> getConstructIds()

Identifies all ConstructIds of all methods and constructors. Identifies all ConstructIds of all methods and constructors contained in the WAR file. Returns true if the WAR has classes in WEB-INF/classes, false otherwise. Note that classes in libraries contained in WEB-INF/lib are ignored.

Overrides:

getConstructIds in class JarAnalyzer

Returns:

a Set 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 JarAnalyzer.createInstrumentedArchive(). 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

Overrides:

getInputStream in class JarAnalyzer

Parameters:

_regex - a String object.

_entry - a JarEntry object.

Returns:

a InputStream object.