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

Interface ServerUpdateResult

public interface ServerUpdateResult
Encapsulates the results of performing a configuration modification on an individual server.
Author:
Brian Stansberry

  • Method Summary

    Modifier and Type
    Method
    Description
    Throwable
    getFailureResult()
    Gets the exception, if any, that occurred while executing this update.
    Throwable
    getRollbackFailure()
    Gets any failure that occurred when rolling back this action on this server.
    ServerIdentity
    getServerIdentity()
    Gets the id of the server on which this update was executed.
    ModelNode
    getSuccessResult()
    Gets the result of the action's modification to the server's configuration.
    UUID
    getUpdateActionId()
    Gets the unique ID of the deployment action.
    boolean
    isCancelled()
    Gets whether the application of this action on this server was cancelled.
    boolean
    isRolledBack()
    Gets whether the application of this action on this server was rolled back.
    boolean
    isServerRestarted()
    Gets whether the application of the update to the server's runtime required a server restart.
    boolean
    isTimedOut()
    Gets whether the application of this action on this server timed out.

  • Method Details

    • getUpdateActionId

      UUID getUpdateActionId()
      Gets the unique ID of the deployment action.
      Returns:
      the ID. Will not be null

    • getServerIdentity

      ServerIdentity getServerIdentity()
      Gets the id of the server on which this update was executed.
      Returns:
      the server identity. Will not be null

    • getSuccessResult

      ModelNode getSuccessResult()
      Gets the result of the action's modification to the server's configuration. This will always be null if isServerRestarted() is true.
      Returns:
      the result. May be null

    • getFailureResult

      Throwable getFailureResult()
      Gets the exception, if any, that occurred while executing this update.
      Returns:
      the exception, or null if no exception occurred

    • isCancelled

      boolean isCancelled()
      Gets whether the application of this action on this server was cancelled.
      Returns:
      true if the action was cancelled; false otherwise

    • isTimedOut

      boolean isTimedOut()
      Gets whether the application of this action on this server timed out.
      Returns:
      true if the action timed out; false otherwise

    • isRolledBack

      boolean isRolledBack()
      Gets whether the application of this action on this server was rolled back.
      Returns:
      true if the action was rolled back; false otherwise

    • getRollbackFailure

      Throwable getRollbackFailure()
      Gets any failure that occurred when rolling back this action on this server.
      Returns:
      the exception, or null if no exception occurred

    • isServerRestarted

      boolean isServerRestarted()
      Gets whether the application of the update to the server's runtime required a server restart.
      Returns:
      true if the server was restarted; false otherwise