com.philemonworks.selfdiagnose.check
Class CheckHttpRequestHeader

java.lang.Object
  com.philemonworks.selfdiagnose.DiagnosticTask
      com.philemonworks.selfdiagnose.PatternMatchingTask
          com.philemonworks.selfdiagnose.check.CheckProperty
              com.philemonworks.selfdiagnose.check.CheckHttpRequestHeader

All Implemented Interfaces:

Serializable

public class CheckHttpRequestHeader
extends CheckProperty

CheckHttpRequestHeader reads a header field from the current Http Servlet Request. If the protocol is specified then the check is only performed when it matches. <checkhttprequestheader header="" protocol="http" pattern="" />

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

CheckHttpRequestHeader()

Method Summary

String	getDescription()
String	getHeader()
String	getProtocol()
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	setHeader(String header)
void	setProtocol(String protocol)
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

CheckHttpRequestHeader

public CheckHttpRequestHeader()

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

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

getHeader

public String getHeader()

setHeader

public void setHeader(String header)