Package org.glassfish.api.admin
Interface Job
-
- All Superinterfaces:
AdminCommandState,Serializable
public interface Job extends AdminCommandState, Serializable
Represents running (or finished) command instance.- Author:
- Martin Mares, Bhakti Mehta
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.glassfish.api.admin.AdminCommandState
AdminCommandState.State
-
-
Field Summary
-
Fields inherited from interface org.glassfish.api.admin.AdminCommandState
EVENT_STATE_CHANGED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcomplete(ActionReport report, Payload.Outbound outbound)longgetCommandCompletionDate()longgetCommandExecutionDate()CommandProgressgetCommandProgress()Command progress only if it is supported by commandAdminCommandEventBrokergetEventBroker()FilegetJobsFile()StringgetName()ParameterMapgetParameters()Payload.OutboundgetPayload()StringgetScope()List<String>getSubjectUsernames()voidrevert()Change state to reverting.voidsetCommandProgress(CommandProgress commandProgress)voidsetFailToRetryable(boolean value)Job will be considered as retryable after fail.voidsetJobsFile(File jobsFile)-
Methods inherited from interface org.glassfish.api.admin.AdminCommandState
complete, getActionReport, getId, getState, isOutboundPayloadEmpty
-
-
-
-
Method Detail
-
getCommandProgress
CommandProgress getCommandProgress()
Command progress only if it is supported by command
-
setCommandProgress
void setCommandProgress(CommandProgress commandProgress)
-
complete
void complete(ActionReport report, Payload.Outbound outbound)
-
revert
void revert()
Change state to reverting. Command Can use it to send info about reverting to Job management infrastructure.
-
getEventBroker
AdminCommandEventBroker getEventBroker()
-
getName
String getName()
-
getCommandExecutionDate
long getCommandExecutionDate()
-
getPayload
Payload.Outbound getPayload()
-
getJobsFile
File getJobsFile()
-
setJobsFile
void setJobsFile(File jobsFile)
-
getScope
String getScope()
-
getCommandCompletionDate
long getCommandCompletionDate()
-
setFailToRetryable
void setFailToRetryable(boolean value)
Job will be considered as retryable after fail. It means that checkpoint will not be deleted and revert or continue can be decided by the user.
-
getParameters
ParameterMap getParameters()
-
-