Class CliActionReport
- java.lang.Object
-
- org.glassfish.api.ActionReport
-
- com.sun.enterprise.admin.remote.reader.CliActionReport
-
- All Implemented Interfaces:
Serializable
public class CliActionReport extends ActionReport
Temporary implementation. Copy of AcctionReporter. It is here until ActionReport refactoring will be complete.- Author:
- mmares
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.glassfish.api.ActionReport
ActionReport.ExitCode, ActionReport.MessagePart
-
-
Field Summary
Fields Modifier and Type Field Description protected String
actionDescription
protected Throwable
exception
protected ActionReport.ExitCode
exitCode
protected List<CliActionReport>
subActions
protected ActionReport.MessagePart
topMessage
-
Constructor Summary
Constructors Constructor Description CliActionReport()
Creates a new instance of HTMLActionReporter
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionReport
addSubActionsReport()
void
appendMessage(String message)
String
getActionDescription()
ActionReport.ExitCode
getActionExitCode()
String
getContentType()
Throwable
getFailureCause()
String
getMessage()
List<CliActionReport>
getSubActionsReport()
ActionReport.MessagePart
getTopMessagePart()
boolean
hasFailures()
return true if the action report or a subaction report has ExitCode.FAILURE.boolean
hasSuccesses()
return true if the action report or a subaction report has ExitCode.SUCCESS.boolean
hasWarnings()
return true if the action report or a subaction report has ExitCode.WARNING.boolean
isFailure()
boolean
isSuccess()
boolean
isWarning()
void
setActionDescription(String message)
void
setActionExitCode(ActionReport.ExitCode exitCode)
Sets the exit code for the report.void
setContentType(String s)
void
setFailure()
void
setFailureCause(Throwable t)
void
setMessage(InputStream in)
void
setMessage(String message)
void
setSuccess()
void
setWarning()
String
toString()
void
writeReport(OutputStream os)
Outputs the formatted information-
Methods inherited from class org.glassfish.api.ActionReport
failure, failure, findProperty, getExtraProperties, getResultType, setExtraProperties, setResultType
-
-
-
-
Field Detail
-
exception
protected Throwable exception
-
actionDescription
protected String actionDescription
-
subActions
protected List<CliActionReport> subActions
-
exitCode
protected ActionReport.ExitCode exitCode
-
topMessage
protected ActionReport.MessagePart topMessage
-
-
Method Detail
-
setFailure
public void setFailure()
-
isFailure
public boolean isFailure()
-
setWarning
public void setWarning()
-
isWarning
public boolean isWarning()
-
isSuccess
public boolean isSuccess()
-
setSuccess
public void setSuccess()
-
setActionDescription
public void setActionDescription(String message)
- Specified by:
setActionDescription
in classActionReport
-
getActionDescription
public String getActionDescription()
-
setFailureCause
public void setFailureCause(Throwable t)
- Specified by:
setFailureCause
in classActionReport
-
getFailureCause
public Throwable getFailureCause()
- Specified by:
getFailureCause
in classActionReport
-
getTopMessagePart
public ActionReport.MessagePart getTopMessagePart()
- Specified by:
getTopMessagePart
in classActionReport
-
addSubActionsReport
public ActionReport addSubActionsReport()
- Specified by:
addSubActionsReport
in classActionReport
-
getSubActionsReport
public List<CliActionReport> getSubActionsReport()
- Specified by:
getSubActionsReport
in classActionReport
-
setActionExitCode
public void setActionExitCode(ActionReport.ExitCode exitCode)
Description copied from class:ActionReport
Sets the exit code for the report. Note that subreports may have a different exitcode.- Specified by:
setActionExitCode
in classActionReport
-
getActionExitCode
public ActionReport.ExitCode getActionExitCode()
- Specified by:
getActionExitCode
in classActionReport
-
setMessage
public void setMessage(String message)
- Specified by:
setMessage
in classActionReport
-
appendMessage
public void appendMessage(String message)
- Specified by:
appendMessage
in classActionReport
-
getMessage
public String getMessage()
- Specified by:
getMessage
in classActionReport
-
setMessage
public void setMessage(InputStream in)
- Specified by:
setMessage
in classActionReport
-
getContentType
public String getContentType()
- Specified by:
getContentType
in classActionReport
-
setContentType
public void setContentType(String s)
- Specified by:
setContentType
in classActionReport
-
hasSuccesses
public boolean hasSuccesses()
Description copied from class:ActionReport
return true if the action report or a subaction report has ExitCode.SUCCESS.- Specified by:
hasSuccesses
in classActionReport
- Returns:
-
hasWarnings
public boolean hasWarnings()
Description copied from class:ActionReport
return true if the action report or a subaction report has ExitCode.WARNING.- Specified by:
hasWarnings
in classActionReport
- Returns:
-
hasFailures
public boolean hasFailures()
Description copied from class:ActionReport
return true if the action report or a subaction report has ExitCode.FAILURE.- Specified by:
hasFailures
in classActionReport
- Returns:
-
writeReport
public void writeReport(OutputStream os) throws IOException
Description copied from class:ActionReport
Outputs the formatted information- Specified by:
writeReport
in classActionReport
- Parameters:
os
- The OutputStream to which the information is sent to- Throws:
IOException
-
toString
public String toString()
- Overrides:
toString
in classActionReport
-
-