com.philemonworks.selfdiagnose.check
Class CheckXMLContent

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

All Implemented Interfaces:

Serializable

public class CheckXMLContent
extends DiagnosticTask

CheckXMLContent is a Diagnostic Task that verifies the presence of an element or attribute (by evaluating an XPath) and optionally test is against a given pattern.

<checkxmlcontent name="resource.xml" xpath="/root/child" pattern="childvalue" />
<checkxmlcontent url="URL string" xpath="/root/child" pattern="childvalue" /> 
<checkxmlcontent url="${variable with URL value}" xpath="/root/child" pattern="childvalue" />
 

Stores the String value found into the (optional) specified variable.

Author:

E.M.Micklei

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

CheckXMLContent()

Method Summary

String	getDescription()
String	getName()
String	getPattern()
String	getUrl()
String	getXpath()
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 name)
void	setPattern(String pattern)
void	setUp(ExecutionContext ctx) Override this method to verify that task parameters are initialized/set correctly.
void	setUrl(String url)
void	setXpath(String xpath)

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

CheckXMLContent

public CheckXMLContent()

Method Detail

getDescription

public String getDescription()

Specified by:

getDescription in class DiagnosticTask

Returns:

String the description

getName

public String getName()

getPattern

public String getPattern()

getUrl

public String getUrl()

getXpath

public String getXpath()

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

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

setName

public void setName(String name)

setPattern

public void setPattern(String pattern)

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

setUrl

public void setUrl(String url)

setXpath

public void setXpath(String xpath)