com.sun.appserv.management.deploy
Interface DeploymentProgress

All Superinterfaces:

MapCapable

All Known Implementing Classes:

DeploymentProgressImpl

public interface DeploymentProgress
extends MapCapable

Interface to provide deployment feedback while deployment is executing in the server backend. This interface may be instantiated by using routines in DeploymentSupport

Field Summary

static String	DEPLOYMENT_PROGRESS_CLASS_NAME Value of the MAP_CAPABLE_TYPE_KEY when turned into a Map.
static String	DESCRIPTION_KEY Key for the Description as returned by getDescription().
static String	LOCALIZED_DESCRIPTION_KEY_BASE Key prefix for the Description as returned by getDescription().
static String	PROGRESS_PERCENT_KEY Key for the progress percent as returned by getProgressPercent().

Fields inherited from interface com.sun.appserv.management.base.MapCapable

MAP_CAPABLE_CLASS_NAME_KEY

Method Summary

String	getDescription()
String	getLocalizedDescription(Locale locale)
byte	getProgressPercent()

Methods inherited from interface com.sun.appserv.management.base.MapCapable

asMap, getMapClassName

Field Detail

DEPLOYMENT_PROGRESS_CLASS_NAME

static final String DEPLOYMENT_PROGRESS_CLASS_NAME

Value of the MAP_CAPABLE_TYPE_KEY when turned into a Map.

See Also:

Constant Field Values

PROGRESS_PERCENT_KEY

static final String PROGRESS_PERCENT_KEY

Key for the progress percent as returned by getProgressPercent().

See Also:

Constant Field Values

DESCRIPTION_KEY

static final String DESCRIPTION_KEY

Key for the Description as returned by getDescription().

See Also:

Constant Field Values

LOCALIZED_DESCRIPTION_KEY_BASE

static final String LOCALIZED_DESCRIPTION_KEY_BASE

Key prefix for the Description as returned by getDescription(). The key for a given locale is LOCALIZED_DESCRIPTION_KEY_BASE + "_" + Locale.toString()

See Also:

Constant Field Values

Method Detail

getProgressPercent

byte getProgressPercent()

Returns:

the deployment progress number between 0 and 100 (deployment finished). This number is purely indicative and cannot be used to calculate actual remaining time

getDescription

String getDescription()

Returns:

the last meaningful description of the current deployment operation

getLocalizedDescription

String getLocalizedDescription(Locale locale)

Returns:

the last meaningful localized description of the current deployment operation.