Package com.sun.enterprise.admin.progress

Class CommandProgressImpl

java.lang.Object

org.glassfish.api.admin.progress.ProgressStatusBase

org.glassfish.api.admin.progress.ProgressStatusImpl

com.sun.enterprise.admin.progress.CommandProgressImpl

All Implemented Interfaces:

Serializable, CommandProgress, ProgressStatus

public class CommandProgressImpl
extends ProgressStatusImpl
implements CommandProgress, Serializable

Basic and probably only implementation of CommandProgress.

Author:

mmares

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CommandProgressImpl.LastChangedMessage

Nested classes/interfaces inherited from class org.glassfish.api.admin.progress.ProgressStatusBase

ProgressStatusBase.ChildProgressStatus

Field Summary

Fields inherited from class org.glassfish.api.admin.progress.ProgressStatusBase

children, completed, currentStepCount, id, name, parent, totalStepCount

Fields inherited from interface org.glassfish.api.admin.CommandProgress

EVENT_PROGRESSSTATUS_CHANGE, EVENT_PROGRESSSTATUS_STATE

Constructor Summary

Constructors

Constructor	Description
CommandProgressImpl(String name, String id)

Method Summary

Modifier and Type	Method	Description
void	complete()	Indicates the command is complete and no further progress status will be delivered.
void	complete(String message)	Indicates the command is complete and no further progress status will be delivered.
ProgressStatusMirroringImpl	createMirroringChild(int allocatedSteps)	Creates child for mirroring (supplemental commands)
protected void	fireEvent(ProgressStatusEvent event)	Fires ProgressStatusEvent to parent.
Date	getEndTime()	Timestamp of command complete event or null for running command
String	getId()	Id is unique for any ProgressStatuses.
String	getLastMessage()
String	getName()
Date	getStartTime()	Timestamp of command creation
boolean	isSpinnerActive()
void	setEventBroker(AdminCommandEventBroker eventBroker)

Methods inherited from class org.glassfish.api.admin.progress.ProgressStatusImpl

doCreateChild

Methods inherited from class org.glassfish.api.admin.progress.ProgressStatusBase

allocateStapsForChildProcess, completeSilently, computeCompletePortion, computeCompleteSteps, computeSumSteps, createChild, createChild, createChild, findById, getChildProgressStatuses, getChildren, getCurrentStepCount, getParrent, getRemainingStepCount, getTotalStepCount, isComplete, progress, progress, progress, progress, setCurrentStepCount, setTotalStepCount, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.glassfish.api.admin.CommandProgress

computeCompletePortion, computeSumSteps

Methods inherited from interface org.glassfish.api.admin.ProgressStatus

createChild, createChild, getRemainingStepCount, getTotalStepCount, isComplete, progress, progress, progress, progress, setCurrentStepCount, setTotalStepCount

Constructor Detail

CommandProgressImpl

public CommandProgressImpl(String name,
                           String id)

Method Detail

fireEvent

protected void fireEvent(ProgressStatusEvent event)

Description copied from class: ProgressStatusBase

Fires ProgressStatusEvent to parent.

Overrides:

fireEvent in class ProgressStatusBase

setEventBroker

public void setEventBroker(AdminCommandEventBroker eventBroker)

Specified by:

setEventBroker in interface CommandProgress

createMirroringChild

public ProgressStatusMirroringImpl createMirroringChild(int allocatedSteps)

Description copied from interface: CommandProgress

Creates child for mirroring (supplemental commands)

Specified by:

createMirroringChild in interface CommandProgress

getEndTime

public Date getEndTime()

Description copied from interface: CommandProgress

Timestamp of command complete event or null for running command

Specified by:

getEndTime in interface CommandProgress

getStartTime

public Date getStartTime()

Description copied from interface: CommandProgress

Timestamp of command creation

Specified by:

getStartTime in interface CommandProgress

getId

public String getId()

Description copied from interface: ProgressStatus

Id is unique for any ProgressStatuses. It is mainly used for remote communication.

Specified by:

getId in interface CommandProgress

Specified by:

getId in interface ProgressStatus

Overrides:

getId in class ProgressStatusBase

getName

public String getName()

Specified by:

getName in interface CommandProgress

Overrides:

getName in class ProgressStatusBase

getLastMessage

public String getLastMessage()

Specified by:

getLastMessage in interface CommandProgress

complete

public void complete()

Description copied from interface: ProgressStatus

Indicates the command is complete and no further progress status will be delivered. Subsequent invocations of progress() will be ignored. This method also invokes complete() on all child ProgressStatus objects. If this method is not invoked prior to the command completing the CLI framework will implicitly invoke complete() for the ProgressStatus associated with the command.

Specified by:

complete in interface ProgressStatus

Overrides:

complete in class ProgressStatusBase

complete

public void complete(String message)

Description copied from interface: ProgressStatus

Indicates the command is complete and no further progress status will be delivered. Subsequent invocations of progress() will be ignored. This method also invokes complete() on all child ProgressStatus objects. If this method is not invoked prior to the command completing the CLI framework will implicitly invoke complete() for the ProgressStatus associated with the command.

Specified by:

complete in interface ProgressStatus

Overrides:

complete in class ProgressStatusBase

Parameters:

message - to be displayed to the user.

isSpinnerActive

public boolean isSpinnerActive()

Specified by:

isSpinnerActive in interface CommandProgress