Package org.wildfly.prospero.api

Class ProvisioningProgressEvent

java.lang.Object

org.wildfly.prospero.api.ProvisioningProgressEvent

public class ProvisioningProgressEvent
extends Object

Represents provisioning progress. Emitted periodically during provisioning of servers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProvisioningProgressEvent.EventType

Constructor Summary

Constructors

Constructor	Description
ProvisioningProgressEvent(String stage, ProvisioningProgressEvent.EventType eventType, long completed, long total)
ProvisioningProgressEvent(String stage, ProvisioningProgressEvent.EventType eventType, long completed, long total, String item, boolean slowPhase)

Method Summary

Modifier and Type	Method	Description
long	getCompleted()	count of completed items when the even is emitted
String	getCurrentItem()	details of currently processed item.
ProvisioningProgressEvent.EventType	getEventType()	type of stage event - see ProvisioningProgressEvent.EventType
double	getProgress()	percentage of completion at the time of emitting the event
String	getStage()	name of the current stage
long	getTotal()	total count of items to complete in current stage
boolean	isSlowPhase()	if set, the current phase doesn't receive any updates and can be a relatively slow process
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProvisioningProgressEvent

public ProvisioningProgressEvent(String stage,
                                 ProvisioningProgressEvent.EventType eventType,
                                 long completed,
                                 long total)

ProvisioningProgressEvent

public ProvisioningProgressEvent(String stage,
                                 ProvisioningProgressEvent.EventType eventType,
                                 long completed,
                                 long total,
                                 String item,
                                 boolean slowPhase)

Method Detail

getCurrentItem

public String getCurrentItem()

details of currently processed item.

Returns:

description of item if available, null otherwise

isSlowPhase

public boolean isSlowPhase()

if set, the current phase doesn't receive any updates and can be a relatively slow process

Returns:

getProgress

public double getProgress()

percentage of completion at the time of emitting the event

Returns:

getEventType

public ProvisioningProgressEvent.EventType getEventType()

type of stage event - see ProvisioningProgressEvent.EventType

getCompleted

public long getCompleted()

count of completed items when the even is emitted

getTotal

public long getTotal()

total count of items to complete in current stage

getStage

public String getStage()

name of the current stage

toString

public String toString()

Overrides:

toString in class Object