org.jenkinsci.plugins.cloudstats

Class ProvisioningActivity

java.lang.Object

org.jenkinsci.plugins.cloudstats.ProvisioningActivity

All Implemented Interfaces:

hudson.model.ModelObject

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public final class ProvisioningActivity
extends Object
implements hudson.model.ModelObject

Record of provisioning attempt lifecycle.

Author:

ogondza.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ProvisioningActivity(ProvisioningActivity.Id id)

Method Summary

Methods

Modifier and Type	Method and Description
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)
String	getDisplayName()
long	getDuration(PhaseExecution execution) Get duration of the provisioning 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 sorted mapping of all phase executions.
Date	getStarted()
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

Constructor Detail

ProvisioningActivity

public ProvisioningActivity(@Nonnull
                    ProvisioningActivity.Id id)

Method Detail

getId

@Nonnull
public ProvisioningActivity.Id getId()

getStarted

@Nonnull
public Date getStarted()

getPhaseExecution

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

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

getPhaseExecutions

@Nonnull
public Map<ProvisioningActivity.Phase,PhaseExecution> getPhaseExecutions()

Get sorted mapping of all phase executions.

Returns:

Map of ProvisioningActivity.Phase and nullable PhaseExecution.

getStatus

@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

@Nonnull
public String getName()

getDisplayName

@Restricted(value=org.kohsuke.accmod.restrictions.DoNotUse.class)
@Nonnull
public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

getPhase

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

getDuration

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

Get duration of the provisioning phase.

Returns:

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

isFor

public boolean isFor(ProvisioningActivity.Id id)

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