org.glassfish.api.admin

Class AdminCommandContextImpl

java.lang.Object

org.glassfish.api.admin.AdminCommandContextImpl

All Implemented Interfaces:

Serializable, AdminCommandContext, ExecutionContext

public class AdminCommandContextImpl
extends Object
implements AdminCommandContext, Serializable

Useful services for administrative commands implementation

Author:

Jerome Dochez

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminCommandContextImpl(Logger logger, ActionReport report)
AdminCommandContextImpl(Logger logger, ActionReport report, Payload.Inbound inboundPayload, Payload.Outbound outboundPayload, AdminCommandEventBroker eventBroker, String jobId)

Method Summary

Modifier and Type	Method and Description
ActionReport	getActionReport() Returns the Reporter for this action
AdminCommandEventBroker	getEventBroker() Simple event broker for inter command communication mostly from server to client.
Payload.Inbound	getInboundPayload() Returns the inbound payload, from the admin client, that accompanied the command request.
String	getJobId() Id of current job.
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.
ProgressStatus	getProgressStatus() ProgressStatus can be used to inform about step by step progress of the command.
Subject	getSubject() Returns the Subject associated with this command context.
void	setActionReport(ActionReport newReport) Change the Reporter for this action
void	setInboundPayload(Payload.Inbound newInboundPayload) Changes the inbound payload for this action.
void	setOutboundPayload(Payload.Outbound newOutboundPayload) Changes the outbound payload for this action.
void	setSubject(Subject subject) Sets the Subject to be associated with this command context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminCommandContextImpl

public AdminCommandContextImpl(Logger logger,
                               ActionReport report)

AdminCommandContextImpl

public AdminCommandContextImpl(Logger logger,
                               ActionReport report,
                               Payload.Inbound inboundPayload,
                               Payload.Outbound outboundPayload,
                               AdminCommandEventBroker eventBroker,
                               String jobId)

Method Detail

getActionReport

public ActionReport getActionReport()

Description copied from interface: AdminCommandContext

Returns the Reporter for this action

Specified by:

getActionReport in interface AdminCommandContext

Returns:

ActionReport implementation suitable for the client

setActionReport

public void setActionReport(ActionReport newReport)

Description copied from interface: AdminCommandContext

Change the Reporter for this action

Specified by:

setActionReport in interface AdminCommandContext

Parameters:

newReport - The ActionReport to set.

getLogger

public Logger getLogger()

Description copied from interface: AdminCommandContext

Returns the Logger

Specified by:

getLogger in interface AdminCommandContext

Specified by:

getLogger in interface ExecutionContext

Returns:

the logger

getInboundPayload

public Payload.Inbound getInboundPayload()

Description copied from interface: AdminCommandContext

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

Specified by:

getInboundPayload in interface AdminCommandContext

Returns:

the inbound payload

setInboundPayload

public void setInboundPayload(Payload.Inbound newInboundPayload)

Description copied from interface: AdminCommandContext

Changes the inbound payload for this action.

Specified by:

setInboundPayload in interface AdminCommandContext

Parameters:

newInboundPayload - inbound payload to set.

getOutboundPayload

public Payload.Outbound getOutboundPayload()

Description copied from interface: AdminCommandContext

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

Specified by:

getOutboundPayload in interface AdminCommandContext

Returns:

the outbound payload

setOutboundPayload

public void setOutboundPayload(Payload.Outbound newOutboundPayload)

Description copied from interface: AdminCommandContext

Changes the outbound payload for this action.

Specified by:

setOutboundPayload in interface AdminCommandContext

Parameters:

newOutboundPayload - outbound payload to set.

getSubject

public Subject getSubject()

Description copied from interface: AdminCommandContext

Returns the Subject associated with this command context.

Specified by:

getSubject in interface AdminCommandContext

Returns:

the Subject

setSubject

public void setSubject(Subject subject)

Description copied from interface: AdminCommandContext

Sets the Subject to be associated with this command context.

Specified by:

setSubject in interface AdminCommandContext

getProgressStatus

public ProgressStatus getProgressStatus()

Description copied from interface: AdminCommandContext

ProgressStatus can be used to inform about step by step progress of the command. It is always ready to use but propagated to the client only if @Progress annotation is on the command implementation.

Specified by:

getProgressStatus in interface AdminCommandContext

Returns:

getEventBroker

public AdminCommandEventBroker getEventBroker()

Description copied from interface: AdminCommandContext

Simple event broker for inter command communication mostly from server to client. (Command to caller).

Specified by:

getEventBroker in interface AdminCommandContext

Returns:

getJobId

public String getJobId()

Description copied from interface: AdminCommandContext

Id of current job. Only managed commands has job id.

Specified by:

getJobId in interface AdminCommandContext

Returns: