com.sun.appserv.management.deploy
Interface DeploymentStatus

All Superinterfaces:

MapCapable, OperationStatus

All Known Implementing Classes:

DeploymentStatusImpl

public interface DeploymentStatus
extends OperationStatus

Final status of a deployment. See DeploymentMgr.getFinalDeploymentStatus()

Field Summary

static String	ADDITIONAL_STATUS_KEY
static String	DEPLOYMENT_STATUS_CLASS_NAME Value of the MapCapable.MAP_CAPABLE_CLASS_NAME_KEY when turned into a Map.
static String	MODULE_ID_KEY Key within the Map of AdditionalStatus.
static String	PARENT_KEY
static String	STAGE_DESCRIPTION_KEY
static String	STAGE_STATUS_KEY
static String	STAGE_STATUS_MESSAGE_KEY
static String	STAGE_THROWABLE_KEY
static int	STATUS_CODE_NOT_INITIALIZED Status code indicating failure due to improper initialization.
static String	SUB_STAGES_KEY

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

STATUS_CODE_FAILURE, STATUS_CODE_KEY, STATUS_CODE_SUCCESS, STATUS_CODE_WARNING, THROWABLE_KEY

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

MAP_CAPABLE_CLASS_NAME_KEY

Method Summary

Map<String,Serializable>	getAdditionalStatus()
DeploymentStatus	getParent()
String	getStageDescription()
int	getStageStatus() Legal status codes include: OperationStatus#STATUS_CODE_SUCCESS OperationStatus#STATUS_CODE_FAILURE OperationStatus#STATUS_CODE_WARNING #STATUS_CODE_NOT_INITIALIZED
String	getStageStatusMessage()
Throwable	getStageThrowable()
Iterator<Map<String,Serializable>>	getSubStages() Deprecated.
List<DeploymentStatus>	getSubStagesList() Get the sub stages for this deployment status.
void	setParent(DeploymentStatus parent) set the parent status for this status if any

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

getStatusCode, getThrowable

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

asMap, getMapClassName

Field Detail

DEPLOYMENT_STATUS_CLASS_NAME

static final String DEPLOYMENT_STATUS_CLASS_NAME

Value of the MapCapable.MAP_CAPABLE_CLASS_NAME_KEY when turned into a Map.

See Also:

Constant Field Values

STATUS_CODE_NOT_INITIALIZED

static final int STATUS_CODE_NOT_INITIALIZED

Status code indicating failure due to improper initialization.

See Also:

Constant Field Values

STAGE_STATUS_KEY

static final String STAGE_STATUS_KEY

See Also:

Constant Field Values

STAGE_STATUS_MESSAGE_KEY

static final String STAGE_STATUS_MESSAGE_KEY

See Also:

Constant Field Values

SUB_STAGES_KEY

static final String SUB_STAGES_KEY

See Also:

Constant Field Values

STAGE_THROWABLE_KEY

static final String STAGE_THROWABLE_KEY

See Also:

Constant Field Values

STAGE_DESCRIPTION_KEY

static final String STAGE_DESCRIPTION_KEY

See Also:

Constant Field Values

PARENT_KEY

static final String PARENT_KEY

See Also:

Constant Field Values

ADDITIONAL_STATUS_KEY

static final String ADDITIONAL_STATUS_KEY

See Also:

Constant Field Values

MODULE_ID_KEY

static final String MODULE_ID_KEY

Key within the Map of AdditionalStatus. The unique module id of the deployed component.

See Also:

Constant Field Values

Method Detail

getSubStages

Iterator<Map<String,Serializable>> getSubStages()

Deprecated.

Get the sub stages for this deployment status, each of which has been converted into a Map. This method is included for backward compatibility; please use getSubStagesList() instead.

Returns:

an Iterator for the sub stages

getSubStagesList

List<DeploymentStatus> getSubStagesList()

Get the sub stages for this deployment status. The list may not be modified.

Returns:

List<DeploymentStatus>

getStageStatus

int getStageStatus()

Legal status codes include:

• OperationStatus#STATUS_CODE_SUCCESS
• OperationStatus#STATUS_CODE_FAILURE
• OperationStatus#STATUS_CODE_WARNING
• #STATUS_CODE_NOT_INITIALIZED

Returns:

the status for this stage (ignoring sub stages status)

getStageStatusMessage

String getStageStatusMessage()

Returns:

a meaningful i18ned reason for failure or warning

getStageThrowable

Throwable getStageThrowable()

Returns:

the exception if an exception was thrown during the execution of the stage

getStageDescription

String getStageDescription()

Returns:

a meaningful i18ned stage description

getAdditionalStatus

Map<String,Serializable> getAdditionalStatus()

Returns:

the map storing additional properties for this status

getParent

DeploymentStatus getParent()

Returns:

the parent status for this status if any

setParent

void setParent(DeploymentStatus parent)

set the parent status for this status if any

Parameters:

parent - DeploymentStatus