Package com.rabbitmq.client
Class ShutdownSignalException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- com.rabbitmq.client.ShutdownSignalException
-
- All Implemented Interfaces:
SensibleClone<ShutdownSignalException>
,java.io.Serializable
,java.lang.Cloneable
- Direct Known Subclasses:
AlreadyClosedException
public class ShutdownSignalException extends java.lang.RuntimeException implements SensibleClone<ShutdownSignalException>
Encapsulates a shutdown condition for a connection to an AMQP broker. Depending on HardError when callinggetReference()
we will either get a reference to the Connection or Channel instance that fired this exception.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
_hardError
True if the connection is shut down, or false if this signal refers to a channelprivate boolean
_initiatedByApplication
True if this exception is caused by explicit application action; false if it originated with the broker or as a result of detectable non-deliberate application failureprivate Method
_reason
Possible explanationprivate java.lang.Object
_ref
Either Channel or Connection instance, depending on _hardErrorprivate static long
serialVersionUID
Default for non-checking.
-
Constructor Summary
Constructors Constructor Description ShutdownSignalException(boolean hardError, boolean initiatedByApplication, Method reason, java.lang.Object ref)
Construct a ShutdownSignalException from the arguments.ShutdownSignalException(boolean hardError, boolean initiatedByApplication, Method reason, java.lang.Object ref, java.lang.String messagePrefix, java.lang.Throwable cause)
Construct a ShutdownSignalException from the arguments.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static java.lang.String
composeMessage(boolean hardError, boolean initiatedByApplication, Method reason, java.lang.String messagePrefix, java.lang.Throwable cause)
Method
getReason()
java.lang.Object
getReference()
boolean
isHardError()
boolean
isInitiatedByApplication()
ShutdownSignalException
sensibleClone()
Like Object.clone but sensible; in particular, public and declared to return the right type.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Default for non-checking.- See Also:
- Constant Field Values
-
_hardError
private final boolean _hardError
True if the connection is shut down, or false if this signal refers to a channel
-
_initiatedByApplication
private final boolean _initiatedByApplication
True if this exception is caused by explicit application action; false if it originated with the broker or as a result of detectable non-deliberate application failure
-
_reason
private final Method _reason
Possible explanation
-
_ref
private final java.lang.Object _ref
Either Channel or Connection instance, depending on _hardError
-
-
Constructor Detail
-
ShutdownSignalException
public ShutdownSignalException(boolean hardError, boolean initiatedByApplication, Method reason, java.lang.Object ref)
Construct a ShutdownSignalException from the arguments.- Parameters:
hardError
- the relevant hard errorinitiatedByApplication
- if the shutdown was client-initiatedreason
- AMQP method describing the exception reasonref
- Reference to Connection or Channel that fired the signal
-
ShutdownSignalException
public ShutdownSignalException(boolean hardError, boolean initiatedByApplication, Method reason, java.lang.Object ref, java.lang.String messagePrefix, java.lang.Throwable cause)
Construct a ShutdownSignalException from the arguments.- Parameters:
hardError
- the relevant hard errorinitiatedByApplication
- if the shutdown was client-initiatedreason
- AMQP method describing the exception reasonref
- Reference to Connection or Channel that fired the signalmessagePrefix
- prefix to add to exception message
-
-
Method Detail
-
composeMessage
private static java.lang.String composeMessage(boolean hardError, boolean initiatedByApplication, Method reason, java.lang.String messagePrefix, java.lang.Throwable cause)
-
isHardError
public boolean isHardError()
- Returns:
- true if this signals a connection error, or false if a channel error
-
isInitiatedByApplication
public boolean isInitiatedByApplication()
- Returns:
- true if this exception was caused by explicit application action; false if it originated with the broker or as a result of detectable non-deliberate application failure
-
getReason
public Method getReason()
- Returns:
- the reason, if any
-
getReference
public java.lang.Object getReference()
- Returns:
- Reference to Connection or Channel object that fired the signal
-
sensibleClone
public ShutdownSignalException sensibleClone()
Description copied from interface:SensibleClone
Like Object.clone but sensible; in particular, public and declared to return the right type.- Specified by:
sensibleClone
in interfaceSensibleClone<ShutdownSignalException>
-
-