org.rhq.core.pc.configuration
Class ConfigurationUpdateException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.rhq.core.pc.configuration.ConfigurationUpdateException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

UpdateInProgressException

public class ConfigurationUpdateException
extends RuntimeException

A plugin can throw this exception to indicate to the container that there was a failure that was handled in some way as opposed to an unexpected failure that is not handled. The container will includes the contents of the message property in the response that is sent back to the server; whereas with any other exception, the entire stack trace will be included in the response that sent back to the server.

Consider the following scenario to illustrate an appropriate use of this exception. A plugin attempts to apply an update, and it receives an error code from an external process indicating that the update failed. The plugin in turn could throw a ConfigurationUpdateException including the error code along with other relevant information to provide to additional context. That error message, as opposed to the full stack trace, will be included in the response that is sent back to the server.

See Also:

Serialized Form

Constructor Summary

ConfigurationUpdateException()

ConfigurationUpdateException(String message)

ConfigurationUpdateException(String message, Throwable cause)

ConfigurationUpdateException(Throwable cause)

Method Summary

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationUpdateException

public ConfigurationUpdateException()

ConfigurationUpdateException

public ConfigurationUpdateException(String message)

ConfigurationUpdateException

public ConfigurationUpdateException(String message,
                                    Throwable cause)

ConfigurationUpdateException

public ConfigurationUpdateException(Throwable cause)