Package com.sun.enterprise.admin.report

Class ActionReporter

java.lang.Object

org.glassfish.api.ActionReport

com.sun.enterprise.admin.report.ActionReporter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DoNothingActionReporter, HTMLActionReporter, JsonActionReporter, PlainTextActionReporter, PropsFileActionReporter, RestActionReporter, XMLActionReporter, XMLContentActionReporter

public abstract class ActionReporter
extends ActionReport

Superclass for common ActionReport extension.

Author:

Jerome Dochez

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 String	contentType
static String	EOL_MARKER
protected Throwable	exception
protected ActionReport.ExitCode	exitCode
protected List<ActionReporter>	subActions
protected ActionReport.MessagePart	topMessage

Constructor Summary

Constructors

Constructor	Description
ActionReporter()	Creates a new instance of HTMLActionReporter

Method Summary

Modifier and Type	Method	Description
ActionReport	addSubActionsReport()
void	appendMessage(String message)
String	getActionDescription()
ActionReport.ExitCode	getActionExitCode()
void	getCombinedMessages(ActionReporter aReport, StringBuilder sb)	Returns combined messages.
String	getContentType()	Returns the content type to be used in sending the response back to the client/caller.
Throwable	getFailureCause()
String	getMessage()
List<ActionReporter>	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()	Sets the exit code of the report to failure
void	setFailureCause(Throwable t)
void	setMessage(InputStream in)
void	setMessage(String message)
void	setSuccess()
void	setWarning()

Methods inherited from class org.glassfish.api.ActionReport

failure, failure, findProperty, getExtraProperties, getResultType, setExtraProperties, setResultType, toString, writeReport

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<ActionReporter> subActions

exitCode

protected ActionReport.ExitCode exitCode

topMessage

protected ActionReport.MessagePart topMessage

contentType

protected String contentType

EOL_MARKER

public static final String EOL_MARKER

See Also:

Constant Field Values

Constructor Detail

ActionReporter

public ActionReporter()

Creates a new instance of HTMLActionReporter

Method Detail

setFailure

public void setFailure()

Sets the exit code of the report to failure

isFailure

public boolean isFailure()

Returns:

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<ActionReporter> 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()

Returns the content type to be used in sending the response back to the client/caller.

This is the default type. Specific subclasses of ActionReporter might override the method to return a different valid type.

Specified by:

getContentType in class ActionReport

Returns:

content type to be used in formatting the command response to the client

setContentType

public void setContentType(String s)

Specified by:

setContentType in class ActionReport

getCombinedMessages

public void getCombinedMessages(ActionReporter aReport,
                                StringBuilder sb)

Returns combined messages. Meant mainly for long running operations where some of the intermediate steps can go wrong, although overall operation succeeds. Does nothing if either of the arguments are null. The traversal visits the message of current reporter first. The various parts of the message are separated by EOL_MARKERs.

Note: This method is a recursive implementation.

Parameters:

aReport - a given (usually top-level) ActionReporter instance

sb - StringBuilder instance that contains all the messages

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: