org.glassfish.api.admin
Class AdminCommandContext

java.lang.Object
  org.glassfish.api.admin.AdminCommandContext

All Implemented Interfaces:

ExecutionContext

public class AdminCommandContext
extends java.lang.Object
implements ExecutionContext

Useful services for administrative commands implementation

Author:

Jerome Dochez

Field Summary

java.util.logging.Logger	logger
ActionReport	report

Constructor Summary

AdminCommandContext(java.util.logging.Logger logger, ActionReport report)

AdminCommandContext(java.util.logging.Logger logger, ActionReport report, Payload.Inbound inboundPayload, Payload.Outbound outboundPayload)

Method Summary

ActionReport	getActionReport() Returns the Reporter for this action
Payload.Inbound	getInboundPayload() Returns the inbound payload, from the admin client, that accompanied the command request.
java.util.logging.Logger	getLogger() Returns the Logger
Payload.Outbound	getOutboundPayload() Returns a reference to the outbound payload so a command implementation can populate the payload for return to the admin client.
void	setActionReport(ActionReport newReport) Change the Reporter for this action

Methods inherited from class java.lang.Object

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

Field Detail

report

public ActionReport report

logger

public final java.util.logging.Logger logger

Constructor Detail

AdminCommandContext

public AdminCommandContext(java.util.logging.Logger logger,
                           ActionReport report)

AdminCommandContext

public AdminCommandContext(java.util.logging.Logger logger,
                           ActionReport report,
                           Payload.Inbound inboundPayload,
                           Payload.Outbound outboundPayload)

Method Detail

getActionReport

public ActionReport getActionReport()

Returns the Reporter for this action

Returns:

ActionReport implementation suitable for the client

setActionReport

public void setActionReport(ActionReport newReport)

Change the Reporter for this action

Parameters:

newReport - The ActionReport to set.

getLogger

public java.util.logging.Logger getLogger()

Returns the Logger

Specified by:

getLogger in interface ExecutionContext

Returns:

the logger

getInboundPayload

public Payload.Inbound getInboundPayload()

Returns the inbound payload, from the admin client, that accompanied the command request.

Returns:

the inbound payload

getOutboundPayload

public Payload.Outbound getOutboundPayload()

Returns a reference to the outbound payload so a command implementation can populate the payload for return to the admin client.

Returns:

the outbound payload