Package org.jboss.as.controller

Class OperationFailedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jboss.as.controller.OperationFailedException

All Implemented Interfaces:

Serializable, OperationClientException

public class OperationFailedException
extends Exception
implements OperationClientException

Exception indicating an operation has failed due to a client mistake (e.g. an operation with invalid parameters was invoked.) Should not be used to report server failures.

Author:

David M. Lloyd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OperationFailedException(String message)	Constructs a OperationFailedException with the given message.
OperationFailedException(String message, Throwable cause)	Constructs a OperationFailedException with the specified cause and message.
OperationFailedException(String msg, Throwable cause, org.jboss.dmr.ModelNode description)	Constructs a OperationFailedException with the specified detail message and cause.
OperationFailedException(String msg, org.jboss.dmr.ModelNode description)	Constructs a OperationFailedException with the specified detail message.
OperationFailedException(Throwable cause)	Constructs a OperationFailedException with the specified cause.
OperationFailedException(Throwable cause, org.jboss.dmr.ModelNode description)	Constructs a OperationFailedException with the specified cause.
OperationFailedException(org.jboss.dmr.ModelNode description)	Deprecated. provide a message and use OperationFailedException(String, org.jboss.dmr.ModelNode) or if the description model node is ModelType.STRING, just use OperationFailedException(String)

Method Summary

Modifier and Type	Method	Description
org.jboss.dmr.ModelNode	getFailureDescription()	Get the detyped failure description.
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationFailedException

public OperationFailedException(String message)

Constructs a OperationFailedException with the given message. The message is also used as the failure description. The cause is not initialized, and may subsequently be initialized by a call to initCause.

Parameters:

message - the description of the failure. Cannot be null

OperationFailedException

public OperationFailedException(String message,
                                Throwable cause)

Constructs a OperationFailedException with the specified cause and message. The message is also used as the failure description.

Parameters:

message - the description of the failure. Cannot be null

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method)

OperationFailedException

@Deprecated
public OperationFailedException(org.jboss.dmr.ModelNode description)

Deprecated.

provide a message and use OperationFailedException(String, org.jboss.dmr.ModelNode) or if the description model node is ModelType.STRING, just use OperationFailedException(String)

Constructs a OperationFailedException with no detail message. The cause is not initialized, and may subsequently be initialized by a call to initCause.

Parameters:

description - the description of the failure. Cannot be null

OperationFailedException

public OperationFailedException(String msg,
                                org.jboss.dmr.ModelNode description)

Constructs a OperationFailedException with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to initCause.

Parameters:

msg - the detail message

description - the description of the failure. Cannot be null

OperationFailedException

public OperationFailedException(Throwable cause)

Constructs a OperationFailedException with the specified cause. The cause's message is also used as the failure description.

Parameters:

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). Cannot be null

OperationFailedException

public OperationFailedException(Throwable cause,
                                org.jboss.dmr.ModelNode description)

Constructs a OperationFailedException with the specified cause. The detail message is set to:

(cause == null ? null : cause.toString())

(which typically contains the class and detail message of cause).

Parameters:

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method)

description - the description of the failure. Cannot be null

OperationFailedException

public OperationFailedException(String msg,
                                Throwable cause,
                                org.jboss.dmr.ModelNode description)

Constructs a OperationFailedException with the specified detail message and cause.

Parameters:

msg - the detail message

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method)

description - the description of the failure. Cannot be null

Method Detail

getFailureDescription

public org.jboss.dmr.ModelNode getFailureDescription()

Get the detyped failure description.

Specified by:

getFailureDescription in interface OperationClientException

Returns:

the description. Will not be null

toString

public String toString()

Overrides:

toString in class Throwable