com.sun.enterprise.admin.remote.reader

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 and Description
protected String	actionDescription
protected Throwable	exception
protected ActionReport.ExitCode	exitCode
protected List<CliActionReport>	subActions
protected ActionReport.MessagePart	topMessage

Constructor Summary

Constructors

Constructor and Description
CliActionReport() Creates a new instance of HTMLActionReporter

Method Summary

Modifier and Type	Method and 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

CliActionReport

public CliActionReport()

Creates a new instance of HTMLActionReporter

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 class ActionReport

getActionDescription

public String getActionDescription()

setFailureCause

public void setFailureCause(Throwable t)

Specified by:

setFailureCause in class ActionReport

getFailureCause

public Throwable getFailureCause()

Specified by:

getFailureCause in class ActionReport

getTopMessagePart

public ActionReport.MessagePart getTopMessagePart()

Specified by:

getTopMessagePart in class ActionReport

addSubActionsReport

public ActionReport addSubActionsReport()

Specified by:

addSubActionsReport in class ActionReport

getSubActionsReport

public List<CliActionReport> getSubActionsReport()

Specified by:

getSubActionsReport in class ActionReport

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 class ActionReport

getActionExitCode

public ActionReport.ExitCode getActionExitCode()

Specified by:

getActionExitCode in class ActionReport

setMessage

public void setMessage(String message)

Specified by:

setMessage in class ActionReport

appendMessage

public void appendMessage(String message)

Specified by:

appendMessage in class ActionReport

getMessage

public String getMessage()

Specified by:

getMessage in class ActionReport

setMessage

public void setMessage(InputStream in)

Specified by:

setMessage in class ActionReport

getContentType

public String getContentType()

Specified by:

getContentType in class ActionReport

setContentType

public void setContentType(String s)

Specified by:

setContentType in class ActionReport

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 class ActionReport

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 class ActionReport

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 class ActionReport

Returns:

writeReport

public void writeReport(OutputStream os)
                 throws IOException

Description copied from class: ActionReport

Outputs the formatted information

Specified by:

writeReport in class ActionReport

Parameters:

os - The OutputStream to which the information is sent to

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object