com.philemonworks.selfdiagnose.check
Class CheckFileContainsString

java.lang.Object
  com.philemonworks.selfdiagnose.DiagnosticTask
      com.philemonworks.selfdiagnose.check.CheckFileContainsString

All Implemented Interfaces:

Serializable

public class CheckFileContainsString
extends DiagnosticTask

CheckFileContainsString is a task that scans a file for at least one occurrence of a String. The file must be character-based and is found as a resource (on the classpath) or a simple file.

 <checkfilecontainsstring name="environment.properties" string="smtp.xs4all.nl" /> 
 <checkfilecontainsstring url="${urlvar}" string="smtp.xs4all.nl" />
 

Stores the URL (java.net.URL) of the file into the (optional) specified variable.

Author:

emicklei

See Also:

Serialized Form

Field Summary

Fields inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

comment, PARAMETER_COMMENT, PARAMETER_REPORT, PARAMETER_VARIABLE, reportResults, requestor, variableName

Constructor Summary

CheckFileContainsString()

Method Summary

String	getConfiguration()
String	getDescription() Return the description of this task.
String	getName() Return the file name.
String	getString() Return the substring to search.
String	getUrl()
void	initializeFromAttributes(Attributes attributes) This method is sent from the SelfDiagnoseHandler when a configuration is being processed.
void	run(ExecutionContext ctx, DiagnosticTaskResult result) Run the task.
void	setName(String newFileName) Set the name of the file.
void	setString(String newString) Set the substring to search.
void	setUp(ExecutionContext ctx) Override this method to verify that task parameters are initialized/set correctly.
void	setUrl(String url)

Methods inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

createResult, getComment, getDefaultReportTemplate, getRequestor, getTaskName, getVariableName, hasComment, isReportResults, run, run, setComment, setReportResults, setRequestor, setVariableName

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckFileContainsString

public CheckFileContainsString()

Method Detail

initializeFromAttributes

public void initializeFromAttributes(Attributes attributes)

Description copied from class: DiagnosticTask

This method is sent from the SelfDiagnoseHandler when a configuration is being processed. Use the passed attributes to initialize the receiver. If a variable parameter is passed then store it.

Overrides:

initializeFromAttributes in class DiagnosticTask

Parameters:

attributes - org.xml.sax.Attributes

getDescription

public String getDescription()

Return the description of this task.

Specified by:

getDescription in class DiagnosticTask

Returns:

String the description

getConfiguration

public String getConfiguration()

setUp

public void setUp(ExecutionContext ctx)
           throws DiagnoseException

Description copied from class: DiagnosticTask

Override this method to verify that task parameters are initialized/set correctly.

Overrides:

setUp in class DiagnosticTask

Parameters:

ctx - ExecutionContext

Throws:

DiagnoseException

run

public void run(ExecutionContext ctx,
                DiagnosticTaskResult result)
         throws DiagnoseException

Description copied from class: DiagnosticTask

Run the task. If an error is detected then raise a DiagnoseException. Otherwise use the result object to the report any messages when a run is completed.

Specified by:

run in class DiagnosticTask

Parameters:

ctx - ExecutionContext

result - DiagnosticTaskResult

Throws:

DiagnoseException

getName

public String getName()

Return the file name.

Returns:

String the name of the file/resource

getString

public String getString()

Return the substring to search.

Returns:

String substring

setName

public void setName(String newFileName)

Set the name of the file.

Parameters:

string - the name of the file/resource

setString

public void setString(String newString)

Set the substring to search.

Parameters:

string -

getUrl

public String getUrl()

setUrl

public void setUrl(String url)