com.ibm.dtfj.analyzer.ext
Interface IInteract


public interface IInteract

This interface indicates that the analyzer implements interactive shell.

All interaction should happen either in IReport.produceReport() or IAnalyze.doAnalysis() method depending on what analyzing interface this analyzer implements.

Interactive commands should be accepted from System.in stream and all response should be sent to System.out stream. The string return by getPrompt() method should be appended to the end of the response to indicate that interactive shell awaits for the next command.

Note, that implementations of the analyzer should not rely on the context to be set in methods of this interface. They are called before any dump preprocessing happens.


Method Summary
 java.lang.String getPrompt()
          Get the prompt this analyzer will use to ask for more data.
 java.lang.String[] getRuntimeJars()
          Get the list of jar which needs to be included at runtime for this analyzer to work.
 

Method Detail

getPrompt

java.lang.String getPrompt()
Get the prompt this analyzer will use to ask for more data. It is necessary for synchronization when the analyzer is run in a separate process. This string should have a final static value since it should be consistent among different instances of this analyzer.

Returns:
String representing the prompt.

getRuntimeJars

java.lang.String[] getRuntimeJars()
                                  throws java.io.FileNotFoundException
Get the list of jar which needs to be included at runtime for this analyzer to work.

Returns:
list of jars required at runtime, empty array if no extra jars are required.
Throws:
java.io.FileNotFoundException - if not all required jars are found.


© Copyright IBM Corp. 2007, 2008 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.