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 ofCommandProgress
.- 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
All Methods Instance Methods Concrete Methods 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)
FiresProgressStatusEvent
to parent.Date
getEndTime()
Timestamp of command complete event ornull
for running commandString
getId()
Id is unique for any ProgressStatuses.String
getLastMessage()
String
getName()
Date
getStartTime()
Timestamp of command creationboolean
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
-
-
-
-
Method Detail
-
fireEvent
protected void fireEvent(ProgressStatusEvent event)
Description copied from class:ProgressStatusBase
FiresProgressStatusEvent
to parent.- Overrides:
fireEvent
in classProgressStatusBase
-
setEventBroker
public void setEventBroker(AdminCommandEventBroker eventBroker)
- Specified by:
setEventBroker
in interfaceCommandProgress
-
createMirroringChild
public ProgressStatusMirroringImpl createMirroringChild(int allocatedSteps)
Description copied from interface:CommandProgress
Creates child for mirroring (supplemental commands)- Specified by:
createMirroringChild
in interfaceCommandProgress
-
getEndTime
public Date getEndTime()
Description copied from interface:CommandProgress
Timestamp of command complete event ornull
for running command- Specified by:
getEndTime
in interfaceCommandProgress
-
getStartTime
public Date getStartTime()
Description copied from interface:CommandProgress
Timestamp of command creation- Specified by:
getStartTime
in interfaceCommandProgress
-
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 interfaceCommandProgress
- Specified by:
getId
in interfaceProgressStatus
- Overrides:
getId
in classProgressStatusBase
-
getName
public String getName()
- Specified by:
getName
in interfaceCommandProgress
- Overrides:
getName
in classProgressStatusBase
-
getLastMessage
public String getLastMessage()
- Specified by:
getLastMessage
in interfaceCommandProgress
-
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 invokescomplete()
on all child ProgressStatus objects. If this method is not invoked prior to the command completing the CLI framework will implicitly invokecomplete()
for the ProgressStatus associated with the command.- Specified by:
complete
in interfaceProgressStatus
- Overrides:
complete
in classProgressStatusBase
-
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 invokescomplete()
on all child ProgressStatus objects. If this method is not invoked prior to the command completing the CLI framework will implicitly invokecomplete()
for the ProgressStatus associated with the command.- Specified by:
complete
in interfaceProgressStatus
- Overrides:
complete
in classProgressStatusBase
- Parameters:
message
- to be displayed to the user.
-
isSpinnerActive
public boolean isSpinnerActive()
- Specified by:
isSpinnerActive
in interfaceCommandProgress
-
-