|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.ws.status.DiagnosticTask
public abstract class DiagnosticTask
A task to be executed for diagnostics. Each task should append any text to return in the event of a failure to the method appendFailureText(). Text to use in the event of a success should be sent to the method appendSuccessText().
Constructor Summary | |
---|---|
DiagnosticTask()
|
Method Summary | |
---|---|
void |
appendSuccessTextLine(String text)
Append a line to the text to be used in the event of a success. |
boolean |
executeTask()
Execute the diagnostic task. |
StringBuilder |
retrieveFailureText()
failure text if this was a failure |
abstract String |
retrieveName()
should be alphaNumeric in camelcase (for config file) |
abstract String |
retrieveNameFriendly()
friendly name to display on screen |
StringBuilder |
retrieveSuccessText()
success text if this was a success |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DiagnosticTask()
Method Detail |
---|
public boolean executeTask()
public StringBuilder retrieveFailureText()
public StringBuilder retrieveSuccessText()
public void appendSuccessTextLine(String text)
Append a line to the text to be used in the event of a success. Each line added has the current time of the operation added to it.
text
- is the text to use.public abstract String retrieveName()
public abstract String retrieveNameFriendly()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |