Package org.jenkinsci.plugins.cloudstats

Class ProvisioningActivity

java.lang.Object

org.jenkinsci.plugins.cloudstats.ProvisioningActivity

All Implemented Interfaces:

ModelObject, Comparable<ProvisioningActivity>

@ExportedBean
public final class ProvisioningActivity
extends Object
implements ModelObject, Comparable<ProvisioningActivity>

Record of provisioning attempt lifecycle.

Author:

ogondza.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProvisioningActivity.Id	Activity identifier.
static enum	ProvisioningActivity.Phase	Progress of an activity.
static enum	ProvisioningActivity.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREMATURE_COMPLETION_DETECTED

Constructor Summary

Constructors

Constructor	Description
ProvisioningActivity(ProvisioningActivity.Id id)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ProvisioningActivity o)
void	enter(ProvisioningActivity.Phase phase)	Make the phase of this activity entered.
boolean	enterIfNotAlready(ProvisioningActivity.Phase phase)	Make sure the phase of this activity is entered.
boolean	equals(Object o)
ProvisioningActivity.Phase	getCurrentPhase()	Get current ProvisioningActivity.Phase.
PhaseExecution	getCurrentPhaseExecution()	Get current PhaseExecution.
String	getDisplayName()
long	getDuration(PhaseExecution execution)	Get duration of the activity phase.
ProvisioningActivity.Id	getId()
String	getName()
PhaseExecution	getPhase(String phaseName)
PhaseExecution	getPhaseExecution(ProvisioningActivity.Phase phase)	PhaseExecution or null in case it is/was not executed.
Map<ProvisioningActivity.Phase,PhaseExecution>	getPhaseExecutions()	Get a snapshot of phase executions for phases that have already started.
Date	getStarted()
long	getStartedTimestamp()
ProvisioningActivity.Status	getStatus()	Status of the activity as a whole.
int	hashCode()
boolean	isFor(ProvisioningActivity.Id id)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

PREMATURE_COMPLETION_DETECTED

public static final String PREMATURE_COMPLETION_DETECTED

See Also:

• Constant Field Values

Constructor Details

ProvisioningActivity

public ProvisioningActivity(@NonNull
 ProvisioningActivity.Id id)

Method Details

getId

@Exported
@NonNull
public ProvisioningActivity.Id getId()

getStarted

@NonNull
public Date getStarted()

getStartedTimestamp

@Exported
public long getStartedTimestamp()

getPhaseExecution

@CheckForNull
public PhaseExecution getPhaseExecution(@NonNull
 ProvisioningActivity.Phase phase)

PhaseExecution or null in case it is/was not executed.

getPhaseExecutions

@Exported(inline=true)
@NonNull
public Map<ProvisioningActivity.Phase,PhaseExecution> getPhaseExecutions()

Get a snapshot of phase executions for phases that have already started.

Phases that have not yet been entered are absent from the returned map. The iteration order follows declaration order of ProvisioningActivity.Phase.

Returns:

Unmodifiable map of started ProvisioningActivity.Phases to their (non-null) PhaseExecution.

getCurrentPhaseExecution

@NonNull
public PhaseExecution getCurrentPhaseExecution()

Get current PhaseExecution.

getCurrentPhase

@Exported
@NonNull
public ProvisioningActivity.Phase getCurrentPhase()

Get current ProvisioningActivity.Phase.

getStatus

@Exported
@NonNull
public ProvisioningActivity.Status getStatus()

Status of the activity as a whole.

It is the works status of any of the phases, OK by default.

enter

public void enter(@NonNull
 ProvisioningActivity.Phase phase)

Make the phase of this activity entered.

Throws:

IllegalArgumentException - In case phases are entered repeatedly.

enterIfNotAlready

public boolean enterIfNotAlready(@NonNull
 ProvisioningActivity.Phase phase)

Make sure the phase of this activity is entered.

Exposed for convenience of clients that can be invoked repeatedly and have no easier way to tell if phase was entered already, such as launch listener.

Returns:

true is phase was entered.

getName

@Exported
@CheckForNull
public String getName()

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

getPhase

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public PhaseExecution getPhase(@NonNull
 String phaseName)

getDuration

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public long getDuration(@NonNull
 PhaseExecution execution)

Get duration of the activity phase.

Returns:

Positive integer in case the phase is completed, negative in case it is in progress

isFor

public boolean isFor(ProvisioningActivity.Id id)

compareTo

public int compareTo(@NonNull
 ProvisioningActivity o)

Specified by:

compareTo in interface Comparable<ProvisioningActivity>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object