com.philemonworks.selfdiagnose.check
Class CheckURLReachable

java.lang.Object
  com.philemonworks.selfdiagnose.DiagnosticTask
      com.philemonworks.selfdiagnose.PatternMatchingTask
          com.philemonworks.selfdiagnose.check.CheckURLReachable

All Implemented Interfaces:

Serializable

public class CheckURLReachable
extends PatternMatchingTask

CheckURLReachable is a DiagnosticTask that verifies that an URL is reachable by connecting to it and inspecting the (http) response code. The url parameter may refer to a variable in the execution context with a String or URL value.

<checkurlreachable url="http://www.philemonworks.com" />
 

Stores the contents returned from the URL into the (optional) specified variable.

Author:

emicklei

See Also:

Serialized Form

Field Summary

Fields inherited from class com.philemonworks.selfdiagnose.PatternMatchingTask

PARAMETER_PATTERN, pattern

Fields inherited from class com.philemonworks.selfdiagnose.DiagnosticTask

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

Constructor Summary

CheckURLReachable()

Method Summary

String	getDescription()
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	setUp(ExecutionContext ctx) Override this method to verify that task parameters are initialized/set correctly.
void	setUrl(String urlSpec) Set the URL to test.

Methods inherited from class com.philemonworks.selfdiagnose.PatternMatchingTask

checkValueAgainstPattern, getPattern, setPattern

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

CheckURLReachable

public CheckURLReachable()

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 PatternMatchingTask

Parameters:

attributes - org.xml.sax.Attributes

getDescription

public String getDescription()

Specified by:

getDescription in class DiagnosticTask

Returns:

String the description

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

setUrl

public void setUrl(String urlSpec)

Set the URL to test.

Parameters:

url - : String