org.jboss.as.controller.client.helpers.domain

Interface DeploymentActionResult

public interface DeploymentActionResult

Describes the results of executing a DeploymentAction across a domain.

Author:

Brian Stansberry

Method Summary

Modifier and Type	Method and Description
DeploymentAction	getDeploymentAction() Gets the deployment action that lead to this result.
UUID	getDeploymentActionId() Gets the unique id of the deployment action.
UpdateFailedException	getDomainControllerFailure() Gets any exception that occurred when applying this update on the domain controller.
UpdateFailedException	getDomainControllerRollbackFailure() Gets any exception that occurred when rolling back this update on the domain controller.
Map<String,UpdateFailedException>	getHostControllerFailures() Gets any exceptions that occurred when applying this update on the host controllers.
Map<String,UpdateFailedException>	getHostControllerRollbackFailures() Gets any exceptions that occurred when rolling back this update on the host controllers.
Map<String,ServerGroupDeploymentActionResult>	getResultsByServerGroup() Gets the results of this action for each server group.
boolean	isCancelledByDomain() Gets whether the action was cancelled by the domain controller before being applied to any servers.
boolean	isRolledBackOnDomain() Gets whether the action was rolled back across the domain after being successfully applied on the domain controller and all host controllers.

Method Detail

getDeploymentActionId

UUID getDeploymentActionId()

Gets the unique id of the deployment action.

Returns:

the id. Will not be null

getDeploymentAction

DeploymentAction getDeploymentAction()

Gets the deployment action that lead to this result.

Returns:

the action. Will not be null

isCancelledByDomain

boolean isCancelledByDomain()

Gets whether the action was cancelled by the domain controller before being applied to any servers.

Returns:

true if the action was cancelled; false otherwise

isRolledBackOnDomain

boolean isRolledBackOnDomain()

Gets whether the action was rolled back across the domain after being successfully applied on the domain controller and all host controllers. Note that depending on the configuration of the deployment plan, an action can be rolled back on individual servers without triggering a rollback across the domain.

This method will return true if a rollback was attempted, whether or not it succeeded. See getDomainControllerRollbackFailure() and getHostControllerRollbackFailures() to see if their were failures on the domain controller or host controllers; for each server see the ServerUpdateResult to see if there were failures on the servers.

Returns:

true if rollback of the action was attempted; false otherwise

getDomainControllerFailure

UpdateFailedException getDomainControllerFailure()

Gets any exception that occurred when applying this update on the domain controller.

Returns:

the exception, or null

getDomainControllerRollbackFailure

UpdateFailedException getDomainControllerRollbackFailure()

Gets any exception that occurred when rolling back this update on the domain controller.

Returns:

the exception, or null

getHostControllerFailures

Map<String,UpdateFailedException> getHostControllerFailures()

Gets any exceptions that occurred when applying this update on the host controllers.

Returns:

the exceptions, keyed by the name of the host whose host controller threw the exception. Will not be null

getHostControllerRollbackFailures

Map<String,UpdateFailedException> getHostControllerRollbackFailures()

Gets any exceptions that occurred when rolling back this update on the host controllers.

Returns:

the exceptions, keyed by the name of the host whose host controller threw the exception. Will not be null

getResultsByServerGroup

Map<String,ServerGroupDeploymentActionResult> getResultsByServerGroup()

Gets the results of this action for each server group.

Returns:

map of server group results, keyed by server group name