com.mesosphere.sdk.scheduler.plan

Class AbstractStep

java.lang.Object

com.mesosphere.sdk.scheduler.plan.AbstractStep

All Implemented Interfaces:

Element, Interruptible, Step

Direct Known Subclasses:

DeploymentStep, TLSCleanupStep, UninstallStep

public abstract class AbstractStep
extends java.lang.Object
implements Step

Provides a default implementation of commonly-used Step logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.UUID	id
protected Logger	logger Non-static to ensure that we inherit the names of subclasses.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStep(java.lang.String name, Status status)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
void	forceComplete() Forcefully marks the element as Status.COMPLETE, cancelling any work that hasn't started.
java.util.UUID	getId() Returns the unique identifier of this Element.
java.lang.String	getName() Returns a user-visible name describing the purpose of this Element.
Status	getStatus() Returns the Status of this Element, used to determine if the element still has work to be completed.
int	hashCode()
void	interrupt() A call to interrupt indicates to an Interruptible that it should not continue work beyond the current point, until Interruptible.proceed() is called.
boolean	isInterrupted() Indicates whether the object is interrupted or not.
void	proceed() A call to proceed indicates to an Interruptible that it should may cancel a previous Interruptible.interrupt() call and resume with any in-progress work.
void	restart() Forcefully restarts the element by putting it into a Status.PENDING state.
protected void	setStatus(Status newStatus) Updates the status setting and logs the outcome.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mesosphere.sdk.scheduler.plan.Step

getDisplayStatus, getMessage, getPodInstanceRequirement, isAssetDirty, isEligible, start, updateOfferStatus

Methods inherited from interface com.mesosphere.sdk.scheduler.plan.Element

getErrors, hasErrors, isComplete, isPending, isPrepared, isRunning, isStarted, isStarting, update, updateParameters

Field Detail

logger

protected final Logger logger

Non-static to ensure that we inherit the names of subclasses.

id

protected java.util.UUID id

Constructor Detail

AbstractStep

protected AbstractStep(java.lang.String name,
                       Status status)

Method Detail

getId

public java.util.UUID getId()

Description copied from interface: Element

Returns the unique identifier of this Element.

Specified by:

getId in interface Element

getName

public java.lang.String getName()

Description copied from interface: Element

Returns a user-visible name describing the purpose of this Element.

Specified by:

getName in interface Element

getStatus

public Status getStatus()

Description copied from interface: Element

Returns the Status of this Element, used to determine if the element still has work to be completed.

Specified by:

getStatus in interface Element

setStatus

protected void setStatus(Status newStatus)

Updates the status setting and logs the outcome. Should only be called either by tests, by this, or by subclasses.

Parameters:

newStatus - the new status to be set

interrupt

public void interrupt()

Description copied from interface: Interruptible

A call to interrupt indicates to an Interruptible that it should not continue work beyond the current point, until Interruptible.proceed() is called. This call has no effect if the object is already interrupted.

Specified by:

interrupt in interface Interruptible

proceed

public void proceed()

Description copied from interface: Interruptible

A call to proceed indicates to an Interruptible that it should may cancel a previous Interruptible.interrupt() call and resume with any in-progress work. This call has no effect if the object is already proceeding.

Specified by:

proceed in interface Interruptible

isInterrupted

public boolean isInterrupted()

Description copied from interface: Interruptible

Indicates whether the object is interrupted or not.

Specified by:

isInterrupted in interface Interruptible

Returns:

true if the object is interrupted, false otherwise.

restart

public void restart()

Description copied from interface: Element

Forcefully restarts the element by putting it into a Status.PENDING state.

Specified by:

restart in interface Element

forceComplete

public void forceComplete()

Description copied from interface: Element

Forcefully marks the element as Status.COMPLETE, cancelling any work that hasn't started.

Specified by:

forceComplete in interface Element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object