com.philemonworks.selfdiagnose.check
Class CheckDirectoryAccessible

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

public class CheckDirectoryAccessible
extends DiagnosticTask

CheckDirectoryAccessible is a DiagnosticTask that verifies access properties of a directory in a File System

<checkdirectoryaccessible path="/home/work" />
<checkdirectoryaccessible path="/home/work" writeable="true" /> 
 
Stores the directory (java.io.File) 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
CheckDirectoryAccessible()
           
 
Method Summary
 String getDescription()
          Return the description of this task.
 String getPath()
           
 void initializeFromAttributes(Attributes attributes)
          This method is sent from the SelfDiagnoseHandler when a configuration is being processed.
 boolean isMustBeWriteable()
           
 void run(ExecutionContext ctx, DiagnosticTaskResult result)
          Run the task.
 void setMustBeWriteable(boolean writeable)
           
 void setPath(String directory)
           
 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

CheckDirectoryAccessible

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

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

getPath

public String getPath()
Returns:
String the path

setPath

public void setPath(String directory)
Parameters:
path - String

isMustBeWriteable

public boolean isMustBeWriteable()
Returns:
boolean mustBeWriteabl

setMustBeWriteable

public void setMustBeWriteable(boolean writeable)
Parameters:
writeable - true if it must be writeable (i.e. a file can be created).


Copyright © 2012. All Rights Reserved.