DFDeploymentStatus (Deployment Client Classes and Interfaces 4.0 API)

java.lang.Object
- org.glassfish.deployment.client.DFDeploymentStatus

```
public class DFDeploymentStatus
extends Object
```
This class encapsulates all status related to backend deployment Backend deployement can consist of several stages. Those stages are organized in a parent/children relationship where the children are the sub stages of a parent stage. For instance, deployment stage consist of j2eec stage and application loading stage. For a stage to be sucessful, its status and all its children's status must be warning or success

Author:

Jerome Dochez

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DFDeploymentStatus.Status
Possible status for a stage or overall deployment status

Nested Classes
Modifier and Type	Class and Description
`static class`	`DFDeploymentStatus.Status` Possible status for a stage or overall deployment status

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONTEXT_ROOT`
`static String`	`COUNT`
`static String`	`KEY_SEPARATOR`
`static String`	`MODULE_ID`
`static String`	`MODULE_TYPE`
`static String`	`SUBMODULE_COUNT`
`static String`	`WSDL_DIRECTORY`
`static String`	`WSDL_FILE_ENTRIES`
`static String`	`WSDL_LOCATION`
`static String`	`WSDL_PUBLISH_URL`

Constructor Summary

Constructors
Constructor and Description
`DFDeploymentStatus()` Creates a new uninitialized DFDeploymentStatus instance
`DFDeploymentStatus(DFDeploymentStatus parent)` Creates a new uninitialized DFDeploymentStatus instance as a sub stage deployment status of the passed DFDeploymentStatus

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProperty(String propertyName, String propertyValue)` Add a new property to this status object
`void`	`addSubStage(DFDeploymentStatus subStage)` Add a sub stage to this deployment status
`Map`	`getAdditionalStatus()`
`String`	`getAllStageMessages()`
`static void`	`getAllStageMessages(DFDeploymentStatus status, StringBuilder sb)`
`static Iterator`	`getAllStageStatusForLevel(DFDeploymentStatus status, DFDeploymentStatus.Status level)` Get all stages with this deployment status level
`DFDeploymentStatus`	`getMainStatus()`
`DFDeploymentStatus`	`getParent()`
`String`	`getProperty(String propertyName)`
`String`	`getStageDescription()`
`Throwable`	`getStageException()`
`String`	`getStageIdentifier()`
`DFDeploymentStatus.Status`	`getStageStatus()`
`DFDeploymentStatus`	`getStageStatusForLevel(DFDeploymentStatus.Status level)`
`String`	`getStageStatusMessage()`
`DFDeploymentStatus.Status`	`getStatus()`
`Iterator`	`getSubStages()` Get the list of sub stages for this deployment status
`static void`	`parseDeploymentStatus(DFDeploymentStatus status, PrintWriter pw)` Traverse through the DeploymenStatus hierarchy and write failure/warning msgs to the print writer
`void`	`setAdditionalStatus(Map additionalStatus)` Set the additional status for this status
`void`	`setParent(DFDeploymentStatus parent)` Setthe parent status for this status
`void`	`setStageDescription(String string)`
`void`	`setStageException(Throwable throwable)` When the stage throws an exception, it should store it here in the assiciated deployment status
`void`	`setStageStatus(DFDeploymentStatus.Status status)` Set the status for this stage
`void`	`setStageStatusMessage(String string)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONTEXT_ROOT
```
public static final String CONTEXT_ROOT
```
    See Also:
    Constant Field Values
  - KEY_SEPARATOR
```
public static final String KEY_SEPARATOR
```
    See Also:
    Constant Field Values
  - MODULE_ID
```
public static final String MODULE_ID
```
    See Also:
    Constant Field Values
  - MODULE_TYPE
```
public static final String MODULE_TYPE
```
    See Also:
    Constant Field Values
  - SUBMODULE_COUNT
```
public static final String SUBMODULE_COUNT
```
    See Also:
    Constant Field Values
  - WSDL_PUBLISH_URL
```
public static final String WSDL_PUBLISH_URL
```
    See Also:
    Constant Field Values
  - WSDL_LOCATION
```
public static final String WSDL_LOCATION
```
    See Also:
    Constant Field Values
  - WSDL_DIRECTORY
```
public static final String WSDL_DIRECTORY
```
    See Also:
    Constant Field Values
  - WSDL_FILE_ENTRIES
```
public static final String WSDL_FILE_ENTRIES
```
    See Also:
    Constant Field Values
  - COUNT
```
public static final String COUNT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - DFDeploymentStatus
```
public DFDeploymentStatus()
```
    Creates a new uninitialized DFDeploymentStatus instance
  - DFDeploymentStatus
