com.philemonworks.selfdiagnose.check.vendor
Class CheckAtgComponentProperty

java.lang.Object
  com.philemonworks.selfdiagnose.DiagnosticTask
      com.philemonworks.selfdiagnose.PatternMatchingTask
          com.philemonworks.selfdiagnose.check.CheckProperty
              com.philemonworks.selfdiagnose.check.vendor.CheckAtgComponentProperty

All Implemented Interfaces:

Serializable

public class CheckAtgComponentProperty
extends CheckProperty

CheckAtgComponentProperty is a task specific to the ATG framework. This task can access a component and its properties to match against an expected pattern.

 <checkatgcomponentproperty component="/atg/dynamo/Configuration" property="siteHttpServerName"/>
 

Author:

ernestmicklei

See Also:

Serialized Form

Field Summary

Fields inherited from class com.philemonworks.selfdiagnose.check.CheckProperty

PARAMETER_PROPERTY, property

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

CheckAtgComponentProperty()

Method Summary

String	getComponentName()
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	setComponentName(String componentName)
void	setUp(ExecutionContext ctx) Override this method to verify that task parameters are initialized/set correctly.

Methods inherited from class com.philemonworks.selfdiagnose.check.CheckProperty

checkPropertyAccess, getProperty, isThisRequested, setProperty

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

CheckAtgComponentProperty

public CheckAtgComponentProperty()

Method Detail

getDescription

public String getDescription()

Specified by:

getDescription in class DiagnosticTask

Returns:

String the description

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 CheckProperty

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 CheckProperty

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

getComponentName

public String getComponentName()

setComponentName

public void setComponentName(String componentName)