com.philemonworks.selfdiagnose.check
Class CheckResourceAccessible

java.lang.Object
  extended by com.philemonworks.selfdiagnose.DiagnosticTask
      extended by com.philemonworks.selfdiagnose.check.CheckResourceAccessible
All Implemented Interfaces:
Serializable

public class CheckResourceAccessible
extends DiagnosticTask

CheckResourceAccessible is a DiagnosticTask that verifies the availability of a resource by name on the classpath.

<checkresourceaccessible name="application.properties" />
 
Stores the URL (java.net.URL) of the resource 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
CheckResourceAccessible()
           
 
Method Summary
 String getDescription()
          Return the description of this task.
 String getName()
           
 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 string)
           
 void setUp(ExecutionContext ctx)
          Override this method to verify that task parameters are initialized/set correctly.
 
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

CheckResourceAccessible

public CheckResourceAccessible()
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

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()
Returns:
String resourceName

setName

public void setName(String string)
Parameters:
string -

getDescription

public String getDescription()
Return the description of this task.

Specified by:
getDescription in class DiagnosticTask
Returns:
String the description


Copyright © 2012. All Rights Reserved.