```
public DFDeploymentStatus(DFDeploymentStatus parent)
```
    Creates a new uninitialized DFDeploymentStatus instance as a sub stage deployment status of the passed DFDeploymentStatus
    
    Parameters:
    parent - DFDeploymentStatus
- Method Detail
  - getStatus
```
public DFDeploymentStatus.Status getStatus()
```
    Returns:
    the combined status for the stage and its children, it will return the lowest status as defined in the constants
  - addSubStage
```
public void addSubStage(DFDeploymentStatus subStage)
```
    Add a sub stage to this deployment status
    
    Parameters:
    the - sub stage deployment status
  - getSubStages
```
public Iterator getSubStages()
```
    Get the list of sub stages for this deployment status
    
    Returns:
    an Iterator for the sub stages
  - setStageStatus
```
public void setStageStatus(DFDeploymentStatus.Status status)
```
    Set the status for this stage
    
    Parameters:
    the - status as defined in the constants
  - getStageStatus
```
public DFDeploymentStatus.Status getStageStatus()
```
    Returns:
    the status for this stage (ignoring sub stages status)
  - getStageException
```
public Throwable getStageException()
```
    Returns:
    the exception if an exception was thrown during the execution of the stage
  - getStageIdentifier
```
public String getStageIdentifier()
```
    Returns:
    a meaningful i18ned stage description
  - getStageDescription
```
public String getStageDescription()
```
    Returns:
    a meaningful i18ned stage description
  - getStageStatusMessage
```
public String getStageStatusMessage()
```
    Returns:
    a meaningful i18ned reason for failure or warning
  - setStageException
```
public void setStageException(Throwable throwable)
```
    When the stage throws an exception, it should store it here in the assiciated deployment status
    
    Parameters:
    throwable -
  - setStageDescription
```
public void setStageDescription(String string)
```
    Parameters:
    string - for a meaningful i18ned stage description
  - setStageStatusMessage
```
public void setStageStatusMessage(String string)
```
    Parameters:
    string - for a meaningful i18ned reason for stage warning or failure
  - getStageStatusForLevel
```
public DFDeploymentStatus getStageStatusForLevel(DFDeploymentStatus.Status level)
```
    Returns:
    the current deployment status or one of the sub stage deployment status with a status equal to the provided level.
  - getParent
```
public DFDeploymentStatus getParent()
```
    Returns:
    the parent status for this status if any
  - setParent
```
public void setParent(DFDeploymentStatus parent)
```
    Setthe parent status for this status
  - getMainStatus
```
public DFDeploymentStatus getMainStatus()
```
    Returns:
    the main status for this deployment operation, which is the parent of all status in this hierarchy
  - addProperty
```
public void addProperty(String propertyName,
               String propertyValue)
```
    Add a new property to this status object
  - getProperty
```
public String getProperty(String propertyName)
```
    Returns:
    the value of for property name
  - getAdditionalStatus
```
public Map getAdditionalStatus()
```
    Returns:
    the additional status map
  - getAllStageMessages
```
public String getAllStageMessages()
```
  - getAllStageMessages
```
public static void getAllStageMessages(DFDeploymentStatus status,
                       StringBuilder sb)
```
  - setAdditionalStatus
```
public void setAdditionalStatus(Map additionalStatus)
```
    Set the additional status for this status
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    a meaningful string about mysefl
  - getAllStageStatusForLevel
```
public static Iterator getAllStageStatusForLevel(DFDeploymentStatus status,
                                 DFDeploymentStatus.Status level)
```
    Get all stages with this deployment status level
    
    Parameters:
    parent - status it needs to iterate through
    status - level it's looking for
    
    Returns:
    an iterator for the stages with the level
  - parseDeploymentStatus
```
public static void parseDeploymentStatus(DFDeploymentStatus status,
                         PrintWriter pw)
```
    Traverse through the DeploymenStatus hierarchy and write failure/warning msgs to the print writer

Class DFDeploymentStatus

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTEXT_ROOT

KEY_SEPARATOR

MODULE_ID

MODULE_TYPE

SUBMODULE_COUNT

WSDL_PUBLISH_URL

WSDL_LOCATION

WSDL_DIRECTORY

WSDL_FILE_ENTRIES

COUNT

Constructor Detail

DFDeploymentStatus

DFDeploymentStatus

Method Detail

getStatus

addSubStage

getSubStages

setStageStatus

getStageStatus

getStageException

getStageIdentifier

getStageDescription

getStageStatusMessage

setStageException

setStageDescription

setStageStatusMessage

getStageStatusForLevel

getParent

setParent

getMainStatus

addProperty

getProperty

getAdditionalStatus

getAllStageMessages

getAllStageMessages

setAdditionalStatus

toString

getAllStageStatusForLevel

parseDeploymentStatus