com.sun.enterprise.v3.common
Class XMLContentActionReporter

java.lang.Object
  org.glassfish.api.ActionReport
      com.sun.enterprise.v3.common.ActionReporter
          com.sun.enterprise.v3.common.XMLContentActionReporter

@Service(name="metadata")
@Scoped(value=org.jvnet.hk2.component.PerLookup.class)
public class XMLContentActionReporter
extends ActionReporter

Represents the action report as XML like this:

<action-report description="xxx" exit-code="xxx" [failure-cause="xxx"]>
<message-part message="">
<property name="xxx" value="xxx"/>
...
<child-type property="value"/>
...
</child-type>
</message-part>
</message-part>
</action-report> Currently this is used to return the metadata for a command, although it could be used more generally to return XML content. In the general case the action-report and message-part elements ought to be removed.

Author:

tjquinn, Bill Shannon

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.api.ActionReport

ActionReport.ExitCode, ActionReport.MessagePart

Field Summary

Fields inherited from class com.sun.enterprise.v3.common.ActionReporter

actionDescription, contentType, EOL_MARKER, exception, exitCode, subActions, topMessage

Constructor Summary

XMLContentActionReporter()

Method Summary

String	getContentType() Returns the content type to be used in sending the response back to the client/caller.
void	writeReport(OutputStream os)

Methods inherited from class com.sun.enterprise.v3.common.ActionReporter

addSubActionsReport, appendMessage, getActionDescription, getActionExitCode, getCombinedMessages, getFailureCause, getMessage, getSubActionsReport, getTopMessagePart, hasFailures, hasSuccesses, hasWarnings, isFailure, isSuccess, isWarning, setActionDescription, setActionExitCode, setContentType, setFailure, setFailureCause, setMessage, setMessage, setSuccess, setWarning

Methods inherited from class org.glassfish.api.ActionReport

failure, failure, getExtraProperties, getResultType, setExtraProperties, setResultType

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLContentActionReporter

public XMLContentActionReporter()

Method Detail

writeReport

public void writeReport(OutputStream os)

Specified by:

writeReport in class ActionReport

getContentType

public String getContentType()

Description copied from class: ActionReporter

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.

Overrides:

getContentType in class ActionReporter

Returns:

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